Improve translations and dialogs

malisipi · malisipi · commit e7fddbace4ef · 2024-04-27T16:32:23.000+03:00
diff --git a/_locales/de/messages.json b/_locales/de/messages.json
@@ -11,6 +11,12 @@
     "useDefaultProfile": {
         "message": "Standardbrowserprofil verwenden"
     },
+    "uiOk": {
+        "message": "Ok"
+    },
+    "uiCancel": {
+        "message": "Abbrechen"
+    },
     "uiURL": {
         "message": "URL"
     },
@@ -49,5 +55,14 @@
     },
     "warningEmptyName": {
         "message": "Der Name darf nicht leer sein"
+    },
+    "warningExceedCommandSize": {
+        "message": "Maximale Befehlsgröße überschritten. Bitte geben Sie die URL oder den Namen der Website kurz an."
+    },
+    "uiDialogDesktopShortcutsTitle": {
+        "message": "Desktop-Verknüpfungen"
+    },
+    "uiDialogDesktopShortcutsDescription": {
+        "message": "Die Erweiterung erstellt Desktop-Verknüpfungen für den einfachen Zugriff auf Ihre SSB-Sites.\nDesktop-Verknüpfungen haben keine Ausführungsberechtigung, bis Sie die Berechtigung erteilen. Heruntergeladene Dateien werden vom Betriebssystem erst erkannt, wenn die Dateierweiterung „.download“ in ihren Namen gelöscht wird. Dies ist auch eine Sicherheitsmaßnahme, die von Firefox gefordert wird."
     }
 }
diff --git a/_locales/en/messages.json b/_locales/en/messages.json
@@ -11,6 +11,12 @@
     "useDefaultProfile": {
         "message": "Use Default Browser Profile"
     },
+    "uiOk": {
+        "message": "Ok"
+    },
+    "uiCancel": {
+        "message": "Cancel"
+    },
     "uiURL": {
         "message": "URL"
     },
@@ -49,5 +55,14 @@
     },
     "warningEmptyName": {
         "message": "Name cannot be empty"
+    },
+    "warningExceedCommandSize": {
+        "message": "Exceeded maximum command size. Please short the URL or Name of Website."
+    },
+    "uiDialogDesktopShortcutsTitle": {
+        "message": "Desktop Shortcuts"
+    },
+    "uiDialogDesktopShortcutsDescription": {
+        "message": "The extension will create desktop shortcuts to access your SSB sites easily.\nDesktop shortcuts would be not have execute permission until you give the permission. Downloaded files will not be recognized by the OS until the \".download\" file extension in their names is deleted. It's also a security measure that required by Firefox."
     }
 }
diff --git a/_locales/es/messages.json b/_locales/es/messages.json
@@ -11,6 +11,12 @@
   "useDefaultProfile": {
     "message": "Usar perfil de navegador predeterminado"
   },
+  "uiOk": {
+      "message": "Aceptar"
+  },
+  "uiCancel": {
+      "message": "Cancelar"
+  },
   "uiURL": {
     "message": "URL"
   },
@@ -49,5 +55,14 @@
   },
   "warningEmptyName": {
     "message": "El nombre no puede estar vacío"
+  },
+  "warningExceedCommandSize": {
+    "message": "Se superó el tamaño máximo de comando. Acorte la URL o el nombre del sitio web."
+  },
+  "uiDialogDesktopShortcutsTitle": {
+      "message": "Accesos directos del escritorio"
+  },
+  "uiDialogDesktopShortcutsDescription": {
+      "message": "La extensión creará accesos directos en el escritorio para acceder fácilmente a sus sitios SSB.\nLos accesos directos en el escritorio no tendrán permiso de ejecución hasta que usted los otorgue. El sistema operativo no reconocerá los archivos descargados hasta que se elimine la extensión de archivo \".download\" en sus nombres. También es una medida de seguridad requerida por Firefox."
   }
 }
diff --git a/_locales/ru/messages.json b/_locales/ru/messages.json
@@ -11,6 +11,12 @@
     "useDefaultProfile": {
         "message": "Использовать профиль браузера по умолчанию"
     },
+    "uiOk": {
+        "message": "ок"
+    },
+    "uiCancel": {
+        "message": "Отменить"
+    },
     "uiURL": {
         "message": "URL"
     },
@@ -49,5 +55,14 @@
     },
     "warningEmptyName": {
         "message": "Имя не может быть пустым"
+    },
+    "warningExceedCommandSize": {
+        "message": "Превышен максимальный размер команды. Сократите URL-адрес или имя веб-сайта."
+    },
+    "uiDialogDesktopShortcutsTitle": {
+        "message": "Ярлыки на рабочем столе"
+    },
+    "uiDialogDesktopShortcutsDescription": {
+        "message": "Расширение создаст ярлыки на рабочем столе для быстрого доступа к вашим сайтам SSB.\nЯрлыки на рабочем столе не будут иметь разрешения на выполнение, пока вы не дадите разрешение. Загруженные файлы не будут распознаваться операционной системой до тех пор, пока в их именах не будет удалено расширение файла «.download». Это также мера безопасности, необходимая Firefox."
     }
 }
diff --git a/_locales/tr/messages.json b/_locales/tr/messages.json
@@ -11,6 +11,12 @@
     "useDefaultProfile": {
         "message": "Varsayılan Tarayıcı Profilini Kullan"
     },
+    "uiOk": {
+        "message": "Tamam"
+    },
+    "uiCancel": {
+        "message": "İptal"
+    },
     "uiURL": {
         "message": "URL"
     },
@@ -49,5 +55,14 @@
     },
     "warningEmptyName": {
         "message": "İsim boş bırakılamaz"
+    },
+    "warningExceedCommandSize": {
+        "message": "Maksimum komut sınırı aşıldı. Lütfen Web Sitesinin URL'ini veya İsmini kısaltın."
+    },
+    "uiDialogDesktopShortcutsTitle": {
+        "message": "Masaüstü Kısayolları"
+    },
+    "uiDialogDesktopShortcutsDescription": {
+        "message": "Uzantı, SSB sitelerinize kolayca erişmenizi sağlayacak masaüstü kısayolları oluşturacaktır.\nSiz izin verene kadar masaüstü kısayollarının yürütme izni olmayacaktır. İndirilen dosyalar, adlarındaki \".download\" dosya uzantısı silinene kadar işletim sistemi tarafından tanınmayacaktır. Bu aynı zamanda Firefox'un gerektirdiği bir güvenlik önlemidir."
     }
 }
diff --git a/comparison_chart.md b/comparison_chart.md
@@ -15,7 +15,7 @@
 | Works with forks of Firefox             | Yes       | Maybe(5)       |
 | Auto-creation of Desktop Entry support  | Partial(6)| Yes            |
 
-> If something is wrong or changed about this table, please open a issue. 
+> If something is wrong or changed about this table, please open a issue.
 
 > PWAsForFirefox extension has more integration with system, however their native executable (runtime) dependency and their workarounds is increasing the possibility of profile/extension corruption. FireSSB is using standarts of WebExtension, so it will be more stable.
 
@@ -26,9 +26,9 @@
 > 3: Not supported [PWAsForFirefox#354](https://github.com/filips123/PWAsForFirefox/issues/354)
 
 > 4: FireSSB is not depended to a native depency or some quirks. All APIs that used by FireSSB is documentated in WebExtension Specification. So it can be ported easily any browser that supports WebExtension.
-> 
+>
 >    PWAsForFirefox is heavily depended browser behaviour and native depency. [PWAsForFirefox#475](https://github.com/filips123/PWAsForFirefox/issues/475)
 
 > 5: Firefox forks can be require some workaround [PWAsForFirefox#357](https://github.com/filips123/PWAsForFirefox/issues/357)
 
-> 6: Desktop Entries can be created by clicking "Create Desktop File" on Linux. (Will not add to application list due to lack of FileSystem permissions of extensions.). No support for other OSs yet.
+> 6: Desktop Entries can be created by clicking "Create Desktop File" on Linux and Windows. (Will not add to application list due to lack of FileSystem permissions of extensions.). No support for other OSs yet.
diff --git a/css/index.css b/css/index.css
@@ -32,6 +32,7 @@ body {
     box-sizing: border-box;
     transition-duration: 50ms;
     color: var(--font-color);
+    font-size: 18px;
 }
 
 #warning {
@@ -61,6 +62,10 @@ body {
     word-wrap: anywhere;
 }
 
+body[dialog_open] {
+    height: 235px;
+}
+
 #dialog[open] {
     position: fixed;
     top: 0;
@@ -77,6 +82,10 @@ body {
     gap: 10px;
 }
 
+#dialog[open][dialog_type="confirm"] #dialog-input {
+    display: none;
+}
+
 #dialog .control-container {
     display: flex;
     flex-direction: row;
@@ -97,6 +106,10 @@ body {
     font-size: 24px;
 }
 
+#dialog #dialog-description {
+    overflow-y: auto;
+}
+
 #input {
     display: flex;
     flex-direction: column;
diff --git a/index.html b/index.html
@@ -15,7 +15,9 @@
 
 	<div id="dialog">
         <div id="dialog-title"></div>
-		<div><input type="url" id="dialog-input"/></div>
+		<div id="dialog-description">It's description.</div>
+		<div><input type="name" id="dialog-input"/></div>
+		<div style="flex-grow: 1;"></div>
         <div class="control-container"><button id="dialog-ok">OK</button><button id="dialog-cancel">Cancel</button></div>
 	</div>
 
diff --git a/js/index.js b/js/index.js
@@ -12,6 +12,7 @@ var components = {
         _: document.querySelector("#dialog"),
         title: document.querySelector("#dialog #dialog-title"),
         input: document.querySelector("#dialog #dialog-input"),
+        description: document.querySelector("#dialog #dialog-description"),
         ok: document.querySelector("#dialog #dialog-ok"),
         cancel: document.querySelector("#dialog #dialog-cancel"),
         resolve: null
@@ -61,9 +62,9 @@ async function active_tab_info() {
 };
 
 function create_ssb_url() {
-	let the_url = location.origin + 
+	let the_url = location.origin +
 					"/ssb.html?url=" + encodeURIComponent(components.input.url.value) +
-					"&name=" + encodeURIComponent(components.input.name.value) + 
+					"&name=" + encodeURIComponent(components.input.name.value) +
 					"&incognito=" + encodeURIComponent(components.input.incognito.checked);
 	the_url = the_url.replaceAll("%","=-=");
 	return the_url;
@@ -101,16 +102,32 @@ function download_file(url, name){ // Download helper to download desktop files
     link.remove();
 };
 
-function modern_prompt(title, pretext = "", placeholder = ""){
+function modern_dialog({title="", pretext="", placeholder="", type="prompt", description=""}){
     components.dialog._.setAttribute("open", true);
+    components.dialog._.setAttribute("dialog_type", type);
+    document.body.setAttribute("dialog_open", true);
     return new Promise((resolve) => {
         components.dialog.title.innerText = title;
-        components.dialog.input.value = pretext;
-        components.dialog.input.placeholder = placeholder;
+        components.dialog.description.innerText = description;
+        components.dialog.description.style.display = ["", "none"][Number(description == "")];
+        console.warn(title);
+        console.warn(type == "prompt");
+        if(type == "prompt"){
+          components.dialog.input.value = pretext;
+          components.dialog.input.placeholder = placeholder;
+        };
+        components.dialog.ok.innerText = browser.i18n.getMessage("uiOk");
+        components.dialog.cancel.innerText = browser.i18n.getMessage("uiCancel");
         components.dialog.resolve = (content) => {
             if(components.dialog._.hasAttribute("open")){
                 components.dialog._.removeAttribute("open");
             };
+            if(components.dialog._.hasAttribute("dialog_type")){
+                components.dialog._.removeAttribute("dialog_type");
+            };
+            if(document.body.hasAttribute("dialog_open")){
+                document.body.removeAttribute("dialog_open");
+            };
             resolve(content);
         };
     });
@@ -119,13 +136,25 @@ function modern_prompt(title, pretext = "", placeholder = ""){
 // Event Listeners
 
 components.dialog.ok.addEventListener("click", () => {
-    components.dialog.resolve(
-        components.dialog.input.value
-    );
+    let type = components.dialog._.getAttribute("dialog_type");
+    if(type == "prompt") {
+        components.dialog.resolve(
+            components.dialog.input.value
+        );
+    } else if (type == "confirm") {
+        components.dialog.resolve(true);
+    }
+    components.dialog.resolve(null); // Fallback
 });
 
 components.dialog.cancel.addEventListener("click", () => {
-    components.dialog.resolve(false);
+  let type = components.dialog._.getAttribute("dialog_type");
+  if(type == "prompt") {
+      components.dialog.resolve(false);
+  } else if (type == "confirm") { // Yes, i know "prompt" and "confirm" has same code however wrong abstraction is worse than having duplication.
+      components.dialog.resolve(false);
+  }
+  components.dialog.resolve(null); // Fallback
 });
 
 components.controls.autofill.addEventListener("click", async function() {
@@ -167,17 +196,27 @@ components.controls.open_ssb.addEventListener("click", async function() {
 });
 
 components.controls.add_desktop_entry_windows.addEventListener("click", async function() {
+  let is_user_informed = localStorage.user_informed_desktop_shortcuts === "true" ?? "false";
+  if(!is_user_informed){
+      let is_user_confirmed = await modern_dialog({title: browser.i18n.getMessage("uiDialogDesktopShortcutsTitle"), "description": browser.i18n.getMessage("uiDialogDesktopShortcutsDescription"), type: "confirm"});
+      if(!is_user_confirmed) {
+          localStorage.user_informed_desktop_shortcuts = "false";
+          return;
+      } else {
+          localStorage.user_informed_desktop_shortcuts = "true";
+      };
+  };
 	if(components.input.url.value == "") return show_warning("warningEmptyURL");
 	if(components.input.name.value == "") return show_warning("warningEmptyName");
 
     let name = sanitize_input(components.input.name.value);
     let ssb_url = create_ssb_url();
     let previous_application = localStorage.previous_firefox_application ?? "firefox";
-    let application = await modern_prompt(browser.i18n.getMessage("browserCommandName"), previous_application, "");
+    let application = await modern_dialog({title:browser.i18n.getMessage("browserCommandName"), pretext:previous_application});
     if(application === false) return;
     application = sanitize_input(application);
     localStorage.previous_firefox_application = application;
-    let profile = await modern_prompt(browser.i18n.getMessage("profile"), "", browser.i18n.getMessage("useDefaultProfile"));
+    let profile = await modern_dialog({title:browser.i18n.getMessage("profile"), placeholder:browser.i18n.getMessage("useDefaultProfile")});
     if(profile === false) return;
     profile = sanitize_input(profile, true);
     if(profile != "") profile = "-P " + profile;
@@ -278,7 +317,7 @@ components.controls.add_desktop_entry_windows.addEventListener("click", async fu
     let allowed_app_command_len = 618;
 
     let app_command = `${application} ${profile} -new-window "${ssb_url}"`;
-    if(app_command.length>=allowed_app_command_len) return show_warning("exceedCommandSize");
+    if(app_command.length>=allowed_app_command_len) return show_warning("warningExceedCommandSize");
 
     let lnk_mid_of_file = (app_command.padEnd(allowed_app_command_len, "\x00").split("").join("\x00")+"\x00").split("").map(x=>x.charCodeAt(0));
 
@@ -292,17 +331,27 @@ components.controls.add_desktop_entry_windows.addEventListener("click", async fu
 });
 
 components.controls.add_desktop_entry_linux.addEventListener("click", async function() {
-	if(components.input.url.value == "") return show_warning("warningEmptyURL");
-	if(components.input.name.value == "") return show_warning("warningEmptyName");
+    let is_user_informed = localStorage.user_informed_desktop_shortcuts === "true" ?? "false";
+    if(!is_user_informed){
+        let is_user_confirmed = await modern_dialog({title: browser.i18n.getMessage("uiDialogDesktopShortcutsTitle"), "description": browser.i18n.getMessage("uiDialogDesktopShortcutsDescription"), type: "confirm"});
+        if(!is_user_confirmed) {
+            localStorage.user_informed_desktop_shortcuts = "false";
+            return;
+        } else {
+            localStorage.user_informed_desktop_shortcuts = "true";
+        };
+    };
+  	if(components.input.url.value == "") return show_warning("warningEmptyURL");
+  	if(components.input.name.value == "") return show_warning("warningEmptyName");
 
     let name = sanitize_input(components.input.name.value);
     let ssb_url = create_ssb_url();
     let previous_application = localStorage.previous_firefox_application ?? "firefox";
-    let application = await modern_prompt(browser.i18n.getMessage("browserCommandName"), previous_application, "");
+    let application = await modern_dialog({title:browser.i18n.getMessage("browserCommandName"), pretext:previous_application});
     if(application === false) return;
     application = sanitize_input(application);
     localStorage.previous_firefox_application = application;
-    let profile = await modern_prompt(browser.i18n.getMessage("profile"), "", browser.i18n.getMessage("useDefaultProfile"));
+    let profile = await modern_dialog({title:browser.i18n.getMessage("profile"), placeholder:browser.i18n.getMessage("useDefaultProfile")});
     if(profile === false) return;
     profile = sanitize_input(profile, true);
     if(profile != "") profile = "-P " + profile;
