From e39e38da112d0dee5fb96ea7de9cfe2c36777928 Mon Sep 17 00:00:00 2001
From: Sun Jia Cheng <sunjc826@gmail.com>
Date: Sat, 9 Mar 2024 11:06:14 +0800
Subject: [PATCH] Implement 'Show Hidden Files' feature

---
 .gitignore          |  3 ++-
 src/UI/UIDesktop.js | 12 ++++++++++++
 src/UI/UIItem.js    |  3 ++-
 src/UI/UIWindow.js  | 12 ++++++++++++
 src/css/style.css   | 12 ++++++++++++
 src/globals.js      | 13 ++++++++++++
 src/helpers.js      | 48 ++++++++++++++++++++++++++++++++++++++++-----
 7 files changed, 96 insertions(+), 7 deletions(-)

diff --git a/.gitignore b/.gitignore
index 8b23bc40..289d6b5b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,5 @@ node_modules/
 *.tgz
 license.config.json
 license-header.txt
-dist/
\ No newline at end of file
+dist/
+.vscode/
\ No newline at end of file
diff --git a/src/UI/UIDesktop.js b/src/UI/UIDesktop.js
index 6b85a06e..844053be 100644
--- a/src/UI/UIDesktop.js
+++ b/src/UI/UIDesktop.js
@@ -683,6 +683,18 @@ async function UIDesktop(options){
                         }
                     },
                     // -------------------------------------------
+                    // Show/Hide hidden files
+                    // -------------------------------------------
+                    {
+                        html: `${window.user_preferences.show_hidden_files ? 'Hide' : 'Show'} hidden files`,
+                        onClick: function(){
+                            window.mutate_user_preferences({
+                                show_hidden_files : !window.user_preferences.show_hidden_files,
+                            });
+                            window.show_or_hide_files(document.querySelectorAll('.item-container'));
+                        }
+                    },
+                    // -------------------------------------------
                     // -
                     // -------------------------------------------
                     '-',
diff --git a/src/UI/UIItem.js b/src/UI/UIItem.js
index b40cf5fc..4d580128 100644
--- a/src/UI/UIItem.js
+++ b/src/UI/UIItem.js
@@ -46,6 +46,7 @@ function UIItem(options){
 
     // set options defaults
     options.disabled = options.disabled ?? false;
+    options.visible = options.visible ?? 'visible'; // one of 'visible', 'revealed', 'hidden'
     options.is_dir = options.is_dir ?? false;
     options.is_selected = options.is_selected ?? false;
     options.is_shared = options.is_shared ?? false;
@@ -71,7 +72,7 @@ function UIItem(options){
     // --------------------------------------------------------
     let h = '';
     h += `<div  id="item-${item_id}" 
-                class="item${options.is_selected ? ' item-selected':''} ${options.disabled ? 'item-disabled':''}" 
+                class="item${options.is_selected ? ' item-selected':''} ${options.disabled ? 'item-disabled':''} item-${options.visible}" 
                 data-id="${item_id}" 
                 data-name="${html_encode(options.name)}" 
                 data-metadata="${html_encode(options.metadata)}" 
diff --git a/src/UI/UIWindow.js b/src/UI/UIWindow.js
index d3da06f1..8d5dc509 100644
--- a/src/UI/UIWindow.js
+++ b/src/UI/UIWindow.js
@@ -1880,6 +1880,18 @@ async function UIWindow(options) {
                             }
                         },
                         // -------------------------------------------
+                        // Show/Hide hidden files
+                        // -------------------------------------------
+                        {
+                            html: `${window.user_preferences.show_hidden_files ? "Hide" : "Show"} hidden files`,
+                            onClick: function(){
+                                window.mutate_user_preferences({
+                                    show_hidden_files : !window.user_preferences.show_hidden_files,
+                                });
+                                window.show_or_hide_files(document.querySelectorAll('.item-container'));
+                            }
+                        },
+                        // -------------------------------------------
                         // -
                         // -------------------------------------------
                         '-',
diff --git a/src/css/style.css b/src/css/style.css
index 51275c3a..5dd97c1e 100644
--- a/src/css/style.css
+++ b/src/css/style.css
@@ -306,6 +306,18 @@ input[type=text]:focus, input[type=password]:focus, input[type=email]:focus, sel
     pointer-events: none;
 }
 
+.item-revealed {
+    opacity: 0.9;
+}
+
+.item-hidden {
+    display: none
+}
+
+.item-revealed.item-disabled {
+    opacity: 0.7
+}
+
 .item-container-list .item {
     height: initial;
     width: max-content;
diff --git a/src/globals.js b/src/globals.js
index 1a0e4c18..d2d336e0 100644
--- a/src/globals.js
+++ b/src/globals.js
@@ -85,6 +85,19 @@ if(window.user !== undefined && window.user !== null){
 }
 window.root_dirname = 'Puter';
 
+// user preferences, persisted across sessions, cached in localStorage
+try {
+    window.user_preferences = JSON.parse(localStorage.getItem('user_preferences'))
+}catch(e){
+    window.user_preferences = null;
+}
+// default values
+if (window.user_preferences === null) {
+    window.user_preferences = {
+        show_hidden_files: false,
+    }
+}
+
 window.window_stack = []
 window.toolbar_height = 30;
 window.default_taskbar_height = 50;
diff --git a/src/helpers.js b/src/helpers.js
index d2a40fce..d7d3da90 100644
--- a/src/helpers.js
+++ b/src/helpers.js
@@ -656,7 +656,13 @@ window.refresh_user_data = async (auth_token)=>{
     // update local user data
     if(whoami){
         update_auth_data(auth_token, whoami)
-    } 
+    }
+
+    // update local user preferences
+    const user_preferences = {
+        show_hidden_files: (await puter.kv.get('user_preferences.show_hidden_files')) === 'true',
+    };
+    update_user_preferences(user_preferences);
 }
 
 window.update_auth_data = (auth_token, user)=>{
@@ -710,6 +716,20 @@ window.update_auth_data = (auth_token, user)=>{
     }
 }
 
+window.mutate_user_preferences = function(user_preferences_delta) {
+    for (const [key, value] of Object.entries(user_preferences_delta)) {
+        // Don't wait for set to be done for better efficiency
+        puter.kv.set(`user_preferences.${key}`, String(value));
+    }
+    // There may be syncing issues across multiple devices
+    update_user_preferences({ ...window.user_preferences, ...user_preferences_delta });
+}
+
+window.update_user_preferences = function(user_preferences) {
+    window.user_preferences = user_preferences;
+    localStorage.setItem('user_preferences', JSON.stringify(user_preferences));
+}
+
 window.sendWindowWillCloseMsg = function(iframe_element) {
     return new Promise(function(resolve){
         const msg_id = uuidv4();
@@ -1255,11 +1275,18 @@ window.refresh_item_container = function(el_item_container, options){
                 if(!window.check_fsentry_against_allowed_file_types_string(fsentry, allowed_file_types))
                     is_disabled = true;
 
-                // skip if hidden (i.e. name starts with `.`)
-                if(fsentry.name.startsWith('.'))
-                    continue;
+                // set visibility based on user preferences and whether file is hidden by default
+                const is_hidden_file = fsentry.name.startsWith('.');
+                let visible;
+                if (!is_hidden_file){
+                    visible = 'visible';
+                }else if (window.user_preferences.show_hidden_files) {
+                    visible = 'revealed';
+                }else{
+                    visible = 'hidden';
+                }
 
-                //metadata
+                // metadata
                 let metadata;
                 if(fsentry.metadata !== ''){
                     try{
@@ -1295,6 +1322,7 @@ window.refresh_item_container = function(el_item_container, options){
                         modified: fsentry.modified,
                         suggested_apps: fsentry.suggested_apps,
                         disabled: is_disabled,
+                        visible: visible,
                     });
                 }
             }
@@ -1380,6 +1408,16 @@ window.sort_items = (item_container, sort_by, sort_order)=>{
     }).appendTo(item_container);
 }
 
+window.show_or_hide_files = (item_containers) => {
+    const show_hidden_files = window.user_preferences.show_hidden_files;
+    const class_to_add = show_hidden_files ? 'item-revealed' : 'item-hidden';
+    const class_to_remove = show_hidden_files ? 'item-hidden' : 'item-revealed';
+    $(item_containers)
+        .find('.item')
+        .filter((_, item) => item.dataset.name.startsWith('.'))
+        .removeClass(class_to_remove).addClass(class_to_add);
+}
+
 window.create_folder = async(basedir, appendto_element)=>{
 	let dirname = basedir;
     let folder_name = 'New Folder';