Add new autoremember-timer-minutes setting (#316)

Author: cxw42

app/common/setting-definitions.js

@@ -188,6 +188,11 @@ _VAL[_NAM.CFGS_FAVICON_SOURCE] = (v) => {
         : undefined;
 };
 
+// #316.  How often to autoremember.  Empty or <= 0 == don't autosave
+_NAM.CFGS_AUTOREMEMBER_MINUTES = "autoremember-timer-minutes";
+_DEF[_NAM.CFGS_AUTOREMEMBER_MINUTES] = "0";
+_VAL[_NAM.CFGS_AUTOREMEMBER_MINUTES] = _vint;
+
 // }}}2
 
 // The exportable format of the above objects

app/settings/manifest.js

@@ -226,6 +226,15 @@ setting_definitions.push(
             "type": "checkbox",
             "label": future_i18n('Prompt for confirmation before closing or deleting a tab that is currently playing audio (<i class="fa fa-music"></i>)'),
         },
+        {
+            "tab": future_i18n("Behaviour"),
+            "group": future_i18n("Autoremember"),
+            "name": S.S_AUTOREMEMBER_MINUTES,
+            "type": "text",
+            "label": future_i18n('If this is an integer <tt>I</tt> &gt;= 0, automatically '
+                + 'remember all open windows/tabs every <tt>I</tt> minutes.  Refresh the '
+                + 'TabFern window to apply changes to this option.'),
+        },
 
         // Appearance
         {
@@ -501,6 +510,9 @@ setting_definitions.push(
             "text":
 `
 <ul>
+<li>TabFern can now automatically mark windows as remembered on a timer.
+    Set the timer you want in ${settings} Behaviour ${gt} Autoremember
+    ${issue(316)}.</li>
 </ul>
 `
         },

app/win/main_tl.js

@@ -4510,6 +4510,49 @@ function addEventListeners(done) {
     done();
 } //addEventListeners
 
+// Mark all windows as remembered
+function rememberAll() {
+    var modified = false;
+    L.log.info("Marking all windows as remembered");
+    try {
+        const root = T.treeobj.get_node($.jstree.root);
+        root.children.forEach((kid_node_id, kid_idx) => {
+            const val = D.windows.by_node_id(kid_node_id);
+            if (val && val.keep !== K.WIN_KEEP) {
+                modified = true;
+                M.remember(kid_node_id);
+            }
+        });
+    } catch (e) {
+        log.warn({ "Failure when trying to auto-remember windows": e });
+        // But don't throw the error since we still want to save the tree.
+    }
+
+    if (modified) {
+        saveTree();
+    }
+} //rememberAll
+
+// Timer handler to call rememberAll() and set the next timer.
+function autoRememberAll(minutes, only_start_timer = false) {
+    if (!only_start_timer) {
+        rememberAll();
+    }
+
+    L.log.info(`Starting autoremember timer for ${minutes} minute(s)`);
+    window.setTimeout(() => {
+        autoRememberAll(minutes);
+    }, minutes * 60 * 1000);
+} // autoRememberAll
+
+function startAutoRememberTimerIfRequested(done) {
+    const minutes = S.getInt(S.S_AUTOREMEMBER_MINUTES, 0);
+    if (minutes > 0) {
+        autoRememberAll(minutes, true); // true => just start the timer
+    }
+    done();
+} // startAutoRememberTimerIfRequested()
+
 /// The last function to be called after all other initialization has
 /// completed successfully.
 function initTreeFinal(done) {
@@ -4620,6 +4663,8 @@ function main() {
         if (spinner) spinner.spin($("#tabfern-container")[0]);
     };
 
+    // --- Init steps ---
+
     s.then(determine_devel_mode)
         .then(basicInit)
 
@@ -4646,16 +4691,23 @@ function main() {
         })
         .then(addOpenWindowsToTree)
         .then(addEventListeners)
-        .then(initTreeFinal)
+        .then(initTreeFinal) // This needs to be the last real init step
+
+        .val(check_init_step_count) // This is a sanity check after initTreeFinal
 
-        .val(check_init_step_count)
+        // --- Post-init steps ---
 
         // Stop the spinner, if it started
         .val(() => {
             spinner.stop();
             spinner = null;
         })
 
+        // Start the autoremember timer now that all the state is consistent
+        .then(startAutoRememberTimerIfRequested)
+
+        // --- Error handling ---
+
         .or((err) => {
             $(K.INIT_MSG_SEL).text($(K.INIT_MSG_SEL).text() + "\n" + err);