Refactoring: use the same cookie functions for all scripts

Author: doxygen

deps/jquery/Makefile

@@ -11,7 +11,8 @@ SCRIPTS = jquery-$(JQUERY_VERSION).min.js \
           jquery.scrollTo-$(SCROLL_VERSION).min.js \
 	  jquery.powertip-$(POWERTIP_VERSION).mod.min.js \
 	  jquery.ui.touch-punch-$(TOUCHPUNCH_VERSION).min.js \
-	  jquery.smartmenus-$(SMARTMENUS_VERSION).min.js
+	  jquery.smartmenus-$(SMARTMENUS_VERSION).min.js \
+	  cookie.js
 RESULTS = jquery.js doxmenu-min.css
 
 all: $(RESULTS)

deps/jquery/cookie.js

@@ -0,0 +1,52 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+var Cookie =
+{
+  cookie_namespace: 'doxygen_',
+
+  readSetting: function(cookie,defVal) {
+    if (window.chrome) {
+      var val = localStorage.getItem(this.cookie_namespace+cookie);
+      if (val) return val;
+    } else {
+      var myCookie = this.cookie_namespace+cookie+"=";
+      if (document.cookie) {
+        var index = document.cookie.indexOf(myCookie);
+        if (index != -1) {
+          var valStart = index + myCookie.length;
+          var valEnd = document.cookie.indexOf(";", valStart);
+          if (valEnd == -1) {
+            valEnd = document.cookie.length;
+          }
+          var val = document.cookie.substring(valStart, valEnd);
+          return val;
+        }
+      }
+    }
+    return defVal;
+  },
+
+  writeSetting: function(cookie,val,days=10*365) { // 10 years -> forever
+    if (window.chrome) {
+      localStorage.setItem(this.cookie_namespace+cookie,val);
+    } else {
+      var date = new Date();
+      date.setTime(date.getTime()+(days*24*60*60*1000));
+      expiration = date.toGMTString();
+      document.cookie = this.cookie_namespace + cookie + "=" +
+                        val + "; SameSite=Lax; expires=" + expiration+"; path=/";
+    }
+  },
+
+  eraseSetting: function(cookie) {
+    if (window.chrome) {
+      var val = localStorage.removeItem(this.cookie_namespace+cookie);
+      if (val) return val;
+    } else {
+      this.writeSetting(cookie,'',-1);
+    }
+  },
+}

templates/html/darkmode_toggle.js

@@ -28,6 +28,10 @@ SOFTWARE.
 */
 
 class DarkModeToggle extends HTMLElement {
+
+    static darkmode_cookie_name = 'prefers-dark';
+    static lightmode_cookie_name = 'prefers-light';
+
     static icon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="1em" width="1em"><g fill="none" fill-rule="evenodd"><path d="M0 0h24v24H0z"></path><rect width="1" height="3" x="12" fill="currentColor" rx=".5"></rect><rect width="1" height="3" x="12" y="21" fill="currentColor" rx=".5"></rect><rect width="1" height="3" x="22" y="10.5" fill="currentColor" rx=".5" transform="rotate(90 22.5 12)"></rect><rect width="1" height="3" x="1" y="10.5" fill="currentColor" rx=".5" transform="rotate(90 1.5 12)"></rect><rect width="1" height="3" x="19" y="3" fill="currentColor" rx=".5" transform="rotate(-135 19.5 4.5)"></rect><rect width="1" height="3" x="19" y="18" fill="currentColor" rx=".5" transform="rotate(135 19.5 19.5)"></rect><rect width="1" height="3" x="4" y="3" fill="currentColor" rx=".5" transform="scale(1 -1) rotate(45 15.37 0)"></rect><rect width="1" height="3" x="4" y="18" fill="currentColor" rx=".5" transform="scale(1 -1) rotate(-45 -42.57 0)"></rect><circle cx="12" cy="12" r="6.5" stroke="currentColor"></circle><path fill="currentColor" stroke="currentColor" d="M12.5 18.48V5.52a6.5 6.5 0 010 12.96z"></path></g></svg>';
     static title = "Toggle Light/Dark Mode"
 
@@ -159,54 +163,29 @@ class DarkModeToggle extends HTMLElement {
     }
 
     static get prefersDarkModeInLightMode() {
-        if (window.chrome) { // Chrome supports localStorage in combination with file:// but not cookies
-          return localStorage.getItem(DarkModeToggle.prefersDarkModeInLightModeKey)
-        } else { // Other browsers support cookies in combination with file:// but not localStorage
-          return DarkModeToggle.readCookie('doxygen_prefers_dark')=='1'
-        }
+        return Cookie.readSetting(DarkModeToggle.darkmode_cookie_name,'0')=='1';
     }
 
     static set prefersDarkModeInLightMode(preference) {
-        if (window.chrome) {
-            if (preference) {
-                localStorage.setItem(DarkModeToggle.prefersDarkModeInLightModeKey, true)
-            } else {
-                localStorage.removeItem(DarkModeToggle.prefersDarkModeInLightModeKey)
-            }
+        if (preference) {
+          Cookie.writeSetting(DarkModeToggle.darkmode_cookie_name,'1');
         } else {
-            if (preference) {
-               DarkModeToggle.createCookie('doxygen_prefers_dark','1',365)
-            } else {
-               DarkModeToggle.eraseCookie('doxygen_prefers_dark')
-            }
+          Cookie.eraseSetting(DarkModeToggle.darkmode_cookie_name);
         }
     }
 
     static get prefersLightModeInDarkMode() {
-        if (window.chrome) { // Chrome supports localStorage in combination with file:// but not cookies
-          return localStorage.getItem(DarkModeToggle.prefersLightModeInDarkModeKey)
-        } else { // Other browsers support cookies in combination with file:// but not localStorage
-          return DarkModeToggle.readCookie('doxygen_prefers_light')=='1'
-        }
+        return Cookie.readSetting(DarkModeToggle.lightmode_cookie_name,'0')=='1'
     }
 
     static set prefersLightModeInDarkMode(preference) {
-        if (window.chrome) {
-            if (preference) {
-                localStorage.setItem(DarkModeToggle.prefersLightModeInDarkModeKey, true)
-            } else {
-                localStorage.removeItem(DarkModeToggle.prefersLightModeInDarkModeKey)
-            }
+        if (preference) {
+          Cookie.writeSetting(DarkModeToggle.lightmode_cookie_name,'1');
         } else {
-            if (preference) {
-               DarkModeToggle.createCookie('doxygen_prefers_light','1',365)
-            } else {
-               DarkModeToggle.eraseCookie('doxygen_prefers_light')
-            }
+          Cookie.eraseSetting(DarkModeToggle.lightmode_cookie_name);
         }
     }
 
-
     /**
      * @returns `true` for dark-mode, `false` for light-mode user preference
      */

templates/html/jquery.js

@@ -25,6 +25,7 @@
 var navTreeSubIndices = new Array();
 var arrowDown = '▼';
 var arrowRight = '►';
+var navpath_cookie_name = 'navpath';
 
 function getData(varName)
 {
@@ -61,37 +62,21 @@ function pathName()
   return $(location).attr('pathname').replace(/[^-A-Za-z0-9+&@#/%?=~_|!:,.;\(\)]/g, '');
 }
 
-function localStorageSupported()
-{
-  try {
-    return 'localStorage' in window && window['localStorage'] !== null && window.localStorage.getItem;
-  }
-  catch(e) {
-    return false;
-  }
-}
-
 function storeLink(link)
 {
-  if (!$("#nav-sync").hasClass('sync') && localStorageSupported()) {
-      window.localStorage.setItem('navpath',link);
+  if (!$("#nav-sync").hasClass('sync')) {
+      Cookie.writeSetting(navpath_cookie_name,link);
   }
 }
 
 function deleteLink()
 {
-  if (localStorageSupported()) {
-    window.localStorage.setItem('navpath','');
-  }
+  Cookie.writeSetting(navpath_cookie_name,'');
 }
 
 function cachedLink()
 {
-  if (localStorageSupported()) {
-    return window.localStorage.getItem('navpath');
-  } else {
-    return '';
-  }
+  return Cookie.readSetting(navpath_cookie_name,'');
 }
 
 function getScript(scriptName,func)
@@ -506,16 +491,14 @@ function initNavTree(toroot,relpath)
   o.node.plus_img.className = 'arrow';
   o.node.plus_img.innerHTML = arrowRight;
 
-  if (localStorageSupported()) {
-    var navSync = $('#nav-sync');
-    if (cachedLink()) {
-      showSyncOff(navSync,relpath);
-      navSync.removeClass('sync');
-    } else {
-      showSyncOn(navSync,relpath);
-    }
-    navSync.click(function(){ toggleSyncButton(relpath); });
+  var navSync = $('#nav-sync');
+  if (cachedLink()) {
+    showSyncOff(navSync,relpath);
+    navSync.removeClass('sync');
+  } else {
+    showSyncOn(navSync,relpath);
   }
+  navSync.click(function(){ toggleSyncButton(relpath); });
 
   if (loadTriggered) { // load before ready
     navTo(o,toroot,hashUrl(),relpath);

templates/html/navtree.js

@@ -22,46 +22,12 @@
 
  @licend  The above is the entire license notice for the JavaScript code in this file
  */
+
 var once=1;
 function initResizable()
 {
-  var cookie_namespace = 'doxygen';
   var sidenav,navtree,content,header,barWidth=6,desktop_vp=768,titleHeight;
-
-  function readSetting(cookie)
-  {
-    if (window.chrome) {
-      var val = localStorage.getItem(cookie_namespace+'_width');
-      if (val) return val;
-    } else {
-      var myCookie = cookie_namespace+"_"+cookie+"=";
-      if (document.cookie) {
-        var index = document.cookie.indexOf(myCookie);
-        if (index != -1) {
-          var valStart = index + myCookie.length;
-          var valEnd = document.cookie.indexOf(";", valStart);
-          if (valEnd == -1) {
-            valEnd = document.cookie.length;
-          }
-          var val = document.cookie.substring(valStart, valEnd);
-          return val;
-        }
-      }
-    }
-    return $TREEVIEW_WIDTH;
-  }
-
-  function writeSetting(cookie, val)
-  {
-    if (window.chrome) {
-      localStorage.setItem(cookie_namespace+"_width",val);
-    } else {
-      var date = new Date();
-      date.setTime(date.getTime()+(10*365*24*60*60*1000)); // default expiration is one week
-      expiration = date.toGMTString();
-      document.cookie = cookie_namespace + "_" + cookie + "=" + val + "; SameSite=Lax; expires=" + expiration+"; path=/";
-    }
-  }
+  var resize_cookie_name = 'width';
 
   function resizeWidth()
   {
@@ -71,7 +37,7 @@ function initResizable()
     if (typeof page_layout!=='undefined' && page_layout==1) {
       footer.css({marginLeft:parseInt(sidenavWidth)+"px"});
     }
-    writeSetting('width',sidenavWidth-barWidth);
+    Cookie.writeSetting(resize_cookie_name,sidenavWidth-barWidth);
   }
 
   function restoreWidth(navWidth)
@@ -114,12 +80,12 @@ function initResizable()
       newWidth=0;
     }
     else {
-      var width = readSetting('width');
+      var width = Cookie.readSetting(resize_cookie_name,$TREEVIEW_WIDTH);
       newWidth = (width>$TREEVIEW_WIDTH && width<$(window).width()) ? width : $TREEVIEW_WIDTH;
     }
     restoreWidth(newWidth);
     var sidenavWidth = $(sidenav).outerWidth();
-    writeSetting('width',sidenavWidth-barWidth);
+    Cookie.writeSetting(resize_cookie_name,sidenavWidth-barWidth);
   }
 
   header  = $("#top");
@@ -138,7 +104,7 @@ function initResizable()
     $('#nav-sync').css({ right:'34px' });
     barWidth=20;
   }
-  var width = readSetting('width');
+  var width = Cookie.readSetting(resize_cookie_name,$TREEVIEW_WIDTH);
   if (width) { restoreWidth(width); } else { resizeWidth(); }
   resizeHeight();
   var url = location.href;

templates/html/resize.js

@@ -22,8 +22,7 @@
 
  @licend  The above is the entire license notice for the JavaScript code in this file
  */
-var cookie_namespace = 'doxygen';
-var cookie_name = '_search_grp';
+var search_cookie_name = 'search_grp';
 
 function convertToId(search)
 {
@@ -274,7 +273,7 @@ function SearchBox(name, resultsPath, extension)
         if (j==id)
         {
           node.innerHTML='•';
-          writeSetting(cookie_name, child.childNodes[1].nodeValue)
+          Cookie.writeSetting(search_cookie_name, child.childNodes[1].nodeValue)
         }
         else
         {
@@ -830,45 +829,10 @@ function createResults(resultsPath)
   }
 }
 
-function writeSetting(cookie, val)
-{
-  if (window.chrome) {
-    localStorage.setItem(cookie_namespace+cookie,val);
-  } else {
-    var date = new Date();
-    date.setTime(date.getTime()+(1*60*60*1000)); // default expiration is one hour
-    expiration = date.toGMTString();
-    document.cookie = cookie_namespace + cookie + "=" + val + "; SameSite=Lax; expires=" + expiration+"; path=/";
-  }
-}
-
 function init_search()
 {
   var results = document.getElementById("MSearchSelectWindow");
 
-  function readSetting(cookie)
-  {
-    if (window.chrome) {
-      var val = localStorage.getItem(cookie_namespace+cookie);
-      if (val) return val;
-    } else {
-      var myCookie = cookie_namespace+cookie+"=";
-      if (document.cookie) {
-        var index = document.cookie.indexOf(myCookie);
-        if (index != -1) {
-          var valStart = index + myCookie.length;
-          var valEnd = document.cookie.indexOf(";", valStart);
-          if (valEnd == -1) {
-            valEnd = document.cookie.length;
-          }
-          var val = document.cookie.substring(valStart, valEnd);
-          return val;
-        }
-      }
-    }
-    return 0;
-  }
-
   results.tabIndex=0;
   for (var key in indexSectionLabels)
   {
@@ -894,7 +858,7 @@ function init_search()
       }
     }
   });
-  var name = readSetting(cookie_name);
+  var name = Cookie.readSetting(search_cookie_name,0);
   var id = searchBox.GetSelectionIdByName(name);
   searchBox.OnSelectItem(id);
 }