Javascript persistency improvements

- Use session storage for Chromium based browsers when using session cookies for Firefox. - Store per project cookies (based on PROJECT_NAME + PROJECT_NUMBER setting in the config file)
doxygen · Oct 31, 2023 · 2f3a72e · 2f3a72e
1 parent 173c944
commit 2f3a72e
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 17 deletions.
diff --git a/deps/jquery/cookie.js b/deps/jquery/cookie.js
@@ -8,7 +8,8 @@ let Cookie = {
 
   readSetting(cookie,defVal) {
     if (window.chrome) {
-      const val = localStorage.getItem(this.cookie_namespace+cookie);
+      const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+                  sessionStorage.getItem(this.cookie_namespace+cookie);
       if (val) return val;
     } else {
       let myCookie = this.cookie_namespace+cookie+"=";
@@ -29,7 +30,11 @@ let Cookie = {
 
   writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
     if (window.chrome) {
-      localStorage.setItem(this.cookie_namespace+cookie,val);
+      if (days==0) {
+        sessionStorage.setItem(this.cookie_namespace+cookie,val);
+      } else {
+        localStorage.setItem(this.cookie_namespace+cookie,val);
+      }
     } else {
       let date = new Date();
       date.setTime(date.getTime()+(days*24*60*60*1000));
@@ -41,8 +46,11 @@ let Cookie = {
 
   eraseSetting(cookie) {
     if (window.chrome) {
-      const val = localStorage.removeItem(this.cookie_namespace+cookie);
-      if (val) return val;
+      if (localStorage.getItem(this.cookie_namespace+cookie)) {
+        localStorage.removeItem(this.cookie_namespace+cookie);
+      } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+        sessionStorage.removeItem(this.cookie_namespace+cookie);
+      }
     } else {
       this.writeSetting(cookie,'',-1);
     }

diff --git a/src/ftvhelp.cpp b/src/ftvhelp.cpp
@@ -835,6 +835,7 @@ static void generateJSNavTree(const FTVNodes &nodeList)
     t << "\nvar SYNCONMSG = '"  << theTranslator->trPanelSynchronisationTooltip(FALSE) << "';";
     t << "\nvar SYNCOFFMSG = '" << theTranslator->trPanelSynchronisationTooltip(TRUE)  << "';";
   }
+
   ResourceMgr::instance().copyResource("navtree.js",htmlOutput);
 }
 
@@ -870,7 +871,10 @@ void FTVHelp::generateTreeViewScripts()
     if (f.is_open())
     {
       TextStream t(&f);
-      t << substitute(mgr.getAsString("resize.js"), "$TREEVIEW_WIDTH", QCString().setNum(Config_getInt(TREEVIEW_WIDTH)));
+      t << substitute(
+             substitute(mgr.getAsString("resize.js"),
+                "$TREEVIEW_WIDTH", QCString().setNum(Config_getInt(TREEVIEW_WIDTH))),
+                "$PROJECTID",      getProjectId());
     }
   }
   {

diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp
@@ -1219,7 +1219,8 @@ void HtmlGenerator::init()
     if (f.is_open())
     {
       TextStream t(&f);
-      t << replaceColorMarkers(mgr.getAsString("darkmode_toggle.js"));
+      t << substitute(replaceColorMarkers(mgr.getAsString("darkmode_toggle.js")),
+          "$PROJECTID",getProjectId());
     }
   }
 

diff --git a/src/util.cpp b/src/util.cpp
@@ -6987,3 +6987,13 @@ QCString detab(const QCString &s,int &refIndent)
   out.addChar(0);
   return out.get();
 }
+
+QCString getProjectId()
+{
+  QCString projectName = Config_getString(PROJECT_NAME)+" "+Config_getString(PROJECT_NUMBER);
+  uint8_t md5_sig[16];
+  char sigStr[33];
+  MD5Buffer(projectName.data(),projectName.length(),md5_sig);
+  MD5SigToString(md5_sig,sigStr);
+  return sigStr;
+}
diff --git a/src/util.h b/src/util.h
@@ -472,4 +472,6 @@ inline QCString fixSpaces(const QCString &s) { return substitute(s," ","&#160;")
 
 QCString detab(const QCString &s,int &refIndent);
 
+QCString getProjectId();
+
 #endif
diff --git a/templates/html/darkmode_toggle.js b/templates/html/darkmode_toggle.js
@@ -29,8 +29,8 @@ SOFTWARE.
 
 class DarkModeToggle extends HTMLElement {
 
-    static darkmode_cookie_name = 'prefers-dark';
-    static lightmode_cookie_name = 'prefers-light';
+    static darkmode_cookie_name = '$PROJECTID'+'_prefers-dark';
+    static lightmode_cookie_name = '$PROJECTID'+'_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"

diff --git a/templates/html/jquery.js b/templates/html/jquery.js
diff --git a/templates/html/resize.js b/templates/html/resize.js
@@ -26,15 +26,15 @@
 let once=1;
 function initResizable() {
   let sidenav,navtree,content,header,footer,barWidth=6;
-  const resize_cookie_name = 'width';
+  const RESIZE_COOKIE_NAME = '$PROJECTID'+'_width';
 
   function resizeWidth() {
     const sidenavWidth = $(sidenav).outerWidth();
     content.css({marginLeft:parseInt(sidenavWidth)+"px"});
     if (typeof page_layout!=='undefined' && page_layout==1) {
       footer.css({marginLeft:parseInt(sidenavWidth)+"px"});
     }
-    Cookie.writeSetting(resize_cookie_name,sidenavWidth-barWidth);
+    Cookie.writeSetting(RESIZE_COOKIE_NAME,sidenavWidth-barWidth);
   }
 
   function restoreWidth(navWidth) {
@@ -72,12 +72,12 @@ function initResizable() {
     if (sidenav.width()>0) {
       newWidth=0;
     } else {
-      const width = Cookie.readSetting(resize_cookie_name,$TREEVIEW_WIDTH);
+      const width = Cookie.readSetting(RESIZE_COOKIE_NAME,$TREEVIEW_WIDTH);
       newWidth = (width>$TREEVIEW_WIDTH && width<$(window).width()) ? width : $TREEVIEW_WIDTH;
     }
     restoreWidth(newWidth);
     const sidenavWidth = $(sidenav).outerWidth();
-    Cookie.writeSetting(resize_cookie_name,sidenavWidth-barWidth);
+    Cookie.writeSetting(RESIZE_COOKIE_NAME,sidenavWidth-barWidth);
   }
 
   header  = $("#top");
@@ -96,7 +96,7 @@ function initResizable() {
     $('#nav-sync').css({ right:'34px' });
     barWidth=20;
   }
-  const width = Cookie.readSetting(resize_cookie_name,$TREEVIEW_WIDTH);
+  const width = Cookie.readSetting(RESIZE_COOKIE_NAME,$TREEVIEW_WIDTH);
   if (width) { restoreWidth(width); } else { resizeWidth(); }
   resizeHeight();
   const url = location.href;