zotero-plugin 1.0.64 → 1.0.65

package/README.md

@@ -27,3 +27,32 @@ to the current branch (or maybe your branch isn't named `gh-<number>`,
 add `#<number>` to the commit message.
 
 Release new versions by issuing `npm version <major|minor|patch>`.
+
+# Starting Zotero with your plugin loaded
+
+Note is is *much* adviced to create a separate Zotero profile for testing!
+
+You will need to have python3 installed to use this.
+
+Create a file called `zotero-plugin.ini` with the following contents:
+
+```
+[profile]
+name = <your test profile name>
+path = <your test profile absolute path>
+
+[zotero]
+log = <file name to write log output to> # optional
+db = <path to zotero.sqlite you want to populate the profile with> # optional
+
+[preferences]
+extensions.zotero.<your extension>.<some setting> = true
+```
+
+and add this script to your package.json:
+
+```
+  "start": "zotero-start"
+```
+
+then when you execute `npm start`, zotero will start up with the latest build of your plugin installed.

package/bin/start.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python3
+
+import os, sys
+import shutil
+import json
+import configparser
+import argparse
+import shlex
+import xml.etree.ElementTree as ET
+import subprocess
+import collections
+import types
+import platform
+
+class Config:
+  def __init__(self):
+    config_file = 'zotero-plugin.ini'
+    assert os.path.isfile(config_file), f'cannot find {config_file}'
+
+    config = configparser.ConfigParser(strict = False)
+    config.read(config_file)
+
+    self.profile = types.SimpleNamespace(
+      path=os.path.expanduser(config.get('profile', 'path')),
+      name=config.get('profile', 'name', fallback=None)
+    )
+
+    self.zotero = types.SimpleNamespace(
+      path=config.get('zotero', 'path', fallback=None),
+      log=config.get('zotero', 'log', fallback=None),
+      db=config.get('profile', 'db', fallback=None)
+    )
+
+    if self.zotero.path:
+      self.zotero.path = os.path.expanduser(self.zotero.path)
+    elif platform.system() == 'Darwin':
+      self.zotero.path = '/Applications/Zotero.app/Contents/MacOS/zotero'
+    elif platform.system() == 'Linux':
+      self.zotero.path = '/usr/lib/zotero/zotero'
+    else:
+      assert False, f'{platform.system()} not supported'
+      
+    if self.zotero.log:
+      self.zotero.log = os.path.expanduser(self.zotero.log)
+
+    if 'preferences' in config:
+      self.preference = { k: self.pref_value(v) for k, v in dict(config['preferences']).items() }
+    else:
+      self.preference = {}
+
+    # always set these
+    self.preference['extensions.autoDisableScopes']= 0
+    self.preference['extensions.enableScopes'] = 15
+    self.preference['extensions.startupScanScopes'] = 15
+    self.preference['extensions.zotero.debug.log'] = True
+    # null deletes if present
+    self.preference['extensions.lastAppBuildId'] = None
+    self.preference['extensions.lastAppVersion'] = None
+
+  def pref_value(self, v):
+    if v in ['true', 'false']: return v == 'true'
+    if v == 'null': return None
+    try:
+      return int(v)
+    except ValueError:
+      pass
+    try:
+      return float(v)
+    except ValueError:
+      pass
+    try:
+      return json.loads(v)
+    except json.decoder.JSONDecodeError:
+      pass
+    return v
+config = Config()
+
+def patch_prefs(prefs, add_config):
+  def name(line):
+    if not line.startswith('user_pref('): return None
+    if not line.startswith('user_pref("'): raise ValueError('unexpected user pref: ' + line)
+    open_quote = None
+    for i, c in enumerate(line):
+      if c == '"':
+        if open_quote is None:
+          open_quote = i
+        else:
+          try:
+            return json.loads(line[open_quote : i + 1])
+          except json.decoder.JSONDecodeError:
+            pass
+    raise ValueError('unexpected user pref: ' + line)
+
+  prefs = os.path.join(config.profile.path, f'{prefs}.js')
+  if not os.path.exists(prefs): return
+
+  user_prefs = []
+  with open(prefs) as f:
+    for line in f.readlines():
+      if name(line) not in config.preference:
+        user_prefs.append(line)
+    if add_config:
+      for key, value in config.preference.items():
+        if value is not None:
+          user_prefs.append(f'user_pref({json.dumps(key)}, {json.dumps(value)});\n')
+
+  with open(prefs, 'w') as f:
+    f.write(''.join(user_prefs))
+
+patch_prefs('prefs', False)
+patch_prefs('user', True)
+
+def system(cmd):
+  print('$', cmd)
+  subprocess.run(cmd, shell=True, check=True)
+
+system('npm run build')
+
+if config.zotero.db:
+  shutil.copyfile(config.zotero.db, os.path.join(config.profile.path, 'zotero', 'zotero.sqlite'))
+
+for plugin_id in ET.parse(os.path.join('build', 'install.rdf')).getroot().findall('{http://www.w3.org/1999/02/22-rdf-syntax-ns#}Description/{http://www.mozilla.org/2004/em-rdf#}id'):
+  plugin_path = os.path.join(config.profile.path, 'extensions', plugin_id.text)
+with open(plugin_path, 'w') as f:
+  sources = os.path.join(os.getcwd(), 'build')
+  if sources[-1] != '/': sources += '/'
+  print(sources, file=f)
+
+cmd = config.zotero.path + ' -purgecaches -P'
+if config.profile.name: cmd += ' ' + shlex.quote(config.profile.name)
+cmd += ' -jsconsole -ZoteroDebugText -datadir profile'
+if config.zotero.log: cmd += ' > ' + shlex.quote(config.zotero.log)
+cmd += ' &'
+
+system(cmd)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin",
-  "version": "1.0.64",
+  "version": "1.0.65",
   "description": "Zotero plugin builder",
   "homepage": "https://github.com/retorquere/zotero-plugin/wiki",
   "bin": {
@@ -8,7 +8,7 @@
     "zotero-plugin-zipup": "bin/zipup.js",
     "zotero-plugin-link": "bin/link.js",
     "issue-branches": "bin/branches.js",
-    "zotero-start": "bin/start.js"
+    "zotero-start": "bin/start.py"
   },
   "author": {
     "name": "Emiliano Heyns",
@@ -67,8 +67,6 @@
   },
   "license": "ISC",
   "files": [
-    "bin/start.d.ts",
-    "bin/start.js",
     "bin/branches.d.ts",
     "bin/branches.js",
     "bin/link.d.ts",
@@ -77,6 +75,7 @@
     "bin/release.js",
     "bin/zipup.d.ts",
     "bin/zipup.js",
+    "bin/start.py",
     "continuous-integration.d.ts",
     "continuous-integration.js",
     "copy-assets.d.ts",

package/bin/start.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/bin/start.js

@@ -1,70 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-/* eslint-disable no-console, prefer-template, @typescript-eslint/no-unsafe-argument, @typescript-eslint/restrict-plus-operands */
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const child_process_1 = require("child_process");
-const shell_quote_1 = require("shell-quote");
-const clp_1 = (0, tslib_1.__importDefault)(require("clp"));
-function quote(args) {
-    return (0, shell_quote_1.quote)(args); // eslint-disable-line @typescript-eslint/no-unsafe-call
-}
-const argv = clp_1.default();
-const root_1 = (0, tslib_1.__importDefault)(require("../root"));
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-const profile = require(path.join(root_1.default, 'profile.json'));
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-const pkg = require(path.join(root_1.default, 'package.json'));
-function exec(cmd) {
-    console.log(cmd);
-    if (!argv.dryRun)
-        (0, child_process_1.execSync)(cmd, { stdio: 'inherit' });
-}
-if (argv.reset) {
-    const settings = {
-        replace: {
-            'extensions.autoDisableScopes': 0,
-            'extensions.enableScopes': 15,
-            'extensions.startupScanScopes': 15,
-        },
-        remove: [
-            'extensions.lastAppBuildId',
-            'extensions.lastAppVersion',
-        ],
-    };
-    const remove = new RegExp(settings.remove.concat(Object.keys(settings)).map(setting => setting.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|'));
-    for (const prefs of ['user', 'prefs']) {
-        const user_prefs = [];
-        for (const user_pref of fs.readFileSync(path.join(profile.dir, `${prefs}.js`), 'utf-8').split('\n')) {
-            if (!user_pref.match(remove))
-                user_prefs.push(user_pref);
-        }
-        for (const [user_pref, value] of Object.entries(settings.replace)) {
-            user_prefs.push(`user_pref("${user_pref}", ${value});`);
-        }
-        fs.writeFileSync(path.join(profile.dir, `${prefs}.js`), user_prefs.join('\n'));
-    }
-}
-exec('npm run build');
-exec(quote(['rm', '-rf', path.join(profile.dir, 'extensions.json')]));
-exec(quote(['rm', '-rf', path.join(profile.dir, 'extensions')]) + path.sep + pkg.name + '*.xpi');
-let code = path.resolve(path.join(root_1.default, 'build'));
-if (!code.endsWith(path.sep))
-    code += path.sep;
-// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-fs.writeFileSync(path.join(profile.dir, 'extensions', pkg.name.replace('zotero-', '') + pkg.author.email.replace(/.*@/, '@')), code);
-let zotero = null;
-switch (process.platform) {
-    case 'darwin':
-        zotero = '/Applications/Zotero.app/Contents/MacOS/zotero';
-        break;
-    case 'win32':
-        console.log('not implemented on windows');
-        process.exit(1);
-    default:
-        zotero = '/usr/local/bin/zotero/zotero';
-        break;
-}
-exec(quote([zotero, '-purgecaches', '-P', profile.name, '-jsconsole', '-ZoteroDebugText']) + ' > ' + quote([profile.log]));