Android release v1.0.292

* Korean Language Support

Korean Language 100% Translated, but something is roughted. soon fix it ;)

* some improved

Some Improved

* Improve v2

some polished

* Ok, now Completed

For Now, Completed Polish(Change Respect of Users, and several fixing & polishing) + 100% Translated. Ready to Shipping

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+patreon: joplin
+custom: https://joplinapp.org/donate/

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,4 @@
+👉 Please follow one of these issue templates:
+- https://github.com/laurent22/joplin/issues/new/choose
+
+Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression in Joplin.
+title: ''
+labels: 'bug'
+
+---
+
+<!--
+  Please provide a clear and concise description of what the bug is. (In the section Steps To Reproduce.)
+  Include screenshots if needed.
+  Please test using the latest Joplin release to make sure your issue has not already been fixed.
+-->
+
+## Environment
+
+Joplin version:
+Platform:
+OS specifcs:
+<!--
+  Platform can be one of: macOS, Linux, Windows, Android, iOS, terminal (or a combination)
+  OS specifcs: e.g. OS version, Linux distribution, Android/iOS version, ...
+-->
+
+## Steps To Reproduce
+
+1.
+2.
+
+<!--
+  Issues without reproduction steps are likely to stall.
+-->
+
+Describe what you expected to happen:
+
+
+
+## Logfile
+
+<!--
+  Please attach a debug log. Issues without a debug log are likely to stall.
+  For information on how to collect a log file: https://joplinapp.org/debugging/
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,33 @@
+---
+name: Feature request
+about: Suggest a feature for Joplin.
+title: '[Feature request] '
+labels: 'feature request'
+
+---
+
+<!--
+  Please search open issues first - many features have already been requested!
+-->
+
+## Has it been discussed in the forum? Link to topic.
+<!--
+  Feature requests should be discussed in the forum first. https://discourse.joplinapp.org
+  Please provide a link to the topic.
+-->
+
+
+## Is your feature request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+
+## Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+
+## Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+
+## Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,29 @@
+---
+name: "🤔 Questions and Help"
+about: The issue tracker is not for questions. Please ask questions on https://discourse.joplinapp.org/.
+title: 'Question: '
+labels: 'question'
+
+---
+
+🚨 The issue tracker is not for questions. 🚨
+
+As it happens, support requests that are created as issues are likely to be closed. We want to make sure you are able to find the help you seek.
+
+## Questions and Help
+
+Please read the [documentation](https://joplinapp.org/) and [FAQ](https://joplinapp.org/faq/) first.
+
+### https://discourse.joplinapp.org/
+
+If you have still questions related to Joplin, please open a topic in the [forum](https://discourse.joplinapp.org/).
+You can use your GitHub credentials to login to the forum.
+
+## Links
+
+- Documentation: https://joplinapp.org
+- FAQ: https://joplinapp.org/faq/
+- Forum: https://discourse.joplinapp.org
+- How to enable end-to-end encryption: https://joplinapp.org/e2ee/
+- API documentation: https://joplinapp.org/api/
+- How to enable debug mode: https://joplinapp.org/debugging/

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,13 @@
+<!--
+
+Please prefix the title with the platform you are targetting:
+
+- "Desktop" for the Windows/macOS/Linux app (Electron app)
+- "Mobile" for the mobile app (or "Android" / "iOS" if the pull request only applies to one of the mobile platforms)
+- "CLI" for the CLI app
+
+For example: "Desktop: Added new setting to change font", or "Mobile: Fixed config screen error"
+
+PLEASE READ THE GUIDE FIRST: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md
+
+-->

.github/stale.yml

@@ -0,0 +1,25 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 90
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - "good first issue"
+  - "essential"
+  - "essential-reviewed"
+  - "help wanted"
+  - "nice to have"
+  - "upstream"
+  - "backlog"
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs.
+  You may also label this issue as "backlog" and I will leave it open.
+  Thank you for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: >
+  Closing this issue after a prolonged period of inactivity. If this issue is still present in the latest release, please feel free to create a new issue with up-to-date information.
+only: issues

.gitignore

@@ -39,5 +39,7 @@ node_modules
 Tools/github_oauth_token.txt
 _releases
 ReactNativeClient/lib/csstojs/
+ReactNativeClient/lib/rnInjectedJs/
 ElectronClient/app/gui/note-viewer/fonts/
+ElectronClient/app/gui/note-viewer/lib.js
 Tools/commit_hook.txt

.travis.yml

@@ -3,6 +3,14 @@ if: tag IS present
 
 rvm: 2.3.3
 
+# It's important to only build production branches otherwise Electron Builder
+# might take assets from dev branches and overwrite those of production.
+# https://docs.travis-ci.com/user/customizing-the-build/#Building-Specific-Branches
+branches:
+  only:
+    - master
+    - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
+
 matrix:
   include:
     - os: osx

Assets/JoplinLetter.svg

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="116.54575mm"
+   height="131.19589mm"
+   viewBox="0 0 116.54575 131.19589"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"
+   sodipodi:docname="JoplinLetter.svg">
+  <defs
+     id="defs2" />
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.49497475"
+     inkscape:cx="152.11122"
+     inkscape:cy="-26.090631"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1920"
+     inkscape:window-height="1017"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-2.7903623,-2.175533)">
+    <path
+       style="fill:#000000;stroke-width:0.26458332"
+       d="m 43.790458,133.13317 c -8.32317,-1.11843 -12.937,-2.40956 -18.46857,-5.16822 -10.21924,-5.09644 -18.1023498,-13.95338 -21.1745998,-23.79038 -1.22214,-3.91319 -1.3607,-4.872332 -1.35685,-9.392712 0.003,-3.72804 0.0907,-4.66941 0.59927,-6.44569 1.0664,-3.7246 2.49409,-6.1704 5.19529,-8.90014 3.2574198,-3.29184 6.6565798,-4.77332 11.3929598,-4.96548 4.53189,-0.18388 7.54661,0.59927 10.40386,2.70266 1.82035,1.34007 3.67693,3.96421 4.71565,6.66525 0.65839,1.71204 0.70959,2.1839 0.90042,8.29756 0.19973,6.39855 0.36372,7.6318 1.39223,10.469902 1.40468,3.87611 3.78939,6.56189 7.33039,8.25588 3.20047,1.53108 5.63801,2.00183 9.60817,1.8556 2.58182,-0.0951 3.60332,-0.25442 5.15337,-0.80371 4.61358,-1.63493 8.46322,-5.31381 10.31326,-9.85579 1.91154,-4.693002 1.90785,-4.609372 1.90213,-43.127082 -0.005,-33.78395 -0.0106,-34.14337 -0.54484,-35.32188 -1.30698,-2.882895 -2.68223,-3.398165 -9.66971,-3.622945 l -5.12472,-0.16486 V 10.998334 2.175533 l 31.41927,0.06723 31.419272,0.06723 0.0697,8.755726 0.0697,8.755724 -5.09675,0.1793 c -2.82759,0.0995 -5.60596,0.33101 -6.24051,0.52006 -1.72896,0.5151 -2.82899,1.538795 -3.52569,3.281045 l -0.61059,1.5269 -0.16762,34.7927 c -0.16988,35.26321 -0.19381,36.08914 -1.18496,40.914372 -1.81292,8.82581 -8.301582,17.89221 -16.959672,23.69719 -6.95182,4.66099 -14.48972,7.21214 -24.82645,8.40235 -2.7431,0.31585 -14.57797,0.31433 -16.93333,-0.002 z"
+       id="path21"
+       inkscape:connector-curvature="0" />
+  </g>
+</svg>

BUILD.md

@@ -1,15 +1,14 @@
+ [![Travis Build Status](https://travis-ci.org/laurent22/joplin.svg?branch=master)](https://travis-ci.org/laurent22/joplin) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/laurent22/joplin?branch=master&passingText=master%20-%20OK&svg=true)](https://ci.appveyor.com/project/laurent22/joplin)
+
 # General information
 
 - All the applications share the same library, which, for historical reasons, is in ReactNativeClient/lib. This library is copied to the relevant directories when building each app.
-- The translations are built by running CliClient/build-translation.sh. You normally don't need to run this if you haven't updated the translation since the compiled files are on the repository.
 
 ## macOS dependencies
 
 	brew install yarn node
 	echo 'export PATH="/usr/local/opt/gettext/bin:$PATH"' >> ~/.bash_profile
 	source ~/.bash_profile
-     
-If you get a node-gyp related error you might need to manually install it: `npm install -g node-gyp`
 
 ## Linux and Windows (WSL) dependencies
 
@@ -37,12 +36,33 @@ yarn dist
 
 If there's an error `while loading shared libraries: libgconf-2.so.4: cannot open shared object file: No such file or directory`, run `sudo apt-get install libgconf-2-4`
 
-For node-gyp to work, you might need to install the `windows-build-tools` using `npm install --global windows-build-tools`.
+If you get a node-gyp related error you might need to manually install it: `npm install -g node-gyp`.
+
+If you get the error `libtool: unrecognized option '-static'`, follow the instructions [in this post](https://stackoverflow.com/a/38552393/561309) to use the correct libtool version.
 
 That will create the executable file in the `dist` directory.
 
 From `/ElectronClient` you can also run `run.sh` to run the app for testing.
 
+## Building Electron application on Windows
+
+```
+cd Tools
+npm install
+cd ..\ElectronClient\app
+xcopy /C /I /H /R /Y /S ..\..\ReactNativeClient\lib lib
+npm install
+yarn dist
+```
+
+If node-gyp does not works (MSBUILD: error MSB3428: Could not load the Visual C++ component "VCBuild.exe"), you might need to install the `windows-build-tools` using `npm install --global windows-build-tools`.
+
+If `yarn dist` fails, it may need administrative rights.
+
+If you get an `error MSB8020: The build tools for v140 cannot be found.` try to run with a different toolset version, eg `npm install --toolset=v141` (See [here](https://github.com/mapbox/node-sqlite3/issues/1124) for more info).
+
+The [building\_win32\_tips on this page](./readme/building_win32_tips.md) might be helpful.
+
 # Building the Mobile application
 
 First you need to setup React Native to build projects with native code. For this, follow the instructions on the [Get Started](https://facebook.github.io/react-native/docs/getting-started.html) tutorial, in the "Building Projects with Native Code" tab.

CONTRIBUTING.md

@@ -1,20 +1,63 @@
+# User support
+
+The [Joplin Forum](https://discourse.joplinapp.org/) is the community driven place for user support, general discussion about Joplin, problems with installation, new features and software development questions. It is possible to login with your GitHub account. Don't use the issue tracker for support questions.
+
 # Reporting a bug
 
-Please check first that it [has not already been reported](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Also consider [enabling debug mode](https://github.com/laurent22/joplin/blob/master/README_debugging.md) before reporting the issue so that you can provide as much details as possible to help fix it.
+File bugs in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Please follow these guidelines:
 
-If possible, **please provide a screenshot**. A screenshot showing the problem is often more useful than a paragraph describing it as it can make it immediately clear what the issue is.
+- Search existing issues first, make sure yours hasn't already been reported.
+- Consider [enabling debug mode](https://joplinapp.org/debugging/) so that you can provide as much details as possible when reporting the issue.
+- Stay on topic, but describe the issue in detail so that others can reproduce it.
+- **Provide a screenshot** if possible. A screenshot showing the problem is often more useful than a paragraph describing it.
+- For web clipper bugs, **please provide the URL causing the issue**. Sometimes the clipper works in one page but not in another so it is important to know what URL has a problem.
 
 # Feature requests
 
-Again, please check that it has not already been requested. If it has, simply **up-vote the issue** - the ones with the most up-votes are likely to be implemented. Adding a "+1" comment does nothing.
+Please check that your request has not already been posted in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). If it has, **up-voting the issue** increases the chances it'll be noticed and implemented in the future. "+1" comments are not tracked.
 
-# Adding new features
+As a general rule, suggestions to *improve Joplin* should be posted first in the [Joplin Forum](https://discourse.joplinapp.org/) for discussion.
 
-If you want to add a new feature, consider asking about it before implementing it to make sure it is within the scope of the project. Of course you are free to create the pull request directly but it is not guaranteed it is going to be accepted.
+Avoid listing multiple requests in one report in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). One issue per request makes it easier to track and discuss it.
+
+Finally, when submitting a pull request, don't forget to [test your code](#unit-tests).
+
+# Contribute to the project
+
+## Contributing to Joplin's translation
+
+Joplin is available in multiple languages thanks to the help of its users. You can help translate Joplin to your language or keep it up to date. Please read the documentation about [Localisation](https://joplinapp.org/#localisation).
+
+## Contributing to Joplin's code
+
+If you want to start contributing to the project's code, please follow these guidelines before creating a pull request: 
+
+- Bug fixes are always welcome. Start by reviewing the list of [essential issues](https://github.com/laurent22/joplin/issues?q=is%3Aissue+is%3Aopen+label%3Aessential)
+- Before adding a new feature, ask about it in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue) or the [Joplin Forum](https://discourse.joplinapp.org/), or check if existing discussions exist to make sure the new functionality is desired.
+- **Changes that will consist in more than 50 lines of code should be discussed the [Joplin Forum](https://discourse.joplinapp.org/)**, so that you don't spend too much time implementing something that might not be accepted.
 
 Building the apps is relatively easy - please [see the build instructions](https://github.com/laurent22/joplin/blob/master/BUILD.md) for more details.
 
-# Coding style
+## Coding style
 
-- Only use tabs for indentation, not spaces.
-- Do not remove or add optional characters from other lines (such as colons or new line characters) as it can make the commit needlessly big, and create conflicts with other changes.
+There are only two rules, but not following them means the pull request will not be accepted (it can be accepted once the issues are fixed):
+
+- **Please use tabs, NOT spaces.**
+- **Please do not add or remove optional characters, such as spaces or colons.** Please setup your editor so that it only changes what you are working on and is not making automated changes elsewhere. The reason for this is that small white space changes make diff hard to read and can cause needless conflicts.
+
+## Unit tests
+
+When submitting a pull request for a new feature or bug fix, please add unit tests for your code. Unit testing GUI changes is not always possible so it is not required, but any change in a file under /lib for example should be unit tested.
+
+The tests are under CliClient/tests. To get them running, you first need to build the CLI app:
+
+    cd CliClient
+    npm i
+
+Then to run all the test units:
+
+    ./run_test.sh
+
+To run just one particular file:
+
+    ./run_test.sh markdownUtils # Don't add the .js extension

CliClient/.gitignore

@@ -13,9 +13,11 @@ tests/fuzzing.*
 tests/fuzzing -*
 tests/logs/*
 tests/cli-integration/
+tests/tmp/
 *.mo
 *.*~
 tests/sync
 out.txt
 linkToLocal.sh
-yarn-error.log
+yarn-error.log
+tests/support/dropbox-auth.txt

CliClient/app/app-gui.js

@@ -1,5 +1,6 @@
 const { Logger } = require('lib/logger.js');
 const Folder = require('lib/models/Folder.js');
+const BaseItem = require('lib/models/BaseItem.js');
 const Tag = require('lib/models/Tag.js');
 const BaseModel = require('lib/BaseModel.js');
 const Note = require('lib/models/Note.js');
@@ -9,6 +10,8 @@ const { reducer, defaultState } = require('lib/reducer.js');
 const { splitCommandString } = require('lib/string-utils.js');
 const { reg } = require('lib/registry.js');
 const { _ } = require('lib/locale.js');
+const Entities = require('html-entities').AllHtmlEntities;
+const htmlentities = (new Entities()).encode;
 
 const chalk = require('chalk');
 const tk = require('terminal-kit');
@@ -35,38 +38,55 @@ const ConsoleWidget = require('./gui/ConsoleWidget.js');
 
 class AppGui {
 
-	constructor(app, store) {
-		this.app_ = app;
-		this.store_ = store;
+	constructor(app, store, keymap) {
+		try {
+			this.app_ = app;
+			this.store_ = store;
 
-		BaseWidget.setLogger(app.logger());
+			BaseWidget.setLogger(app.logger());
 
-		this.term_ = new TermWrapper(tk.terminal);
+			this.term_ = new TermWrapper(tk.terminal);
 
-		this.renderer_ = null;
-		this.logger_ = new Logger();
-		this.buildUi();
+			// Some keys are directly handled by the tkwidget framework
+			// so they need to be remapped in a different way.
+			this.tkWidgetKeys_ = {
+				'focus_next': 'TAB',
+				'focus_previous': 'SHIFT_TAB',
+				'move_up': 'UP',
+				'move_down': 'DOWN',
+				'page_down': 'PAGE_DOWN',
+				'page_up': 'PAGE_UP',
+			};
 
-		this.renderer_ = new Renderer(this.term(), this.rootWidget_);
+			this.renderer_ = null;
+			this.logger_ = new Logger();
+			this.buildUi();
 
-		this.app_.on('modelAction', async (event) => {
-			await this.handleModelAction(event.action);
-		});
+			this.renderer_ = new Renderer(this.term(), this.rootWidget_);
 
-		this.shortcuts_ = this.setupShortcuts();
+			this.app_.on('modelAction', async (event) => {
+				await this.handleModelAction(event.action);
+			});
 
-		this.inputMode_ = AppGui.INPUT_MODE_NORMAL;
+			this.keymap_ = this.setupKeymap(keymap);
 
-		this.commandCancelCalled_ = false;
+			this.inputMode_ = AppGui.INPUT_MODE_NORMAL;
 
-		this.currentShortcutKeys_ = [];
-		this.lastShortcutKeyTime_ = 0;
+			this.commandCancelCalled_ = false;
 
-		// Recurrent sync is setup only when the GUI is started. In
-		// a regular command it's not necessary since the process
-		// exits right away.
-		reg.setupRecurrentSync();
-		DecryptionWorker.instance().scheduleStart();
+			this.currentShortcutKeys_ = [];
+			this.lastShortcutKeyTime_ = 0;
+
+			// Recurrent sync is setup only when the GUI is started. In
+			// a regular command it's not necessary since the process
+			// exits right away.
+			reg.setupRecurrentSync();
+			DecryptionWorker.instance().scheduleStart();
+		} catch (error) {
+			this.fullScreen(false);
+			console.error(error);
+			process.exit(1);
+		}
 	}
 
 	store() {
@@ -105,6 +125,7 @@ class AppGui {
 	buildUi() {
 		this.rootWidget_ = new ReduxRootWidget(this.store_);
 		this.rootWidget_.name = 'root';
+		this.rootWidget_.autoShortcutsEnabled = false;
 
 		const folderList = new FolderListWidget();
 		folderList.style = {
@@ -269,155 +290,31 @@ class AppGui {
 
 	addCommandToConsole(cmd) {
 		if (!cmd) return;
+		const isConfigPassword = cmd.indexOf('config ') >= 0 && cmd.indexOf('password') >= 0;
+		if (isConfigPassword) return;
 		this.stdout(chalk.cyan.bold('> ' + cmd));	
 	}
 
-	setupShortcuts() {
-		const shortcuts = {};
+	setupKeymap(keymap) {
+		const output = [];
 
-		shortcuts['TAB'] = {
-			friendlyName: 'Tab',
-			description: () => _('Give focus to next pane'),
-			isDocOnly: true,
-		}
+		for (let i = 0; i < keymap.length; i++) {
+			const item = Object.assign({}, keymap[i]);
 
-		shortcuts['SHIFT_TAB'] = {
-			friendlyName: 'Shift+Tab',
-			description: () => _('Give focus to previous pane'),
-			isDocOnly: true,
-		}
+			if (!item.command) throw new Error('Missing command for keymap item: ' + JSON.stringify(item));
 
-		shortcuts[':'] = {
-			description: () => _('Enter command line mode'),
-			action: async () => {
-				const cmd = await this.widget('statusBar').prompt();
-				if (!cmd) return;
-				this.addCommandToConsole(cmd);
-				await this.processCommand(cmd);
-			},
-		};
+			if (!('type' in item)) item.type = 'exec';
 
-		shortcuts['ESC'] = { // Built into terminal-kit inputField
-			description: () => _('Exit command line mode'),
-			isDocOnly: true,
-		};
-
-		shortcuts['ENTER'] = {
-			description: () => _('Edit the selected note'),
-			action: () => {
-				const w = this.widget('mainWindow').focusedWidget;
-				if (w.name === 'folderList') {
-					this.widget('noteList').focus();
-				} else if (w.name === 'noteList' || w.name === 'noteText') {
-					this.processCommand('edit $n');
-				}
-			},
-		}
-
-		shortcuts['CTRL_C'] = {
-			description: () => _('Cancel the current command.'),
-			friendlyName: 'Ctrl+C',
-			isDocOnly: true,
-		}
-
-		shortcuts['CTRL_D'] = {
-			description: () => _('Exit the application.'),
-			friendlyName: 'Ctrl+D',
-			isDocOnly: true,
-		}
-
-		shortcuts['DELETE'] = {
-			description: () => _('Delete the currently selected note or notebook.'),
-			action: async () => {
-				if (this.widget('folderList').hasFocus) {
-					const item = this.widget('folderList').selectedJoplinItem;
-
-					if (!item) return;
-
-					if (item.type_ === BaseModel.TYPE_FOLDER) {
-						await this.processCommand('rmbook ' + item.id);
-					} else if (item.type_ === BaseModel.TYPE_TAG) {
-						this.stdout(_('To delete a tag, untag the associated notes.'));
-					} else if (item.type_ === BaseModel.TYPE_SEARCH) {
-						this.store().dispatch({
-							type: 'SEARCH_DELETE',
-							id: item.id,
-						});
-					}
-				} else if (this.widget('noteList').hasFocus) {
-					await this.processCommand('rmnote $n');
-				} else {
-					this.stdout(_('Please select the note or notebook to be deleted first.'));
-				}
+			if (item.command in this.tkWidgetKeys_) {
+				item.type = 'tkwidgets';
 			}
-		};
 
-		shortcuts['BACKSPACE'] = {
-			alias: 'DELETE',
-		};
+			item.canRunAlongOtherCommands = item.type === 'function' && ['toggle_metadata', 'toggle_console'].indexOf(item.command) >= 0;
 
-		shortcuts[' '] = {
-			friendlyName: 'SPACE',
-			description: () => _('Set a to-do as completed / not completed'),
-			action: 'todo toggle $n',
+			output.push(item);
 		}
 
-		shortcuts['tc'] = {
-			description: () => _('[t]oggle [c]onsole between maximized/minimized/hidden/visible.'),
-			action: () => {
-				if (!this.consoleIsShown()) {
-					this.showConsole();
-					this.minimizeConsole();
-				} else {
-					if (this.consoleIsMaximized()) {
-						this.hideConsole();
-					} else {
-						this.maximizeConsole();
-					}
-				}
-			},
-			canRunAlongOtherCommands: true,
-		}
-
-		shortcuts['/'] = {
-			description: () => _('Search'),
-			action: { type: 'prompt', initialText: 'search ""', cursorPosition: -2 },
-		};
-
-		shortcuts['tm'] = {
-			description: () => _('[t]oggle note [m]etadata.'),
-			action: () => {
-				this.toggleNoteMetadata();
-			},
-			canRunAlongOtherCommands: true,
-		}
-
-		shortcuts['mn'] = {
-			description: () => _('[M]ake a new [n]ote'),
-			action: { type: 'prompt', initialText: 'mknote ""', cursorPosition: -2 },
-		}
-
-		shortcuts['mt'] = {
-			description: () => _('[M]ake a new [t]odo'),
-			action: { type: 'prompt', initialText: 'mktodo ""', cursorPosition: -2 },
-		}
-
-		shortcuts['mb'] = {
-			description: () => _('[M]ake a new note[b]ook'),
-			action: { type: 'prompt', initialText: 'mkbook ""', cursorPosition: -2 },
-		}
-
-		shortcuts['yn'] = {
-			description: () => _('Copy ([Y]ank) the [n]ote to a notebook.'),
-			action: { type: 'prompt', initialText: 'cp $n ""', cursorPosition: -2 },
-		}
-
-		shortcuts['dn'] = {
-			description: () => _('Move the note to a notebook.'),
-			action: { type: 'prompt', initialText: 'mv $n ""', cursorPosition: -2 },
-		}
-
-		return shortcuts;
+		return output;
 	}
 
 	toggleConsole() {
@@ -492,8 +389,16 @@ class AppGui {
 		return this.logger_;
 	}
 
-	shortcuts() {
-		return this.shortcuts_;
+	keymap() {
+		return this.keymap_;
+	}
+
+	keymapItemByKey(key) {
+		for (let i = 0; i < this.keymap_.length; i++) {
+			const item = this.keymap_[i];
+			if (item.keys.indexOf(key) >= 0) return item;
+		}
+		return null;
 	}
 
 	term() {
@@ -524,17 +429,77 @@ class AppGui {
 		}
 	}
 
-	async processCommand(cmd) {
+	async processFunctionCommand(cmd) {
+
+		if (cmd === 'activate') {
+
+			const w = this.widget('mainWindow').focusedWidget;
+			if (w.name === 'folderList') {
+				this.widget('noteList').focus();
+			} else if (w.name === 'noteList' || w.name === 'noteText') {
+				this.processPromptCommand('edit $n');
+			}
+
+		} else if (cmd === 'delete') {
+
+			if (this.widget('folderList').hasFocus) {
+				const item = this.widget('folderList').selectedJoplinItem;
+
+				if (!item) return;
+
+				if (item.type_ === BaseModel.TYPE_FOLDER) {
+					await this.processPromptCommand('rmbook ' + item.id);
+				} else if (item.type_ === BaseModel.TYPE_TAG) {
+					this.stdout(_('To delete a tag, untag the associated notes.'));
+				} else if (item.type_ === BaseModel.TYPE_SEARCH) {
+					this.store().dispatch({
+						type: 'SEARCH_DELETE',
+						id: item.id,
+					});
+				}
+			} else if (this.widget('noteList').hasFocus) {
+				await this.processPromptCommand('rmnote $n');
+			} else {
+				this.stdout(_('Please select the note or notebook to be deleted first.'));
+			}
+
+		} else if (cmd === 'toggle_console') {
+
+			if (!this.consoleIsShown()) {
+				this.showConsole();
+				this.minimizeConsole();
+			} else {
+				if (this.consoleIsMaximized()) {
+					this.hideConsole();
+				} else {
+					this.maximizeConsole();
+				}
+			}
+
+		} else if (cmd === 'toggle_metadata') {
+
+			this.toggleNoteMetadata();
+
+		} else if (cmd === 'enter_command_line_mode') {
+
+			const cmd = await this.widget('statusBar').prompt();
+			if (!cmd) return;
+			this.addCommandToConsole(cmd);
+			await this.processPromptCommand(cmd);			
+
+		} else {
+
+			throw new Error('Unknown command: ' + cmd);
+
+		}
+	}
+
+	async processPromptCommand(cmd) {
 		if (!cmd) return;
 		cmd = cmd.trim();
 		if (!cmd.length) return;
 
-		this.logger().info('Got command: ' + cmd);
-
-		if (cmd === 'q' || cmd === 'wq' || cmd === 'qa') { // Vim bonus
-			await this.app().exit();
-			return;
-		}	
+		// this.logger().debug('Got command: ' + cmd);
 
 		try {			
 			let note = this.widget('noteList').currentItem;
@@ -676,12 +641,27 @@ class AppGui {
 				return true;
 			}
 
-			if (link.type === 'resource') {
-				const resourceId = link.id;
-				let resource = await Resource.load(resourceId);
-				if (!resource) throw new Error('No resource with ID ' + resourceId); // Should be nearly impossible
-				if (resource.mime) response.setHeader('Content-Type', resource.mime);
-				response.write(await Resource.content(resource));
+			if (link.type === 'item') {
+				const itemId = link.id;
+				let item = await BaseItem.loadItemById(itemId);
+				if (!item) throw new Error('No item with ID ' + itemId); // Should be nearly impossible
+
+				if (item.type_ === BaseModel.TYPE_RESOURCE) {
+					if (item.mime) response.setHeader('Content-Type', item.mime);
+					response.write(await Resource.content(item));
+				} else if (item.type_ === BaseModel.TYPE_NOTE) {
+					const html = [`
+						<!DOCTYPE html>
+						<html class="client-nojs" lang="en" dir="ltr">
+						<head><meta charset="UTF-8"/></head><body>
+					`];
+					html.push('<pre>' + htmlentities(item.title) + '\n\n' + htmlentities(item.body) + '</pre>');
+					html.push('</body></html>');
+					response.write(html.join(''));
+				} else {
+					throw new Error('Unsupported item type: ' + item.type_);
+				}
+
 				return true;
 			}
 
@@ -697,7 +677,7 @@ class AppGui {
 
 				if (resourceIdRegex.test(url)) {
 					noteLinks[index] = {
-						type: 'resource',
+						type: 'item',
 						id: url.substr(2),
 					};					
 				} else if (hasProtocol(url, ['http', 'https', 'file', 'ftp'])) {
@@ -786,35 +766,34 @@ class AppGui {
 				// -------------------------------------------------------------------------
 
 				const shortcutKey = this.currentShortcutKeys_.join('');
-				let cmd = shortcutKey in this.shortcuts_ ? this.shortcuts_[shortcutKey] : null;
+				let keymapItem = this.keymapItemByKey(shortcutKey);
 
 				// If this command is an alias to another command, resolve to the actual command
-				if (cmd && cmd.alias) cmd = this.shortcuts_[cmd.alias];
 
-				let processShortcutKeys = !this.app().currentCommand() && cmd;
-				if (cmd && cmd.canRunAlongOtherCommands) processShortcutKeys = true;
+				let processShortcutKeys = !this.app().currentCommand() && keymapItem;
+				if (keymapItem && keymapItem.canRunAlongOtherCommands) processShortcutKeys = true;
 				if (statusBar.promptActive) processShortcutKeys = false;
-				if (cmd && cmd.isDocOnly) processShortcutKeys = false;
 
 				if (processShortcutKeys) {
-					this.logger().info('Shortcut:', shortcutKey, cmd.description());
+					this.logger().debug('Shortcut:', shortcutKey, keymapItem);
 
 					this.currentShortcutKeys_ = [];
-					if (typeof cmd.action === 'function') {
-						await cmd.action();
-					} else if (typeof cmd.action === 'object') {
-						if (cmd.action.type === 'prompt') {
-							let promptOptions = {};
-							if ('cursorPosition' in cmd.action) promptOptions.cursorPosition = cmd.action.cursorPosition;
-							const commandString = await statusBar.prompt(cmd.action.initialText ? cmd.action.initialText : '', null, promptOptions);
-							this.addCommandToConsole(commandString);
-							await this.processCommand(commandString);
-						} else {
-							throw new Error('Unknown command: ' + JSON.stringify(cmd.action));
-						}
-					} else { // String
-						this.stdout(cmd.action);
-						await this.processCommand(cmd.action);
+
+					if (keymapItem.type === 'function') {
+						this.processFunctionCommand(keymapItem.command);
+					} else if (keymapItem.type === 'prompt') {
+						let promptOptions = {};
+						if ('cursorPosition' in keymapItem) promptOptions.cursorPosition = keymapItem.cursorPosition;
+						const commandString = await statusBar.prompt(keymapItem.command ? keymapItem.command : '', null, promptOptions);
+						this.addCommandToConsole(commandString);
+						await this.processPromptCommand(commandString);
+					} else if (keymapItem.type === 'exec') {
+						this.stdout(keymapItem.command);
+						await this.processPromptCommand(keymapItem.command);
+					} else if (keymapItem.type === 'tkwidgets') {
+						this.widget('root').handleKey(this.tkWidgetKeys_[keymapItem.command]);
+					} else {
+						throw new Error('Unknown command type: ' + JSON.stringify(keymapItem));
 					}
 				}
 

CliClient/app/app.js

@@ -5,6 +5,7 @@ const { JoplinDatabase } = require('lib/joplin-database.js');
 const { Database } = require('lib/database.js');
 const { FoldersScreenUtils } = require('lib/folders-screen-utils.js');
 const { DatabaseDriverNode } = require('lib/database-driver-node.js');
+const ResourceService = require('lib/services/ResourceService');
 const BaseModel = require('lib/BaseModel.js');
 const Folder = require('lib/models/Folder.js');
 const BaseItem = require('lib/models/BaseItem.js');
@@ -20,8 +21,9 @@ const { _, setLocale, defaultLocale, closestSupportedLocale } = require('lib/loc
 const os = require('os');
 const fs = require('fs-extra');
 const { cliUtils } = require('./cli-utils.js');
-const EventEmitter = require('events');
 const Cache = require('lib/Cache');
+const WelcomeUtils = require('lib/WelcomeUtils');
+const RevisionService = require('lib/services/RevisionService');
 
 class Application extends BaseApplication {
 
@@ -283,7 +285,7 @@ class Application extends BaseApplication {
 			exit: () => {},
 			showModalOverlay: (text) => {},
 			hideModalOverlay: () => {},
-			stdoutMaxWidth: () => { return 78; },
+			stdoutMaxWidth: () => { return 100; },
 			forceRender: () => {},
 			termSaveState: () => {},
 			termRestoreState: (state) => {},
@@ -292,7 +294,7 @@ class Application extends BaseApplication {
 
 	async execCommand(argv) {
 		if (!argv.length) return this.execCommand(['help']);
-		reg.logger().info('execCommand()', argv);
+		// reg.logger().debug('execCommand()', argv);
 		const commandName = argv[0];
 		this.activeCommand_ = this.findCommandByName(commandName);
 
@@ -312,6 +314,63 @@ class Application extends BaseApplication {
 		return this.activeCommand_;
 	}
 
+	async loadKeymaps() {
+		const defaultKeyMap = [
+			{ "keys": [":"], "type": "function", "command": "enter_command_line_mode" },
+			{ "keys": ["TAB"], "type": "function", "command": "focus_next" },
+			{ "keys": ["SHIFT_TAB"], "type": "function", "command": "focus_previous" },
+			{ "keys": ["UP"], "type": "function", "command": "move_up" },
+			{ "keys": ["DOWN"], "type": "function", "command": "move_down" },
+			{ "keys": ["PAGE_UP"], "type": "function", "command": "page_up" },
+			{ "keys": ["PAGE_DOWN"], "type": "function", "command": "page_down" },
+			{ "keys": ["ENTER"], "type": "function", "command": "activate" },
+			{ "keys": ["DELETE", "BACKSPACE"], "type": "function", "command": "delete" },
+			{ "keys": [" "], "command": "todo toggle $n" },
+			{ "keys": ["tc"], "type": "function", "command": "toggle_console" },
+			{ "keys": ["tm"], "type": "function", "command": "toggle_metadata" },
+			{ "keys": ["/"], "type": "prompt", "command": "search \"\"", "cursorPosition": -2 },
+			{ "keys": ["mn"], "type": "prompt", "command": "mknote \"\"", "cursorPosition": -2 },
+			{ "keys": ["mt"], "type": "prompt", "command": "mktodo \"\"", "cursorPosition": -2 },
+			{ "keys": ["mb"], "type": "prompt", "command": "mkbook \"\"", "cursorPosition": -2 },
+			{ "keys": ["yn"], "type": "prompt", "command": "cp $n \"\"", "cursorPosition": -2 },
+			{ "keys": ["dn"], "type": "prompt", "command": "mv $n \"\"", "cursorPosition": -2 }
+		];
+
+		// Filter the keymap item by command so that items in keymap.json can override
+		// the default ones.
+		const itemsByCommand = {};
+
+		for (let i = 0; i < defaultKeyMap.length; i++) {
+			itemsByCommand[defaultKeyMap[i].command] = defaultKeyMap[i]
+		}
+
+		const filePath = Setting.value('profileDir') + '/keymap.json';
+		if (await fs.pathExists(filePath)) {
+			try {
+				let configString = await fs.readFile(filePath, 'utf-8');
+				configString = configString.replace(/^\s*\/\/.*/, ''); // Strip off comments
+				const keymap = JSON.parse(configString);
+				for (let keymapIndex = 0; keymapIndex < keymap.length; keymapIndex++) {
+					const item = keymap[keymapIndex];
+					itemsByCommand[item.command] = item;
+				}
+			} catch (error) {
+				let msg = error.message ? error.message : '';
+				msg = 'Could not load keymap ' + filePath + '\n' + msg;
+				error.message = msg;
+				throw error;
+			}
+		}
+
+		const output = [];
+		for (let n in itemsByCommand) {
+			if (!itemsByCommand.hasOwnProperty(n)) continue;
+			output.push(itemsByCommand[n]);
+		}
+
+		return output;
+	}
+
 	async start(argv) {
 		argv = await super.start(argv);
 
@@ -330,16 +389,25 @@ class Application extends BaseApplication {
 				await this.execCommand(argv);
 			} catch (error) {
 				if (this.showStackTraces_) {
-					console.info(error);
+					console.error(error);
 				} else {
 					console.info(error.message);
 				}
+				process.exit(1);
 			}
+
+			await Setting.saveAll();
+
+			// Need to call exit() explicitely, otherwise Node wait for any timeout to complete
+			// https://stackoverflow.com/questions/18050095
+			process.exit(0);
 		} else { // Otherwise open the GUI
 			this.initRedux();
 
+			const keymap = await this.loadKeymaps();
+
 			const AppGui = require('./app-gui.js');
-			this.gui_ = new AppGui(this, this.store());
+			this.gui_ = new AppGui(this, this.store(), keymap);
 			this.gui_.setLogger(this.logger_);
 			await this.gui_.start();
 
@@ -352,6 +420,10 @@ class Application extends BaseApplication {
 
 			const tags = await Tag.allWithNotes();
 
+			ResourceService.runInBackground();
+			
+			RevisionService.instance().runInBackground();
+
 			this.dispatch({
 				type: 'TAG_UPDATE_ALL',
 				items: tags,

CliClient/app/autocompletion.js

@@ -36,7 +36,7 @@ async function handleAutocompletionPromise(line) {
 	if (next[0] === '-') {
 		for (let i = 0; i<metadata.options.length; i++) {
 			const options = metadata.options[i][0].split(' ');
-		//if there are multiple options then they will be seperated by comma and
+		//if there are multiple options then they will be separated by comma and
 			//space. The comma should be removed
 			if (options[0][options[0].length - 1] === ',') {
 				options[0] = options[0].slice(0, -1);

CliClient/app/base-command.js

@@ -32,10 +32,6 @@ class BaseCommand {
 		return this.compatibleUis().indexOf(ui) >= 0;
 	}
 
-	aliases() {
-		return [];
-	}
-
 	options() {
 		return [];
 	}

CliClient/app/build-doc.js

@@ -102,7 +102,7 @@ function getFooter() {
 
 	output.push('WEBSITE');
 	output.push('');
-	output.push(INDENT + 'http://joplin.cozic.net');
+	output.push(INDENT + 'https://joplinapp.org');
 
 	output.push('');
 

CliClient/app/command-apidoc.js

@@ -0,0 +1,299 @@
+const { BaseCommand } = require('./base-command.js');
+const { _ } = require('lib/locale.js');
+const { cliUtils } = require('./cli-utils.js');
+const EncryptionService = require('lib/services/EncryptionService');
+const DecryptionWorker = require('lib/services/DecryptionWorker');
+const MasterKey = require('lib/models/MasterKey');
+const BaseItem = require('lib/models/BaseItem');
+const BaseModel = require('lib/BaseModel');
+const Setting = require('lib/models/Setting.js');
+const { toTitleCase } = require('lib/string-utils.js');
+const { reg } = require('lib/registry.js');
+const markdownUtils = require('lib/markdownUtils');
+const { Database } = require('lib/database.js');
+
+class Command extends BaseCommand {
+
+	usage() {
+		return 'apidoc';
+	}
+
+	description() {
+		return 'Build the API doc';
+	}
+
+	createPropertiesTable(tableFields) {
+  		const headers = [
+  			{ name: 'name', label: 'Name' },
+  			{ name: 'type', label: 'Type', filter: (value) => {
+  				return Database.enumName('fieldType', value);
+  			}},
+  			{ name: 'description', label: 'Description' },
+  		];
+		
+		return markdownUtils.createMarkdownTable(headers, tableFields); 
+	}
+
+	async action(args) {
+		const models = [
+			{
+				type: BaseModel.TYPE_NOTE,
+			},
+			{
+				type: BaseModel.TYPE_FOLDER,
+			},
+			{
+				type: BaseModel.TYPE_RESOURCE,
+			},
+			{
+				type: BaseModel.TYPE_TAG,
+			},
+		];
+
+		const lines = [];
+
+		lines.push('# Joplin API');
+		lines.push('');
+
+		lines.push('When the Web Clipper service is enabled, Joplin exposes a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer) which allows third-party applications to access Joplin\'s data and to create, modify or delete notes, notebooks, resources or tags.');
+		lines.push('');
+		lines.push('In order to use it, you\'ll first need to find on which port the service is running. To do so, open the Web Clipper Options in Joplin and if the service is running it should tell you on which port. Normally it runs on port **41184**. If you want to find it programmatically, you may follow this kind of algorithm:');
+		lines.push('');
+		lines.push('```javascript');
+		lines.push('let port = null;');
+		lines.push('for (let portToTest = 41184; portToTest <= 41194; portToTest++) {');
+		lines.push('    const result = pingPort(portToTest); // Call GET /ping');
+		lines.push('    if (result == \'JoplinClipperServer\') {');
+		lines.push('        port = portToTest; // Found the port');
+		lines.push('        break;');
+		lines.push('    }');
+		lines.push('}');
+		lines.push('```');
+		lines.push('');
+		
+		lines.push('# Authorisation')
+		lines.push('');
+		lines.push('To prevent unauthorised applications from accessing the API, the calls must be authentified. To do so, you must provide a token as a query parameter for each API call. You can get this token from the Joplin desktop application, on the Web Clipper Options screen.');
+		lines.push('');
+		lines.push('This would be an example of valid cURL call using a token:');
+		lines.push('');
+		lines.push('\tcurl http://localhost:41184/notes?token=ABCD123ABCD123ABCD123ABCD123ABCD123');
+		lines.push('');
+		lines.push('In the documentation below, the token will not be specified every time however you will need to include it.');
+		lines.push('');
+
+		lines.push('# Using the API');
+		lines.push('');
+		lines.push('All the calls, unless noted otherwise, receives and send **JSON data**. For example to create a new note:');
+		lines.push('');
+		lines.push('\tcurl --data \'{ "title": "My note", "body": "Some note in **Markdown**"}\' http://localhost:41184/notes');
+		lines.push('');
+		lines.push('In the documentation below, the calls may include special parameters such as :id or :note_id. You would replace this with the item ID or note ID.');
+		lines.push('');
+		lines.push('For example, for the endpoint `DELETE /tags/:id/notes/:note_id`, to remove the tag with ID "ABCD1234" from the note with ID "EFGH789", you would run for example:');
+		lines.push('');
+		lines.push('\tcurl -X DELETE http://localhost:41184/tags/ABCD1234/notes/EFGH789');
+		lines.push('');
+		lines.push('The four verbs supported by the API are the following ones:');
+		lines.push('');
+		lines.push('* **GET**: To retrieve items (notes, notebooks, etc.).');
+		lines.push('* **POST**: To create new items. In general most item properties are optional. If you omit any, a default value will be used.');
+		lines.push('* **PUT**: To update an item. Note in a REST API, traditionally PUT is used to completely replace an item, however in this API it will only replace the properties that are provided. For example if you PUT {"title": "my new title"}, only the "title" property will be changed. The other properties will be left untouched (they won\'t be cleared nor changed).');
+		lines.push('* **DELETE**: To delete items.');
+		lines.push('');
+
+		lines.push('# Filtering data');
+		lines.push('');
+		lines.push('You can change the fields that will be returned by the API using the `fields=` query parameter, which takes a list of comma separated fields. For example, to get the longitude and latitude of a note, use this:');
+		lines.push('');
+		lines.push('\tcurl http://localhost:41184/notes/ABCD123?fields=longitude,latitude');
+		lines.push('');
+		lines.push('To get the IDs only of all the tags:');
+		lines.push('');
+		lines.push('\tcurl http://localhost:41184/tags?fields=id');
+		lines.push('');
+
+		lines.push('# Error handling');
+		lines.push('');
+		lines.push('In case of an error, an HTTP status code >= 400 will be returned along with a JSON object that provides more info about the error. The JSON object is in the format `{ "error": "description of error" }`.');
+		lines.push('');
+
+		lines.push('# About the property types');
+		lines.push('');
+		lines.push('* Text is UTF-8.');
+		lines.push('* All date/time are Unix timestamps in milliseconds.');
+		lines.push('* Booleans are integer values 0 or 1.');
+		lines.push('');
+
+		lines.push('# Testing if the service is available');
+		lines.push('');
+		lines.push('Call **GET /ping** to check if the service is available. It should return "JoplinClipperServer" if it works.');
+		lines.push('');
+
+		lines.push('# Searching');
+		lines.push('');
+		lines.push('Call **GET /search?query=YOUR_QUERY** to search for notes. This end-point supports the `field` parameter which is recommended to use so that you only get the data that you need. The query syntax is as described in the main documentation: https://joplinapp.org/#searching');
+		lines.push('');
+
+		for (let i = 0; i < models.length; i++) {
+			const model = models[i];
+			const ModelClass = BaseItem.getClassByItemType(model.type);
+			const tableName = ModelClass.tableName();
+			let tableFields = reg.db().tableFields(tableName, { includeDescription: true });
+			const singular = tableName.substr(0, tableName.length - 1);
+
+			if (model.type === BaseModel.TYPE_NOTE) {
+				tableFields = tableFields.slice();
+				tableFields.push({
+					name: 'body_html',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'Note body, in HTML format',
+				});
+				tableFields.push({
+					name: 'base_url',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'If `body_html` is provided and contains relative URLs, provide the `base_url` parameter too so that all the URLs can be converted to absolute ones. The base URL is basically where the HTML was fetched from, minus the query (everything after the \'?\'). For example if the original page was `https://stackoverflow.com/search?q=%5Bjava%5D+test`, the base URL is `https://stackoverflow.com/search`.',
+				});
+				tableFields.push({
+					name: 'image_data_url',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'An image to attach to the note, in [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format.',
+				});
+				tableFields.push({
+					name: 'crop_rect',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'If an image is provided, you can also specify an optional rectangle that will be used to crop the image. In format `{ x: x, y: y, width: width, height: height }`',
+				});
+				// tableFields.push({
+				// 	name: 'tags',
+				// 	type: Database.enumId('fieldType', 'text'),
+				// 	description: 'Comma-separated list of tags. eg. `tag1,tag2`.',
+				// });
+			}
+
+			lines.push('# ' + toTitleCase(tableName));
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_FOLDER) {
+				lines.push('This is actually a notebook. Internally notebooks are called "folders".');
+				lines.push('');
+			}
+
+			lines.push('## Properties');
+			lines.push('');
+			lines.push(this.createPropertiesTable(tableFields));
+			lines.push('');
+
+			lines.push('## GET /' + tableName);
+			lines.push('');
+			lines.push('Gets all ' + tableName);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_FOLDER) {
+				lines.push('The folders are returned as a tree. The sub-notebooks of a notebook, if any, are under the `children` key.');
+				lines.push('');
+			}
+
+			lines.push('## GET /' + tableName + '/:id');
+			lines.push('');
+			lines.push('Gets ' + singular + ' with ID :id');
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_TAG) {
+				lines.push('## GET /tags/:id/notes');
+				lines.push('');
+				lines.push('Gets all the notes with this tag.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_NOTE) {
+				lines.push('## GET /notes/:id/tags');
+				lines.push('');
+				lines.push('Gets all the tags attached to this note.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_FOLDER) {
+				lines.push('## GET /folders/:id/notes');
+				lines.push('');
+				lines.push('Gets all the notes inside this folder.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_RESOURCE) {
+				lines.push('## GET /resources/:id/file');
+				lines.push('');
+				lines.push('Gets the actual file associated with this resource.');
+				lines.push('');
+			}
+
+			lines.push('## POST /' + tableName);
+			lines.push('');
+			lines.push('Creates a new ' + singular);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_RESOURCE) {
+				lines.push('Creating a new resource is special because you also need to upload the file. Unlike other API calls, this one must have the "multipart/form-data" Content-Type. The file data must be passed to the "data" form field, and the other properties to the "props" form field. An example of a valid call with cURL would be:');
+				lines.push('');
+				lines.push('\tcurl -F \'data=@/path/to/file.jpg\' -F \'props={"title":"my resource title"}\' http://localhost:41184/resources');
+				lines.push('');
+				lines.push('The "data" field is required, while the "props" one is not. If not specified, default values will be used.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_TAG) {
+				lines.push('## POST /tags/:id/notes');
+				lines.push('');
+				lines.push('Post a note to this endpoint to add the tag to the note. The note data must at least contain an ID property (all other properties will be ignored).');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_NOTE) {
+				lines.push('You can either specify the note body as Markdown by setting the `body` parameter, or in HTML by setting the `body_html`.');
+				lines.push('');
+				lines.push('Examples:');
+				lines.push('');
+				lines.push('* Create a note from some Markdown text');
+				lines.push('');
+				lines.push('      curl --data \'{ "title": "My note", "body": "Some note in **Markdown**"}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+				lines.push('* Create a note from some HTML');
+				lines.push('');
+				lines.push('      curl --data \'{ "title": "My note", "body_html": "Some note in <b>HTML</b>"}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+				lines.push('* Create a note and attach an image to it:');
+				lines.push('');
+				lines.push('      curl --data \'{ "title": "Image test", "body": "Here is Joplin icon:", "image_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAIAAABLbSncAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAANZJREFUeNoAyAA3/wFwtO3K6gUB/vz2+Prw9fj/+/r+/wBZKAAExOgF4/MC9ff+MRH6Ui4E+/0Bqc/zutj6AgT+/Pz7+vv7++nu82c4DlMqCvLs8goA/gL8/fz09fb59vXa6vzZ6vjT5fbn6voD/fwC8vX4UiT9Zi//APHyAP8ACgUBAPv5APz7BPj2+DIaC2o3E+3o6ywaC5fT6gD6/QD9/QEVf9kD+/dcLQgJA/7v8vqfwOf18wA1IAIEVycAyt//v9XvAPv7APz8LhoIAPz9Ri4OAgwARgx4W/6fVeEAAAAASUVORK5CYII="}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+				lines.push('### Creating a note with a specific ID');
+				lines.push('');
+				lines.push('When a new note is created, it is automatically assigned a new unique ID so **normally you do not need to set the ID**. However, if for some reason you want to set it, you can supply it as the `id` property. It needs to be a 32 characters long hexadecimal string. **Make sure it is unique**, for example by generating it using whatever GUID function is available in your programming language.');
+				lines.push('');
+				lines.push('      curl --data \'{ "id": "00a87474082744c1a8515da6aa5792d2", "title": "My note with custom ID"}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+			}
+
+			lines.push('## PUT /' + tableName + '/:id');
+			lines.push('');
+			lines.push('Sets the properties of the ' + singular + ' with ID :id');
+			lines.push('');
+
+			lines.push('## DELETE /' + tableName + '/:id');
+			lines.push('');
+			lines.push('Deletes the ' + singular + ' with ID :id');
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_TAG) {
+				lines.push('## DELETE /tags/:id/notes/:note_id');
+				lines.push('');
+				lines.push('Remove the tag from the note.');
+				lines.push('');
+			}
+		}
+
+		this.stdout(lines.join('\n'));
+	}
+
+}
+
+module.exports = Command;

CliClient/app/command-config.js

@@ -26,7 +26,7 @@ class Command extends BaseCommand {
 			const md = Setting.settingMetadata(name);
 			let value = Setting.value(name);
 			if (typeof value === 'object' || Array.isArray(value)) value = JSON.stringify(value);
-			if (md.secure) value = '********';
+			if (md.secure && value) value = '********';
 
 			if (Setting.isEnum(name)) {
 				return _('%s = %s (%s)', name, value, Setting.enumOptionsDoc(name));

CliClient/app/command-e2ee.js

@@ -6,6 +6,10 @@ const DecryptionWorker = require('lib/services/DecryptionWorker');
 const MasterKey = require('lib/models/MasterKey');
 const BaseItem = require('lib/models/BaseItem');
 const Setting = require('lib/models/Setting.js');
+const { shim } = require('lib/shim');
+const pathUtils = require('lib/path-utils.js');
+const imageType = require('image-type');
+const readChunk = require('read-chunk');
 
 class Command extends BaseCommand {
 
@@ -14,7 +18,7 @@ class Command extends BaseCommand {
 	}
 
 	description() {
-		return _('Manages E2EE configuration. Commands are `enable`, `disable`, `decrypt`, `status` and `target-status`.');
+		return _('Manages E2EE configuration. Commands are `enable`, `disable`, `decrypt`, `status`, `decrypt-file` and `target-status`.');
 	}
 
 	options() {
@@ -22,6 +26,7 @@ class Command extends BaseCommand {
 			// This is here mostly for testing - shouldn't be used
 			['-p, --password <password>', 'Use this password as master password (For security reasons, it is not recommended to use this option).'],
 			['-v, --verbose', 'More verbose output for the `target-status` command'],
+			['-o, --output <directory>', 'Output directory'],
 		];
 	}
 
@@ -30,6 +35,18 @@ class Command extends BaseCommand {
 
 		const options = args.options;
 
+		const askForMasterKey = async (error) => {
+			const masterKeyId = error.masterKeyId;
+			const password = await this.prompt(_('Enter master password:'), { type: 'string', secure: true });
+			if (!password) {
+				this.stdout(_('Operation cancelled'));
+				return false;
+			}
+			Setting.setObjectKey('encryption.passwordCache', masterKeyId, password);
+			await EncryptionService.instance().loadMasterKeysFromSettings();
+			return true;
+		}
+
 		if (args.command === 'enable') {
 			const password = options.password ? options.password.toString() : await this.prompt(_('Enter master password:'), { type: 'string', secure: true });
 			if (!password) {
@@ -47,30 +64,29 @@ class Command extends BaseCommand {
 		}
 
 		if (args.command === 'decrypt') {
-			this.stdout(_('Starting decryption... Please wait as it may take several minutes depending on how much there is to decrypt.'));
+			if (args.path) {
+				const plainText = await EncryptionService.instance().decryptString(args.path);
+				this.stdout(plainText);
+			} else {
+				this.stdout(_('Starting decryption... Please wait as it may take several minutes depending on how much there is to decrypt.'));
 
-			while (true) {
-				try {
-					await DecryptionWorker.instance().start();
-					break;
-				} catch (error) {
-					if (error.code === 'masterKeyNotLoaded') {
-						const masterKeyId = error.masterKeyId;
-						const password = await this.prompt(_('Enter master password:'), { type: 'string', secure: true });
-						if (!password) {
-							this.stdout(_('Operation cancelled'));
-							return;
+				while (true) {
+					try {
+						await DecryptionWorker.instance().start();
+						break;
+					} catch (error) {
+						if (error.code === 'masterKeyNotLoaded') {
+							const ok = await askForMasterKey(error);
+							if (!ok) return;
+							continue;
 						}
-						Setting.setObjectKey('encryption.passwordCache', masterKeyId, password);
-						await EncryptionService.instance().loadMasterKeysFromSettings();
-						continue;
+
+						throw error;
 					}
-
-					throw error;
 				}
-			}
 
-			this.stdout(_('Completed decryption.'));
+				this.stdout(_('Completed decryption.'));
+			}
 
 			return;
 		}
@@ -80,6 +96,36 @@ class Command extends BaseCommand {
 			return;
 		}
 
+		if (args.command === 'decrypt-file') {
+			while (true) {
+				try {
+					const outputDir = options.output ? options.output : require('os').tmpdir();
+					let outFile = outputDir + '/' + pathUtils.filename(args.path) + '.' + Date.now() + '.bin'; 
+					await EncryptionService.instance().decryptFile(args.path, outFile);
+					const buffer = await readChunk(outFile, 0, 64);
+					const detectedType = imageType(buffer);
+
+					if (detectedType) {
+						const newOutFile = outFile + '.' + detectedType.ext;
+						await shim.fsDriver().move(outFile, newOutFile);
+						outFile = newOutFile;
+					}
+
+					this.stdout(outFile);
+					break;
+				} catch (error) {
+					if (error.code === 'masterKeyNotLoaded') {
+						const ok = await askForMasterKey(error);
+						if (!ok) return;
+						continue;
+					}
+
+					throw error;
+				}
+			}
+			return;
+		}
+
 		if (args.command === 'target-status') {
 			const fs = require('fs-extra');
 			const pathUtils = require('lib/path-utils.js');

CliClient/app/command-export.js

@@ -1,5 +1,5 @@
 const { BaseCommand } = require('./base-command.js');
-const { Exporter } = require('lib/services/exporter.js');
+const InteropService = require('lib/services/InteropService.js');
 const BaseModel = require('lib/BaseModel.js');
 const Note = require('lib/models/Note.js');
 const { reg } = require('lib/registry.js');
@@ -10,15 +10,21 @@ const fs = require('fs-extra');
 class Command extends BaseCommand {
 
 	usage() {
-		return 'export <directory>';
+		return 'export <path>';
 	}
 
 	description() {
-		return _('Exports Joplin data to the given directory. By default, it will export the complete database including notebooks, notes, tags and resources.');
+		return _('Exports Joplin data to the given path. By default, it will export the complete database including notebooks, notes, tags and resources.');
 	}
 
 	options() {
+		const service = new InteropService();
+		const formats = service.modules()
+			.filter(m => m.type === 'exporter')
+			.map(m => m.format + (m.description ? ' (' + m.description + ')' : ''));
+
 		return [
+			['--format <format>', _('Destination format: %s', formats.join(', '))],
 			['--note <note>', _('Exports only the given note.')],
 			['--notebook <notebook>', _('Exports only the given notebook.')],
 		];
@@ -26,13 +32,9 @@ class Command extends BaseCommand {
 	
 	async action(args) {
 		let exportOptions = {};
-		exportOptions.destDir = args.directory;
-		exportOptions.writeFile = (filePath, data) => {
-			return fs.writeFile(filePath, data);
-		};
-		exportOptions.copyFile = (source, dest) => {
-			return fs.copy(source, dest, { overwrite: true });
-		};
+		exportOptions.path = args.path;
+
+		exportOptions.format = args.options.format ? args.options.format : 'jex';
 
 		if (args.options.note) {
 
@@ -48,10 +50,10 @@ class Command extends BaseCommand {
 
 		}
 
-		const exporter = new Exporter();
-		const result = await exporter.export(exportOptions);
+		const service = new InteropService();
+		const result = await service.export(exportOptions);
 
-		reg.logger().info('Export result: ', result);
+		result.warnings.map((w) => this.stdout(w));
 	}
 
 }

CliClient/app/command-help.js

@@ -36,21 +36,22 @@ class Command extends BaseCommand {
 	async action(args) {
 		const stdoutWidth = app().commandStdoutMaxWidth();
 
-		if (args.command === 'shortcuts') {
+		if (args.command === 'shortcuts' || args.command === 'keymap') {
+			this.stdout(_('For information on how to customise the shortcuts please visit %s', 'https://joplinapp.org/terminal/#shortcuts'));
+			this.stdout('');
+
 			if (app().gui().isDummy()) {
 				throw new Error(_('Shortcuts are not available in CLI mode.'));
 			}
 
-			const shortcuts = app().gui().shortcuts();
+			const keymap = app().gui().keymap();
 
 			let rows = [];
 
-			for (let n in shortcuts) {
-				if (!shortcuts.hasOwnProperty(n)) continue;
-				const shortcut = shortcuts[n];
-				if (!shortcut.description) continue;
-				n = shortcut.friendlyName ? shortcut.friendlyName : n;
-				rows.push([n, shortcut.description()]);
+			for (let i = 0; i < keymap.length; i++) {
+				const item = keymap[i];
+				const keys = item.keys.map((k) => k === ' ' ? '(SPACE)' : k);
+				rows.push([keys.join(', '), item.command]);
 			}
 
 			cliUtils.printArray(this.stdout.bind(this), rows);
@@ -71,14 +72,14 @@ class Command extends BaseCommand {
 			this.stdout('');
 			this.stdout(commandNames.join(', '));
 			this.stdout('');
-			this.stdout(_('In any command, a note or notebook can be refered to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.'));
+			this.stdout(_('In any command, a note or notebook can be referred to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.'));
 			this.stdout('');
 			this.stdout(_('To move from one pane to another, press Tab or Shift+Tab.'));
 			this.stdout(_('Use the arrows and page up/down to scroll the lists and text areas (including this console).'));
-			this.stdout(_('To maximise/minimise the console, press "TC".'));
+			this.stdout(_('To maximise/minimise the console, press "tc".'));
 			this.stdout(_('To enter command line mode, press ":"'));
 			this.stdout(_('To exit command line mode, press ESCAPE'));
-			this.stdout(_('For the complete list of available keyboard shortcuts, type `help shortcuts`'));
+			this.stdout(_('For the list of keyboard shortcuts and config options, type `help keymap`'));
 		}
 
 		app().gui().showConsole();

CliClient/app/command-import-enex.js

@@ -1,68 +0,0 @@
-const { BaseCommand } = require('./base-command.js');
-const { app } = require('./app.js');
-const { _ } = require('lib/locale.js');
-const Folder = require('lib/models/Folder.js');
-const { importEnex } = require('lib/import-enex');
-const { filename, basename } = require('lib/path-utils.js');
-const { cliUtils } = require('./cli-utils.js');
-
-class Command extends BaseCommand {
-
-	usage() {
-		return 'import-enex <file> [notebook]';
-	}
-
-	description() {
-		return _('Imports an Evernote notebook file (.enex file).');
-	}
-
-	options() {
-		return [
-			['-f, --force', _('Do not ask for confirmation.')],
-		];
-	}
-
-	async action(args) {
-		let filePath = args.file;
-		let folder = null;
-		let folderTitle = args['notebook'];
-		let force = args.options.force === true;
-
-		if (!folderTitle) folderTitle = filename(filePath);
-		folder = await Folder.loadByField('title', folderTitle);
-		const msg = folder ? _('File "%s" will be imported into existing notebook "%s". Continue?', basename(filePath), folderTitle) : _('New notebook "%s" will be created and file "%s" will be imported into it. Continue?', folderTitle, basename(filePath));
-		const ok = force ? true : await this.prompt(msg);
-		if (!ok) return;
-
-		let lastProgress = '';
-
-		let options = {
-			onProgress: (progressState) => {
-				let line = [];
-				line.push(_('Found: %d.', progressState.loaded));
-				line.push(_('Created: %d.', progressState.created));
-				if (progressState.updated) line.push(_('Updated: %d.', progressState.updated));
-				if (progressState.skipped) line.push(_('Skipped: %d.', progressState.skipped));
-				if (progressState.resourcesCreated) line.push(_('Resources: %d.', progressState.resourcesCreated));
-				if (progressState.notesTagged) line.push(_('Tagged: %d.', progressState.notesTagged));
-				lastProgress = line.join(' ');
-				cliUtils.redraw(lastProgress);
-			},
-			onError: (error) => {
-				let s = error.trace ? error.trace : error.toString();
-				this.stdout(s);
-			},
-		}
-
-		folder = !folder ? await Folder.save({ title: folderTitle }) : folder;
-		
-		app().gui().showConsole();
-		this.stdout(_('Importing notes...'));
-		await importEnex(folder.id, filePath, options);
-		cliUtils.redrawDone();
-		this.stdout(_('The notes have been imported: %s', lastProgress));
-	}
-
-}
-
-module.exports = Command;

CliClient/app/command-import.js

@@ -0,0 +1,75 @@
+const { BaseCommand } = require('./base-command.js');
+const InteropService = require('lib/services/InteropService.js');
+const BaseModel = require('lib/BaseModel.js');
+const Note = require('lib/models/Note.js');
+const { filename, basename, fileExtension } = require('lib/path-utils.js');
+const { importEnex } = require('lib/import-enex');
+const { cliUtils } = require('./cli-utils.js');
+const { reg } = require('lib/registry.js');
+const { app } = require('./app.js');
+const { _ } = require('lib/locale.js');
+const fs = require('fs-extra');
+
+class Command extends BaseCommand {
+	
+	usage() {
+		return 'import <path> [notebook]';
+	}
+
+	description() {
+		return _('Imports data into Joplin.');
+	}
+
+	options() {
+		const service = new InteropService();
+		const formats = service.modules().filter(m => m.type === 'importer').map(m => m.format);
+
+		return [
+			['--format <format>', _('Source format: %s', (['auto'].concat(formats)).join(', '))],
+			['-f, --force', _('Do not ask for confirmation.')],
+		];
+	}
+	
+	async action(args) {
+		let folder = await app().loadItem(BaseModel.TYPE_FOLDER, args.notebook);
+
+		if (args.notebook && !folder) throw new Error(_('Cannot find "%s".', args.notebook));
+
+		const importOptions = {};
+		importOptions.path = args.path;
+		importOptions.format = args.options.format ? args.options.format : 'auto';
+		importOptions.destinationFolderId = folder ? folder.id : null;
+
+		let lastProgress = '';
+
+		// onProgress/onError supported by Enex import only
+
+		importOptions.onProgress = (progressState) => {
+			let line = [];
+			line.push(_('Found: %d.', progressState.loaded));
+			line.push(_('Created: %d.', progressState.created));
+			if (progressState.updated) line.push(_('Updated: %d.', progressState.updated));
+			if (progressState.skipped) line.push(_('Skipped: %d.', progressState.skipped));
+			if (progressState.resourcesCreated) line.push(_('Resources: %d.', progressState.resourcesCreated));
+			if (progressState.notesTagged) line.push(_('Tagged: %d.', progressState.notesTagged));
+			lastProgress = line.join(' ');
+			cliUtils.redraw(lastProgress);
+		};
+
+		importOptions.onError = (error) => {
+			let s = error.trace ? error.trace : error.toString();
+			this.stdout(s);
+		};
+
+		app().gui().showConsole();
+		this.stdout(_('Importing notes...'));
+		const service = new InteropService();
+		const result = await service.import(importOptions);
+		result.warnings.map((w) => this.stdout(w));
+		cliUtils.redrawDone();
+		if (lastProgress) this.stdout(_('The notes have been imported: %s', lastProgress));
+	}
+
+}
+
+module.exports = Command;

CliClient/app/command-ls.js

@@ -22,7 +22,7 @@ class Command extends BaseCommand {
 	enabled() {
 		return false;
 	}
-	
+
 	options() {
 		return [
 			['-n, --limit <num>', _('Displays only the first top <num> notes.')],
@@ -93,7 +93,7 @@ class Command extends BaseCommand {
 						row.push(await Folder.noteCount(item.id));
 					}
 
-					row.push(time.unixMsToLocalDateTime(item.user_updated_time));
+					row.push(time.formatMsToLocal(item.user_updated_time));
 				}
 
 				let title = item.title;
@@ -123,4 +123,4 @@ class Command extends BaseCommand {
 
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-mkbook.js

@@ -14,10 +14,6 @@ class Command extends BaseCommand {
 		return _('Creates a new notebook.');
 	}
 
-	aliases() {
-		return ['mkdir'];
-	}
-
 	async action(args) {
 		let folder = await Folder.save({ title: args['new-notebook'] }, { userSideValidation: true });		
 		app().switchCurrentFolder(folder);

CliClient/app/command-rmbook.js

@@ -29,7 +29,7 @@ class Command extends BaseCommand {
 
 		const folder = await app().loadItem(BaseModel.TYPE_FOLDER, pattern);
 		if (!folder) throw new Error(_('Cannot find "%s".', pattern));
-		const ok = force ? true : await this.prompt(_('Delete notebook? All notes within this notebook will also be deleted.'), { booleanAnswerDefault: 'n' });
+		const ok = force ? true : await this.prompt(_('Delete notebook? All notes and sub-notebooks within this notebook will also be deleted.'), { booleanAnswerDefault: 'n' });
 		if (!ok) return;
 
 		await Folder.delete(folder.id);

CliClient/app/command-search.js

@@ -49,35 +49,6 @@ class Command extends BaseCommand {
 			type: 'SEARCH_SELECT',
 			id: searchId,
 		});
-
-		// let fields = Note.previewFields();
-		// fields.push('body');
-		// const notes = await Note.previews(folder ? folder.id : null, {
-		// 	fields: fields,
-		// 	anywherePattern: '*' + pattern + '*',
-		// });
-
-		// const fragmentLength = 50;
-
-		// let parents = {};
-
-		// for (let i = 0; i < notes.length; i++) {
-		// 	const note = notes[i];
-		// 	const parent = parents[note.parent_id] ? parents[note.parent_id] : await Folder.load(note.parent_id);
-		// 	parents[note.parent_id] = parent;
-
-		// 	const idx = note.body.indexOf(pattern);
-		// 	let line = '';
-		// 	if (idx >= 0) {
-		// 		let fragment = note.body.substr(Math.max(0, idx - fragmentLength / 2), fragmentLength);
-		// 		fragment = fragment.replace(/\n/g, ' ');
-		// 		line = sprintf('%s: %s / %s: %s', BaseModel.shortId(note.id), parent.title, note.title, fragment);
-		// 	} else {
-		// 		line = sprintf('%s: %s / %s', BaseModel.shortId(note.id), parent.title, note.title);
-		// 	}
-
-		// 	this.stdout(line);
-		// }
 	}
 
 }

CliClient/app/command-sync.js

@@ -4,13 +4,13 @@ const { _ } = require('lib/locale.js');
 const { OneDriveApiNodeUtils } = require('./onedrive-api-node-utils.js');
 const Setting = require('lib/models/Setting.js');
 const BaseItem = require('lib/models/BaseItem.js');
+const ResourceFetcher = require('lib/services/ResourceFetcher');
 const { Synchronizer } = require('lib/synchronizer.js');
 const { reg } = require('lib/registry.js');
 const { cliUtils } = require('./cli-utils.js');
 const md5 = require('md5');
 const locker = require('proper-lockfile');
 const fs = require('fs-extra');
-const osTmpdir = require('os-tmpdir');
 const SyncTargetRegistry = require('lib/SyncTargetRegistry');
 
 class Command extends BaseCommand {
@@ -79,10 +79,26 @@ class Command extends BaseCommand {
 				return false;
 			}
 
+			return true;
+		} else if (syncTargetMd.name === 'dropbox') { // Dropbox
+			const api = await syncTarget.api();
+			const loginUrl = api.loginUrl();
+			this.stdout(_('To allow Joplin to synchronise with Dropbox, please follow the steps below:'));
+			this.stdout(_('Step 1: Open this URL in your browser to authorise the application:'));
+			this.stdout(loginUrl);
+			const authCode = await this.prompt(_('Step 2: Enter the code provided by Dropbox:'), { type: 'string' });
+			if (!authCode) {
+				this.stdout(_('Authentication was not completed (did not receive an authentication token).'));
+				return false;
+			}
+
+			const response = await api.execAuthToken(authCode);
+			Setting.setValue('sync.' + this.syncTargetId_ + '.auth', response.access_token);
+			api.setAuthToken(response.access_token);
 			return true;
 		}
 
-		this.stdout(_('Not authentified with %s. Please provide any missing credentials.', syncTarget.label()));
+		this.stdout(_('Not authentified with %s. Please provide any missing credentials.', syncTargetMd.label));
 		return false;
 	}
 
@@ -101,7 +117,7 @@ class Command extends BaseCommand {
 		this.releaseLockFn_ = null;
 
 		// Lock is unique per profile/database
-		const lockFilePath = osTmpdir() + '/synclock_' + md5(escape(Setting.value('profileDir'))); // https://github.com/pvorb/node-md5/issues/41
+		const lockFilePath = require('os').tmpdir() + '/synclock_' + md5(escape(Setting.value('profileDir'))); // https://github.com/pvorb/node-md5/issues/41
 		if (!await fs.pathExists(lockFilePath)) await fs.writeFile(lockFilePath, 'synclock');
 
 		try {
@@ -131,7 +147,7 @@ class Command extends BaseCommand {
 
 			const syncTarget = reg.syncTarget(this.syncTargetId_);
 
-			if (!syncTarget.isAuthenticated()) {
+			if (!await syncTarget.isAuthenticated()) {
 				app().gui().showConsole();
 				app().gui().maximizeConsole();
 
@@ -175,6 +191,15 @@ class Command extends BaseCommand {
 				}
 			}
 
+			// When using the tool in command line mode, the ResourceFetcher service is
+			// not going to be running in the background, so the resources need to be
+			// explicitely downloaded below.
+			if (!app().hasGui()) {
+				this.stdout(_('Downloading resources...'));
+				await ResourceFetcher.instance().fetchAll();
+				await ResourceFetcher.instance().waitForAllFinished();
+			}
+
 			await app().refreshCurrentFolder();
 		} catch (error) {
 			cleanUp();
@@ -198,7 +223,7 @@ class Command extends BaseCommand {
 
 		const syncTarget = reg.syncTarget(syncTargetId);
 
-		if (syncTarget.isAuthenticated()) {
+		if (await syncTarget.isAuthenticated()) {
 			const sync = await syncTarget.synchronizer();
 			if (sync) await sync.cancel();
 		} else {

CliClient/app/command-tag.js

@@ -3,6 +3,7 @@ const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 const Tag = require('lib/models/Tag.js');
 const BaseModel = require('lib/BaseModel.js');
+const { time } = require('lib/time-utils.js');
 
 class Command extends BaseCommand {
 
@@ -11,11 +12,19 @@ class Command extends BaseCommand {
 	}
 
 	description() {
-		return _('<tag-command> can be "add", "remove" or "list" to assign or remove [tag] from [note], or to list the notes associated with [tag]. The command `tag list` can be used to list all the tags.');
+		return _('<tag-command> can be "add", "remove" or "list" to assign or remove [tag] from [note], or to list the notes associated with [tag]. The command `tag list` can be used to list all the tags (use -l for long option).');
 	}
-	
+
+	options() {
+		return [
+			['-l, --long', _('Use long list format. Format is ID, NOTE_COUNT (for notebook), DATE, TODO_CHECKED (for to-dos), TITLE')],
+		];
+	}
+
 	async action(args) {
 		let tag = null;
+		let options = args.options;
+
 		if (args.tag) tag = await app().loadItem(BaseModel.TYPE_TAG, args.tag);
 		let notes = [];
 		if (args.note) {
@@ -41,7 +50,28 @@ class Command extends BaseCommand {
 		} else if (command == 'list') {
 			if (tag) {
 				let notes = await Tag.notes(tag.id);
-				notes.map((note) => { this.stdout(note.title); });
+				notes.map((note) => {
+					let line = '';
+					if (options.long) {
+						line += BaseModel.shortId(note.id);
+						line += ' ';
+						line += time.formatMsToLocal(note.user_updated_time);
+						line += ' ';
+					}
+					if (note.is_todo) {
+						line += '[';
+						if (note.todo_completed) {
+						   line += 'X';
+						} else {
+							line += ' ';
+						}
+						line += '] ';
+					} else {
+						line += '	';
+					}
+					line += note.title;
+					this.stdout(line);
+				});
 			} else {
 				let tags = await Tag.all();
 				tags.map((tag) => { this.stdout(tag.title); });

CliClient/app/gui/FolderListWidget.js

@@ -18,26 +18,36 @@ class FolderListWidget extends ListWidget {
 		this.notesParentType_ = 'Folder';
 		this.updateIndexFromSelectedFolderId_ = false;
 		this.updateItems_ = false;
+		this.trimItemTitle = false;
 
 		this.itemRenderer = (item) => {
 			let output = [];
 			if (item === '-') {
 				output.push('-'.repeat(this.innerWidth));
 			} else if (item.type_ === Folder.modelType()) {
-				output.push(Folder.displayTitle(item));
+				output.push(' '.repeat(this.folderDepth(this.folders, item.id)) + Folder.displayTitle(item));
 			} else if (item.type_ === Tag.modelType()) {
 				output.push('[' + Folder.displayTitle(item) + ']');
 			} else if (item.type_ === BaseModel.TYPE_SEARCH) {
 				output.push(_('Search:'));
 				output.push(item.title);
-			}			
-
-			// if (item && item.id) output.push(item.id.substr(0, 5));
+			}
 			
 			return output.join(' ');
 		};
 	}
 
+	folderDepth(folders, folderId) {
+		let output = 0;
+		while (true) {
+			const folder = BaseModel.byId(folders, folderId);
+			if (!folder.parent_id) return output;
+			output++;
+			folderId = folder.parent_id;
+		}
+		throw new Error('unreachable');
+	}
+
 	get selectedFolderId() {
 		return this.selectedFolderId_;
 	}
@@ -73,7 +83,6 @@ class FolderListWidget extends ListWidget {
 	}
 
 	set notesParentType(v) {
-		//if (this.notesParentType_ === v) return;
 		this.notesParentType_ = v;
 		this.updateIndexFromSelectedItemId()
 		this.invalidate();
@@ -111,6 +120,14 @@ class FolderListWidget extends ListWidget {
 		this.updateIndexFromSelectedItemId()
 		this.invalidate();
 	}
+
+	folderHasChildren_(folders, folderId) {
+		for (let i = 0; i < folders.length; i++) {
+			let folder = folders[i];
+			if (folder.parent_id === folderId) return true;
+		}
+		return false;
+	}
 	
 	render() {
 		if (this.updateItems_) {
@@ -118,7 +135,19 @@ class FolderListWidget extends ListWidget {
 			const wasSelectedItemId = this.selectedJoplinItemId;
 			const previousParentType = this.notesParentType;
 
-			let newItems = this.folders.slice();
+			let newItems = [];
+			const orderFolders = (parentId) => {
+				for (let i = 0; i < this.folders.length; i++) {
+					const f = this.folders[i];
+					const folderParentId = f.parent_id ? f.parent_id : '';
+					if (folderParentId === parentId) {
+						newItems.push(f);
+						if (this.folderHasChildren_(this.folders, f.id)) orderFolders(f.id);
+					}
+				}
+			}
+
+			orderFolders('');
 
 			if (this.tags.length) {
 				if (newItems.length) newItems.push('-');

CliClient/app/gui/StatusBarWidget.js

@@ -133,7 +133,8 @@ class StatusBarWidget extends BaseWidget {
 						resolveResult = input ? input.trim() : input;
 						// Add the command to history but only if it's longer than one character.
 						// Below that it's usually an answer like "y"/"n", etc.
-						if (!isSecurePrompt && input && input.length > 1) this.history_.push(input);
+						const isConfigPassword = input.indexOf('config ') >= 0 && input.indexOf('password') >= 0;
+						if (!isSecurePrompt && input && input.length > 1 && !isConfigPassword) this.history_.push(input);
 					}
 				}
 

CliClient/app/help-utils.js

@@ -53,9 +53,8 @@ function renderCommandHelp(cmd, width = null) {
 				desc.push(label);
 			}
 
-			if (md.description) {
-				desc.push(md.description());
-			}
+			const description = Setting.keyDescription(md.key, 'cli');
+			if (description) desc.push(description);
 
 			desc.push(_('Type: %s.', md.isEnum ? _('Enum') : Setting.typeToString(md.type)));
 			if (md.isEnum) desc.push(_('Possible values: %s.', Setting.enumOptionsDoc(md.key, '%s (%s)')));

CliClient/app/main.js

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 
+// Use njstrace to find out what Node.js might be spending time on
+// var njstrace = require('njstrace').inject();
+
 // Make it possible to require("/lib/...") without specifying full path
 require('app-module-path').addPath(__dirname);
 
@@ -19,6 +22,7 @@ const Tag = require('lib/models/Tag.js');
 const NoteTag = require('lib/models/NoteTag.js');
 const MasterKey = require('lib/models/MasterKey');
 const Setting = require('lib/models/Setting.js');
+const Revision = require('lib/models/Revision.js');
 const { Logger } = require('lib/logger.js');
 const { FsDriverNode } = require('lib/fs-driver-node.js');
 const { shimInit } = require('lib/shim-init-node.js');
@@ -40,6 +44,7 @@ BaseItem.loadClass('Resource', Resource);
 BaseItem.loadClass('Tag', Tag);
 BaseItem.loadClass('NoteTag', NoteTag);
 BaseItem.loadClass('MasterKey', MasterKey);
+BaseItem.loadClass('Revision', Revision);
 
 Setting.setConstant('appId', 'net.cozic.joplin-cli');
 Setting.setConstant('appType', 'cli');
@@ -66,54 +71,14 @@ process.stdout.on('error', function( err ) {
 	}
 });
 
-
-
-
-
-// async function main() {
-// 	const WebDavApi = require('lib/WebDavApi');
-// 	const api = new WebDavApi('http://nextcloud.local/remote.php/dav/files/admin/Joplin', { username: 'admin', password: '1234567' });
-// 	const { FileApiDriverWebDav } = new require('lib/file-api-driver-webdav');
-// 	const driver = new FileApiDriverWebDav(api);
-
-// 	const stat = await driver.stat('');
-// 	console.info(stat);
-
-// 	// const stat = await driver.stat('testing.txt');
-// 	// console.info(stat);
-
-
-// 	// const content = await driver.get('testing.txta');
-// 	// console.info(content);
-
-// 	// const content = await driver.get('testing.txta', { target: 'file', path: '/var/www/joplin/CliClient/testing-file.txt' });
-// 	// console.info(content);
-
-// 	// const content = await driver.mkdir('newdir5');
-// 	// console.info(content);
-
-// 	//await driver.put('myfile4.md', 'this is my content');
-
-// 	// await driver.put('testimg.jpg', null, { source: 'file', path: '/mnt/d/test.jpg' });
-
-// 	// await driver.delete('myfile4.md');
-
-// 	// const deltaResult = await driver.delta('', {
-// 	// 	allItemIdsHandler: () => { return []; }
-// 	// });
-// 	// console.info(deltaResult);
-// }
-
-// main().catch((error) => { console.error(error); });
-
-
-
-
-
-
-
-
 application.start(process.argv).catch((error) => {
-	console.error(_('Fatal error:'));
-	console.error(error);
+	if (error.code == 'flagError') {
+		console.error(error.message);
+		console.error(_('Type `joplin help` for usage information.'));
+	} else {
+		console.error(_('Fatal error:'));
+		console.error(error);
+	}
+
+	process.exit(1);
 });

CliClient/package.json

@@ -15,11 +15,12 @@
     "years": [
       2016,
       2017,
-      2018
+      2018,
+      2019
     ],
     "owner": "Laurent Cozic"
   },
-  "version": "0.10.93",
+  "version": "1.0.140",
   "bin": {
     "joplin": "./main.js"
   },
@@ -28,38 +29,52 @@
   },
   "dependencies": {
     "app-module-path": "^2.2.0",
+    "async-mutex": "^0.1.3",
     "base-64": "^0.1.0",
     "compare-version": "^0.1.2",
+    "diacritics": "^1.3.0",
+    "diff-match-patch": "^1.0.4",
+    "es6-promise-pool": "^2.5.0",
+    "file-uri-to-path": "^1.0.0",
     "follow-redirects": "^1.2.4",
     "form-data": "^2.1.4",
     "fs-extra": "^5.0.0",
     "html-entities": "^1.2.1",
+    "html-minifier": "^3.5.15",
+    "image-data-uri": "^2.0.0",
+    "image-type": "^3.0.0",
+    "joplin-turndown": "^4.0.17",
+    "joplin-turndown-plugin-gfm": "^1.0.8",
     "jssha": "^2.3.0",
     "levenshtein": "^1.0.5",
     "lodash": "^4.17.4",
+    "markdown-it": "^8.4.2",
     "md5": "^2.2.1",
     "mime": "^2.0.3",
     "moment": "^2.18.1",
     "node-emoji": "^1.8.1",
     "node-fetch": "^1.7.1",
     "node-persist": "^2.1.0",
-    "os-tmpdir": "^1.0.2",
     "promise": "^7.1.1",
     "proper-lockfile": "^2.0.1",
     "query-string": "4.3.4",
+    "read-chunk": "^2.1.0",
     "redux": "^3.7.2",
     "sax": "^1.2.2",
     "server-destroy": "^1.0.1",
-    "sharp": "^0.18.4",
+    "sharp": "^0.22.1",
     "sprintf-js": "^1.1.1",
-    "sqlite3": "^3.1.8",
+    "sqlite3": "^4.0.7",
     "string-padding": "^1.0.2",
     "string-to-stream": "^1.1.0",
     "strip-ansi": "^4.0.0",
+    "syswide-cas": "^5.2.0",
+    "tar": "^4.4.0",
     "tcp-port-used": "^0.1.2",
-    "tkwidgets": "^0.5.21",
+    "tkwidgets": "^0.5.26",
     "url-parse": "^1.2.0",
     "uuid": "^3.0.1",
+    "valid-url": "^1.0.9",
     "word-wrap": "^1.2.3",
     "xml2js": "^0.4.19",
     "yargs-parser": "^7.0.0"

CliClient/run.sh

@@ -3,5 +3,4 @@ set -e
 CLIENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 bash "$CLIENT_DIR/build.sh" && node "$CLIENT_DIR/build/main.js" --profile ~/Temp/TestNotes2 --stack-trace-enabled --log-level debug --env dev "$@"
-
-# bash $CLIENT_DIR/build.sh && NODE_PATH="$CLIENT_DIR/build/" node build/main.js --profile ~/.config/joplin --stack-trace-enabled --log-level debug "$@"
+# bash "$CLIENT_DIR/build.sh" && node "$CLIENT_DIR/build/main.js" --profile ~/.config/joplin --stack-trace-enabled --log-level debug --env dev "$@"

CliClient/run_test.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+START_DIR="$(pwd)"
 ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 BUILD_DIR="$ROOT_DIR/tests-build"
 TEST_FILE="$1"
@@ -8,10 +9,39 @@ rsync -a "$ROOT_DIR/../ReactNativeClient/lib/" "$BUILD_DIR/lib/"
 rsync -a "$ROOT_DIR/build/locales/" "$BUILD_DIR/locales/"
 mkdir -p "$BUILD_DIR/data"
 
-if [[ $TEST_FILE == "" ]]; then
-	(cd "$ROOT_DIR" && npm test tests-build/synchronizer.js)
-	(cd "$ROOT_DIR" && npm test tests-build/encryption.js)
-	(cd "$ROOT_DIR" && npm test tests-build/ArrayUtils.js)
-else
+if [[ $TEST_FILE != "" ]]; then
 	(cd "$ROOT_DIR" && npm test tests-build/$TEST_FILE.js)
-fi
+	exit
+fi
+
+function finish {
+	cd "$START_DIR"
+}
+
+trap finish EXIT
+
+cd "$ROOT_DIR"
+npm test tests-build/ArrayUtils.js
+npm test tests-build/encryption.js
+npm test tests-build/EnexToMd.js
+npm test tests-build/HtmlToMd.js
+npm test tests-build/markdownUtils.js
+npm test tests-build/models_BaseItem.js
+npm test tests-build/models_Folder.js
+npm test tests-build/models_ItemChange.js
+npm test tests-build/models_Note.js
+npm test tests-build/models_Resource.js
+npm test tests-build/models_Revision.js
+npm test tests-build/models_Setting.js
+npm test tests-build/models_Tag.js
+npm test tests-build/pathUtils.js
+npm test tests-build/services_InteropService.js
+npm test tests-build/services_KvStore.js
+npm test tests-build/services_ResourceService.js
+npm test tests-build/services_rest_Api.js
+npm test tests-build/services_SearchEngine.js
+npm test tests-build/services_Revision.js
+npm test tests-build/StringUtils.js
+npm test tests-build/TaskQueue.js
+npm test tests-build/synchronizer.js
+npm test tests-build/urlUtils.js

CliClient/tests/ArrayUtils.js

@@ -44,4 +44,13 @@ describe('ArrayUtils', function() {
 		done();
 	});
 
+	it('should compare arrays', async (done) => {
+		expect(ArrayUtils.contentEquals([], [])).toBe(true);
+		expect(ArrayUtils.contentEquals(['a'], ['a'])).toBe(true);
+		expect(ArrayUtils.contentEquals(['b', 'a'], ['a', 'b'])).toBe(true);
+		expect(ArrayUtils.contentEquals(['b'], ['a', 'b'])).toBe(false);
+
+		done();
+	});
+
 });

CliClient/tests/EnexToMd.js

@@ -0,0 +1,68 @@
+require('app-module-path').addPath(__dirname);
+
+const os = require('os');
+const { time } = require('lib/time-utils.js');
+const { filename } = require('lib/path-utils.js');
+const { asyncTest, fileContentEqual, setupDatabase, setupDatabaseAndSynchronizer, db, synchronizer, fileApi, sleep, clearDatabase, switchClient, syncTargetId, objectsEqual, checkThrowAsync } = require('test-utils.js');
+const Folder = require('lib/models/Folder.js');
+const Note = require('lib/models/Note.js');
+const BaseModel = require('lib/BaseModel.js');
+const { shim } = require('lib/shim');
+const { enexXmlToMd } = require('lib/import-enex-md-gen.js');
+
+jasmine.DEFAULT_TIMEOUT_INTERVAL = 60 * 60 * 1000; // Can run for a while since everything is in the same test unit
+
+process.on('unhandledRejection', (reason, p) => {
+	console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+describe('EnexToMd', function() {
+
+	beforeEach(async (done) => {
+		await setupDatabaseAndSynchronizer(1);
+		await switchClient(1);
+		done();
+	});
+
+	it('should convert from Enex to Markdown', asyncTest(async () => {
+		const basePath = __dirname + '/enex_to_md';
+		const files = await shim.fsDriver().readDirStats(basePath);
+		
+		for (let i = 0; i < files.length; i++) {
+			const htmlFilename = files[i].path;
+			if (htmlFilename.indexOf('.html') < 0) continue;
+
+			const htmlPath = basePath + '/' + htmlFilename;
+			const mdPath = basePath + '/' + filename(htmlFilename) + '.md';
+
+			// if (htmlFilename !== 'multiline_inner_text.html') continue;
+
+			const html = await shim.fsDriver().readFile(htmlPath);
+			let expectedMd = await shim.fsDriver().readFile(mdPath);
+
+			let actualMd = await enexXmlToMd('<div>' + html + '</div>', []);
+			
+			if (os.EOL === '\r\n') {
+				expectedMd = expectedMd.replace(/\r\n/g, '\n')
+				actualMd = actualMd.replace(/\r\n/g, '\n')
+			}
+
+			if (actualMd !== expectedMd) {
+				console.info('');
+				console.info('Error converting file: ' + htmlFilename);
+				console.info('--------------------------------- Got:');
+				console.info(actualMd.split('\n'));
+				console.info('--------------------------------- Expected:');
+				console.info(expectedMd.split('\n'));
+				console.info('--------------------------------------------');
+				console.info('');
+
+				expect(false).toBe(true);
+				// return;
+			} else {
+				expect(true).toBe(true)
+			}
+		}
+	}));
+
+});

CliClient/tests/HtmlToMd.js

@@ -0,0 +1,82 @@
+require('app-module-path').addPath(__dirname);
+
+const os = require('os');
+const { time } = require('lib/time-utils.js');
+const { filename } = require('lib/path-utils.js');
+const { asyncTest, fileContentEqual, setupDatabase, setupDatabaseAndSynchronizer, db, synchronizer, fileApi, sleep, clearDatabase, switchClient, syncTargetId, objectsEqual, checkThrowAsync } = require('test-utils.js');
+const Folder = require('lib/models/Folder.js');
+const Note = require('lib/models/Note.js');
+const BaseModel = require('lib/BaseModel.js');
+const { shim } = require('lib/shim');
+const HtmlToMd = require('lib/HtmlToMd');
+const { enexXmlToMd } = require('lib/import-enex-md-gen.js');
+
+jasmine.DEFAULT_TIMEOUT_INTERVAL = 60 * 60 * 1000; // Can run for a while since everything is in the same test unit
+
+process.on('unhandledRejection', (reason, p) => {
+	console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+describe('HtmlToMd', function() {
+
+	beforeEach(async (done) => {
+		await setupDatabaseAndSynchronizer(1);
+		await switchClient(1);
+		done();
+	});
+
+	it('should convert from Html to Markdown', asyncTest(async () => {
+		const basePath = __dirname + '/html_to_md';
+		const files = await shim.fsDriver().readDirStats(basePath);
+		const htmlToMd = new HtmlToMd();
+		
+		for (let i = 0; i < files.length; i++) {
+			const htmlFilename = files[i].path;
+			if (htmlFilename.indexOf('.html') < 0) continue;
+
+			const htmlPath = basePath + '/' + htmlFilename;
+			const mdPath = basePath + '/' + filename(htmlFilename) + '.md';
+
+			// if (htmlFilename !== 'mathjax_block.html') continue;
+
+			const htmlToMdOptions = {}
+
+			if (htmlFilename === 'anchor_local.html') {
+				// Normally the list of anchor names in the document are retrieved from the HTML code
+				// This is straightforward when the document is still in DOM format, as with the clipper,
+				// but otherwise it would need to be somehow parsed out from the HTML. Here we just
+				// hard code the anchors that we know are in the file.
+				htmlToMdOptions.anchorNames = ['first', 'second']
+			}
+
+			const html = await shim.fsDriver().readFile(htmlPath);
+			let expectedMd = await shim.fsDriver().readFile(mdPath);
+
+			let actualMd = await htmlToMd.parse('<div>' + html + '</div>', htmlToMdOptions);
+
+			if (os.EOL === '\r\n') {
+				expectedMd = expectedMd.replace(/\r\n/g, '\n')
+				actualMd = actualMd.replace(/\r\n/g, '\n')
+			}
+
+			if (actualMd !== expectedMd) {
+				console.info('');
+				console.info('Error converting file: ' + htmlFilename);
+				console.info('--------------------------------- Got:');
+				console.info(actualMd);
+				console.info('--------------------------------- Raw:');
+				console.info(actualMd.split('\n'));
+				console.info('--------------------------------- Expected:');
+				console.info(expectedMd.split('\n'));
+				console.info('--------------------------------------------');
+				console.info('');
+
+				expect(false).toBe(true);
+				// return;
+			} else {
+				expect(true).toBe(true)
+			}
+		}
+	}));
+
+});

CliClient/tests/StringUtils.js

@@ -0,0 +1,45 @@
+require('app-module-path').addPath(__dirname);
+
+const { time } = require('lib/time-utils.js');
+const { fileContentEqual, setupDatabase, setupDatabaseAndSynchronizer, db, synchronizer, fileApi, sleep, clearDatabase, switchClient, syncTargetId, objectsEqual, checkThrowAsync } = require('test-utils.js');
+const StringUtils = require('lib/string-utils');
+
+process.on('unhandledRejection', (reason, p) => {
+	console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+describe('StringUtils', function() {
+
+	beforeEach(async (done) => {
+		done();
+	});
+
+	it('should surround keywords with strings', async (done) => {
+		const testCases = [
+			[[], 'test', 'a', 'b', 'test'],
+			[['test'], 'test', 'a', 'b', 'atestb'],
+			[['test'], 'Test', 'a', 'b', 'aTestb'],
+			[['te[]st'], 'Te[]st', 'a', 'b', 'aTe[]stb'],
+			// [['test1', 'test2'], 'bla test1 blabla test1 bla test2 not this one - test22', 'a', 'b', 'bla atest1b blabla atest1b bla atest2b not this one - test22'],
+			[['test1', 'test2'], 'bla test1 test1 bla test2', '<span class="highlighted-keyword">', '</span>', 'bla <span class="highlighted-keyword">test1</span> <span class="highlighted-keyword">test1</span> bla <span class="highlighted-keyword">test2</span>'],
+			// [[{ type:'regex', value:'test.*?'}], 'bla test1 test1 bla test2 test tttest', 'a', 'b', 'bla atest1b atest1b bla atest2b atestb tttest'],
+		];
+
+		for (let i = 0; i < testCases.length; i++) {
+			const t = testCases[i];
+
+			const keywords = t[0];
+			const input = t[1];
+			const prefix = t[2];
+			const suffix = t[3];
+			const expected = t[4];
+
+			const actual = StringUtils.surroundKeywords(keywords, input, prefix, suffix);
+
+			expect(actual).toBe(expected, 'Test case ' + i);
+		}
+
+		done();
+	});
+
+});

CliClient/tests/TaskQueue.js

@@ -0,0 +1,57 @@
+require('app-module-path').addPath(__dirname);
+
+const { asyncTest, fileContentEqual, setupDatabase, revisionService, setupDatabaseAndSynchronizer, db, synchronizer, fileApi, sleep, clearDatabase, switchClient, syncTargetId, objectsEqual, checkThrowAsync } = require('test-utils.js');
+const TaskQueue = require('lib/TaskQueue.js');
+
+process.on('unhandledRejection', (reason, p) => {
+	console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+describe('TaskQueue', function() {
+
+	beforeEach(async (done) => {
+		await setupDatabaseAndSynchronizer(1);
+		await switchClient(1);
+		done();
+	});
+
+	it('should queue and execute tasks', asyncTest(async () => {
+		const queue = new TaskQueue();
+
+		queue.push(1, async () => { await sleep(0.5); return 'a'; });
+		queue.push(2, async () => { await sleep(0.5); return 'b'; });
+		queue.push(3, async () => { await sleep(0.5); return 'c'; });
+
+		const results = [];
+
+		results.push(await queue.waitForResult(1));
+		results.push(await queue.waitForResult(2));
+		results.push(await queue.waitForResult(3));
+
+		expect(results[0].id).toBe(1);
+		expect(results[0].result).toBe('a');
+		expect(results[1].id).toBe(2);
+		expect(results[1].result).toBe('b');
+		expect(results[2].id).toBe(3);
+		expect(results[2].result).toBe('c');
+	}));
+
+	it('should handle errors', asyncTest(async () => {
+		const queue = new TaskQueue();
+
+		queue.push(1, async () => { await sleep(0.5); return 'a'; });
+		queue.push(2, async () => { await sleep(0.5); throw new Error('e'); });
+
+		const results = [];
+
+		results.push(await queue.waitForResult(1));
+		results.push(await queue.waitForResult(2));
+
+		expect(results[0].id).toBe(1);
+		expect(results[0].result).toBe('a');
+		expect(results[1].id).toBe(2);
+		expect(!results[1].result).toBe(true);
+		expect(results[1].error.message).toBe('e');
+	}));
+
+});

CliClient/tests/encryption.js

@@ -25,8 +25,7 @@ describe('Encryption', function() {
 
 	beforeEach(async (done) => {
 		await setupDatabaseAndSynchronizer(1);
-		//await setupDatabaseAndSynchronizer(2);
-		//await switchClient(1);
+		await switchClient(1);
 		service =  new EncryptionService();
 		BaseItem.encryptionService_ = service;
 		Setting.setValue('encryption.enabled', true);

CliClient/tests/enex_to_md/code1.html

@@ -0,0 +1,16 @@
+<div>
+	<p>For example, consider a web page like this:</p>
+
+<pre class="brush: html line-numbers  language-html"><code class=" language-html"><span class="token doctype">&lt;!DOCTYPE html&gt;</span>
+<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>html</span><span class="token punctuation">&gt;</span></span>
+  <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>head</span><span class="token punctuation">&gt;</span></span>
+    <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>meta</span> <span class="token attr-name">http-equiv</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>content-type<span class="token punctuation">"</span></span> <span class="token attr-name">content</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>text/html; charset<span class="token punctuation">=</span>utf-8<span class="token punctuation">"</span></span> <span class="token punctuation">/&gt;</span></span>
+  <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>head</span><span class="token punctuation">&gt;</span></span>
+
+  <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>body</span><span class="token punctuation">&gt;</span></span>
+    <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>page-scripts/page-script.js<span class="token punctuation">"</span></span><span class="token punctuation">&gt;</span></span><span class="token script language-javascript"></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
+  <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>body</span><span class="token punctuation">&gt;</span></span>
+<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>html</span><span class="token punctuation">&gt;</span></span><span class="line-numbers-rows"><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span><span></span></span></code></pre>
+
+	<p>The script "page-script.js" does this:</p>
+</div>

CliClient/tests/enex_to_md/code1.md

@@ -0,0 +1,14 @@
+For example, consider a web page like this:
+
+	<!DOCTYPE html>
+	<html>
+	  <head>
+	    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+	  </head>
+
+	  <body>
+	    <script src="page-scripts/page-script.js"></script>
+	  </body>
+	</html>
+
+The script "page-script.js" does this:

CliClient/tests/enex_to_md/code2.html

@@ -0,0 +1,7 @@
+<p>Subshell:</p>
+<pre><code>(
+    set -e
+    false
+    echo Unreachable
+) &amp;&amp; echo Great success
+</code></pre>

CliClient/tests/enex_to_md/code2.md

@@ -0,0 +1,7 @@
+Subshell:
+
+	(
+	    set -e
+	    false
+	    echo Unreachable
+	) && echo Great success

CliClient/tests/enex_to_md/heading.html

@@ -0,0 +1,9 @@
+<div>
+	<div class="note">
+		<p>Values added to the global scope of a content script with</p>
+	</div>
+
+	<h2 id="Loading_content_scripts">Loading content scripts</h2>
+
+	<p>You can load a content script into a web page in one of three ways:</p>
+</div>

CliClient/tests/enex_to_md/heading.md

@@ -0,0 +1,5 @@
+Values added to the global scope of a content script with
+
+## Loading content scripts
+
+You can load a content script into a web page in one of three ways:

CliClient/tests/enex_to_md/inlineCode.html

@@ -0,0 +1,3 @@
+<div>
+	<p>Similarly, I need another regex to match double newlines (<code>\n\n</code>) that are not part of a longer run of newline characters like <code>\n\n\n</code> or <code>\n\n\n\n\n\n</code> etc.</p>
+</div>

CliClient/tests/enex_to_md/inlineCode.md

@@ -0,0 +1 @@
+Similarly, I need another regex to match double newlines (`\n\n`) that are not part of a longer run of newline characters like `\n\n\n` or `\n\n\n\n\n\n` etc.

CliClient/tests/enex_to_md/inlineCodeWithLink.html

@@ -0,0 +1,3 @@
+<div>
+<p>the&nbsp;<code><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/onConnect">runtime.onConnect</a></code> listener gets passed its own <code><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/Port">runtime.Port</a></code> object.</p>
+</div>

CliClient/tests/enex_to_md/inlineCodeWithLink.md

@@ -0,0 +1 @@
+the `[runtime.onConnect](/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/onConnect)` listener gets passed its own `[runtime.Port](/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/Port)` object.

CliClient/tests/enex_to_md/link1.html

@@ -0,0 +1,4 @@
+<a href="https://arstechnica.com/civis/ucp.php?mode=login&return_to=%2Ftech-policy%2F2018%2F05%2Fjails-are-replacing-in-person-visits-with-video-calling-services-theyre-awful%2F" class="dropdown-toggle">
+      Sign in
+      <span class="icon dropdown-indicator icon-drop-indicator"></span>
+    </a>

CliClient/tests/enex_to_md/link1.md

@@ -0,0 +1 @@
+[Sign in](https://arstechnica.com/civis/ucp.php?mode=login&return_to=%2Ftech-policy%2F2018%2F05%2Fjails-are-replacing-in-person-visits-with-video-calling-services-theyre-awful%2F)

CliClient/tests/enex_to_md/list.html

@@ -0,0 +1,17 @@
+<div>
+	<p>Liste de courses</p>
+
+	<div>
+		<div><en-todo checked="true"/>Pizzas</div>
+		<div><en-todo checked="true"/>Pain</div>
+		<div><en-todo checked="true"/>Jambon</div>
+	</div>
+
+	<div><br/></div>
+
+	<div>
+		<div><en-todo checked="true"/>On its own</div>
+	</div>
+
+	<p>End</p>
+</div>

CliClient/tests/enex_to_md/list.md

@@ -0,0 +1,9 @@
+Liste de courses
+
+- [X] Pizzas
+- [X] Pain
+- [X] Jambon
+
+- [X] On its own
+
+End