Merge upstream/develop a0aedd6

Author: gberche-orange

CHANGELOG.md

@@ -1,3 +1,32 @@
+# 1.6.1
+ * NEW: Hook aceRegisterNonScrollableEditEvents to register events that shouldn't scroll
+ * NEW: Added 'item' parameter to registerAceCommand Hook
+ * NEW: Added LibreJS support
+ * Fix: Crash on malformed export url
+ * Fix: Re-enable editor after user is reconnected to server
+ * Fix: minification
+ * Other: Added 'no-referrer' for all pads
+ * Other: Improved cookie security
+ * Other: Fixed compatibility with nodejs 7
+ * Other: Updates
+  - socket.io to 1.6.0
+  - express to 4.13.4
+  - express-session to 1.13.0
+  - clean-css to 3.4.12
+  - uglify-js to 2.6.2
+  - log4js to 0.6.35
+  - cheerio to 0.20.0
+  - ejs to 2.4.1
+  - graceful-fs to 4.1.3
+  - semver to 5.1.0
+  - unorm to 1.4.1
+  - jsonminify to 0.4.1
+  - measured to 1.1.0
+  - mocha to 2.4.5
+  - supertest to 1.2.0
+  - npm to 4.0.2
+  - Node.js for Windows to 6.9.2
+
 # 1.6.0
  * SECURITY: Fix a possible xss attack in iframe link
  * NEW: Add a aceSelectionChanged hook to allow plugins to react when the cursor location changes.

bin/doc/README.md

@@ -72,5 +72,5 @@ Each type of heading has a description block.
 
 Run the following from the etherpad-lite root directory:
 ```sh
-$ node tools/doc/generate doc/index.md --format=html --template=doc/template.html > out.html
+$ node bin/doc/generate doc/index.md --format=html --template=doc/template.html > out.html
 ```

bin/installDeps.sh

@@ -95,7 +95,7 @@ if [ -f "src/static/js/jquery.js" ]; then
 fi
 
 if [ $DOWNLOAD_JQUERY = "true" ]; then
-  curl -lo src/static/js/jquery.js http://code.jquery.com/jquery-$NEEDED_VERSION.js || exit 1
+  curl -lo src/static/js/jquery.js https://code.jquery.com/jquery-$NEEDED_VERSION.js || exit 1
 fi
 
 #Remove all minified data to force node creating it new

doc/api/editbar.md

@@ -1,5 +1,5 @@
 # Editbar
-srf/static/js/pad_editbar.js
+src/static/js/pad_editbar.js
 
 ## isEnabled()
 
@@ -25,4 +25,4 @@ toolbar.registerAceCommand("insertorderedlist", function (cmd, ace) {
 Ties a `div.popup` where `id` equals `dropdown` to a `command` fired by clicking a button.
 
 ## triggerCommand(cmd[, item])
-Triggers a command (optionally with some internal representation of the toolbar item that triggered it).
+Triggers a command (optionally with some internal representation of the toolbar item that triggered it).

doc/api/editorInfo.md

@@ -69,9 +69,9 @@ This function replaces a range (from y1 to y2) with `newText`.
 ## editorInfo.ace_renumberList(lineNum)
 If you delete a line, calling this method will fix the line numbering.
 ## editorInfo.ace_doReturnKey()
-Forces a return key at the current carret position.
+Forces a return key at the current caret position.
 ## editorInfo.ace_isBlockElement(element)
-Returns true if your passed elment is registered as a block element
+Returns true if your passed element is registered as a block element
 ## editorInfo.ace_getLineListType(lineNum)
 Returns the line's html list type.
 ## editorInfo.ace_caretLine()

doc/api/hooks_server-side.md

@@ -36,7 +36,7 @@ Things in context: None
 This function is called after a specific plugin is initialized. This would probably be more useful than the previous two functions if you only wanted to add in features to one specific plugin.
 
 ## expressConfigure
-Called from: src/node/server.js
+Called from: src/node/hooks/express.js
 
 Things in context:
 
@@ -45,7 +45,7 @@ Things in context:
 This is a helpful hook for changing the behavior and configuration of the application. It's called right after the application gets configured.
 
 ## expressCreateServer
-Called from: src/node/server.js
+Called from: src/node/hooks/express.js
 
 Things in context:
 
@@ -72,7 +72,7 @@ Available blocks in `pad.html` are:
  * `editbarMenuRight` - right tool bar
  * `afterEditbar` - allows you to add stuff immediately after the toolbar
  * `userlist` - the contents of the userlist dropdown
- * `loading` - the intial loading message
+ * `loading` - the initial loading message
  * `mySettings` - the left column of the settings dropdown ("My view"); intended for adding checkboxes only
  * `mySettings.dropdowns` - add your dropdown settings here
  * `globalSettings` - the right column of the settings dropdown ("Global view")
@@ -104,9 +104,9 @@ Things in context:
 
 Here you can add custom toolbar items that will be available in the toolbar config in `settings.json`. For more about the toolbar controller see the API section.
 
-Usage examples: 
+Usage examples:
 
-* [https://github.com/tiblu/ep_authorship_toggle]()
+* https://github.com/tiblu/ep_authorship_toggle
 
 ## padCreate
 Called from: src/node/db/Pad.js
@@ -137,6 +137,20 @@ Things in context:
 
 This hook gets called when an existing pad was updated.
 
+## padCopy
+Called from: src/node/db/Pad.js
+
+Things in context:
+
+1. originalPad - the source pad instance
+2. destinationID - the id of the pad copied from originalPad
+
+This hook gets called when an existing pad was copied.
+
+Usage examples:
+
+* https://github.com/ether/ep_comments
+
 ## padRemove
 Called from: src/node/db/Pad.js
 
@@ -146,6 +160,10 @@ Things in context:
 
 This hook gets called when an existing pad was removed/deleted.
 
+Usage examples:
+
+* https://github.com/ether/ep_comments
+
 ## socketio
 Called from: src/node/hooks/express/socketio.js
 

doc/api/http_api.md

@@ -3,42 +3,42 @@
 ## What can I do with this API?
 The API gives another web application control of the pads. The basic functions are
 
-* create/delete pads 
+* create/delete pads
 * grant/forbid access to pads
 * get/set pad content
 
 The API is designed in a way, so you can reuse your existing user system with their permissions, and map it to Etherpad. Means: Your web application still has to do authentication, but you can tell Etherpad via the api, which visitors should get which permissions. This allows Etherpad to fit into any web application and extend it with real-time functionality. You can embed the pads via an iframe into your website.
 
-Take a look at [HTTP API client libraries](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) to see if a library in your favorite language.
+Take a look at [HTTP API client libraries](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) to check if a library in your favorite programming language is available.
 
 ## Examples
 
 ### Example 1
 
-A portal (such as WordPress) wants to give a user access to a new pad. Let's assume the user have the internal id 7 and his name is michael. 
+A portal (such as WordPress) wants to give a user access to a new pad. Let's assume the user have the internal id 7 and his name is michael.
 
-Portal maps the internal userid to an etherpad author. 
+Portal maps the internal userid to an etherpad author.
 
 > Request: `http://pad.domain/api/1/createAuthorIfNotExistsFor?apikey=secret&name=Michael&authorMapper=7`
-> 
+>
 > Response: `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
 
 Portal maps the internal userid to an etherpad group:
 
 > Request: `http://pad.domain/api/1/createGroupIfNotExistsFor?apikey=secret&groupMapper=7`
-> 
+>
 > Response: `{code: 0, message:"ok", data: {groupID: "g.s8oes9dhwrvt0zif"}}`
 
 Portal creates a pad in the userGroup
 
 > Request: `http://pad.domain/api/1/createGroupPad?apikey=secret&groupID=g.s8oes9dhwrvt0zif&padName=samplePad&text=This is the first sentence in the pad`
-> 
+>
 > Response: `{code: 0, message:"ok", data: null}`
 
 Portal starts the session for the user on the group:
 
 > Request: `http://pad.domain/api/1/createSession?apikey=secret&groupID=g.s8oes9dhwrvt0zif&authorID=a.s8oes9dhwrvt0zif&validUntil=1312201246`
-> 
+>
 > Response: `{"data":{"sessionID": "s.s8oes9dhwrvt0zif"}}`
 
 Portal places the cookie "sessionID" with the given value on the client and creates an iframe including the pad.
@@ -50,7 +50,7 @@ A portal (such as WordPress) wants to transform the contents of a pad that multi
 Portal retrieves the contents of the pad for entry into the db as a blog post:
 
 > Request: `http://pad.domain/api/1/getText?apikey=secret&padID=g.s8oes9dhwrvt0zif$123`
-> 
+>
 > Response: `{code: 0, message:"ok", data: {text:"Welcome Text"}}`
 
 Portal submits content into new blog post
@@ -103,7 +103,7 @@ Responses are valid JSON in the following format:
 
 ### Authentication
 
-Authentication works via a token that is sent with each request as a post parameter.  There is a single token per Etherpad deployment.  This token will be random string, generated by Etherpad at the first start. It will be saved in APIKEY.txt in the root folder of Etherpad. Only Etherpad and the requesting application knows this key. Token management will not be exposed through this API. 
+Authentication works via a token that is sent with each request as a post parameter.  There is a single token per Etherpad deployment.  This token will be random string, generated by Etherpad at the first start. It will be saved in APIKEY.txt in the root folder of Etherpad. Only Etherpad and the requesting application knows this key. Token management will not be exposed through this API.
 
 ### Node Interoperability
 
@@ -123,7 +123,7 @@ Pads can belong to a group. The padID of grouppads is starting with a groupID li
 
 #### createGroup()
  * API >= 1
- 
+
 creates a new group
 
 *Example returns:*
@@ -132,7 +132,7 @@ creates a new group
 #### createGroupIfNotExistsFor(groupMapper)
  * API >= 1
 
-this functions helps you to map your application group ids to Etherpad group ids 
+this functions helps you to map your application group ids to Etherpad group ids
 
 *Example returns:*
   * `{code: 0, message:"ok", data: {groupID: g.s8oes9dhwrvt0zif}}`
@@ -175,7 +175,7 @@ lists all existing groups
   * `{code: 0, message:"ok", data: {groupIDs: []}}`
 
 ### Author
-These authors are bound to the attributes the users choose (color and name). 
+These authors are bound to the attributes the users choose (color and name).
 
 #### createAuthor([name])
  * API >= 1
@@ -188,7 +188,7 @@ creates a new author
 #### createAuthorIfNotExistsFor(authorMapper [, name])
  * API >= 1
 
-this functions helps you to map your application author ids to Etherpad author ids 
+this functions helps you to map your application author ids to Etherpad author ids
 
 *Example returns:*
   * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
@@ -411,7 +411,7 @@ creates a chat message, saves it to the database and sends it to all connected c
 * `{code: 1, message:"text is no string", data: null}`
 
 ### Pad
-Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security manager controls access of them and its forbidden for normal pads to include a $ in the name. 
+Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security manager controls access of them and its forbidden for normal pads to include a $ in the name.
 
 #### createPad(padID [, text])
  * API >= 1
@@ -575,7 +575,7 @@ returns the timestamp of the last revision of the pad
 *Example returns:*
   * `{code: 0, message:"ok", data: {lastEdited: 1340815946602}}`
   * `{code: 1, message:"padID does not exist", data: null}`
-  
+
 #### sendClientsMessage(padID, msg)
  * API >= 1.1
 
@@ -598,7 +598,7 @@ returns ok when the current api token is valid
 
 #### listAllPads()
  * API >= 1.2.1
- 
+
 lists all pads on this epl instance
 
 *Example returns:*

doc/database.md

@@ -6,7 +6,7 @@
 A list of all existing groups (a JSON object with groupIDs as keys and `1` as values).
 
 ### pad:$PADID
-Saves all informations about pads
+Contains all information about pads
 
 * **atext** - the latest attributed text
 * **pool** - the attribute pool
@@ -24,10 +24,10 @@ Saves a revision $REVNUM of pad $PADID
 * **changeset** - the changeset of this revision
 
 ### pad:$PADID:chat:$CHATNUM
-Saves a chatentry with num $CHATNUM of pad $PADID
+Saves a chat entry with num $CHATNUM of pad $PADID
 
 * **text** - the text of this chat entry
-* **userId** - the autorID of this chat entry
+* **userId** - the authorID of this chat entry
 * **time** - the timestamp of this chat entry
 
 ### pad2readonly:$PADID
@@ -43,9 +43,9 @@ Information about an author
 * **colorID** - the colorID of this author as shown in the pad
 
 ### mapper2group:$MAPPER
-Maps an external application identifier to an internal group 
+Maps an external application identifier to an internal group
 ### mapper2author:$MAPPER
-Maps an external application identifier to an internal author 
+Maps an external application identifier to an internal author
 ### group:$GROUPID
 a group of pads
 

doc/documentation.md

@@ -11,5 +11,5 @@ heading.
 
 Every `.html` file is generated based on the corresponding
 `.markdown` file in the `doc/api/` folder in the source tree. The
-documentation is generated using the `tools/doc/generate.js` program.
-The HTML template is located at `doc/template.html`.
+documentation is generated using the `bin/doc/generate.js` program.
+The HTML template is located at `doc/template.html`.

doc/localization.md

@@ -1,5 +1,5 @@
 # Localization
-Etherpad provides a  multi-language user interface, that's apart from your users' content, so users from different countries can collaborate on a single document, while still having the user interface displayed in their mother tongue.
+Etherpad provides a multi-language user interface, that's apart from your users' content, so users from different countries can collaborate on a single document, while still having the user interface displayed in their mother tongue.
 
 
 ## Translating
@@ -31,7 +31,7 @@ Translations will be send back to us regularly and will eventually appear in the
 Each translation consists of a key (the id of the string that is to be translated) and the translated string. Terms in curly braces must not be touched but left as they are, since they represent a dynamically changing part of the string like a variable. Imagine a message welcoming a user: `Welcome, {{userName}}!` would be translated as `Ahoy, {{userName}}!` in pirate.
 
 ### Client-side
-We use a `language` cookie to save your language settings if you change them. If you don't, we autodetect your locale using information from your browser. Now, that we know your preferred language this information is feeded into a very nice library called [html10n.js](https://github.com/marcelklehr/html10n.js), which loads the appropriate translations and applies them to our templates, providing translation params, pluralization, include rules and even a nice javascript API along the way.
+We use a `language` cookie to save your language settings if you change them. If you don't, we autodetect your locale using information from your browser. Then, the preferred language is fed into a library called [html10n.js](https://github.com/marcelklehr/html10n.js), which loads the appropriate translations and applies them to our templates. Its features include translation params, pluralization, include rules and a nice javascript API.
 
 
 
@@ -79,7 +79,7 @@ alert(window._('pad.chat'));
 }
 ```
 
-Everytime the http server is started, it will auto-detect your messages and merge them automatically with the core messages.
+Every time the http server is started, it will auto-detect your messages and merge them automatically with the core messages.
 
 ### Overwrite core messages