Android release v1.0.294

* Update eslint config

* Applied linter to lib

* Applied eslint config to CliClient/app

* Removed prettier due to https://github.com/prettier/prettier/pull/4765

* First pass on test units

* Applied linter config to test units

* Applied eslint config to clipper

* Applied to plugin dir

* Applied to root of ElectronClient

* Applied on RN root

* Applied on CLI root

* Applied on Clipper root

* Applied config to tools

* test hook

* test hook

* test hook

* Added pre-commit hook

* Applied rule no-trailing-spaces

* Make sure root packages are installed when installing sub-dir

* Added doc

.eslintignore

@@ -0,0 +1,40 @@
+*.min.js
+.git/
+.github/
+_mydocs/
+_releases/
+Assets/
+CliClient/build
+CliClient/locales
+CliClient/node_modules
+CliClient/tests-build
+CliClient/tests/enex_to_md
+CliClient/tests/html_to_md
+CliClient/tests/logs
+CliClient/tests/support
+CliClient/tests/sync
+CliClient/tests/tmp
+Clipper/joplin-webclipper/content_scripts/JSDOMParser.js
+Clipper/joplin-webclipper/content_scripts/Readability-readerable.js
+Clipper/joplin-webclipper/content_scripts/Readability.js
+Clipper/joplin-webclipper/dist
+Clipper/joplin-webclipper/icons
+Clipper/joplin-webclipper/popup/build
+Clipper/joplin-webclipper/popup/node_modules
+docs/
+ElectronClient/app/dist
+ElectronClient/app/lib
+ElectronClient/app/lib/vendor/sjcl-rn.js
+ElectronClient/app/lib/vendor/sjcl.js
+ElectronClient/app/locales
+ElectronClient/app/node_modules
+highlight.pack.js
+node_modules/
+ReactNativeClient/android
+ReactNativeClient/ios
+ReactNativeClient/lib/vendor/
+ReactNativeClient/locales
+ReactNativeClient/node_modules
+readme/
+Tools/node_modules
+Tools/PortableAppsLauncher

.eslintrc.js

@@ -0,0 +1,53 @@
+module.exports = {
+	'env': {
+		'browser': true,
+		'es6': true,
+		'node': true,
+	},
+	'extends': ['eslint:recommended'],
+	'globals': {
+		'Atomics': 'readonly',
+		'SharedArrayBuffer': 'readonly',
+
+		// Jasmine variables
+		'expect': 'readonly',
+		'describe': 'readonly',
+		'it': 'readonly',
+		'beforeEach': 'readonly',
+		'jasmine': 'readonly',
+
+		// React Native variables
+		'__DEV__': 'readonly',
+
+		// Clipper variables
+		'browserSupportsPromises_': true,
+		'chrome': 'readonly',
+		'browser': 'readonly',
+	},
+	'parserOptions': {
+		'ecmaVersion': 2018,
+		"ecmaFeatures": {
+			"jsx": true,
+	    },
+	    "sourceType": "module",
+	},
+	'rules': {
+		"react/jsx-uses-react": "error",
+		"react/jsx-uses-vars": "error",
+		// Ignore all unused function arguments, because in some
+		// case they are kept to indicate the function signature.
+		"no-unused-vars": ["error", { "argsIgnorePattern": ".*" }],
+		"no-constant-condition": 0,
+		"no-prototype-builtins": 0,
+		"space-in-parens": ["error", "never"],
+		"semi": ["error", "always"],
+		"eol-last": ["error", "always"],
+		"quotes": ["error", "single"],
+		"indent": ["error", "tab"],
+		"comma-dangle": ["error", "always-multiline"],
+		"no-trailing-spaces": "error",
+	},
+	"plugins": [
+		"react",
+	],
+};

.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

@@ -35,4 +35,11 @@ _vieux/
 _mydocs
 .DS_Store
 Assets/DownloadBadges*.psd
-node_modules
+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

@@ -1,5 +1,16 @@
+# Only build tags (Doesn't work - doesn't build anything)
+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
@@ -43,7 +54,8 @@ before_install:
 
 script:
   - |
-    cd ElectronClient/app
-    rsync -aP ../../ReactNativeClient/lib/ lib/
+    cd Tools
     npm install
-    yarn dist
+    cd ../ElectronClient/app
+    rsync -aP --delete ../../ReactNativeClient/lib/ lib/
+    npm install && yarn dist

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>

Assets/build_mac_icons.sh

@@ -1,2 +0,0 @@
-#!/bin/bash
-iconutil --convert icns macOs.iconset

Assets/check-square-o.svg

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1472 930v318q0 119-84.5 203.5t-203.5 84.5h-832q-119 0-203.5-84.5t-84.5-203.5v-832q0-119 84.5-203.5t203.5-84.5h832q63 0 117 25 15 7 18 23 3 17-9 29l-49 49q-10 10-23 10-3 0-9-2-23-6-45-6h-832q-66 0-113 47t-47 113v832q0 66 47 113t113 47h832q66 0 113-47t47-113v-254q0-13 9-22l64-64q10-10 23-10 6 0 12 3 20 8 20 29zm231-489l-814 814q-24 24-57 24t-57-24l-430-430q-24-24-24-57t24-57l110-110q24-24 57-24t57 24l263 263 647-647q24-24 57-24t57 24l110 110q24 24 24 57t-24 57z"/></svg>

Assets/check-square.svg

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M813 1299l614-614q19-19 19-45t-19-45l-102-102q-19-19-45-19t-45 19l-467 467-211-211q-19-19-45-19t-45 19l-102 102q-19 19-19 45t19 45l358 358q19 19 45 19t45-19zm851-883v960q0 119-84.5 203.5t-203.5 84.5h-960q-119 0-203.5-84.5t-84.5-203.5v-960q0-119 84.5-203.5t203.5-84.5h960q119 0 203.5 84.5t84.5 203.5z"/></svg>

Assets/square-o.svg

@@ -1,2 +0,0 @@
-<?xml version='1.0' encoding='utf-8'?>
-<svg viewBox='0 0 1792 1792' xmlns='http://www.w3.org/2000/svg'><path d='M1312 256h-832q-66 0-113 47t-47 113v832q0 66 47 113t113 47h832q66 0 113-47t47-113v-832q0-66-47-113t-113-47zm288 160v832q0 119-84.5 203.5t-203.5 84.5h-832q-119 0-203.5-84.5t-84.5-203.5v-832q0-119 84.5-203.5t203.5-84.5h832q119 0 203.5 84.5t84.5 203.5z'/></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 builing 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.
+- 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.
 
 ## 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
 
@@ -17,29 +16,66 @@ If you get a node-gyp related error you might need to manually install it: `npm
 - Install node v8.x (check with `node --version`) - https://nodejs.org/en/
 - If you get a node-gyp related error you might need to manually install it: `npm install -g node-gyp`
 
+# Building the tools
+
+Before building any of the applications, you need to build the tools:
+
+```
+cd Tools
+npm install
+```
+
 # Building the Electron application
 
 ```
 cd ElectronClient/app
-rsync -a ../../ReactNativeClient/lib/ lib/
+rsync --delete -a ../../ReactNativeClient/lib/ lib/
 npm install
 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`
 
+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
 
-From `/ReactNativeClient`, run `npm install`, then `react-native run-ios` or `react-native run-android`.
+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.
+
+Then, from `/ReactNativeClient`, run `npm install`, then `react-native run-ios` or `react-native run-android`.
 
 # Building the Terminal application
 
-From `/CliClient`:
-- Run `npm install`
-- Then `build.sh`
-- Copy the translations to the build directory: `rsync -aP ../ReactNativeClient/locales/ build/locales/`
-- Run `run.sh` to start the application for testing.
+```
+cd CliClient
+npm install
+./build.sh
+rsync --delete -aP ../ReactNativeClient/locales/ build/locales/
+```
+
+Run `run.sh` to start the application for testing.

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# 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
+
+File bugs in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Please follow these guidelines:
+
+- 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
+
+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.
+
+As a general rule, suggestions to *improve Joplin* should be posted first in the [Joplin Forum](https://discourse.joplinapp.org/) for discussion.
+
+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 is enforced by a pre-commit hook that runs eslint. This hook is installed whenever running `npm install` on any of the application directory. If for some reason the pre-commit hook didn't get installed, you can manually install it by running `npm install` at the root of the repository.
+
+## 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
+
+To run the test units, you must have an instance of the cli app running. In a first window navigate into `CliClient` and run:
+
+```sh
+./run.sh
+```
+
+> If you get an error like `Error: Cannot find module '../locales/index.js'`, this means you must (a) rebuild translations or (b) take > them from one of the other apps. To do option b, you can run the following command to copy them from the `ReactNativeClient` directory:> 
+>
+> ```sh
+> cd .. # Return to the root of the project
+> rsync -aP ./ReactNativeClient/locales/ ./CliClient/build/locales/
+> ```
+
+Then run the tests in a second window. 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/ResourceServer.js

@@ -1,14 +1,11 @@
-const { _ } = require('lib/locale.js');
 const { Logger } = require('lib/logger.js');
-const { Resource } = require('lib/models/resource.js');
 const { netUtils } = require('lib/net-utils.js');
 
-const http = require("http");
-const urlParser = require("url");
+const http = require('http');
+const urlParser = require('url');
 const enableServerDestroy = require('server-destroy');
 
 class ResourceServer {
-
 	constructor() {
 		this.server_ = null;
 		this.logger_ = new Logger();
@@ -40,7 +37,7 @@ class ResourceServer {
 
 	async start() {
 		this.port_ = await netUtils.findAvailablePort([9167, 9267, 8167, 8267]);
-		if (!this.port_) {	
+		if (!this.port_) {
 			this.logger().error('Could not find available port to start resource server. Please report the error at https://github.com/laurent22/joplin');
 			return;
 		}
@@ -48,11 +45,10 @@ class ResourceServer {
 		this.server_ = http.createServer();
 
 		this.server_.on('request', async (request, response) => {
-
-			const writeResponse = (message) => {
+			const writeResponse = message => {
 				response.write(message);
 				response.end();
-			}
+			};
 
 			const url = urlParser.parse(request.url, true);
 			let resourceId = url.pathname.split('/');
@@ -69,6 +65,7 @@ class ResourceServer {
 				if (!done) throw new Error('Unhandled resource: ' + resourceId);
 			} catch (error) {
 				response.setHeader('Content-Type', 'text/plain');
+				// eslint-disable-next-line require-atomic-updates
 				response.statusCode = 400;
 				response.write(error.message);
 			}
@@ -76,7 +73,7 @@ class ResourceServer {
 			response.end();
 		});
 
-		this.server_.on('error', (error) => {
+		this.server_.on('error', error => {
 			this.logger().error('Resource server:', error);
 		});
 
@@ -91,7 +88,6 @@ class ResourceServer {
 		if (this.server_) this.server_.destroy();
 		this.server_ = null;
 	}
-
 }
 
-module.exports = ResourceServer;
+module.exports = ResourceServer;

CliClient/app/app-gui.js

@@ -1,27 +1,28 @@
 const { Logger } = require('lib/logger.js');
-const { Folder } = require('lib/models/folder.js');
-const { Tag } = require('lib/models/tag.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Note } = require('lib/models/note.js');
-const { Resource } = require('lib/models/resource.js');
-const { cliUtils } = require('./cli-utils.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');
+const Resource = require('lib/models/Resource.js');
 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');
 const TermWrapper = require('tkwidgets/framework/TermWrapper.js');
 const Renderer = require('tkwidgets/framework/Renderer.js');
+const DecryptionWorker = require('lib/services/DecryptionWorker');
 
 const BaseWidget = require('tkwidgets/BaseWidget.js');
-const ListWidget = require('tkwidgets/ListWidget.js');
 const TextWidget = require('tkwidgets/TextWidget.js');
 const HLayoutWidget = require('tkwidgets/HLayoutWidget.js');
 const VLayoutWidget = require('tkwidgets/VLayoutWidget.js');
 const ReduxRootWidget = require('tkwidgets/ReduxRootWidget.js');
-const RootWidget = require('tkwidgets/RootWidget.js');
 const WindowWidget = require('tkwidgets/WindowWidget.js');
 
 const NoteWidget = require('./gui/NoteWidget.js');
@@ -33,38 +34,55 @@ const StatusBarWidget = require('./gui/StatusBarWidget.js');
 const ConsoleWidget = require('./gui/ConsoleWidget.js');
 
 class AppGui {
+	constructor(app, store, keymap) {
+		try {
+			this.app_ = app;
+			this.store_ = store;
 
-	constructor(app, store) {
-		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);
+			// 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_ = null;
-		this.logger_ = new Logger();
-		this.buildUi();
+			this.renderer_ = null;
+			this.logger_ = new Logger();
+			this.buildUi();
 
-		this.renderer_ = new Renderer(this.term(), this.rootWidget_);
+			this.renderer_ = new Renderer(this.term(), this.rootWidget_);
 
-		this.app_.on('modelAction', async (event) => {
-			await this.handleModelAction(event.action);
-		});
+			this.app_.on('modelAction', async event => {
+				await this.handleModelAction(event.action);
+			});
 
-		this.shortcuts_ = this.setupShortcuts();
+			this.keymap_ = this.setupKeymap(keymap);
 
-		this.inputMode_ = AppGui.INPUT_MODE_NORMAL;
+			this.inputMode_ = AppGui.INPUT_MODE_NORMAL;
 
-		this.commandCancelCalled_ = false;
+			this.commandCancelCalled_ = false;
 
-		this.currentShortcutKeys_ = [];
-		this.lastShortcutKeyTime_ = 0;
+			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();
+			// 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() {
@@ -80,8 +98,16 @@ class AppGui {
 		await this.renderer_.renderRoot();
 	}
 
-	prompt(initialText = '', promptString = ':') {
-		return this.widget('statusBar').prompt(initialText, promptString);
+	termSaveState() {
+		return this.term().saveState();
+	}
+
+	termRestoreState(state) {
+		return this.term().restoreState(state);
+	}
+
+	prompt(initialText = '', promptString = ':', options = null) {
+		return this.widget('statusBar').prompt(initialText, promptString, options);
 	}
 
 	stdoutMaxWidth() {
@@ -95,6 +121,7 @@ class AppGui {
 	buildUi() {
 		this.rootWidget_ = new ReduxRootWidget(this.store_);
 		this.rootWidget_.name = 'root';
+		this.rootWidget_.autoShortcutsEnabled = false;
 
 		const folderList = new FolderListWidget();
 		folderList.style = {
@@ -103,7 +130,7 @@ class AppGui {
 		};
 		folderList.name = 'folderList';
 		folderList.vStretch = true;
-		folderList.on('currentItemChange', async (event) => {
+		folderList.on('currentItemChange', async event => {
 			const item = folderList.currentItem;
 
 			if (item === '-') {
@@ -138,7 +165,7 @@ class AppGui {
 				});
 			}
 		});
-		this.rootWidget_.connect(folderList, (state) => {
+		this.rootWidget_.connect(folderList, state => {
 			return {
 				selectedFolderId: state.selectedFolderId,
 				selectedTagId: state.selectedTagId,
@@ -165,7 +192,7 @@ class AppGui {
 				id: note ? note.id : null,
 			});
 		});
-		this.rootWidget_.connect(noteList, (state) => {
+		this.rootWidget_.connect(noteList, state => {
 			return {
 				selectedNoteId: state.selectedNoteIds.length ? state.selectedNoteIds[0] : null,
 				items: state.notes,
@@ -179,7 +206,7 @@ class AppGui {
 			borderBottomWidth: 1,
 			borderLeftWidth: 1,
 		};
-		this.rootWidget_.connect(noteText, (state) => {
+		this.rootWidget_.connect(noteText, state => {
 			return {
 				noteId: state.selectedNoteIds.length ? state.selectedNoteIds[0] : null,
 				notes: state.notes,
@@ -194,7 +221,7 @@ class AppGui {
 			borderLeftWidth: 1,
 			borderRightWidth: 1,
 		};
-		this.rootWidget_.connect(noteMetadata, (state) => {
+		this.rootWidget_.connect(noteMetadata, state => {
 			return { noteId: state.selectedNoteIds.length ? state.selectedNoteIds[0] : null };
 		});
 		noteMetadata.hide();
@@ -259,155 +286,31 @@ class AppGui {
 
 	addCommandToConsole(cmd) {
 		if (!cmd) return;
-		this.stdout(chalk.cyan.bold('> ' + cmd));	
+		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() {
@@ -482,8 +385,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() {
@@ -493,7 +404,7 @@ class AppGui {
 	activeListItem() {
 		const widget = this.widget('mainWindow').focusedWidget;
 		if (!widget) return null;
-		
+
 		if (widget.name == 'noteList' || widget.name == 'folderList') {
 			return widget.currentItem;
 		}
@@ -514,19 +425,66 @@ 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);
+		// this.logger().debug('Got command: ' + cmd);
 
-		if (cmd === 'q' || cmd === 'wq' || cmd === 'qa') { // Vim bonus
-			await this.app().exit();
-			return;
-		}	
-
-		try {			
+		try {
 			let note = this.widget('noteList').currentItem;
 			let folder = this.widget('folderList').currentItem;
 			let args = splitCommandString(cmd);
@@ -536,7 +494,7 @@ class AppGui {
 					args[i] = note ? note.id : '';
 				} else if (args[i] == '$b') {
 					args[i] = folder ? folder.id : '';
-				} else  if (args[i] == '$c') {
+				} else if (args[i] == '$c') {
 					const item = this.activeListItem();
 					args[i] = item ? item.id : '';
 				}
@@ -548,6 +506,10 @@ class AppGui {
 		}
 
 		this.widget('console').scrollBottom();
+
+		// Invalidate so that the screen is redrawn in case inputting a command has moved
+		// the GUI up (in particular due to autocompletion), it's moved back to the right position.
+		this.widget('root').invalidate();
 	}
 
 	async updateFolderList() {
@@ -624,7 +586,7 @@ class AppGui {
 	async setupResourceServer() {
 		const linkStyle = chalk.blue.underline;
 		const noteTextWidget = this.widget('noteText');
-		const resourceIdRegex = /^:\/[a-f0-9]+$/i
+		const resourceIdRegex = /^:\/[a-f0-9]+$/i;
 		const noteLinks = {};
 
 		const hasProtocol = function(s, protocols) {
@@ -634,7 +596,7 @@ class AppGui {
 				if (s.indexOf(protocols[i] + '://') === 0) return true;
 			}
 			return false;
-		}
+		};
 
 		// By default, before the server is started, only the regular
 		// URLs appear in blue.
@@ -658,16 +620,33 @@ class AppGui {
 			const link = noteLinks[path];
 
 			if (link.type === 'url') {
-				response.writeHead(302, { 'Location': link.url });
+				response.writeHead(302, { Location: link.url });
 				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;
 			}
 
@@ -683,9 +662,9 @@ class AppGui {
 
 				if (resourceIdRegex.test(url)) {
 					noteLinks[index] = {
-						type: 'resource',
+						type: 'item',
 						id: url.substr(2),
-					};					
+					};
 				} else if (hasProtocol(url, ['http', 'https', 'file', 'ftp'])) {
 					noteLinks[index] = {
 						type: 'url',
@@ -717,7 +696,6 @@ class AppGui {
 			term.grabInput();
 
 			term.on('key', async (name, matches, data) => {
-
 				// -------------------------------------------------------------------------
 				// Handle special shortcuts
 				// -------------------------------------------------------------------------
@@ -735,13 +713,13 @@ class AppGui {
 					return;
 				}
 
-				if (name === 'CTRL_C' ) {
+				if (name === 'CTRL_C') {
 					const cmd = this.app().currentCommand();
 					if (!cmd || !cmd.cancellable() || this.commandCancelCalled_) {
 						this.stdout(_('Press Ctrl+D or type "exit" to exit the application'));
 					} else {
 						this.commandCancelCalled_ = true;
-						await cmd.cancel()
+						await cmd.cancel();
 						this.commandCancelCalled_ = false;
 					}
 					return;
@@ -750,8 +728,8 @@ class AppGui {
 				// -------------------------------------------------------------------------
 				// Build up current shortcut
 				// -------------------------------------------------------------------------
-				
-				const now = (new Date()).getTime();
+
+				const now = new Date().getTime();
 
 				if (now - this.lastShortcutKeyTime_ > 800 || this.isSpecialKey(name)) {
 					this.currentShortcutKeys_ = [name];
@@ -772,35 +750,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));
 					}
 				}
 
@@ -820,10 +797,9 @@ class AppGui {
 			process.exit(1);
 		});
 	}
-
 }
 
 AppGui.INPUT_MODE_NORMAL = 1;
 AppGui.INPUT_MODE_META = 2;
 
-module.exports = AppGui;
+module.exports = AppGui;

CliClient/app/app.js

@@ -1,29 +1,21 @@
 const { BaseApplication } = require('lib/BaseApplication');
-const { createStore, applyMiddleware } = require('redux');
-const { reducer, defaultState } = require('lib/reducer.js');
-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 { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { BaseItem } = require('lib/models/base-item.js');
-const { Note } = require('lib/models/note.js');
-const { Tag } = require('lib/models/tag.js');
-const { Setting } = require('lib/models/setting.js');
-const { Logger } = require('lib/logger.js');
-const { sprintf } = require('sprintf-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');
+const Note = require('lib/models/Note.js');
+const Tag = require('lib/models/Tag.js');
+const Setting = require('lib/models/Setting.js');
 const { reg } = require('lib/registry.js');
 const { fileExtension } = require('lib/path-utils.js');
-const { shim } = require('lib/shim.js');
-const { _, setLocale, defaultLocale, closestSupportedLocale } = require('lib/locale.js');
-const os = require('os');
+const { _ } = require('lib/locale.js');
 const fs = require('fs-extra');
 const { cliUtils } = require('./cli-utils.js');
-const EventEmitter = require('events');
+const Cache = require('lib/Cache');
+const RevisionService = require('lib/services/RevisionService');
 
 class Application extends BaseApplication {
-
 	constructor() {
 		super();
 
@@ -34,6 +26,7 @@ class Application extends BaseApplication {
 		this.allCommandsLoaded_ = false;
 		this.showStackTraces_ = false;
 		this.gui_ = null;
+		this.cache_ = new Cache();
 	}
 
 	gui() {
@@ -71,7 +64,7 @@ class Application extends BaseApplication {
 			// const response = await cliUtils.promptMcq(msg, answers);
 			// if (!response) return null;
 
-			return output[response - 1];
+			// return output[response - 1];
 		} else {
 			return output.length ? output[0] : null;
 		}
@@ -93,10 +86,12 @@ class Application extends BaseApplication {
 		const parent = options.parent ? options.parent : app().currentFolder();
 		const ItemClass = BaseItem.itemClass(type);
 
-		if (type == BaseModel.TYPE_NOTE && pattern.indexOf('*') >= 0) { // Handle it as pattern
+		if (type == BaseModel.TYPE_NOTE && pattern.indexOf('*') >= 0) {
+			// Handle it as pattern
 			if (!parent) throw new Error(_('No notebook selected.'));
 			return await Note.previews(parent.id, { titlePattern: pattern });
-		} else { // Single item
+		} else {
+			// Single item
 			let item = null;
 			if (type == BaseModel.TYPE_NOTE) {
 				if (!parent) throw new Error(_('No notebook has been specified.'));
@@ -122,15 +117,15 @@ class Application extends BaseApplication {
 	}
 
 	setupCommand(cmd) {
-		cmd.setStdout((text) => {
+		cmd.setStdout(text => {
 			return this.stdout(text);
 		});
 
-		cmd.setDispatcher((action) => {
+		cmd.setDispatcher(action => {
 			if (this.store()) {
 				return this.store().dispatch(action);
 			} else {
-				return (action) => {};
+				return action => {};
 			}
 		});
 
@@ -144,13 +139,15 @@ class Application extends BaseApplication {
 				message += ' (' + options.answers.join('/') + ')';
 			}
 
-			let answer = await this.gui().prompt('', message + ' ');
+			let answer = await this.gui().prompt('', message + ' ', options);
 
 			if (options.type === 'boolean') {
 				if (answer === null) return false; // Pressed ESCAPE
 				if (!answer) answer = options.answers[0];
 				let positiveIndex = options.booleanAnswerDefault == 'y' ? 0 : 1;
 				return answer.toLowerCase() === options.answers[positiveIndex].toLowerCase();
+			} else {
+				return answer;
 			}
 		});
 
@@ -179,9 +176,9 @@ class Application extends BaseApplication {
 
 	commands(uiType = null) {
 		if (!this.allCommandsLoaded_) {
-			fs.readdirSync(__dirname).forEach((path) => {
+			fs.readdirSync(__dirname).forEach(path => {
 				if (path.indexOf('command-') !== 0) return;
-				const ext = fileExtension(path)
+				const ext = fileExtension(path);
 				if (ext != 'js') return;
 
 				let CommandClass = require('./' + path);
@@ -221,12 +218,8 @@ class Application extends BaseApplication {
 	async commandMetadata() {
 		if (this.commandMetadata_) return this.commandMetadata_;
 
-		const osTmpdir = require('os-tmpdir');
-		const storage = require('node-persist');
-		await storage.init({ dir: osTmpdir() + '/commandMetadata', ttl: 1000 * 60 * 60 * 24 });
-
-		let output = await storage.getItem('metadata');
-		if (Setting.value('env') != 'dev' && output) {
+		let output = await this.cache_.getItem('metadata');
+		if (output) {
 			this.commandMetadata_ = output;
 			return Object.assign({}, this.commandMetadata_);
 		}
@@ -240,7 +233,7 @@ class Application extends BaseApplication {
 			output[n] = cmd.metadata();
 		}
 
-		await storage.setItem('metadata', output);
+		await this.cache_.setItem('metadata', output, 1000 * 60 * 60 * 24);
 
 		this.commandMetadata_ = output;
 		return Object.assign({}, this.commandMetadata_);
@@ -274,28 +267,39 @@ class Application extends BaseApplication {
 
 	dummyGui() {
 		return {
-			isDummy: () => { return true; },
-			prompt: (initialText = '', promptString = '') => { return cliUtils.prompt(initialText, promptString); },
+			isDummy: () => {
+				return true;
+			},
+			prompt: (initialText = '', promptString = '', options = null) => {
+				return cliUtils.prompt(initialText, promptString, options);
+			},
 			showConsole: () => {},
 			maximizeConsole: () => {},
-			stdout: (text) => { console.info(text); },
-			fullScreen: (b=true) => {},
+			stdout: text => {
+				console.info(text);
+			},
+			fullScreen: (b = true) => {},
 			exit: () => {},
-			showModalOverlay: (text) => {},
+			showModalOverlay: text => {},
 			hideModalOverlay: () => {},
-			stdoutMaxWidth: () => { return 78; }
+			stdoutMaxWidth: () => {
+				return 100;
+			},
+			forceRender: () => {},
+			termSaveState: () => {},
+			termRestoreState: state => {},
 		};
 	}
 
 	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);
 
 		let outException = null;
 		try {
-			if (this.gui().isDummy() && !this.activeCommand_.supportsUi('cli')) throw new Error(_('The command "%s" is only available in GUI mode', this.activeCommand_.name()));			
+			if (this.gui().isDummy() && !this.activeCommand_.supportsUi('cli')) throw new Error(_('The command "%s" is only available in GUI mode', this.activeCommand_.name()));
 			const cmdArgs = cliUtils.makeCommandArgs(this.activeCommand_, argv);
 			await this.activeCommand_.action(cmdArgs);
 		} catch (error) {
@@ -309,10 +313,67 @@ 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);
 
-		cliUtils.setStdout((object) => {
+		cliUtils.setStdout(object => {
 			return this.stdout(object);
 		});
 
@@ -327,16 +388,26 @@ 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);
 			}
-		} else { // Otherwise open the GUI
+
+			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();
 
@@ -349,9 +420,13 @@ class Application extends BaseApplication {
 
 			const tags = await Tag.allWithNotes();
 
+			ResourceService.runInBackground();
+
+			RevisionService.instance().runInBackground();
+
 			this.dispatch({
 				type: 'TAG_UPDATE_ALL',
-				tags: tags,
+				items: tags,
 			});
 
 			this.store().dispatch({
@@ -360,7 +435,6 @@ class Application extends BaseApplication {
 			});
 		}
 	}
-
 }
 
 let application_ = null;
@@ -371,4 +445,4 @@ function app() {
 	return application_;
 }
 
-module.exports = { app };
+module.exports = { app };

CliClient/app/autocompletion.js

@@ -0,0 +1,198 @@
+var { app } = require('./app.js');
+var Note = require('lib/models/Note.js');
+var Folder = require('lib/models/Folder.js');
+var Tag = require('lib/models/Tag.js');
+var { cliUtils } = require('./cli-utils.js');
+var yargParser = require('yargs-parser');
+var fs = require('fs-extra');
+
+async function handleAutocompletionPromise(line) {
+	// Auto-complete the command name
+	const names = await app().commandNames();
+	let words = getArguments(line);
+	//If there is only one word and it is not already a command name then you
+	//should look for commmands it could be
+	if (words.length == 1) {
+		if (names.indexOf(words[0]) === -1) {
+			let x = names.filter(n => n.indexOf(words[0]) === 0);
+			if (x.length === 1) {
+				return x[0] + ' ';
+			}
+			return x.length > 0 ? x.map(a => a + ' ') : line;
+		} else {
+			return line;
+		}
+	}
+	//There is more than one word and it is a command
+	const metadata = (await app().commandMetadata())[words[0]];
+	//If for some reason this command does not have any associated metadata
+	//just don't autocomplete. However, this should not happen.
+	if (metadata === undefined) {
+		return line;
+	}
+	//complete an option
+	let next = words.length > 1 ? words[words.length - 1] : '';
+	let l = [];
+	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 separated by comma and
+			//space. The comma should be removed
+			if (options[0][options[0].length - 1] === ',') {
+				options[0] = options[0].slice(0, -1);
+			}
+			if (words.includes(options[0]) || words.includes(options[1])) {
+				continue;
+			}
+			//First two elements are the flag and the third is the description
+			//Only autocomplete long
+			if (options.length > 1 && options[1].indexOf(next) === 0) {
+				l.push(options[1]);
+			} else if (options[0].indexOf(next) === 0) {
+				l.push(options[0]);
+			}
+		}
+		if (l.length === 0) {
+			return line;
+		}
+		let ret = l.map(a => toCommandLine(a));
+		ret.prefix = toCommandLine(words.slice(0, -1)) + ' ';
+		return ret;
+	}
+	//Complete an argument
+	//Determine the number of positional arguments by counting the number of
+	//words that don't start with a - less one for the command name
+	const positionalArgs = words.filter(a => a.indexOf('-') !== 0).length - 1;
+
+	let cmdUsage = yargParser(metadata.usage)['_'];
+	cmdUsage.splice(0, 1);
+
+	if (cmdUsage.length >= positionalArgs) {
+		let argName = cmdUsage[positionalArgs - 1];
+		argName = cliUtils.parseCommandArg(argName).name;
+
+		const currentFolder = app().currentFolder();
+
+		if (argName == 'note' || argName == 'note-pattern') {
+			const notes = currentFolder ? await Note.previews(currentFolder.id, { titlePattern: next + '*' }) : [];
+			l.push(...notes.map(n => n.title));
+		}
+
+		if (argName == 'notebook') {
+			const folders = await Folder.search({ titlePattern: next + '*' });
+			l.push(...folders.map(n => n.title));
+		}
+
+		if (argName == 'item') {
+			const notes = currentFolder ? await Note.previews(currentFolder.id, { titlePattern: next + '*' }) : [];
+			const folders = await Folder.search({ titlePattern: next + '*' });
+			l.push(...notes.map(n => n.title), folders.map(n => n.title));
+		}
+
+		if (argName == 'tag') {
+			let tags = await Tag.search({ titlePattern: next + '*' });
+			l.push(...tags.map(n => n.title));
+		}
+
+		if (argName == 'file') {
+			let files = await fs.readdir('.');
+			l.push(...files);
+		}
+
+		if (argName == 'tag-command') {
+			let c = filterList(['add', 'remove', 'list'], next);
+			l.push(...c);
+		}
+
+		if (argName == 'todo-command') {
+			let c = filterList(['toggle', 'clear'], next);
+			l.push(...c);
+		}
+	}
+	if (l.length === 1) {
+		return toCommandLine([...words.slice(0, -1), l[0]]);
+	} else if (l.length > 1) {
+		let ret = l.map(a => toCommandLine(a));
+		ret.prefix = toCommandLine(words.slice(0, -1)) + ' ';
+		return ret;
+	}
+	return line;
+}
+function handleAutocompletion(str, callback) {
+	handleAutocompletionPromise(str).then(function(res) {
+		callback(undefined, res);
+	});
+}
+function toCommandLine(args) {
+	if (Array.isArray(args)) {
+		return args
+			.map(function(a) {
+				if (a.indexOf('"') !== -1 || a.indexOf(' ') !== -1) {
+					return '\'' + a + '\'';
+				} else if (a.indexOf('\'') !== -1) {
+					return '"' + a + '"';
+				} else {
+					return a;
+				}
+			})
+			.join(' ');
+	} else {
+		if (args.indexOf('"') !== -1 || args.indexOf(' ') !== -1) {
+			return '\'' + args + '\' ';
+		} else if (args.indexOf('\'') !== -1) {
+			return '"' + args + '" ';
+		} else {
+			return args + ' ';
+		}
+	}
+}
+function getArguments(line) {
+	let inSingleQuotes = false;
+	let inDoubleQuotes = false;
+	let currentWord = '';
+	let parsed = [];
+	for (let i = 0; i < line.length; i++) {
+		if (line[i] === '"') {
+			if (inDoubleQuotes) {
+				inDoubleQuotes = false;
+				//maybe push word to parsed?
+				//currentWord += '"';
+			} else {
+				inDoubleQuotes = true;
+				//currentWord += '"';
+			}
+		} else if (line[i] === '\'') {
+			if (inSingleQuotes) {
+				inSingleQuotes = false;
+				//maybe push word to parsed?
+				//currentWord += "'";
+			} else {
+				inSingleQuotes = true;
+				//currentWord += "'";
+			}
+		} else if (/\s/.test(line[i]) && !(inDoubleQuotes || inSingleQuotes)) {
+			if (currentWord !== '') {
+				parsed.push(currentWord);
+				currentWord = '';
+			}
+		} else {
+			currentWord += line[i];
+		}
+	}
+	if (!(inSingleQuotes || inDoubleQuotes) && /\s/.test(line[line.length - 1])) {
+		parsed.push('');
+	} else {
+		parsed.push(currentWord);
+	}
+	return parsed;
+}
+function filterList(list, next) {
+	let output = [];
+	for (let i = 0; i < list.length; i++) {
+		if (list[i].indexOf(next) !== 0) continue;
+		output.push(list[i]);
+	}
+	return output;
+}
+
+module.exports = { handleAutocompletion };

CliClient/app/base-command.js

@@ -2,7 +2,6 @@ const { _ } = require('lib/locale.js');
 const { reg } = require('lib/registry.js');
 
 class BaseCommand {
-
 	constructor() {
 		this.stdout_ = null;
 		this.prompt_ = null;
@@ -12,6 +11,10 @@ class BaseCommand {
 		throw new Error('Usage not defined');
 	}
 
+	encryptionCheck(item) {
+		if (item && item.encryption_applied) throw new Error(_('Cannot change encrypted item'));
+	}
+
 	description() {
 		throw new Error('Description not defined');
 	}
@@ -28,10 +31,6 @@ class BaseCommand {
 		return this.compatibleUis().indexOf(ui) >= 0;
 	}
 
-	aliases() {
-		return [];
-	}
-
 	options() {
 		return [];
 	}
@@ -93,7 +92,6 @@ class BaseCommand {
 	logger() {
 		return reg.logger();
 	}
-
 }
 
-module.exports = { BaseCommand };
+module.exports = { BaseCommand };

CliClient/app/build-doc.js

@@ -1,7 +1,7 @@
 const fs = require('fs-extra');
-const { fileExtension, basename, dirname } = require('lib/path-utils.js');
+const { fileExtension, dirname } = require('lib/path-utils.js');
 const wrap_ = require('word-wrap');
-const { _, setLocale, languageCode } = require('lib/locale.js');
+const { languageCode } = require('lib/locale.js');
 
 const rootDir = dirname(dirname(__dirname));
 const MAX_WIDTH = 78;
@@ -22,14 +22,14 @@ function renderOptions(options) {
 		let option = options[i];
 		const flag = option[0];
 		const indent = INDENT + INDENT + ' '.repeat(optionColWidth + 2);
-		
+
 		let r = wrap(option[1], indent);
 		r = r.substr(flag.length + (INDENT + INDENT).length);
 		r = INDENT + INDENT + flag + r;
 		output.push(r);
 	}
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function renderCommand(cmd) {
@@ -44,14 +44,14 @@ function renderCommand(cmd) {
 		output.push('');
 		output.push(optionString);
 	}
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function getCommands() {
 	let output = [];
-	fs.readdirSync(__dirname).forEach((path) => {
+	fs.readdirSync(__dirname).forEach(path => {
 		if (path.indexOf('command-') !== 0) return;
-		const ext = fileExtension(path)
+		const ext = fileExtension(path);
 		if (ext != 'js') return;
 
 		let CommandClass = require('./' + path);
@@ -87,14 +87,14 @@ function getHeader() {
 	let description = [];
 	description.push('Joplin is a note taking and to-do application, which can handle a large number of notes organised into notebooks.');
 	description.push('The notes are searchable, can be copied, tagged and modified with your own text editor.');
-	description.push("\n\n");
+	description.push('\n\n');
 	description.push('The notes can be synchronised with various target including the file system (for example with a network directory) or with Microsoft OneDrive.');
-	description.push("\n\n");
+	description.push('\n\n');
 	description.push('Notes exported from Evenotes via .enex files can be imported into Joplin, including the formatted content, resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.).');
 
 	output.push(wrap(description.join(''), INDENT));
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function getFooter() {
@@ -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('');
 
@@ -113,7 +113,7 @@ function getFooter() {
 	const licenseText = fs.readFileSync(filePath, 'utf8');
 	output.push(wrap(licenseText, INDENT));
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 async function main() {
@@ -128,12 +128,12 @@ async function main() {
 	}
 
 	const headerText = getHeader();
-	const commandsText = commandBlocks.join("\n\n");
+	const commandsText = commandBlocks.join('\n\n');
 	const footerText = getFooter();
 
-	console.info(headerText + "\n\n" + 'USAGE' + "\n\n" + commandsText + "\n\n" + footerText);
+	console.info(headerText + '\n\n' + 'USAGE' + '\n\n' + commandsText + '\n\n' + footerText);
 }
 
-main().catch((error) => {
+main().catch(error => {
 	console.error(error);
-});
+});

CliClient/app/cli-integration-tests.js

@@ -1,16 +1,16 @@
-"use strict"
+'use strict';
 
 const fs = require('fs-extra');
 const { Logger } = require('lib/logger.js');
 const { dirname } = require('lib/path-utils.js');
 const { DatabaseDriverNode } = require('lib/database-driver-node.js');
 const { JoplinDatabase } = require('lib/joplin-database.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { Setting } = require('lib/models/setting.js');
+const BaseModel = require('lib/BaseModel.js');
+const Folder = require('lib/models/Folder.js');
+const Note = require('lib/models/Note.js');
+const Setting = require('lib/models/Setting.js');
 const { sprintf } = require('sprintf-js');
-const exec = require('child_process').exec
+const exec = require('child_process').exec;
 
 process.on('unhandledRejection', (reason, p) => {
 	console.error('Unhandled promise rejection', p, 'reason:', reason);
@@ -32,8 +32,8 @@ db.setLogger(dbLogger);
 
 function createClient(id) {
 	return {
-		'id': id,
-		'profileDir': baseDir + '/client' + id,
+		id: id,
+		profileDir: baseDir + '/client' + id,
 	};
 }
 
@@ -72,14 +72,7 @@ function assertEquals(expected, real) {
 }
 
 async function clearDatabase() {
-	await db.transactionExecBatch([
-		'DELETE FROM folders',
-		'DELETE FROM notes',
-		'DELETE FROM tags',
-		'DELETE FROM note_tags',
-		'DELETE FROM resources',
-		'DELETE FROM deleted_items',
-	]);
+	await db.transactionExecBatch(['DELETE FROM folders', 'DELETE FROM notes', 'DELETE FROM tags', 'DELETE FROM note_tags', 'DELETE FROM resources', 'DELETE FROM deleted_items']);
 }
 
 const testUnits = {};
@@ -101,7 +94,7 @@ testUnits.testFolders = async () => {
 
 	folders = await Folder.all();
 	assertEquals(0, folders.length);
-}
+};
 
 testUnits.testNotes = async () => {
 	await execCommand(client, 'mkbook nb1');
@@ -121,16 +114,16 @@ testUnits.testNotes = async () => {
 	notes = await Note.all();
 	assertEquals(2, notes.length);
 
-	await execCommand(client, "rm -f 'blabla*'");
+	await execCommand(client, 'rm -f \'blabla*\'');
 
 	notes = await Note.all();
 	assertEquals(2, notes.length);
 
-	await execCommand(client, "rm -f 'n*'");
+	await execCommand(client, 'rm -f \'n*\'');
 
 	notes = await Note.all();
 	assertEquals(0, notes.length);
-}
+};
 
 testUnits.testCat = async () => {
 	await execCommand(client, 'mkbook nb1');
@@ -145,7 +138,7 @@ testUnits.testCat = async () => {
 
 	r = await execCommand(client, 'cat -v mynote');
 	assertTrue(r.indexOf(note.id) >= 0);
-}
+};
 
 testUnits.testConfig = async () => {
 	await execCommand(client, 'config editor vim');
@@ -159,7 +152,7 @@ testUnits.testConfig = async () => {
 	let r = await execCommand(client, 'config');
 	assertTrue(r.indexOf('editor') >= 0);
 	assertTrue(r.indexOf('subl') >= 0);
-}
+};
 
 testUnits.testCp = async () => {
 	await execCommand(client, 'mkbook nb2');
@@ -180,7 +173,7 @@ testUnits.testCp = async () => {
 	notes = await Note.previews(f2.id);
 	assertEquals(1, notes.length);
 	assertEquals(notesF1[0].title, notes[0].title);
-}
+};
 
 testUnits.testLs = async () => {
 	await execCommand(client, 'mkbook nb1');
@@ -190,7 +183,7 @@ testUnits.testLs = async () => {
 
 	assertTrue(r.indexOf('note1') >= 0);
 	assertTrue(r.indexOf('note2') >= 0);
-}
+};
 
 testUnits.testMv = async () => {
 	await execCommand(client, 'mkbook nb2');
@@ -210,14 +203,14 @@ testUnits.testMv = async () => {
 	await execCommand(client, 'mknote note2');
 	await execCommand(client, 'mknote note3');
 	await execCommand(client, 'mknote blabla');
-	await execCommand(client, "mv 'note*' nb2");
+	await execCommand(client, 'mv \'note*\' nb2');
 
 	notes1 = await Note.previews(f1.id);
 	notes2 = await Note.previews(f2.id);
 
 	assertEquals(1, notes1.length);
 	assertEquals(4, notes2.length);
-}
+};
 
 async function main(argv) {
 	await fs.remove(baseDir);
@@ -243,7 +236,7 @@ async function main(argv) {
 	}
 }
 
-main(process.argv).catch((error) => {
+main(process.argv).catch(error => {
 	console.info('');
 	logger.error(error);
-});
+});

CliClient/app/cli-utils.js

@@ -16,7 +16,7 @@ cliUtils.printArray = function(logFunction, rows, headers = null) {
 
 	for (let i = 0; i < rows.length; i++) {
 		let row = rows[i];
-		
+
 		for (let j = 0; j < row.length; j++) {
 			let item = row[j];
 			let width = item ? item.toString().length : 0;
@@ -26,7 +26,6 @@ cliUtils.printArray = function(logFunction, rows, headers = null) {
 		}
 	}
 
-	let lines = [];
 	for (let row = 0; row < rows.length; row++) {
 		let line = [];
 		for (let col = 0; col < colWidths.length; col++) {
@@ -37,7 +36,7 @@ cliUtils.printArray = function(logFunction, rows, headers = null) {
 		}
 		logFunction(line.join(' '));
 	}
-}
+};
 
 cliUtils.parseFlags = function(flags) {
 	let output = {};
@@ -56,7 +55,7 @@ cliUtils.parseFlags = function(flags) {
 		}
 	}
 	return output;
-}
+};
 
 cliUtils.parseCommandArg = function(arg) {
 	if (arg.length <= 2) throw new Error('Invalid command arg: ' + arg);
@@ -72,7 +71,7 @@ cliUtils.parseCommandArg = function(arg) {
 	} else {
 		throw new Error('Invalid command arg: ' + arg);
 	}
-}
+};
 
 cliUtils.makeCommandArgs = function(cmd, argv) {
 	let cmdUsage = cmd.usage();
@@ -85,7 +84,6 @@ cliUtils.makeCommandArgs = function(cmd, argv) {
 	for (let i = 0; i < options.length; i++) {
 		if (options[i].length != 2) throw new Error('Invalid options: ' + options[i]);
 		let flags = options[i][0];
-		let text = options[i][1];
 
 		flags = cliUtils.parseFlags(flags);
 
@@ -125,27 +123,27 @@ cliUtils.makeCommandArgs = function(cmd, argv) {
 	output.options = argOptions;
 
 	return output;
-}
+};
 
 cliUtils.promptMcq = function(message, answers) {
 	const readline = require('readline');
 
 	const rl = readline.createInterface({
 		input: process.stdin,
-		output: process.stdout
+		output: process.stdout,
 	});
 
-	message += "\n\n";
+	message += '\n\n';
 	for (let n in answers) {
 		if (!answers.hasOwnProperty(n)) continue;
-		message += _('%s: %s', n, answers[n]) + "\n";
+		message += _('%s: %s', n, answers[n]) + '\n';
 	}
 
-	message += "\n";
+	message += '\n';
 	message += _('Your choice: ');
 
 	return new Promise((resolve, reject) => {
-		rl.question(message, (answer) => {
+		rl.question(message, answer => {
 			rl.close();
 
 			if (!(answer in answers)) {
@@ -156,7 +154,7 @@ cliUtils.promptMcq = function(message, answers) {
 			resolve(answer);
 		});
 	});
-}
+};
 
 cliUtils.promptConfirm = function(message, answers = null) {
 	if (!answers) answers = [_('Y'), _('n')];
@@ -164,54 +162,54 @@ cliUtils.promptConfirm = function(message, answers = null) {
 
 	const rl = readline.createInterface({
 		input: process.stdin,
-		output: process.stdout
+		output: process.stdout,
 	});
 
 	message += ' (' + answers.join('/') + ')';
 
 	return new Promise((resolve, reject) => {
-		rl.question(message + ' ', (answer) => {
+		rl.question(message + ' ', answer => {
 			const ok = !answer || answer.toLowerCase() == answers[0].toLowerCase();
 			rl.close();
 			resolve(ok);
 		});
 	});
-}
-
-cliUtils.promptInput = function(message) {
-	const readline = require('readline');
-
-	const rl = readline.createInterface({
-		input: process.stdin,
-		output: process.stdout
-	});
-
-	return new Promise((resolve, reject) => {
-		rl.question(message + ' ', (answer) => {
-			rl.close();
-			resolve(answer);
-		});
-	});
-}
+};
 
 // Note: initialText is there to have the same signature as statusBar.prompt() so that
 // it can be a drop-in replacement, however initialText is not used (and cannot be
 // with readline.question?).
-cliUtils.prompt = function(initialText = '', promptString = ':') {
+cliUtils.prompt = function(initialText = '', promptString = ':', options = null) {
+	if (!options) options = {};
+
 	const readline = require('readline');
+	const Writable = require('stream').Writable;
+
+	const mutableStdout = new Writable({
+		write: function(chunk, encoding, callback) {
+			if (!this.muted) process.stdout.write(chunk, encoding);
+			callback();
+		},
+	});
 
 	const rl = readline.createInterface({
 		input: process.stdin,
-		output: process.stdout
+		output: mutableStdout,
+		terminal: true,
 	});
 
 	return new Promise((resolve, reject) => {
-		rl.question(promptString, (answer) => {
+		mutableStdout.muted = false;
+
+		rl.question(promptString, answer => {
 			rl.close();
+			if (options.secure) this.stdout_('');
 			resolve(answer);
 		});
+
+		mutableStdout.muted = !!options.secure;
 	});
-}
+};
 
 let redrawStarted_ = false;
 let redrawLastLog_ = null;
@@ -219,7 +217,7 @@ let redrawLastUpdateTime_ = 0;
 
 cliUtils.setStdout = function(v) {
 	this.stdout_ = v;
-}
+};
 
 cliUtils.redraw = function(s) {
 	const now = time.unixMs();
@@ -232,8 +230,8 @@ cliUtils.redraw = function(s) {
 		redrawLastLog_ = s;
 	}
 
-   redrawStarted_ = true;
-}
+	redrawStarted_ = true;
+};
 
 cliUtils.redrawDone = function() {
 	if (!redrawStarted_) return;
@@ -244,6 +242,6 @@ cliUtils.redrawDone = function() {
 
 	redrawLastLog_ = null;
 	redrawStarted_ = false;
-}
+};
 
-module.exports = { cliUtils };
+module.exports = { cliUtils };

CliClient/app/command-apidoc.js

@@ -0,0 +1,295 @@
+const { BaseCommand } = require('./base-command.js');
+const BaseItem = require('lib/models/BaseItem');
+const BaseModel = require('lib/BaseModel');
+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-attach.js

@@ -1,12 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
+const BaseModel = require('lib/BaseModel.js');
 const { shim } = require('lib/shim.js');
-const fs = require('fs-extra');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'attach <note> <file>';
 	}
@@ -19,13 +17,13 @@ class Command extends BaseCommand {
 		let title = args['note'];
 
 		let note = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
+		this.encryptionCheck(note);
 		if (!note) throw new Error(_('Cannot find "%s".', title));
 
 		const localFilePath = args['file'];
 
 		await shim.attachFileToNote(note, localFilePath);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-cat.js

@@ -1,12 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'cat <note>';
 	}
@@ -16,13 +14,7 @@ class Command extends BaseCommand {
 	}
 
 	options() {
-		return [
-			['-v, --verbose', _('Displays the complete information about note.')],
-		];
-	}
-
-	enabled() {
-		return false;
+		return [['-v, --verbose', _('Displays the complete information about note.')]];
 	}
 
 	async action(args) {
@@ -33,8 +25,14 @@ class Command extends BaseCommand {
 
 		const content = args.options.verbose ? await Note.serialize(item) : await Note.serializeForEdit(item);
 		this.stdout(content);
-	}
 
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
+	}
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-config.js

@@ -1,35 +1,36 @@
 const { BaseCommand } = require('./base-command.js');
 const { _, setLocale } = require('lib/locale.js');
 const { app } = require('./app.js');
-const { Setting } = require('lib/models/setting.js');
+const Setting = require('lib/models/Setting.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'config [name] [value]';
 	}
 
 	description() {
-		return _("Gets or sets a config value. If [value] is not provided, it will show the value of [name]. If neither [name] nor [value] is provided, it will list the current configuration.");
+		return _('Gets or sets a config value. If [value] is not provided, it will show the value of [name]. If neither [name] nor [value] is provided, it will list the current configuration.');
 	}
 
 	options() {
-		return [
-			['-v, --verbose', _('Also displays unset and hidden config variables.')],
-		];
+		return [['-v, --verbose', _('Also displays unset and hidden config variables.')]];
 	}
 
 	async action(args) {
 		const verbose = args.options.verbose;
 
-		const renderKeyValue = (name) => {
-			const value = Setting.value(name);
+		const renderKeyValue = name => {
+			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) value = '********';
+
 			if (Setting.isEnum(name)) {
 				return _('%s = %s (%s)', name, value, Setting.enumOptionsDoc(name));
 			} else {
 				return _('%s = %s', name, value);
 			}
-		}
+		};
 
 		if (!args.name && !args.value) {
 			let keys = Setting.keys(!verbose, 'cli');
@@ -39,15 +40,23 @@ class Command extends BaseCommand {
 				if (!verbose && !value) continue;
 				this.stdout(renderKeyValue(keys[i]));
 			}
-			app().gui().showConsole();
-			app().gui().maximizeConsole();
+			app()
+				.gui()
+				.showConsole();
+			app()
+				.gui()
+				.maximizeConsole();
 			return;
 		}
 
 		if (args.name && !args.value) {
 			this.stdout(renderKeyValue(args.name));
-			app().gui().showConsole();
-			app().gui().maximizeConsole();
+			app()
+				.gui()
+				.showConsole();
+			app()
+				.gui()
+				.maximizeConsole();
 			return;
 		}
 
@@ -60,7 +69,6 @@ class Command extends BaseCommand {
 
 		await Setting.saveAll();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-cp.js

@@ -1,12 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'cp <note> [notebook]';
 	}
@@ -33,7 +31,6 @@ class Command extends BaseCommand {
 			Note.updateGeolocation(newNote.id);
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-done.js

@@ -1,13 +1,11 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Note = require('lib/models/Note.js');
 const { time } = require('lib/time-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'done <note>';
 	}
@@ -16,8 +14,9 @@ class Command extends BaseCommand {
 		return _('Marks a to-do as done.');
 	}
 
-	static async handleAction(args, isCompleted) {
+	static async handleAction(commandInstance, args, isCompleted) {
 		const note = await app().loadItem(BaseModel.TYPE_NOTE, args.note);
+		commandInstance.encryptionCheck(note);
 		if (!note) throw new Error(_('Cannot find "%s".', args.note));
 		if (!note.is_todo) throw new Error(_('Note is not a to-do: "%s"', args.note));
 
@@ -32,9 +31,8 @@ class Command extends BaseCommand {
 	}
 
 	async action(args) {
-		await Command.handleAction(args, true);
+		await Command.handleAction(this, args, true);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-dump.js

@@ -1,12 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
-const { app } = require('./app.js');
-const { _ } = require('lib/locale.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { Tag } = require('lib/models/tag.js');
+const Folder = require('lib/models/Folder.js');
+const Note = require('lib/models/Note.js');
+const Tag = require('lib/models/Tag.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'dump';
 	}
@@ -35,10 +32,9 @@ class Command extends BaseCommand {
 		}
 
 		items = items.concat(tags);
-		
+
 		this.stdout(JSON.stringify(items));
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-e2ee.js

@@ -0,0 +1,224 @@
+const { BaseCommand } = require('./base-command.js');
+const { _ } = require('lib/locale.js');
+const EncryptionService = require('lib/services/EncryptionService');
+const DecryptionWorker = require('lib/services/DecryptionWorker');
+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 {
+	usage() {
+		return 'e2ee <command> [path]';
+	}
+
+	description() {
+		return _('Manages E2EE configuration. Commands are `enable`, `disable`, `decrypt`, `status`, `decrypt-file` and `target-status`.');
+	}
+
+	options() {
+		return [
+			// 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'],
+		];
+	}
+
+	async action(args) {
+		// change-password
+
+		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) {
+				this.stdout(_('Operation cancelled'));
+				return;
+			}
+
+			await EncryptionService.instance().generateMasterKeyAndEnableEncryption(password);
+			return;
+		}
+
+		if (args.command === 'disable') {
+			await EncryptionService.instance().disableEncryption();
+			return;
+		}
+
+		if (args.command === '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 ok = await askForMasterKey(error);
+							if (!ok) return;
+							continue;
+						}
+
+						throw error;
+					}
+				}
+
+				this.stdout(_('Completed decryption.'));
+			}
+
+			return;
+		}
+
+		if (args.command === 'status') {
+			this.stdout(_('Encryption is: %s', Setting.value('encryption.enabled') ? _('Enabled') : _('Disabled')));
+			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 targetPath = args.path;
+			if (!targetPath) throw new Error('Please specify the sync target path.');
+
+			const dirPaths = function(targetPath) {
+				let paths = [];
+				fs.readdirSync(targetPath).forEach(path => {
+					paths.push(path);
+				});
+				return paths;
+			};
+
+			let itemCount = 0;
+			let resourceCount = 0;
+			let encryptedItemCount = 0;
+			let encryptedResourceCount = 0;
+			let otherItemCount = 0;
+
+			let encryptedPaths = [];
+			let decryptedPaths = [];
+
+			let paths = dirPaths(targetPath);
+
+			for (let i = 0; i < paths.length; i++) {
+				const path = paths[i];
+				const fullPath = targetPath + '/' + path;
+				const stat = await fs.stat(fullPath);
+
+				// this.stdout(fullPath);
+
+				if (path === '.resource') {
+					let resourcePaths = dirPaths(fullPath);
+					for (let j = 0; j < resourcePaths.length; j++) {
+						const resourcePath = resourcePaths[j];
+						resourceCount++;
+						const fullResourcePath = fullPath + '/' + resourcePath;
+						const isEncrypted = await EncryptionService.instance().fileIsEncrypted(fullResourcePath);
+						if (isEncrypted) {
+							encryptedResourceCount++;
+							encryptedPaths.push(fullResourcePath);
+						} else {
+							decryptedPaths.push(fullResourcePath);
+						}
+					}
+				} else if (stat.isDirectory()) {
+					continue;
+				} else {
+					const content = await fs.readFile(fullPath, 'utf8');
+					const item = await BaseItem.unserialize(content);
+					const ItemClass = BaseItem.itemClass(item);
+
+					if (!ItemClass.encryptionSupported()) {
+						otherItemCount++;
+						continue;
+					}
+
+					itemCount++;
+
+					const isEncrypted = await EncryptionService.instance().itemIsEncrypted(item);
+
+					if (isEncrypted) {
+						encryptedItemCount++;
+						encryptedPaths.push(fullPath);
+					} else {
+						decryptedPaths.push(fullPath);
+					}
+				}
+			}
+
+			this.stdout('Encrypted items: ' + encryptedItemCount + '/' + itemCount);
+			this.stdout('Encrypted resources: ' + encryptedResourceCount + '/' + resourceCount);
+			this.stdout('Other items (never encrypted): ' + otherItemCount);
+
+			if (options.verbose) {
+				this.stdout('');
+				this.stdout('# Encrypted paths');
+				this.stdout('');
+				for (let i = 0; i < encryptedPaths.length; i++) {
+					const path = encryptedPaths[i];
+					this.stdout(path);
+				}
+
+				this.stdout('');
+				this.stdout('# Decrypted paths');
+				this.stdout('');
+				for (let i = 0; i < decryptedPaths.length; i++) {
+					const path = decryptedPaths[i];
+					this.stdout(path);
+				}
+			}
+
+			return;
+		}
+	}
+}
+
+module.exports = Command;

CliClient/app/command-edit.js

@@ -3,15 +3,11 @@ const { BaseCommand } = require('./base-command.js');
 const { uuid } = require('lib/uuid.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { Setting } = require('lib/models/setting.js');
-const { BaseModel } = require('lib/base-model.js');
-const { cliUtils } = require('./cli-utils.js');
-const { time } = require('lib/time-utils.js');
+const Note = require('lib/models/Note.js');
+const Setting = require('lib/models/Setting.js');
+const BaseModel = require('lib/BaseModel.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'edit <note>';
 	}
@@ -21,20 +17,19 @@ class Command extends BaseCommand {
 	}
 
 	async action(args) {
-		let watcher = null;
 		let tempFilePath = null;
 
 		const onFinishedEditing = async () => {
 			if (tempFilePath) fs.removeSync(tempFilePath);
-		}
+		};
 
 		const textEditorPath = () => {
 			if (Setting.value('editor')) return Setting.value('editor');
 			if (process.env.EDITOR) return process.env.EDITOR;
 			throw new Error(_('No text editor is defined. Please set it using `config editor <editor-path>`'));
-		}
+		};
 
-		try {		
+		try {
 			// -------------------------------------------------------------------------
 			// Load note or create it if it doesn't exist
 			// -------------------------------------------------------------------------
@@ -44,6 +39,8 @@ class Command extends BaseCommand {
 			if (!app().currentFolder()) throw new Error(_('No active notebook.'));
 			let note = await app().loadItem(BaseModel.TYPE_NOTE, title);
 
+			this.encryptionCheck(note);
+
 			if (!note) {
 				const ok = await this.prompt(_('Note does not exist: "%s". Create it?', title));
 				if (!ok) return;
@@ -74,16 +71,30 @@ class Command extends BaseCommand {
 
 			this.logger().info('Disabling fullscreen...');
 
-			app().gui().showModalOverlay(_('Starting to edit note. Close the editor to get back to the prompt.'));
-			await app().gui().forceRender();
-			const termState = app().gui().term().saveState();
+			app()
+				.gui()
+				.showModalOverlay(_('Starting to edit note. Close the editor to get back to the prompt.'));
+			await app()
+				.gui()
+				.forceRender();
+			const termState = app()
+				.gui()
+				.termSaveState();
 
-			const spawnSync	= require('child_process').spawnSync;
-			spawnSync(editorPath, editorArgs, { stdio: 'inherit' });
+			const spawnSync = require('child_process').spawnSync;
+			const result = spawnSync(editorPath, editorArgs, { stdio: 'inherit' });
 
-			app().gui().term().restoreState(termState);
-			app().gui().hideModalOverlay();
-			app().gui().forceRender();
+			if (result.error) this.stdout(_('Error opening note in editor: %s', result.error.message));
+
+			app()
+				.gui()
+				.termRestoreState(termState);
+			app()
+				.gui()
+				.hideModalOverlay();
+			app()
+				.gui()
+				.forceRender();
 
 			// -------------------------------------------------------------------------
 			// Save the note and clean up
@@ -103,13 +114,11 @@ class Command extends BaseCommand {
 			});
 
 			await onFinishedEditing();
-
-		} catch(error) {
+		} catch (error) {
 			await onFinishedEditing();
 			throw error;
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-exit.js

@@ -3,7 +3,6 @@ const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'exit';
 	}
@@ -19,7 +18,6 @@ class Command extends BaseCommand {
 	async action(args) {
 		await app().exit();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-export-sync-status.js

@@ -1,13 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
-const { Database } = require('lib/database.js');
 const { app } = require('./app.js');
-const { Setting } = require('lib/models/setting.js');
-const { _ } = require('lib/locale.js');
+const Setting = require('lib/models/Setting.js');
 const { ReportService } = require('lib/services/report.js');
 const fs = require('fs-extra');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'export-sync-status';
 	}
@@ -23,14 +20,17 @@ class Command extends BaseCommand {
 	async action(args) {
 		const service = new ReportService();
 		const csv = await service.basicItemList({ format: 'csv' });
-		const filePath = Setting.value('profileDir') + '/syncReport-' + (new Date()).getTime() + '.csv';
+		const filePath = Setting.value('profileDir') + '/syncReport-' + new Date().getTime() + '.csv';
 		await fs.writeFileSync(filePath, csv);
 		this.stdout('Sync status exported to ' + filePath);
 
-		app().gui().showConsole();
-		app().gui().maximizeConsole();
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-export.js

@@ -1,59 +1,49 @@
 const { BaseCommand } = require('./base-command.js');
-const { Exporter } = require('lib/services/exporter.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Note } = require('lib/models/note.js');
-const { reg } = require('lib/registry.js');
+const InteropService = require('lib/services/InteropService.js');
+const BaseModel = require('lib/BaseModel.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-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() {
-		return [
-			['--note <note>', _('Exports only the given note.')],
-			['--notebook <notebook>', _('Exports only the given notebook.')],
-		];
+		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.')]];
 	}
-	
+
 	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) {
-
 			const notes = await app().loadItems(BaseModel.TYPE_NOTE, args.options.note, { parent: app().currentFolder() });
 			if (!notes.length) throw new Error(_('Cannot find "%s".', args.options.note));
-			exportOptions.sourceNoteIds = notes.map((n) => n.id);
-
+			exportOptions.sourceNoteIds = notes.map(n => n.id);
 		} else if (args.options.notebook) {
-
 			const folders = await app().loadItems(BaseModel.TYPE_FOLDER, args.options.notebook);
 			if (!folders.length) throw new Error(_('Cannot find "%s".', args.options.notebook));
-			exportOptions.sourceFolderIds = folders.map((n) => n.id);
-
+			exportOptions.sourceFolderIds = folders.map(n => n.id);
 		}
 
-		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));
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-geoloc.js

@@ -1,12 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'geoloc <note>';
 	}
@@ -23,9 +21,10 @@ class Command extends BaseCommand {
 		const url = Note.geolocationUrl(item);
 		this.stdout(url);
 
-		app().gui().showConsole();
+		app()
+			.gui()
+			.showConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-help.js

@@ -1,14 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { renderCommandHelp } = require('./help-utils.js');
-const { Database } = require('lib/database.js');
-const { Setting } = require('lib/models/setting.js');
-const { wrap } = require('lib/string-utils.js');
 const { _ } = require('lib/locale.js');
 const { cliUtils } = require('./cli-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'help [command]';
 	}
@@ -28,7 +24,7 @@ class Command extends BaseCommand {
 			output.push(command);
 		}
 
-		output.sort((a, b) => a.name() < b.name() ? -1 : +1);
+		output.sort((a, b) => (a.name() < b.name() ? -1 : +1));
 
 		return output;
 	}
@@ -36,57 +32,65 @@ class Command extends BaseCommand {
 	async action(args) {
 		const stdoutWidth = app().commandStdoutMaxWidth();
 
-		if (args.command === 'shortcuts') {
-			if (app().gui().isDummy()) {
+		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);
 		} else if (args.command === 'all') {
 			const commands = this.allCommands();
-			const output = commands.map((c) => renderCommandHelp(c));
+			const output = commands.map(c => renderCommandHelp(c));
 			this.stdout(output.join('\n\n'));
 		} else if (args.command) {
 			const command = app().findCommandByName(args['command']);
 			if (!command) throw new Error(_('Cannot find "%s".', args.command));
 			this.stdout(renderCommandHelp(command, stdoutWidth));
 		} else {
-			const commandNames = this.allCommands().map((a) => a.name());
+			const commandNames = this.allCommands().map(a => a.name());
 
-			this.stdout(_('Type `help [command]` for more information about a command.'));
+			this.stdout(_('Type `help [command]` for more information about a command; or type `help all` for the complete usage information.'));
 			this.stdout('');
 			this.stdout(_('The possible commands are:'));
 			this.stdout('');
-			this.stdout(_('Type `help all` for the complete help of all the commands.'));
-			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();
-		app().gui().maximizeConsole();
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

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,70 @@
+const { BaseCommand } = require('./base-command.js');
+const InteropService = require('lib/services/InteropService.js');
+const BaseModel = require('lib/BaseModel.js');
+const { cliUtils } = require('./cli-utils.js');
+const { app } = require('./app.js');
+const { _ } = require('lib/locale.js');
+
+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

@@ -1,16 +1,15 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Setting } = require('lib/models/setting.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Folder = require('lib/models/Folder.js');
+const Setting = require('lib/models/Setting.js');
+const Note = require('lib/models/Note.js');
 const { sprintf } = require('sprintf-js');
 const { time } = require('lib/time-utils.js');
 const { cliUtils } = require('./cli-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'ls [note-pattern]';
 	}
@@ -22,16 +21,9 @@ class Command extends BaseCommand {
 	enabled() {
 		return false;
 	}
-	
+
 	options() {
-		return [
-			['-n, --limit <num>', _('Displays only the first top <num> notes.')],
-			['-s, --sort <field>', _('Sorts the item by <field> (eg. title, updated_time, created_time).')],
-			['-r, --reverse', _('Reverses the sorting order.')],
-			['-t, --type <type>', _('Displays only the items of the specific type(s). Can be `n` for notes, `t` for to-dos, or `nt` for notes and to-dos (eg. `-tt` would display only the to-dos, while `-ttd` would display notes and to-dos.')],
-			['-f, --format <format>', _('Either "text" or "json"')],
-			['-l, --long', _('Use long list format. Format is ID, NOTE_COUNT (for notebook), DATE, TODO_CHECKED (for to-dos), TITLE')],
-		];
+		return [['-n, --limit <num>', _('Displays only the first top <num> notes.')], ['-s, --sort <field>', _('Sorts the item by <field> (eg. title, updated_time, created_time).')], ['-r, --reverse', _('Reverses the sorting order.')], ['-t, --type <type>', _('Displays only the items of the specific type(s). Can be `n` for notes, `t` for to-dos, or `nt` for notes and to-dos (eg. `-tt` would display only the to-dos, while `-ttd` would display notes and to-dos.')], ['-f, --format <format>', _('Either "text" or "json"')], ['-l, --long', _('Use long list format. Format is ID, NOTE_COUNT (for notebook), DATE, TODO_CHECKED (for to-dos), TITLE')]];
 	}
 
 	async action(args) {
@@ -93,7 +85,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;
@@ -105,7 +97,7 @@ class Command extends BaseCommand {
 
 				if (hasTodos) {
 					if (item.is_todo) {
-						row.push(sprintf('[%s]', !!item.todo_completed ? 'X' : ' '));
+						row.push(sprintf('[%s]', item.todo_completed ? 'X' : ' '));
 					} else {
 						row.push('   ');
 					}
@@ -118,9 +110,7 @@ class Command extends BaseCommand {
 
 			cliUtils.printArray(this.stdout.bind(this), rows);
 		}
-
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-mkbook.js

@@ -1,11 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { Folder } = require('lib/models/folder.js');
-const { reg } = require('lib/registry.js');
+const Folder = require('lib/models/Folder.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'mkbook <new-notebook>';
 	}
@@ -14,15 +12,10 @@ 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 });		
+		let folder = await Folder.save({ title: args['new-notebook'] }, { userSideValidation: true });
 		app().switchCurrentFolder(folder);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-mknote.js

@@ -1,10 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { Note } = require('lib/models/note.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'mknote <new-note>';
 	}
@@ -26,7 +25,6 @@ class Command extends BaseCommand {
 
 		app().switchCurrentFolder(app().currentFolder());
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-mktodo.js

@@ -1,10 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { Note } = require('lib/models/note.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'mktodo <new-todo>';
 	}
@@ -27,7 +26,6 @@ class Command extends BaseCommand {
 
 		app().switchCurrentFolder(app().currentFolder());
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-mv.js

@@ -1,12 +1,11 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Folder = require('lib/models/Folder.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'mv <note> [notebook]';
 	}
@@ -18,7 +17,7 @@ class Command extends BaseCommand {
 	async action(args) {
 		const pattern = args['note'];
 		const destination = args['notebook'];
-		
+
 		const folder = await Folder.loadByField('title', destination);
 		if (!folder) throw new Error(_('Cannot find "%s".', destination));
 
@@ -29,7 +28,6 @@ class Command extends BaseCommand {
 			await Note.moveToFolder(notes[i].id, folder.id);
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-ren.js

@@ -1,12 +1,11 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Folder = require('lib/models/Folder.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'ren <item> <name>';
 	}
@@ -20,6 +19,7 @@ class Command extends BaseCommand {
 		const name = args['name'];
 
 		const item = await app().loadItem('folderOrNote', pattern);
+		this.encryptionCheck(item);
 		if (!item) throw new Error(_('Cannot find "%s".', pattern));
 
 		const newItem = {
@@ -34,7 +34,6 @@ class Command extends BaseCommand {
 			await Note.save(newItem);
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-rmbook.js

@@ -1,14 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseItem } = require('lib/models/base-item.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { BaseModel } = require('lib/base-model.js');
-const { cliUtils } = require('./cli-utils.js');
+const Folder = require('lib/models/Folder.js');
+const BaseModel = require('lib/BaseModel.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'rmbook <notebook>';
 	}
@@ -18,9 +14,7 @@ class Command extends BaseCommand {
 	}
 
 	options() {
-		return [
-			['-f, --force', _('Deletes the notebook without asking for confirmation.')],
-		];
+		return [['-f, --force', _('Deletes the notebook without asking for confirmation.')]];
 	}
 
 	async action(args) {
@@ -29,12 +23,11 @@ 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 "%s"?', folder.title), { 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);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-rmnote.js

@@ -1,14 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseItem } = require('lib/models/base-item.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { BaseModel } = require('lib/base-model.js');
-const { cliUtils } = require('./cli-utils.js');
+const Note = require('lib/models/Note.js');
+const BaseModel = require('lib/BaseModel.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'rmnote <note-pattern>';
 	}
@@ -18,9 +14,7 @@ class Command extends BaseCommand {
 	}
 
 	options() {
-		return [
-			['-f, --force', _('Deletes the notes without asking for confirmation.')],
-		];
+		return [['-f, --force', _('Deletes the notes without asking for confirmation.')]];
 	}
 
 	async action(args) {
@@ -32,10 +26,9 @@ class Command extends BaseCommand {
 
 		const ok = force ? true : await this.prompt(notes.length > 1 ? _('%d notes match this pattern. Delete them?', notes.length) : _('Delete note?'), { booleanAnswerDefault: 'n' });
 		if (!ok) return;
-		let ids = notes.map((n) => n.id);
+		let ids = notes.map(n => n.id);
 		await Note.batchDelete(ids);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-search.js

@@ -1,15 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
-const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { sprintf } = require('sprintf-js');
-const { time } = require('lib/time-utils.js');
+const BaseModel = require('lib/BaseModel.js');
+const Folder = require('lib/models/Folder.js');
 const { uuid } = require('lib/uuid.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'search <pattern> [notebook]';
 	}
@@ -49,37 +44,7 @@ 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);
-		// }
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-set.js

@@ -1,14 +1,11 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
+const BaseModel = require('lib/BaseModel.js');
 const { Database } = require('lib/database.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { BaseItem } = require('lib/models/base-item.js');
+const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'set <note> <name> [value]';
 	}
@@ -35,6 +32,8 @@ class Command extends BaseCommand {
 		if (!notes.length) throw new Error(_('Cannot find "%s".', title));
 
 		for (let i = 0; i < notes.length; i++) {
+			this.encryptionCheck(notes[i]);
+
 			let newNote = {
 				id: notes[i].id,
 				type_: notes[i].type_,
@@ -43,7 +42,6 @@ class Command extends BaseCommand {
 			await Note.save(newNote);
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-status.js

@@ -1,12 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
-const { Database } = require('lib/database.js');
 const { app } = require('./app.js');
-const { Setting } = require('lib/models/setting.js');
+const Setting = require('lib/models/Setting.js');
 const { _ } = require('lib/locale.js');
 const { ReportService } = require('lib/services/report.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'status';
 	}
@@ -34,10 +32,13 @@ class Command extends BaseCommand {
 			}
 		}
 
-		app().gui().showConsole();
-		app().gui().maximizeConsole();
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-sync.js

@@ -2,18 +2,17 @@ const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 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/base-item.js');
+const Setting = require('lib/models/Setting.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 {
-
 	constructor() {
 		super();
 		this.syncTargetId_ = null;
@@ -30,9 +29,7 @@ class Command extends BaseCommand {
 	}
 
 	options() {
-		return [
-			['--target <target>', _('Sync to provided target (defaults to sync.target config value)')],
-		];
+		return [['--target <target>', _('Sync to provided target (defaults to sync.target config value)')]];
 	}
 
 	static lockFile(filePath) {
@@ -61,14 +58,48 @@ class Command extends BaseCommand {
 		});
 	}
 
-	async doAuth(syncTargetId) {
+	async doAuth() {
 		const syncTarget = reg.syncTarget(this.syncTargetId_);
-		this.oneDriveApiUtils_ = new OneDriveApiNodeUtils(syncTarget.api());
-		const auth = await this.oneDriveApiUtils_.oauthDance({
-			log: (...s) => { return this.stdout(...s); }
-		});
-		this.oneDriveApiUtils_ = null;
-		return auth;
+		const syncTargetMd = SyncTargetRegistry.idToMetadata(this.syncTargetId_);
+
+		if (this.syncTargetId_ === 3 || this.syncTargetId_ === 4) {
+			// OneDrive
+			this.oneDriveApiUtils_ = new OneDriveApiNodeUtils(syncTarget.api());
+			const auth = await this.oneDriveApiUtils_.oauthDance({
+				log: (...s) => {
+					return this.stdout(...s);
+				},
+			});
+			this.oneDriveApiUtils_ = null;
+
+			Setting.setValue('sync.' + this.syncTargetId_ + '.auth', auth ? JSON.stringify(auth) : null);
+			if (!auth) {
+				this.stdout(_('Authentication was not completed (did not receive an authentication token).'));
+				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.', syncTargetMd.label));
+		return false;
 	}
 
 	cancelAuth() {
@@ -86,8 +117,8 @@ class Command extends BaseCommand {
 		this.releaseLockFn_ = null;
 
 		// Lock is unique per profile/database
-		const lockFilePath = osTmpdir() + '/synclock_' + md5(Setting.value('profileDir'));
-		if (!await fs.pathExists(lockFilePath)) await fs.writeFile(lockFilePath, 'synclock');
+		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 {
 			if (await Command.isLocked(lockFilePath)) throw new Error(_('Synchronisation is already in progress.'));
@@ -116,26 +147,26 @@ class Command extends BaseCommand {
 
 			const syncTarget = reg.syncTarget(this.syncTargetId_);
 
-			if (!syncTarget.isAuthenticated()) {
-				app().gui().showConsole();
-				app().gui().maximizeConsole();
+			if (!(await syncTarget.isAuthenticated())) {
+				app()
+					.gui()
+					.showConsole();
+				app()
+					.gui()
+					.maximizeConsole();
 
-				const auth = await this.doAuth(this.syncTargetId_);
-				Setting.setValue('sync.' + this.syncTargetId_ + '.auth', auth ? JSON.stringify(auth) : null);
-				if (!auth) {
-					this.stdout(_('Authentication was not completed (did not receive an authentication token).'));
-					return cleanUp();
-				}
+				const authDone = await this.doAuth();
+				if (!authDone) return cleanUp();
 			}
-			
+
 			const sync = await syncTarget.synchronizer();
 
 			let options = {
-				onProgress: (report) => {
+				onProgress: report => {
 					let lines = Synchronizer.reportToLines(report);
 					if (lines.length) cliUtils.redraw(lines.join(' '));
 				},
-				onMessage: (msg) => {
+				onMessage: msg => {
 					cliUtils.redrawDone();
 					this.stdout(msg);
 				},
@@ -164,6 +195,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();
@@ -187,7 +227,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 {
@@ -201,7 +241,6 @@ class Command extends BaseCommand {
 	cancellable() {
 		return true;
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-tag.js

@@ -1,21 +1,27 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { Tag } = require('lib/models/tag.js');
-const { BaseModel } = require('lib/base-model.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 {
-
 	usage() {
 		return 'tag <tag-command> [tag] [note]';
 	}
 
 	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,16 +47,38 @@ 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); });
+				tags.map(tag => {
+					this.stdout(tag.title);
+				});
 			}
 		} else {
 			throw new Error(_('Invalid command: "%s"', command));
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-todo.js

@@ -1,13 +1,11 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
+const BaseModel = require('lib/BaseModel.js');
+const Note = require('lib/models/Note.js');
 const { time } = require('lib/time-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'todo <todo-command> <note-pattern>';
 	}
@@ -25,6 +23,8 @@ class Command extends BaseCommand {
 		for (let i = 0; i < notes.length; i++) {
 			const note = notes[i];
 
+			this.encryptionCheck(note);
+
 			let toSave = {
 				id: note.id,
 			};
@@ -37,12 +37,11 @@ class Command extends BaseCommand {
 				}
 			} else if (action == 'clear') {
 				toSave.is_todo = 0;
-			}			
+			}
 
 			await Note.save(toSave);
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-undone.js

@@ -1,15 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
-const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Note } = require('lib/models/note.js');
-const { time } = require('lib/time-utils.js');
 
 const CommandDone = require('./command-done.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'undone <note>';
 	}
@@ -19,9 +13,8 @@ class Command extends BaseCommand {
 	}
 
 	async action(args) {
-		await CommandDone.handleAction(args, false);
+		await CommandDone.handleAction(this, args, false);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-use.js

@@ -1,11 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
+const BaseModel = require('lib/BaseModel.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'use <notebook>';
 	}
@@ -14,10 +12,6 @@ class Command extends BaseCommand {
 		return _('Switches to [notebook] - all further operations will happen within this notebook.');
 	}
 
-	autocomplete() {
-		return { data: autocompleteFolders };
-	}
-
 	compatibleUis() {
 		return ['cli'];
 	}
@@ -27,7 +21,6 @@ class Command extends BaseCommand {
 		if (!folder) throw new Error(_('Cannot find "%s".', args['notebook']));
 		app().switchCurrentFolder(folder);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-version.js

@@ -1,9 +1,8 @@
 const { BaseCommand } = require('./base-command.js');
-const { Setting } = require('lib/models/setting.js');
+const Setting = require('lib/models/Setting.js');
 const { _ } = require('lib/locale.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'version';
 	}
@@ -16,7 +15,6 @@ class Command extends BaseCommand {
 		const p = require('./package.json');
 		this.stdout(_('%s %s (%s)', p.name, p.version, Setting.value('env')));
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/gui/ConsoleWidget.js

@@ -1,7 +1,6 @@
 const TextWidget = require('tkwidgets/TextWidget.js');
 
 class ConsoleWidget extends TextWidget {
-
 	constructor() {
 		super();
 		this.lines_ = [];
@@ -16,7 +15,7 @@ class ConsoleWidget extends TextWidget {
 	}
 
 	get lastLine() {
-		return this.lines_.length ? this.lines_[this.lines_.length-1] : '';
+		return this.lines_.length ? this.lines_[this.lines_.length - 1] : '';
 	}
 
 	addLine(line) {
@@ -40,13 +39,12 @@ class ConsoleWidget extends TextWidget {
 			if (this.lines_.length > this.maxLines_) {
 				this.lines_.splice(0, this.lines_.length - this.maxLines_);
 			}
-			this.text = this.lines_.join("\n");
+			this.text = this.lines_.join('\n');
 			this.updateText_ = false;
 		}
 
 		super.render();
 	}
-
 }
 
-module.exports = ConsoleWidget;
+module.exports = ConsoleWidget;

CliClient/app/gui/FolderListWidget.js

@@ -1,11 +1,10 @@
-const Folder = require('lib/models/folder.js').Folder;
-const Tag = require('lib/models/tag.js').Tag;
-const BaseModel = require('lib/base-model.js').BaseModel;
+const Folder = require('lib/models/Folder.js');
+const Tag = require('lib/models/Tag.js');
+const BaseModel = require('lib/BaseModel.js');
 const ListWidget = require('tkwidgets/ListWidget.js');
 const _ = require('lib/locale.js')._;
 
 class FolderListWidget extends ListWidget {
-
 	constructor() {
 		super();
 
@@ -18,33 +17,42 @@ class FolderListWidget extends ListWidget {
 		this.notesParentType_ = 'Folder';
 		this.updateIndexFromSelectedFolderId_ = false;
 		this.updateItems_ = false;
+		this.trimItemTitle = false;
 
-		this.itemRenderer = (item) => {
+		this.itemRenderer = item => {
 			let output = [];
 			if (item === '-') {
 				output.push('-'.repeat(this.innerWidth));
 			} else if (item.type_ === Folder.modelType()) {
-				output.push(item.title);
+				output.push(' '.repeat(this.folderDepth(this.folders, item.id)) + Folder.displayTitle(item));
 			} else if (item.type_ === Tag.modelType()) {
-				output.push('[' + item.title + ']');
+				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;
+		}
+	}
+
 	get selectedFolderId() {
 		return this.selectedFolderId_;
 	}
 
 	set selectedFolderId(v) {
 		this.selectedFolderId_ = v;
-		this.updateIndexFromSelectedItemId()
+		this.updateIndexFromSelectedItemId();
 		this.invalidate();
 	}
 
@@ -54,7 +62,7 @@ class FolderListWidget extends ListWidget {
 
 	set selectedSearchId(v) {
 		this.selectedSearchId_ = v;
-		this.updateIndexFromSelectedItemId()
+		this.updateIndexFromSelectedItemId();
 		this.invalidate();
 	}
 
@@ -64,7 +72,7 @@ class FolderListWidget extends ListWidget {
 
 	set selectedTagId(v) {
 		this.selectedTagId_ = v;
-		this.updateIndexFromSelectedItemId()
+		this.updateIndexFromSelectedItemId();
 		this.invalidate();
 	}
 
@@ -73,9 +81,8 @@ class FolderListWidget extends ListWidget {
 	}
 
 	set notesParentType(v) {
-		//if (this.notesParentType_ === v) return;
 		this.notesParentType_ = v;
-		this.updateIndexFromSelectedItemId()
+		this.updateIndexFromSelectedItemId();
 		this.invalidate();
 	}
 
@@ -86,7 +93,7 @@ class FolderListWidget extends ListWidget {
 	set searches(v) {
 		this.searches_ = v;
 		this.updateItems_ = true;
-		this.updateIndexFromSelectedItemId()
+		this.updateIndexFromSelectedItemId();
 		this.invalidate();
 	}
 
@@ -97,7 +104,7 @@ class FolderListWidget extends ListWidget {
 	set tags(v) {
 		this.tags_ = v;
 		this.updateItems_ = true;
-		this.updateIndexFromSelectedItemId()
+		this.updateIndexFromSelectedItemId();
 		this.invalidate();
 	}
 
@@ -108,17 +115,37 @@ class FolderListWidget extends ListWidget {
 	set folders(v) {
 		this.folders_ = v;
 		this.updateItems_ = true;
-		this.updateIndexFromSelectedItemId()
+		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_) {
 			this.logger().debug('Rebuilding items...', this.notesParentType, this.selectedJoplinItemId, this.selectedSearchId);
 			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('-');
@@ -133,7 +160,7 @@ class FolderListWidget extends ListWidget {
 			this.items = newItems;
 
 			this.notesParentType = previousParentType;
-			this.updateIndexFromSelectedItemId(wasSelectedItemId)
+			this.updateIndexFromSelectedItemId(wasSelectedItemId);
 			this.updateItems_ = false;
 		}
 
@@ -159,7 +186,6 @@ class FolderListWidget extends ListWidget {
 		const index = this.itemIndexByKey('id', itemId);
 		this.currentIndex = index >= 0 ? index : 0;
 	}
-
 }
 
-module.exports = FolderListWidget;
+module.exports = FolderListWidget;

CliClient/app/gui/NoteListWidget.js

@@ -1,16 +1,15 @@
-const Note = require('lib/models/note.js').Note;
+const Note = require('lib/models/Note.js');
 const ListWidget = require('tkwidgets/ListWidget.js');
 
 class NoteListWidget extends ListWidget {
-
 	constructor() {
 		super();
 		this.selectedNoteId_ = 0;
 
 		this.updateIndexFromSelectedNoteId_ = false;
 
-		this.itemRenderer = (note) => {
-			let label = note.title; // + ' ' + note.id;
+		this.itemRenderer = note => {
+			let label = Note.displayTitle(note); // + ' ' + note.id;
 			if (note.is_todo) {
 				label = '[' + (note.todo_completed ? 'X' : ' ') + '] ' + label;
 			}
@@ -32,7 +31,6 @@ class NoteListWidget extends ListWidget {
 
 		super.render();
 	}
-
 }
 
-module.exports = NoteListWidget;
+module.exports = NoteListWidget;

CliClient/app/gui/NoteMetadataWidget.js

@@ -1,8 +1,7 @@
-const Note = require('lib/models/note.js').Note;
+const Note = require('lib/models/Note.js');
 const TextWidget = require('tkwidgets/TextWidget.js');
 
 class NoteMetadataWidget extends TextWidget {
-
 	constructor() {
 		super();
 		this.noteId_ = 0;
@@ -30,7 +29,6 @@ class NoteMetadataWidget extends TextWidget {
 			this.text = this.note_ ? await Note.minimalSerializeForDisplay(this.note_) : '';
 		}
 	}
-
 }
 
-module.exports = NoteMetadataWidget;
+module.exports = NoteMetadataWidget;

CliClient/app/gui/NoteWidget.js

@@ -1,8 +1,8 @@
-const Note = require('lib/models/note.js').Note;
+const Note = require('lib/models/Note.js');
 const TextWidget = require('tkwidgets/TextWidget.js');
+const { _ } = require('lib/locale.js');
 
 class NoteWidget extends TextWidget {
-
 	constructor() {
 		super();
 		this.noteId_ = 0;
@@ -32,11 +32,24 @@ class NoteWidget extends TextWidget {
 		this.reloadNote();
 	}
 
+	welcomeText() {
+		return _('Welcome to Joplin!\n\nType `:help shortcuts` for the list of keyboard shortcuts, or just `:help` for usage information.\n\nFor example, to create a notebook press `mb`; to create a note press `mn`.');
+	}
+
 	reloadNote() {
-		if (this.noteId_) {
+		if (!this.noteId_ && !this.notes.length) {
+			this.text = this.welcomeText();
+			this.scrollTop = 0;
+		} else if (this.noteId_) {
 			this.doAsync('loadNote', async () => {
 				this.note_ = await Note.load(this.noteId_);
-				this.text = this.note_ ? this.note_.title + "\n\n" + this.note_.body : '';
+
+				if (this.note_ && this.note_.encryption_applied) {
+					this.text = _('One or more items are currently encrypted and you may need to supply a master password. To do so please type `e2ee decrypt`. If you have already supplied the password, the encrypted items are being decrypted in the background and will be available soon.');
+				} else {
+					this.text = this.note_ ? this.note_.title + '\n\n' + this.note_.body : '';
+				}
+
 				if (this.lastLoadedNoteId_ !== this.noteId_) this.scrollTop = 0;
 				this.lastLoadedNoteId_ = this.noteId_;
 			});
@@ -45,7 +58,6 @@ class NoteWidget extends TextWidget {
 			this.scrollTop = 0;
 		}
 	}
-
 }
 
-module.exports = NoteWidget;
+module.exports = NoteWidget;

CliClient/app/gui/StatusBarWidget.js

@@ -2,9 +2,9 @@ const BaseWidget = require('tkwidgets/BaseWidget.js');
 const chalk = require('chalk');
 const termutils = require('tkwidgets/framework/termutils.js');
 const stripAnsi = require('strip-ansi');
+const { handleAutocompletion } = require('../autocompletion.js');
 
 class StatusBarWidget extends BaseWidget {
-
 	constructor() {
 		super();
 
@@ -41,6 +41,7 @@ class StatusBarWidget extends BaseWidget {
 		};
 
 		if ('cursorPosition' in options) this.promptState_.cursorPosition = options.cursorPosition;
+		if ('secure' in options) this.promptState_.secure = options.secure;
 
 		this.promptState_.promise = new Promise((resolve, reject) => {
 			this.promptState_.resolve = resolve;
@@ -73,7 +74,7 @@ class StatusBarWidget extends BaseWidget {
 		super.render();
 
 		const doSaveCursor = !this.promptActive;
-		
+
 		if (doSaveCursor) this.term.saveCursor();
 
 		this.innerClear();
@@ -85,14 +86,13 @@ class StatusBarWidget extends BaseWidget {
 
 		//const textStyle = this.promptActive ? (s) => s : chalk.bgBlueBright.white;
 		//const textStyle = (s) => s;
-		const textStyle = this.promptActive ? (s) => s : chalk.gray;
+		const textStyle = this.promptActive ? s => s : chalk.gray;
 
 		this.term.drawHLine(this.absoluteInnerX, this.absoluteInnerY, this.innerWidth, textStyle(' '));
 
 		this.term.moveTo(this.absoluteInnerX, this.absoluteInnerY);
 
 		if (this.promptActive) {
-
 			this.term.write(textStyle(this.promptState_.promptString));
 
 			if (this.inputEventEmitter_) {
@@ -104,13 +104,19 @@ class StatusBarWidget extends BaseWidget {
 
 			this.term.showCursor(true);
 
+			const isSecurePrompt = !!this.promptState_.secure;
+
 			let options = {
 				cancelable: true,
 				history: this.history,
 				default: this.promptState_.initialText,
+				autoComplete: handleAutocompletion,
+				autoCompleteHint: true,
+				autoCompleteMenu: true,
 			};
 
 			if ('cursorPosition' in this.promptState_) options.cursorPosition = this.promptState_.cursorPosition;
+			if (isSecurePrompt) options.echoChar = true;
 
 			this.inputEventEmitter_ = this.term.inputField(options, (error, input) => {
 				let resolveResult = null;
@@ -125,7 +131,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 (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);
 					}
 				}
 
@@ -144,19 +151,15 @@ class StatusBarWidget extends BaseWidget {
 				// Only callback once everything has been cleaned up and reset
 				resolveFn(resolveResult);
 			});
-
 		} else {
-
 			for (let i = 0; i < this.items_.length; i++) {
 				const s = this.items_[i].substr(0, this.innerWidth - 1);
 				this.term.write(textStyle(s));
 			}
-
 		}
 
 		if (doSaveCursor) this.term.restoreCursor();
 	}
-
 }
 
-module.exports = StatusBarWidget;
+module.exports = StatusBarWidget;

CliClient/app/help-utils.js

@@ -1,10 +1,7 @@
-const fs = require('fs-extra');
 const { wrap } = require('lib/string-utils.js');
-const { Setting } = require('lib/models/setting.js');
-const { fileExtension, basename, dirname } = require('lib/path-utils.js');
-const { _, setLocale, languageCode } = require('lib/locale.js');
+const Setting = require('lib/models/Setting.js');
+const { _ } = require('lib/locale.js');
 
-const rootDir = dirname(dirname(__dirname));
 const MAX_WIDTH = 78;
 const INDENT = '    ';
 
@@ -16,14 +13,14 @@ function renderTwoColumnData(options, baseIndent, width) {
 		let option = options[i];
 		const flag = option[0];
 		const indent = baseIndent + INDENT + ' '.repeat(optionColWidth + 2);
-		
+
 		let r = wrap(option[1], indent, width);
 		r = r.substr(flag.length + (baseIndent + INDENT).length);
 		r = baseIndent + INDENT + flag + r;
 		output.push(r);
 	}
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function renderCommandHelp(cmd, width = null) {
@@ -44,7 +41,7 @@ function renderCommandHelp(cmd, width = null) {
 	}
 
 	if (cmd.name() === 'config') {
-		const renderMetadata = (md) => {
+		const renderMetadata = md => {
 			let desc = [];
 
 			if (md.label) {
@@ -53,9 +50,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)')));
@@ -68,13 +64,13 @@ function renderCommandHelp(cmd, width = null) {
 				} else if (md.type === Setting.TYPE_INT) {
 					defaultString = (md.value ? md.value : 0).toString();
 				} else if (md.type === Setting.TYPE_BOOL) {
-					defaultString = (md.value === true ? 'true' : 'false');
+					defaultString = md.value === true ? 'true' : 'false';
 				}
 			}
-			
+
 			if (defaultString !== null) desc.push(_('Default: %s', defaultString));
 
-			return [md.key, desc.join("\n")];
+			return [md.key, desc.join('\n')];
 		};
 
 		output.push('');
@@ -84,7 +80,7 @@ function renderCommandHelp(cmd, width = null) {
 		let keysValues = [];
 		const keys = Setting.keys(true, 'cli');
 		for (let i = 0; i < keys.length; i++) {
-			if (keysValues.length) keysValues.push(['','']);
+			if (keysValues.length) keysValues.push(['', '']);
 			const md = Setting.settingMetadata(keys[i]);
 			if (!md.label) continue;
 			keysValues.push(renderMetadata(md));
@@ -92,8 +88,8 @@ function renderCommandHelp(cmd, width = null) {
 
 		output.push(renderTwoColumnData(keysValues, baseIndent, width));
 	}
-	
-	return output.join("\n");
+
+	return output.join('\n');
 }
 
 function getOptionColWidth(options) {
@@ -105,4 +101,4 @@ function getOptionColWidth(options) {
 	return output;
 }
 
-module.exports = { renderCommandHelp };
+module.exports = { renderCommandHelp };

CliClient/app/main.js

@@ -1,26 +1,40 @@
 #!/usr/bin/env node
 
-// Loading time: 20170803: 1.5s with no commands
+// 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);
 
+const compareVersion = require('compare-version');
+const nodeVersion = process && process.versions && process.versions.node ? process.versions.node : '0.0.0';
+if (compareVersion(nodeVersion, '8.0.0') < 0) {
+	console.error('Joplin requires Node 8+. Detected version ' + nodeVersion);
+	process.exit(1);
+}
+
 const { app } = require('./app.js');
-const { BaseModel } = require('lib/base-model.js');
-const { Folder } = require('lib/models/folder.js');
-const { Resource } = require('lib/models/resource.js');
-const { BaseItem } = require('lib/models/base-item.js');
-const { Note } = require('lib/models/note.js');
-const { Tag } = require('lib/models/tag.js');
-const { NoteTag } = require('lib/models/note-tag.js');
-const { Setting } = require('lib/models/setting.js');
+const Folder = require('lib/models/Folder.js');
+const Resource = require('lib/models/Resource.js');
+const BaseItem = require('lib/models/BaseItem.js');
+const Note = require('lib/models/Note.js');
+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');
 const { _ } = require('lib/locale.js');
+const { FileApiDriverLocal } = require('lib/file-api-driver-local.js');
+const EncryptionService = require('lib/services/EncryptionService');
 
 const fsDriver = new FsDriverNode();
 Logger.fsDriver_ = fsDriver;
 Resource.fsDriver_ = fsDriver;
+EncryptionService.fsDriver_ = fsDriver;
+FileApiDriverLocal.fsDriver_ = fsDriver;
 
 // That's not good, but it's to avoid circular dependency issues
 // in the BaseItem class.
@@ -29,6 +43,8 @@ BaseItem.loadClass('Folder', Folder);
 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');
@@ -37,25 +53,32 @@ shimInit();
 
 const application = app();
 
-if (process.platform === "win32") {
-	var rl = require("readline").createInterface({
+if (process.platform === 'win32') {
+	var rl = require('readline').createInterface({
 		input: process.stdin,
-		output: process.stdout
+		output: process.stdout,
 	});
 
-	rl.on("SIGINT", function () {
-		process.emit("SIGINT");
+	rl.on('SIGINT', function() {
+		process.emit('SIGINT');
 	});
 }
 
-process.stdout.on('error', function( err ) {
+process.stdout.on('error', function(err) {
 	// https://stackoverflow.com/questions/12329816/error-write-epipe-when-piping-node-output-to-head#15884508
-	if (err.code == "EPIPE") {
+	if (err.code == 'EPIPE') {
 		process.exit(0);
 	}
 });
 
-application.start(process.argv).catch((error) => {
-	console.error(_('Fatal error:'));
-	console.error(error);
-});
+application.start(process.argv).catch(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/app/onedrive-api-node-utils.js

@@ -1,13 +1,11 @@
 const { _ } = require('lib/locale.js');
 const { netUtils } = require('lib/net-utils.js');
 
-const http = require("http");
-const urlParser = require("url");
-const FormData = require('form-data');
+const http = require('http');
+const urlParser = require('url');
 const enableServerDestroy = require('server-destroy');
 
 class OneDriveApiNodeUtils {
-
 	constructor(api) {
 		this.api_ = api;
 		this.oauthServer_ = null;
@@ -48,7 +46,7 @@ class OneDriveApiNodeUtils {
 
 		let authCodeUrl = this.api().authCodeUrl('http://localhost:' + port);
 
-		return new Promise((resolve, reject) => {			
+		return new Promise((resolve, reject) => {
 			this.oauthServer_ = http.createServer();
 			let errorMessage = null;
 
@@ -56,7 +54,7 @@ class OneDriveApiNodeUtils {
 				const url = urlParser.parse(request.url, true);
 
 				if (url.pathname === '/auth') {
-					response.writeHead(302, { 'Location': authCodeUrl });
+					response.writeHead(302, { Location: authCodeUrl });
 					response.end();
 					return;
 				}
@@ -64,10 +62,10 @@ class OneDriveApiNodeUtils {
 				const query = url.query;
 
 				const writeResponse = (code, message) => {
-					response.writeHead(code, {"Content-Type": "text/html"});
+					response.writeHead(code, { 'Content-Type': 'text/html' });
 					response.write(this.makePage(message));
 					response.end();
-				}
+				};
 
 				// After the response has been received, don't destroy the server right
 				// away or the browser might display a connection reset error (even
@@ -77,21 +75,24 @@ class OneDriveApiNodeUtils {
 						this.oauthServer_.destroy();
 						this.oauthServer_ = null;
 					}, 1000);
-				}
+				};
 
 				if (!query.code) return writeResponse(400, '"code" query parameter is missing');
 
-				this.api().execTokenRequest(query.code, 'http://localhost:' + port.toString()).then(() => {
-					writeResponse(200, _('The application has been authorised - you may now close this browser tab.'));
-					targetConsole.log('');
-					targetConsole.log(_('The application has been successfully authorised.'));
-					waitAndDestroy();
-				}).catch((error) => {
-					writeResponse(400, error.message);
-					targetConsole.log('');
-					targetConsole.log(error.message);
-					waitAndDestroy();
-				});
+				this.api()
+					.execTokenRequest(query.code, 'http://localhost:' + port.toString())
+					.then(() => {
+						writeResponse(200, _('The application has been authorised - you may now close this browser tab.'));
+						targetConsole.log('');
+						targetConsole.log(_('The application has been successfully authorised.'));
+						waitAndDestroy();
+					})
+					.catch(error => {
+						writeResponse(400, error.message);
+						targetConsole.log('');
+						targetConsole.log(error.message);
+						waitAndDestroy();
+					});
 			});
 
 			this.oauthServer_.on('close', () => {
@@ -116,7 +117,6 @@ class OneDriveApiNodeUtils {
 			targetConsole.log('http://127.0.0.1:' + port + '/auth');
 		});
 	}
-
 }
 
-module.exports = { OneDriveApiNodeUtils };
+module.exports = { OneDriveApiNodeUtils };

CliClient/build.sh

@@ -4,6 +4,6 @@ ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 BUILD_DIR="$ROOT_DIR/build"
 
 rsync -a --exclude "node_modules/" "$ROOT_DIR/app/" "$BUILD_DIR/"
-rsync -a "$ROOT_DIR/../ReactNativeClient/lib/" "$BUILD_DIR/lib/"
+rsync -a --delete "$ROOT_DIR/../ReactNativeClient/lib/" "$BUILD_DIR/lib/"
 cp "$ROOT_DIR/package.json" "$BUILD_DIR"
 chmod 755 "$BUILD_DIR/main.js"