Merge pull request #323 from matteofuso/oauth-webbrowser-response

kokarare1212 · web-flow · commit 76983a40e67f · 2025-11-13T08:57:55.000+09:00
Fix OAuth callback server to return a response to the browser
diff --git a/README.md b/README.md
@@ -76,18 +76,22 @@ session = Session.Builder() \
     .create()
 ```
 
-#### With auth url callback
+#### With auth url callback and changing the content of the success page
 
 ```python
 from librespot.core import Session
+import webbrowser
 
 # This will pass the auth url to the method
 
 def auth_url_callback(url):
-    print(url)
+    webbrowser.open(url)
+
+# This is the response sent to the browser once the flow has been completed successfully
+success_page = "<html><body><h1>Login Successful</h1><p>You can close this window now.</p><script>setTimeout(() => {window.close()}, 100);</script></body></html>"
 
 session = Session.Builder() \
-    .oauth(auth_url_callback) \
+    .oauth(auth_url_callback, success_page) \
     .create()
 ```
 
diff --git a/librespot/core.py b/librespot/core.py
@@ -1638,7 +1638,7 @@ def stored_file(self,
                             pass
             return self
 
-        def oauth(self, oauth_url_callback) -> Session.Builder:
+        def oauth(self, oauth_url_callback, success_page_content = None) -> Session.Builder:
             """
             Login via OAuth
 
@@ -1647,7 +1647,7 @@ def oauth(self, oauth_url_callback) -> Session.Builder:
             """
             if os.path.isfile(self.conf.stored_credentials_file):
                 return self.stored_file(None)
-            self.login_credentials = OAuth(MercuryRequests.keymaster_client_id, "http://127.0.0.1:5588/login", oauth_url_callback).flow()
+            self.login_credentials = OAuth(MercuryRequests.keymaster_client_id, "http://127.0.0.1:5588/login", oauth_url_callback).set_success_page_content(success_page_content).flow()
             return self
 
         def user_pass(self, username: str, password: str) -> Session.Builder:
diff --git a/librespot/oauth.py b/librespot/oauth.py
@@ -22,11 +22,16 @@ class OAuth:
     __token = ""
     __server = None
     __oauth_url_callback = None
+    __success_page_content = None
 
     def __init__(self, client_id, redirect_url, oauth_url_callback):
         self.__client_id = client_id
         self.__redirect_url = redirect_url
         self.__oauth_url_callback = oauth_url_callback
+    
+    def set_success_page_content(self, content):
+        self.__success_page_content = content
+        return self
 
     def __generate_generate_code_verifier(self):
         possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
@@ -76,22 +81,34 @@ def get_credentials(self):
     class CallbackServer(HTTPServer):
         callback_path = None
 
-        def __init__(self, server_address, RequestHandlerClass, callback_path, set_code):
+        def __init__(self, server_address, RequestHandlerClass, callback_path, set_code, success_page_content):
             self.callback_path = callback_path
             self.set_code = set_code
+            self.success_page_content = success_page_content
             super().__init__(server_address, RequestHandlerClass)
 
     class CallbackRequestHandler(BaseHTTPRequestHandler):
         def do_GET(self):
             if(self.path.startswith(self.server.callback_path)):
                 query = urllib.parse.parse_qs(urlparse(self.path).query)
                 if not query.__contains__("code"):
+                    self.send_response(400)
+                    self.send_header('Content-type', 'text/html')
+                    self.end_headers()
                     self.wfile.write(b"Request doesn't contain 'code'")
                     return
                 self.server.set_code(query.get("code")[0])
-                self.wfile.write(b"librespot-python received callback")
+                self.send_response(200)
+                self.send_header('Content-type', 'text/html')
+                self.end_headers()
+                success_page = self.server.success_page_content or "librespot-python received callback"
+                self.wfile.write(success_page.encode('utf-8'))
             pass
 
+        # Suppress logging
+        def log_message(self, format, *args) -> None:
+            return
+
     def __start_server(self):
         try:
             self.__server.handle_request()
@@ -106,7 +123,8 @@ def run_callback_server(self):
             (url.hostname, url.port),
             self.CallbackRequestHandler,
             url.path,
-            self.set_code
+            self.set_code,
+            self.__success_page_content,
         )
         logging.info("OAuth: Waiting for callback on %s", url.hostname + ":" + str(url.port))
         self.__start_server()
