zotero-plugin 6.3.2 → 6.4.0

package/README.md

@@ -124,3 +124,52 @@ then when you execute `npm start`, zotero will start up with the latest build of
 **DO CREATE A BACKUP OF YOUR ZOTERO DATA *AND* YOUR ZOTERO PROFILE BEFORE USING THIS THE FIRST TIME**
 
 `zotero-start` will **blindly** trust you've set it up right and will **alter data** in the profile
+
+# Getting logging from your users
+
+In your startup, you can call
+
+```
+import { DebugLog } from 'zotero-plugin/debug-log'
+DebugLog.register('<your plugin name>', ['your-plugin.', 'fileHandler.pdf'])
+```
+
+and you will get an entry in the Help menu that will allow your users to upload their debug log for diagnosis. You can fetch the log by
+running
+
+```
+zp-fetch-log <the ID that the user was presented with>
+```
+
+If you want to be extra secure, you can encrypt the logs before they are sent; first, run
+
+```
+zp-keypair
+```
+
+which will generate a keypair. Remember the passphrase, it cannot be recovered, but if you do forget, you can generate a new keypair. Logs
+sent with the old keypair cannot be decrypted, so if you forget your passphrase, you will have to put out a new release of your plugin.
+
+add this to your esbuild script:
+
+```
+const { pem } = require('zotero-plugin/esbuild')
+```
+
+and add `pem` to your plugins in the esbuild config:
+
+```
+...
+plugins: [pem],
+...
+```
+
+and in your code, register using
+
+```
+DebugLog.register('<your plugin name>', ['your-plugin.', 'fileHandler.pdf'], require('./public.pem'))
+```
+
+Logs are sent to/retrieved from 0x0.st
+
+The preferences you list will be included in the log; if a preference ends with a period (`.`), all preferences under it will be included

package/bin/fetch-log.mjs

@@ -11,7 +11,7 @@ import { Entry as KeyRingEntry } from "@napi-rs/keyring";
 import prompts from "prompts";
 
 // package.json
-var version = "6.3.2";
+var version = "6.4.0";
 
 // bin/crypto.ts
 import crypto from "crypto";
@@ -92,7 +92,7 @@ async function main() {
       if (entry.isDirectory) continue;
       const m2 = entry.name.match(/(?<filename>.+)\.(?<type>key|enc|iv)$/i);
       let filename = m2?.groups.filename || entry.name;
-      const type = (m2?.groups.ext || "").toLowerCase();
+      const type = (m2?.groups.type || "").toLowerCase();
       if (type && !options.encrypted) oops("unexpected", type, "file in non-encrypted log");
       if (type === "key") {
         decryptionKey = crypto2.privateDecrypt({

package/bin/link.mjs

@@ -15,7 +15,7 @@ var root_default = process.cwd();
 
 // bin/link.ts
 var pkg = { ...__require(path.join(root_default, "package.json")) };
-if (!pkg.id) pkg.id = `${pkg.name.replace(/^zotero-/, "")}@${pkg.author.email.replace(/.*@/, "")}`.toLowerCase();
+if (!pkg.id) pkg.id = `${pkg.name}@${pkg.author.email.replace(/.*@/, "")}`.toLowerCase();
 if (pkg.xpi) Object.assign(pkg, pkg.xpi);
 var build = path.join(root_default, "build");
 var zotero = process.argv[2];

package/debug-log.d.ts

@@ -7,6 +7,7 @@ export declare class Bundler {
     get zip(): ArrayBuffer;
     get name(): string;
     id(remote: string): string;
+    formData(expire?: number): FormData;
 }
 declare class DebugLogSender {
     id: {

package/debug-log.js

@@ -55,8 +55,16 @@ class Bundler {
     id(remote) {
         return `${this.key}-${remote}${this.#refs ? '.refs' : ''}${this.#pubkey ? '.enc' : ''}`;
     }
+    formData(expire = 7) {
+        const blob = new Blob([this.zip], { type: 'application/zip' });
+        const formData = new FormData();
+        formData.append('file', blob, this.name);
+        formData.append('expire', `${expire * 24}`);
+        return formData;
+    }
 }
 exports.Bundler = Bundler;
+const zotero_prefs_root = 'extensions.zotero.';
 class DebugLogSender {
     id = {
         menu: 'debug-log-sender-menu',
@@ -128,14 +136,10 @@ class DebugLogSender {
         let rdf = await this.rdf();
         if (rdf)
             await bundler.add('items.rdf', rdf, true);
-        const blob = new Blob([bundler.zip], { type: 'application/zip' });
-        const formData = new FormData();
-        formData.append('file', blob, bundler.name);
-        formData.append('expire', `${7 * 24}`);
         try {
             const response = await fetch('https://0x0.st', {
                 method: 'POST',
-                body: formData,
+                body: bundler.formData(),
                 headers: {
                     'User-Agent': `Zotero-plugin/${pkg.version}`,
                 },
@@ -154,7 +158,12 @@ class DebugLogSender {
         const prefs = {};
         const names = [];
         for (let pref of preferences) {
-            pref = pref.replace(/^:/, 'extensions.zotero.');
+            if (pref[0] === ':') {
+                pref = pref.substring(1);
+            }
+            else if (!pref.startsWith(zotero_prefs_root)) {
+                pref = zotero_prefs_root + pref;
+            }
             if (pref.endsWith('.')) {
                 const childkeys = Services.prefs.getBranch(pref).getChildList('', {});
                 for (const key of childkeys) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin",
-  "version": "6.3.2",
+  "version": "6.4.0",
   "description": "Zotero plugin builder",
   "homepage": "https://github.com/retorquere/zotero-plugin/wiki",
   "bin": {