Merge pull request r0x0r#1364 from r0x0r/clear-cookies

r0x0r · web-flow · commit 60e960c6038f · 2024-04-15T22:55:58.000+03:00
Clear cookies
diff --git a/docs/guide/api.md b/docs/guide/api.md
@@ -508,6 +508,19 @@ window.height
 
 Get height of the window
 
+### window.clear_cookies
+
+``` python
+window.clear_cookies()
+```
+
+Clear all the cookies including `HttpOnly` ones.
+
+#### Example
+
+* [Cookies](/examples/cookies.html)
+
+
 ### window.create\_confirmation\_dialog
 
 ``` python
@@ -762,7 +775,7 @@ Get DOM document's window `window` as an `Element` object
 
 ## Window events
 
-Window object exposes a number of lifecycle and window management events. To subscribe to an event, use the `+=` syntax, e.g. `window.events.loaded += func`. Duplicate subscriptions are ignored and function is invoked only once for duplicate subscribers. To unsubscribe, use the `-=` syntax, `window.events.loaded -= func`.
+Window object exposes a number of lifecycle and window management events. To subscribe to an event, use the `+=` syntax, e.g. `window.events.loaded += func`. Duplicate subscriptions are ignored and function is invoked only once for duplicate subscribers. To unsubscribe, use the `-=` syntax, `window.events.loaded -= func`. To access the window object from the event handler, you can supply `window` parameter as a first positional argument of the handler.
 
 ### window.events.closed
 
@@ -810,20 +823,20 @@ Event fired when pywebview window is shown.
 
 [Example](/examples/events.html)
 
-
 ## DOM events
 
 _pywebview_ exposes a `window.pywebviewready` DOM event that is fired after `window.pywebview` is created.
 
 [Example](/examples/js_api.html)
 
-
 ## Drag area
 
 With a frameless _pywebview_ window, A window can be moved or dragged by adding a special class called `pywebview-drag-region` in your html
+
 ```html
 <div class='pywebview-drag-region'>This div element can be used to moved or drag your window like a native OS window</div>
 ```
+
 The magic class name can be overriden by re-assigning the `webview.DRAG_REGION_SELECTOR` constant.
 
 
diff --git a/examples/assets/cookies.html b/examples/assets/cookies.html
@@ -21,8 +21,9 @@ <h1>Cookies Example</h1>
 <p>Cookies: <span id='cookies'></span></p>
 <p>Local storage: <span id='localstorage'></span></p>
 
-
 <button onClick="setCookies()">Set cookies</button><br/>
+<button onClick="showCookies()">Read cookies</button><br/>
+<button onClick="clearCookies()">Clear cookies</button>
 <script>
     var cookieContainer = document.getElementById('cookies')
     var localStorageContainer = document.getElementById('localstorage')
@@ -39,6 +40,10 @@ <h1>Cookies Example</h1>
       cookieContainer.innerHTML = document.cookie
       localStorageContainer.innerHTML = localStorage.getItem('pywebview')
     }
+
+    function clearCookies() {
+      pywebview.api.clearCookies().then(showCookies)
+    }
 </script>
 </body>
 </html>
diff --git a/examples/cookies.py b/examples/cookies.py
@@ -9,8 +9,13 @@ def read_cookies(window):
         print(c.output())
 
 
+class Api:
+    def clearCookies(self):
+        window.clear_cookies()
+        print('Cookies cleared')
+
 if __name__ == '__main__':
-    window = webview.create_window('Cookie example', 'assets/cookies.html')
+    window = webview.create_window('Cookie example', 'assets/cookies.html', js_api=Api())
 
     # We need to explicitly set a http port to persist cookies between sessions
     webview.start(read_cookies, window, private_mode=False, http_server=True, http_port=13377)
diff --git a/tests/assets/script.js b/tests/assets/script.js
@@ -1 +1,2 @@
 window.testResult = 80085
+document.cookie = 'pywebview=true'
diff --git a/tests/assets/test.html b/tests/assets/test.html
@@ -4,7 +4,7 @@
 		<meta charset="utf-8">
 		<title>Test app</title>
 		<link rel="stylesheet" href="styles.css">
-        <script src="script.js"></script>
+		<script src="script.js"></script>
 	</head>
 	<body>
     <h1 id="heading">Hello there!</h1>
diff --git a/tests/test_cookies.py b/tests/test_cookies.py
@@ -0,0 +1,30 @@
+import pytest
+
+import webview
+from time import sleep
+from .util import run_test
+
+
+@pytest.fixture
+def window():
+    return webview.create_window('Cookie test', 'assets/test.html')
+
+
+def test_get_cookies(window):
+    run_test(webview, window, get_cookies_test)
+
+
+def test_clear_cookies(window):
+    run_test(webview, window, clear_cookies_test)
+
+
+def get_cookies_test(window):
+    cookies = window.get_cookies()
+    assert len(cookies) == 1
+    assert cookies[0].output() == 'Set-Cookie: pywebview=true; Domain=127.0.0.1; expires=None; Path=/; SameSite=None'
+
+
+def clear_cookies_test(window):
+    window.clear_cookies()
+    cookies = window.get_cookies()
+    assert len(cookies) == 0
diff --git a/webview/platforms/android.py b/webview/platforms/android.py
@@ -333,6 +333,11 @@ def _evaluate_js():
     lock.acquire()
     return js_result
 
+def clear_cookies(_):
+    def _cookies():
+        CookieManager.getInstance().removeAllCookies(None)
+
+    Runnable(_cookies)()
 
 def get_cookies(_):
     def _cookies():
diff --git a/webview/platforms/cef.py b/webview/platforms/cef.py
@@ -174,6 +174,11 @@ def evaluate_js(self, code, unique_id):
 
         return result
 
+    def clear_cookies(self):
+        self.loaded.wait()
+        self.cookie_manager.DeleteCookies('', '')
+        self.cookie_manager.FlushStore()
+
     def get_cookies(self):
         self.loaded.wait()
         self.cookie_visitor.cookies = []
@@ -237,7 +242,7 @@ def wrapper(*args, **kwargs):
         uid = args[-1]
 
         if uid not in instances:
-            logger.error('CEF window with uid {0} does not exist'.format(uid))
+            logger.error(f'CEF window with uid {uid} does not exist with {func}')
             return
 
         return func(*args, **kwargs)
@@ -350,6 +355,12 @@ def evaluate_js(code, result, uid):
     return instance.evaluate_js(code, result)
 
 
+@_cef_call
+def clear_cookies(uid):
+    instance = instances[uid]
+    return instance.clear_cookies()
+
+
 @_cef_call
 def get_cookies(uid):
     instance = instances[uid]
diff --git a/webview/platforms/cocoa.py b/webview/platforms/cocoa.py
@@ -524,11 +524,11 @@ def __init__(self, window):
         config.userContentController().addScriptMessageHandler_name_(
             self._browserDelegate, 'browserDelegate'
         )
+        self.datastore = WebKit.WKWebsiteDataStore.defaultDataStore()
 
         if _settings['private_mode']:
             # nonPersisentDataStore preserves cookies for some unknown reason. For this reason we use default datastore
             # and clear all the cookies beforehand
-            self.datastore = WebKit.WKWebsiteDataStore.defaultDataStore()
 
             def dummy_completion_handler():
                 pass
@@ -540,7 +540,6 @@ def dummy_completion_handler():
                 data_types, from_start, dummy_completion_handler
             )
         else:
-            self.datastore = WebKit.WKWebsiteDataStore.defaultDataStore()
             config.setWebsiteDataStore_(self.datastore)
 
         try:
@@ -728,6 +727,16 @@ def center(self):
 
         self.window.setFrameOrigin_(window_frame.origin)
 
+    def clear_cookies(self):
+        def clear():
+            self.datastore.removeDataOfTypes_modifiedSince_completionHandler_(
+                WebKit.WKWebsiteDataStore.allWebsiteDataTypes(),
+                Foundation.NSDate.dateWithTimeIntervalSince1970_(0),
+                lambda: None,
+            )
+
+        AppHelper.callAfter(clear)
+
     def get_cookies(self):
         def handler(cookies):
             for c in cookies:
@@ -1308,6 +1317,12 @@ def get_current_url(uid):
         return i.get_current_url()
 
 
+def clear_cookies(uid):
+    i = BrowserView.instances.get(uid)
+    if i:
+        i.clear_cookies()
+
+
 def get_cookies(uid):
     i = BrowserView.instances.get(uid)
     if i:
diff --git a/webview/platforms/edgechromium.py b/webview/platforms/edgechromium.py
@@ -94,6 +94,9 @@ def _callback(result):
             js_result.append(None)
             semaphore.release()
 
+    def clear_cookies(self):
+        self.web_view.CoreWebView2.CookieManager.DeleteAllCookies()
+
     def get_cookies(self, cookies, semaphore):
         def _callback(task):
             for c in task.Result:
diff --git a/webview/platforms/gtk.py b/webview/platforms/gtk.py
@@ -307,7 +307,7 @@ def on_load_finish(self, webview, status):
                     source_uri=None,
                     cancellable=None,
                     callback=None)
-                
+
             self._set_js_api()
 
     def on_download_started(self, session, download):
@@ -494,6 +494,12 @@ def _add_file_filters(self, dialog, file_types):
 
             dialog.add_filter(f)
 
+    def clear_cookies(self):
+        def _clear_cookies():
+            self.cookie_manager.delete_all_cookies()
+
+        glib.idle_add(_clear_cookies)
+
     def get_cookies(self):
         def _get_cookies():
             self.cookie_manager.get_cookies(self.webview.get_uri(), None, callback, None)
@@ -579,7 +585,7 @@ def create_bridge():
                     source_uri=None,
                     cancellable=None,
                     callback=None)
-    
+
             self.loaded.set()
 
         glib.idle_add(create_bridge)
@@ -702,6 +708,12 @@ def restore(uid):
         glib.idle_add(i.restore)
 
 
+def clear_cookies(uid):
+    i = BrowserView.instances.get(uid)
+    if i:
+        i.clear_cookies()
+
+
 def get_cookies(uid):
     i = BrowserView.instances.get(uid)
     if i:
diff --git a/webview/platforms/qt.py b/webview/platforms/qt.py
@@ -223,7 +223,6 @@ def acceptNavigationRequest(self, url, type, is_main_frame):
 
     class WebPage(QWebPage):
         def __init__(self, parent=None, profile=None):
-            print(profile)
             if is_webengine and profile:
                 super(BrowserView.WebPage, self).__init__(profile, parent.view)
             else:
@@ -686,6 +685,10 @@ def set_title(self, title):
     def get_cookies(self):
         return list(self.cookies.values())
 
+    def clear_cookies(self):
+        self.cookies = {}
+        self.profile.cookieStore().deleteAllCookies()
+
     def get_current_url(self):
         self.loaded.wait()
         self.current_url_trigger.emit()
@@ -897,6 +900,12 @@ def set_title(title, uid):
         i.set_title(title)
 
 
+def clear_cookies(uid):
+    i = BrowserView.instances.get(uid)
+    if i:
+        i.clear_cookies()
+
+
 def get_cookies(uid):
     i = BrowserView.instances.get(uid)
     if i:
diff --git a/webview/platforms/winforms.py b/webview/platforms/winforms.py
@@ -122,7 +122,7 @@ def edge_build(key_type, key, description=''):
     from . import mshtml as IE
 
     logger.warning(
-        'MSHTML is deprecated. See https://pywebview.flowrl.com/guide/renderer.html#web-engine on details how to use Edge Chromium'
+        'MSHTML is deprecated. See https://pywebview.flowrl.com/guide/web_engine.html on details how to use Edge Chromium'
     )
     logger.debug('Using WinForms / MSHTML')
     IE._set_ie_mode()
@@ -265,9 +265,6 @@ def on_activated(self, *_):
             if not self.pywebview_window.focus:
                 windll.user32.SetWindowLongW(self.Handle.ToInt32(), -20, windll.user32.GetWindowLongW(self.Handle.ToInt32(), -20) | 0x8000000)
 
-            if is_cef and self.pywebview_window.focus:
-                CEF.focus(self.uid)
-
         def on_shown(self, *_):
             if not is_cef:
                 self.shown.set()
@@ -356,6 +353,16 @@ def _evaluate_js():
 
             return self.browser.js_result
 
+        def clear_cookies(self):
+            def _clear_cookies():
+                self.browser.clear_cookies()
+
+            if not is_chromium:
+                logger.error('clear_cookies() is not implemented for this platform')
+                return
+
+            self.Invoke(Func[Type](_clear_cookies))
+
         def get_cookies(self):
             def _get_cookies():
                 self.browser.get_cookies(cookies, semaphore)
@@ -702,6 +709,15 @@ def create_file_dialog(dialog_type, directory, allow_multiple, save_filename, fi
         return None
 
 
+def clear_cookies(uid):
+    if is_cef:
+        CEF.clear_cookies(uid)
+    i = BrowserView.instances.get(uid)
+
+    if i:
+        i.clear_cookies()
+
+
 def get_cookies(uid):
     if is_cef:
         return CEF.get_cookies(uid)
diff --git a/webview/util.py b/webview/util.py
@@ -69,6 +69,11 @@ def get_app_root() -> str:
         return os.path.dirname(sys.executable)
 
     if 'pytest' in sys.modules:
+        root_dir = [arg.split('=')[1] for arg in sys.argv if arg.startswith('--rootdir')]
+
+        if root_dir:
+            return root_dir[0]
+
         for arg in reversed(sys.argv):
             path = os.path.realpath(arg.split('::')[0])
             if os.path.exists(path):
diff --git a/webview/window.py b/webview/window.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`window.testResult = 80085`
	`2`	`+document.cookie = 'pywebview=true'`