GNU bug report logs - #79168
30.1; Proposed changes for oauth2

Previous Next

Full log

View this message in rfc822 format

From: Xiyue Deng <manphiz <at> gmail.com>
To: 79168 <at> debbugs.gnu.org
Cc: Xiyue Deng <manphiz <at> gmail.com>
Subject: bug#79168: [PATCH 10/11] Close the plstore handle after use
Date: Sun,  3 Aug 2025 17:20:48 -0700

Before this, the plstore stores a handle to `oauth2-token-file' and it
is kept open at all times.  This may cause issues when the file is
accessed by other processes and it may confuse Emacs. This patch
ensures that the plstore is properly closed upon each use.

Note that the plstore field in oauth2-token is unused and will always
be nil but is kept for backward-compatibility for now.
---
 oauth2.el | 57 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 31 insertions(+), 26 deletions(-)

diff --git a/oauth2.el b/oauth2.el
index 87fa1f0793..e4e9ff8d6c 100644
--- a/oauth2.el
+++ b/oauth2.el
@@ -84,6 +84,13 @@
   (when oauth2-debug
     (apply #'oauth2--do-warn msg)))
 
+(defmacro oauth2--with-plstore (&rest body)
+  "A macro that ensures the plstore is closed after use."
+  `(let ((plstore (plstore-open oauth2-token-file)))
+     (unwind-protect
+         (progn ,@body)
+       (plstore-close plstore))))
+
 (defun oauth2--current-timestamp ()
   "Get the current timestamp in seconds."
   (time-convert nil 'integer))
@@ -231,7 +238,7 @@ TOKEN should be obtained with `oauth2-request-access'."
                                "&refresh_token="
                                (oauth2-token-refresh-token token)
                                "&grant_type=refresh_token")))))
-    (when-let* ((plstore (oauth2-token-plstore token)))
+    (oauth2--with-plstore
      (oauth2--update-plstore plstore token)))
 
   token)
@@ -267,31 +274,29 @@ redirect response.
 
 Returns an `oauth2-token'."
   ;; We store a MD5 sum of all URL
-  (let* ((plstore (plstore-open oauth2-token-file))
-         (plstore-id (oauth2-compute-id auth-url token-url scope client-id))
-         (plist (cdr (plstore-get plstore plstore-id))))
-    ;; Check if we found something matching this access
-    (if plist
-        ;; We did, return the token object
-        (make-oauth2-token :plstore plstore
-                           :plstore-id plstore-id
-                           :client-id client-id
-                           :client-secret client-secret
-                           :access-token (plist-get plist :access-token)
-                           :refresh-token (plist-get plist :refresh-token)
-                           :request-timestamp (plist-get plist
-                                                         :request-timestamp)
-                           :auth-url auth-url
-                           :token-url token-url
-                           :access-response (plist-get plist :access-response))
-      (let ((token (oauth2-auth auth-url token-url
-                                client-id client-secret state
-                                redirect-uri)))
-        ;; Set the plstore
-        (setf (oauth2-token-plstore token) plstore)
-        (setf (oauth2-token-plstore-id token) plstore-id)
-        (oauth2--update-plstore plstore token)
-        token))))
+  (oauth2--with-plstore
+   (let* ((plstore-id (oauth2-compute-id auth-url token-url scope client-id))
+          (plist (cdr (plstore-get plstore plstore-id))))
+     ;; Check if we found something matching this access
+     (if plist
+         ;; We did, return the token object
+         (make-oauth2-token :plstore-id plstore-id
+                            :client-id client-id
+                            :client-secret client-secret
+                            :access-token (plist-get plist :access-token)
+                            :refresh-token (plist-get plist :refresh-token)
+                            :request-timestamp (plist-get plist
+                                                          :request-timestamp)
+                            :auth-url auth-url
+                            :token-url token-url
+                            :access-response (plist-get plist :access-response))
+       (let ((token (oauth2-auth auth-url token-url
+                                 client-id client-secret state
+                                 redirect-uri)))
+         ;; Set the plstore
+         (setf (oauth2-token-plstore-id token) plstore-id)
+         (oauth2--update-plstore plstore token)
+         token)))))
 
 (provide 'oauth2)
 
-- 
2.39.5

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.