inital commit

jlegewie · jlegewie · commit 7825e00ad605 · 2023-08-05T16:13:11.000-04:00
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+/Makefile.in
+.DS_Store
+*.xpi
+*.icloud
diff --git a/Makefile b/Makefile
@@ -0,0 +1,17 @@
+all: Makefile.in
+
+-include Makefile.in
+
+RELEASE:=$(shell grep version manifest.json | sed '2q;d' | sed -e 's/^ *"version": "//' -e 's/",//')
+
+ZotFileRecovery.xpi: FORCE
+	rm -rf $@
+	zip -FSr $@ bootstrap.js locale manifest.json ZotFileRecovery.js ZotFileRecovery_menus.js -x \*.DS_Store
+
+ZotFileRecovery-%-fx.xpi: ZotFileRecovery.xpi
+	mv $< $@
+
+Makefile.in: manifest.json
+	echo "all: ZotFileRecovery-${RELEASE}-fx.xpi" > Makefile.in
+
+FORCE:
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# ZotFile Recovery
+
+Unfortunatly, ZotFile is not compatible with Zotero 7 and most likely never will be. Several alternative projects implement some of ZotFile's functionality for Zotero 7. Take a look at [Zotero File](https://github.com/MuiseDestiny/zotero-file) and [ZotMoov](https://github.com/wileyyugioh/zotmoov). However, one of zotfiles features might still makes certain files inaccesible from Zotero 7. This problem impacts users who use send and get files from the tablet (optional setting under "Tablet Settings") and have set the ".tablet.mode" setting to 1, which is the default called "background mode" in the documentation. While these tablet still exist in the tablet folder specified in the zotfile settings, you won't be able to access them from Zotero 7. To address this problem `ZotFile Recovery` adds a menu item to recover files from the tablet. This menu item is disables (as in the screenshot below) unless you select a zotero item or attachment. Similar to the ZotFile function "Get from Tablet", this function removes the tablet file from from the tablet location.
+
+Please use the issue tracker for this GitHub repro to report any bugs.
+
+<img src="res/ZotFileRecoveryMenu.png" width="500"/>
diff --git a/ZotFileRecovery.js b/ZotFileRecovery.js
@@ -0,0 +1,239 @@
+
+Components.utils.importGlobalProperties(['PathUtils', 'IOUtils']);
+
+Zotero.ZotFileRecovery = {
+    id: null,
+    version: null,
+    rootURI: null,
+    initialized: false,
+
+    init({ id, version, rootURI }) {
+        if(this.initialized) return;
+
+        this.id = id;
+        this.version = version;
+        this.rootURI = rootURI;
+        this.initialized = true;
+
+    },
+
+    getTabletInfo (att, key) {
+        try {
+            var parser = new DOMParser();
+            var value,
+                content = att.getNote(),
+                doc = parser.parseFromString(content, 'text/html'),
+                p = doc.querySelector('#zotfile-data');
+            if(p === null) p = doc.querySelector('[title*="lastmod"][title*="projectFolder"]');
+            if(p === null) {
+                // support for old system
+                var search = content.search(key);
+                value = content.substring(search);
+                value = value.substring(value.search('{') + 1, value.search('}'));
+            }
+            else {
+                var data = JSON.parse(p.getAttribute('title').replace(/&quot;/g, '"'));
+                value = key in data ? data[key] : undefined;
+            }
+            // for location tag: replace [BaseFolder] with destination folder
+            if(key == 'location') {
+                let dest_dir = Zotero.Prefs.get('extensions.zotfile.tablet.dest_dir', true);
+                dest_dir = dest_dir === undefined ? "" : dest_dir;
+                value = value.replace('[BaseFolder]', dest_dir);
+            }
+            // for location and projectFolder tag: correct window/mac file system
+            if(['location', 'projectFolder'].includes(key) && Zotero.isWin) value = value.replace(/\//g, '\\');
+            if(['location', 'projectFolder'].includes(key) && !Zotero.isWin) value = value.replace(/\\/g, '/');
+            // return
+            return value;
+        }
+        catch (err) {
+            return '';
+        }
+    },
+
+    clearInfo (att) {
+        try {
+            var parser = new DOMParser();
+            var content = att.getNote().replace(/zotero:\/\//g, 'http://zotfile.com/'),
+                doc = parser.parseFromString(content, 'text/html'),
+                p = doc.querySelector('#zotfile-data');
+            if(p === null) p = doc.querySelector('[title*="lastmod"][title*="projectFolder"]');
+            if (p !== null) doc.removeChild(p);
+            // save content back to note
+            content = doc.documentElement.innerHTML
+                // remove old zotfile data
+                .replace(/(lastmod|mode|location|projectFolder)\{.*?\};?/g,'')
+                // replace links with zotero links
+                .replace(/http:\/\/zotfile.com\//g, 'zotero://');
+            att.setNote(content);
+        }
+        catch(e) {
+            att.setNote('');
+        }
+    },
+
+    _getSelectedAttachments() {
+        let atts = Zotero.getActiveZoteroPane().getSelectedItems()
+            .map(item => item.isRegularItem() ? item.getAttachments() : item)
+            .reduce((a, b) => a.concat(b), [])
+            .map(item => typeof item == 'number' ? Zotero.Items.get(item) : item)
+            .filter(item => item.isAttachment())
+            .filter(item => this.getTabletInfo(item, 'mode') == 1);
+        return atts;
+    },
+
+    removeTabletTag(att, tag) {
+        // remove from attachment
+        att.removeTag(tag);
+        // remove from parent item
+        var item = Zotero.Items.get(att.parentItemID);
+        if(item.hasTag(tag)) {
+            var atts = Zotero.Items.get(item.getAttachments());
+            if(!atts.some(att => att.hasTag(tag)))
+                item.removeTag(tag);
+        }
+    },
+
+    // async recoverTabletFile() {
+    async recoverTabletFile() {
+        Zotero.debug("ZotFileRecovery: Running 'recoverTabletFile'");
+        // get selected attachments
+        let atts = this._getSelectedAttachments();
+        // filter by tablet tag
+        let tablet_tag = Zotero.Prefs.get('extensions.zotfile.tablet.tag', true);
+        tablet_tag = tablet_tag === undefined ? "_tablet" : tablet_tag;
+        atts = atts.filter(att => att.hasTag(tablet_tag));
+        if(atts.length == 0) return;
+        // get attachments from tablet
+        atts = atts.map(att => this.getAttachmentFromTablet(att));
+        return;
+    },
+
+    async getTabletFilePath(att) {
+        Zotero.debug("ZotFileRecovery: Running 'getTabletFilePath'");
+        // foreground mode
+        if(this.getTabletInfo(att, 'mode') == 2)
+            return await att.getFilePathAsync();
+        // background mode
+        var path = this.getTabletInfo(att, 'location');
+        return path;
+    },
+
+    promptUser(message,but_0,but_1_cancel,but_2, title) {
+        var title = typeof title !== 'ZotFile Dialog' ? title : true;
+        var prompts = Components.classes['@mozilla.org/embedcomp/prompt-service;1']
+                    .getService(Components.interfaces.nsIPromptService);
+
+        var check = {value: false};                  // default the checkbox to false
+
+        var flags = prompts.BUTTON_POS_0 * prompts.BUTTON_TITLE_IS_STRING +
+                prompts.BUTTON_POS_1 * prompts.BUTTON_TITLE_IS_STRING  +
+                prompts.BUTTON_POS_2 * prompts.BUTTON_TITLE_IS_STRING;
+
+        var button = prompts.confirmEx(null, title, message,
+                    flags,  but_0,but_1_cancel,but_2, null, check);
+
+        return(button);
+
+    },
+
+    getPref(pref, def) {
+        let value = Zotero.Prefs.get('extensions.zotfile.' + pref, true);
+        value = value === undefined ? def : value;;
+        return value;
+    },
+
+    // async getAttachmentFromTablet(att) {
+    async getAttachmentFromTablet(att) {
+        Zotero.debug("ZotFileRecovery: Running 'getAttachmentFromTablet'");
+        var item = Zotero.Items.get(att.parentItemID),
+            tablet_tag = this.getPref('tablet.tag', '_tablet'),
+            tablet_tagMod = this.getPref('tablet.tagModified', '_tablet_modified'),
+            tag_parent = this.getPref('tablet.tagParentPush_tag', '_tablet_parent');
+        // Zotero and tablet file paths
+        var path_zotero = await att.getFilePathAsync(),
+            path_tablet = await this.getTabletFilePath(att, false);
+        Zotero.debug("ZotFileRecovery 'path_tablet': " + path_tablet);
+        Zotero.debug("ZotFileRecovery 'path_zotero':" + path_zotero);
+        var path_tablet_exists = await IOUtils.exists(path_tablet);
+        if (path_tablet == '' | !path_tablet_exists) {
+            this.removeTabletTag(att, tablet_tag);
+            this.clearInfo(att);
+            await att.saveTx();
+            await item.saveTx();
+            this.infoWindow('ZotFile Warning', 'The tablet file "' + att.attachmentFilename + '" was manually moved and does not exist.');
+            return att;
+        }
+        // get modification times for files        
+        var time_tablet = 0, time_zotero = 0;
+        if(await IOUtils.exists(path_tablet)) {
+            let tablet_file_stat = await IOUtils.stat(path_tablet);
+            time_tablet = tablet_file_stat.lastModified;
+        }
+        var time_saved  = parseInt(this.getTabletInfo(att, 'lastmod'), 10);
+        if(await IOUtils.exists(path_zotero)) {
+            let zotero_file_stat = await IOUtils.stat(path_zotero);
+            time_zotero = zotero_file_stat.lastModified;
+        }
+        Zotero.debug("ZotFileRecovery lastModified (tablet, saved, zotero): " + time_tablet + " " + time_saved + " " + time_zotero);
+        // background mode
+        if((time_tablet == 0 & time_zotero == 0)) {
+            this.infoWindow('ZotFile Warning', 'Recovery of tablet file "' + att.attachmentFilename + '" failed. Please manually recover the file at "' + path_tablet + '"');
+            return att;
+        }
+
+        // Status of tablet file 'tablet_status'
+        // 0 - Tablet file modified -> Replace zotero file
+        // 1 - Both files modified -> Prompt user
+        // 2 - Zotero file modified -> Delete tablet file
+        var tablet_status = 1;
+        if (time_tablet > time_saved  && time_zotero <= time_saved) tablet_status = 0;
+        if (time_tablet <= time_saved && time_zotero <= time_saved) tablet_status = 2;
+        if (time_tablet <= time_saved && time_zotero > time_saved) tablet_status = 2;
+        if (time_tablet > time_saved  && time_zotero > time_saved) tablet_status = 1;
+        Zotero.debug("ZotFileRecovery 'tablet_status': " + tablet_status);
+
+        // prompt if both file have been modified
+        if (tablet_status == 1) {
+            let message = "Both copies of the attachment file '" + att.attachmentFilename + "'  have been modified. What do you want to do?\n\nRemoving the tablet file discards all changes made to the file on the tablet.";
+            tablet_status = this.promptUser(message, "Replace Zotero File", "Cancel", "Remove Tablet File");
+            if (tablet_status == 1) return;
+        }
+        
+        // Replace zotero file
+        if(tablet_status == 0) 
+            await IOUtils.move(path_tablet, path_zotero);
+        // Remove tablet file
+        if(tablet_status == 2)
+            await Zotero.File.removeIfExists(path_tablet);
+        
+        // remove tag from attachment and parent item
+        this.removeTabletTag(att, tablet_tag);
+        if(item.hasTag(tag_parent)) item.removeTag(tag_parent);
+        // clear attachment note
+        this.Tablet.clearInfo(att);
+        // remove modified tag from attachment
+        this.removeTabletTag(att, this.Tablet.tagMod);
+        await att.saveTx();
+        await item.saveTx();
+        // notification
+        this.infoWindow('ZotFile Recovery', 'The tablet file "' + att.attachmentFilename + '" was removed from the tablet.');
+        // return...
+        return att;
+    },
+
+    infoWindow (headline, content) {
+        // default arguments
+        main = typeof main !== 'undefined' ? main : 'title';
+        message = typeof message !== 'undefined' ? message : 'message';
+        // show window
+        var progressWin = new Zotero.ProgressWindow();
+        progressWin.changeHeadline(headline);
+        progressWin.addLines(content);
+        progressWin.show();
+        progressWin.startCloseTimer();
+    },
+
+
+};
diff --git a/ZotFileRecovery_menus.js b/ZotFileRecovery_menus.js
@@ -0,0 +1,93 @@
+
+Components.utils.import('resource://gre/modules/Services.jsm');
+
+ZotFileRecovery_Menus = {
+    _store_added_elements: [],
+    _opt_disable_elements: [],
+
+    _window_listener: {
+        onOpenWindow: function(a_window) {
+            let dom_window = a_window.QueryInterface(Ci.nsIInterfaceRequestor).getInterface(Ci.nsIDOMWindow);
+            dom_window.addEventListener('load', function() {
+                dom_window.removeEventListener('load', arguments.callee, false);
+                if (dom_window.document.documentElement.getAttribute('windowtype') != 'navigator:browser') return;
+                ZotFileRecovery_Menus._store_added_elements = []; // Clear tracked elements since destroyed by closed window
+                ZotFileRecovery_Menus._opt_disable_elements = [];
+                ZotFileRecovery_Menus._init();
+            }, false);
+        }
+    },
+
+    _popupShowing() {
+        // let should_hide = !ZotFileRecovery_Menus._hasTabletFile();
+        let should_disabled = !ZotFileRecovery_Menus._hasTabletFile();
+        for (let element of ZotFileRecovery_Menus._opt_disable_elements) {
+            // element.hidden = should_hide;
+            element.disabled = should_disabled;
+        }
+    },
+
+    _getWindow() {
+        let enumerator = Services.wm.getEnumerator('navigator:browser');
+        while (enumerator.hasMoreElements())
+        {
+            let win = enumerator.getNext();
+            if (!win.ZoteroPane) continue;
+            return win;
+        }
+    },    
+
+    _hasTabletFile() {
+        let atts = Zotero.ZotFileRecovery._getSelectedAttachments();
+        let tablet_tag = Zotero.ZotFileRecovery.getPref('tablet.tag', '_tablet');
+        return atts.some(att => att.hasTag(tablet_tag));
+    },
+
+    init() {
+        this._init();
+        Services.wm.addListener(this._window_listener);
+    },
+
+    _init() {
+        let win = this._getWindow();
+        let doc = win.document;
+
+        // Menu separator
+        let menuseparator = doc.createXULElement('menuseparator');
+        // Move Selected Menu item
+        let recovery_item = doc.createXULElement('menuitem');
+        recovery_item.id = 'ZotFileRecovery-recover-file';
+        recovery_item.setAttribute('data-l10n-id', 'ZotFileRecovery-recover-file');
+        recovery_item.addEventListener('command', function() {
+            Zotero.ZotFileRecovery.recoverTabletFile();
+        });
+        let zotero_itemmenu = doc.getElementById('zotero-itemmenu');
+        zotero_itemmenu.addEventListener('popupshowing', this._popupShowing);
+        zotero_itemmenu.appendChild(menuseparator);
+        zotero_itemmenu.appendChild(recovery_item);
+        this._store_added_elements.push(menuseparator, recovery_item);
+        this._opt_disable_elements.push(menuseparator, recovery_item);
+
+        // Enable localization
+        win.MozXULElement.insertFTLIfNeeded('ZotFileRecovery.ftl');
+    },
+
+    destroy() {
+        this._destroy();
+        Services.wm.removeListener(this._window_listener);
+    },
+
+    _destroy() {
+        let doc = this._getWindow().document;
+        for (let element of this._store_added_elements) {
+            if (element) element.remove();
+        }
+        doc.querySelector('[href="ZotFileRecovery.ftl"]').remove();
+
+        let zotero_itemmenu = doc.getElementById('zotero-itemmenu');
+        zotero_itemmenu.removeEventListener('popupshowing', this._popupShowing);
+
+        this._store_added_elements = [];
+        this._opt_disable_elements = [];
+    }
+}
diff --git a/bootstrap.js b/bootstrap.js
@@ -0,0 +1,29 @@
+var ZotFileRecovery;
+
+function install() {
+    Zotero.debug('ZotFileRecovery: Installed');
+}
+
+async function startup({ id, version, rootURI}) {
+    Zotero.debug('ZotFileRecovery: Starting');
+    Zotero.debug('ZotFileRecovery rootURI: ' + rootURI);
+    Services.scriptloader.loadSubScript(rootURI + 'ZotFileRecovery.js');
+    Services.scriptloader.loadSubScript(rootURI + 'ZotFileRecovery_menus.js');
+    Zotero.ZotFileRecovery.init({ id, version, rootURI });
+    ZotFileRecovery_Menus.init();
+}
+
+function shutdown() {
+    Zotero.debug('ZotFileRecovery: Shutting down');
+    // ZotFileRecovery.removeFromAllWindows();
+
+    // Zotero.ZotFileRecovery.destroy();
+    ZotFileRecovery_Menus.destroy();
+
+    Zotero.ZotFileRecovery = undefined;
+    ZotFileRecovery_Menus = undefined;
+}
+
+function uninstall() {
+    Zotero.debug('ZotFileRecovery: Uninstalled');
+}
diff --git a/locale/en-US/ZotFileRecovery.ftl b/locale/en-US/ZotFileRecovery.ftl
diff --git a/manifest.json b/manifest.json
diff --git a/res/ZotFileRecoveryMenu.png b/res/ZotFileRecoveryMenu.png

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Auto detect text files and perform LF normalization`
	`2`	`+* text=auto`