Integrates Google Scholar's citation count functionality, a websocket client for JabRef and other extensions/fixes

.gitignore

@@ -1,4 +1,3 @@
-JabFox.sublime-workspace
 node_modules
 web-ext-artifacts
 
@@ -78,3 +77,128 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.gitignore.io/api/linux,macos,windows
+
+# Created by https://www.gitignore.io/api/intellij,sublimetext
+# Edit at https://www.gitignore.io/?templates=intellij,sublimetext
+
+### Intellij ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator/
+
+### SublimeText ###
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+*.sublime-workspace
+
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
+# *.sublime-project
+
+# SFTP configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+# End of https://www.gitignore.io/api/intellij,sublimetext

README.md

@@ -55,12 +55,13 @@ To update dependencies:
  - `npm outdated` gives an overview of outdated packages ([doc](https://docs.npmjs.com/cli/outdated))
  - `npm-upgrade` updates all packages 
  - `npm install` install updated packages
- - 
+ - running
    ```
     git subtree pull --prefix zotero-connectors https://github.com/zotero/zotero-connectors.git master --squash
     git subtree pull --prefix zotero-connectors/src/zotero https://github.com/zotero/zotero.git master --squash
+    git subtree pull --prefix zotero-scholar-citations https://github.com/MaxKuehn/zotero-scholar-citations.git master --squash
    ```
-   updates `zotero-connectors` submodule
+   updates the `zotero-connectors` submodule and the `zotero-scholar-citations` submodule  
 
  - `gulp update-zotero-scripts` copies and post-processes Zotero scripts from `zotero-connectors` to `Zotero` folder
 

background.js

@@ -6,6 +6,8 @@ Zotero.Repo.init();
 Zotero.Messaging.init();
 Zotero.Connector_Types.init();
 Zotero.Translators.init();
+zsc.init();
+wsClient.startClient();
 
 /*
 	Show/hide import button for all tabs (when add-on is loaded).
@@ -121,6 +123,12 @@ browser.runtime.onMessage.addListener(function(message, sender, sendResponse) {
 				console.log("JabRef: Start translation for tab %o", JSON.parse(JSON.stringify(tab)));
 				Zotero.Connector_Browser.saveWithTranslator(tab, 0);
 			});
+	} else if (message.getWsClientState) {
+		console.debug("JabRef: wsClientState requested");
+		let wsClientState = {};
+		wsClientState.clientStarted = wsClient.isClientStarted();
+		wsClientState.connectionState = wsClient.getConnectionState();
+		sendResponse(wsClientState);
 	} else if (message.eval) {
 		console.debug("JabRef: eval in background.js: %o", JSON.parse(JSON.stringify(message.eval)));
 		return evalInTab(sender.tab.id, message.eval);

bibtexConverter.js

@@ -1,10 +1,16 @@
-convertToBibTex = function(items) {
-	console.log("JabRef: Convert items to BibTeX: %o", items);
+convertToBibTex = function(items, conversionMode) {
 	var deferred = Zotero.Promise.defer();
-
 	var translation = new Zotero.Translate.Export();
+
 	translation.setItems(items);
-	translation.setTranslator("9cb70025-a888-4a29-a210-93ec52da40d4"); // BibTeX
+	if (conversionMode === 1) {
+		console.log("JabRef: Converting item(s) to BibLaTeX: %o", items);
+		translation.setTranslator("b6e39b57-8942-4d11-8259-342c46ce395f"); // BibLaTeX
+	}
+	else {
+		console.log("JabRef: Converting item(s) to BibTeX: %o", items);
+		translation.setTranslator("9cb70025-a888-4a29-a210-93ec52da40d4"); // BibTeX
+	}
 	translation.setHandler("done", function(obj, worked) {
 		if (worked) {
 			deferred.resolve(obj.string);
@@ -232,6 +238,6 @@ Zotero.Schema = new function() {
 browser.runtime.onMessage.addListener(message => {
 	if (message.convertToBibTex) {
 		console.log("JabRef: Got task to convert %o to BibTeX", message.convertToBibTex);
-		return convertToBibTex(message.convertToBibTex);
+		return convertToBibTex(message.convertToBibTex, message.conversionMode);
 	}
 });

connector.js

@@ -9,29 +9,56 @@ if (!Date.prototype.toISODate) {
 Zotero.Connector = new function() {
 	this.callMethod = Zotero.Promise.method(function(options, data, cb, tab) {
 		throw new Error("JabRef: Tried to contact Zotero standalone: " + options);
-	})
+	});
 
 	this.callMethodWithCookies = function(options, data, tab) {
-		if (options == "saveItems") {
-			this.convertToBibTex(data.items)
-				.then((bibtex) => this.sendBibTexToJabRef(bibtex));
-		} else if (options == "saveSnapshot") {
+		if (options === "saveItems") {
+			browser.storage.sync.get(['exportMode', 'takeSnapshots', 'retrieveCitationCounts'])
+				.then(configuration => {
+					// fetch current settings
+					configuration.exportMode = configuration.exportMode || 2;
+					configuration.takeSnapshots = configuration.takeSnapshots || false;
+					configuration.retrieveCitationCounts = configuration.retrieveCitationCounts || false;
+					console.debug("exportMode: " + configuration.exportMode);
+					console.debug("takeSnapshots: " + configuration.takeSnapshots);
+					console.debug("retrieveCitationCounts: " + configuration.retrieveCitationCounts);
+
+					let items = [];
+
+					if (configuration.retrieveCitationCounts) {
+						console.log("[scholar-citations] fetching citation counts...");
+
+						// create zsc compatible items
+						for (let i = 0; i < data.items.length; i++) {
+							let item = new ZscItem(data.items[i]);
+							// add internal metadata
+							item.setField('_externalRequest', false); // false: triggered from browser; true: triggered from JabRef
+							item.setStatus(false, true, false, false); // init: no success, item complete (initial assumption), no captcha, not too many requests
+							items.push(item);
+						}
+
+						// get citations counts for all items
+						zsc.processItems(items);
+					}
+
+					this.convertToBibTex(items, configuration.exportMode, configuration.takeSnapshots)
+						.then((bibtex) => this.sendBibTexToJabRef(bibtex));
+				});
+		} else if (options === "saveSnapshot") {
 			// Ignore this
 		} else {
 			throw new Error("JabRef: Tried to contact Zotero standalone: " + options);
 		}
-	}
+	};
 
 	this.checkIsOnline = Zotero.Promise.method(function() {
 		var deferred = Zotero.Promise.defer();
 		// Pretend that we are connected to Zotero standalone
 		deferred.resolve(true);
 		return deferred.promise;
-	})
+	});
 
-	this.prepareForExport = function(items) {
-		// TODO: Get value from preferences
-		var shouldTakeSnapshots;
+	this.prepareForExport = function(items, takeSnapshots) {
 		for (var i = 0; i < items.length; i++) {
 			var item = items[i];
 			for (var j = 0; j < item.attachments.length; j++) {
@@ -40,7 +67,7 @@ Zotero.Connector = new function() {
 				var isLink = attachment.mimeType === 'text/html' || attachment.mimeType === 'application/xhtml+xml';
 				if (isLink && attachment.snapshot !== false) {
 					// Snapshot
-					if (shouldTakeSnapshots && attachment.url) {
+					if (takeSnapshots && attachment.url) {
 						attachment.localPath = attachment.url;
 					} else {
 						// Ignore
@@ -59,10 +86,10 @@ Zotero.Connector = new function() {
 				item.accessDate = new Date().toISODate();
 			}
 		}
-	}
+	};
 
-	this.convertToBibTex = function(items) {
-		this.prepareForExport(items);
+	this.convertToBibTex = function(items, conversionMode, takeSnapshots) {
+		this.prepareForExport(items, takeSnapshots);
 
 		browser.runtime.sendMessage({
 			"onConvertToBibtex": "convertStarted"
@@ -75,12 +102,13 @@ Zotero.Connector = new function() {
 			for (let tab of tabs) {
 				return browser.tabs.sendMessage(
 					tab.id, {
-						convertToBibTex: items
+						convertToBibTex: items,
+						conversionMode: conversionMode
 					}
 				);
 			}
 		})
-	}
+	};
 
 	this.sendBibTexToJabRef = function(bibtex) {
 		browser.runtime.sendMessage({
@@ -105,4 +133,4 @@ Zotero.Connector = new function() {
 				});
 			});
 	}
-}
+};