<<t title || "ProsePad">>

├── data └── .gitkeep ├── public ├── favicon.ico └── css │ ├── editor-base.css │ └── site.css ├── .gitignore ├── templates ├── header.html ├── foot.html ├── head.html └── editor.html ├── src ├── collab │ ├── server │ │ ├── defaultinstances.js │ │ ├── start.js │ │ ├── route.js │ │ ├── comments.js │ │ ├── instance.js │ │ └── server.js │ ├── schema.js │ └── client │ │ ├── fullpage.js │ │ ├── reporter.js │ │ ├── http.js │ │ ├── startpage.js │ │ ├── users.js │ │ ├── chat.js │ │ ├── connection.js │ │ ├── prosepad.js │ │ └── comment.js ├── mold.js └── build │ └── build.js ├── README.md ├── Makefile ├── pages └── index.html ├── package.json ├── rollup.config.js └── LICENSE /data/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adrianheine/ProsePad/HEAD/public/favicon.ico -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /lib/build.js 2 | /lib/server.js 3 | /node_modules 4 | /public/index.html 5 | /public/js/fullpage.js 6 | /public/js/startpage.js 7 | /public/css/editor.css 8 | .tern-port 9 | /data/instances.json 10 | -------------------------------------------------------------------------------- /templates/header.html: -------------------------------------------------------------------------------- 1 |

2 | 8 |

9 | -------------------------------------------------------------------------------- /templates/foot.html: -------------------------------------------------------------------------------- 1 | 9 | -------------------------------------------------------------------------------- /templates/head.html: -------------------------------------------------------------------------------- 1 | <> 2 | 3 | 4 | 5 | 6 | <<t title || "ProsePad">> 7 | 8 | -------------------------------------------------------------------------------- /src/collab/server/defaultinstances.js: -------------------------------------------------------------------------------- 1 | import {schema} from "../schema" 2 | 3 | const $node = (type, attrs, content, marks) => schema.node(type, attrs, content, marks) 4 | const $text = (str, marks) => schema.text(str, marks) 5 | const em = schema.marks.em.create(), strong = schema.marks.strong.create() 6 | 7 | export function populateDefaultInstances(newInstance) { 8 | } 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ProsePad 2 | 3 | ProsePad is a real-time collaborative text editor like 4 | [Etherpad](http://etherpad.org), but based on 5 | [ProseMirror](http://prosemirror.net). 6 | 7 | ## Installation 8 | 9 | Install [Node.js](http://nodejs.org). 10 | 11 | Install the module's dependencies: 12 | 13 | ```bash 14 | npm install 15 | ``` 16 | 17 | Start the server 18 | 19 | ``` 20 | PORT=8888 npm start 21 | ``` 22 | 23 | That will get you a server at [localhost:8888](http://localhost:8888/). 24 | -------------------------------------------------------------------------------- /src/mold.js: -------------------------------------------------------------------------------- 1 | import fs from "fs" 2 | import Mold from "mold-template" 3 | 4 | var templateDir = __dirname + "/../templates/" 5 | 6 | const mold = new Mold({}) 7 | const buildFile = function(file, name) { 8 | var text = fs.readFileSync(file, "utf8").trim() 9 | return mold.bake(name, text) 10 | } 11 | 12 | fs.readdirSync(templateDir).forEach(function(filename) { 13 | var match = /^(.*?)\.html$/.exec(filename) 14 | if (match) 15 | buildFile(templateDir + match[0], match[1]) 16 | }) 17 | 18 | export default mold 19 | -------------------------------------------------------------------------------- /src/collab/server/start.js: -------------------------------------------------------------------------------- 1 | import {createServer} from "http" 2 | import ProsePadServer from "./server" 3 | 4 | const port = process.env.PORT 5 | 6 | const server = new ProsePadServer({ 7 | cookie_secret: "a" 8 | }) 9 | 10 | // The collaborative editing document server. 11 | createServer((req, resp) => { 12 | if (!server.handle(req, resp)) { 13 | resp.writeHead(404, {"Content-Type": "text/plain"}) 14 | resp.end("Not found") 15 | } 16 | }).listen(port/*, "127.0.0.1"*/) 17 | 18 | console.log("ProsePad server listening on " + port) 19 | -------------------------------------------------------------------------------- /src/build/build.js: -------------------------------------------------------------------------------- 1 | import path from "path" 2 | import fs from "fs" 3 | 4 | var pageDir = path.resolve("pages/") 5 | var outDir = path.resolve("public/") 6 | 7 | import mold from "../mold" 8 | 9 | const buildFile = function(file) { 10 | var text = fs.readFileSync(file, "utf8").trim() 11 | return mold.bake(file, text)() 12 | } 13 | 14 | process.argv.slice(2).forEach(function(file) { 15 | var result = buildFile(file) 16 | var outfile = outDir + path.resolve(file).slice(pageDir.length).replace(/\.\w+$/, ".html") 17 | fs.writeFileSync(outfile, result, "utf8") 18 | }) 19 | -------------------------------------------------------------------------------- /src/collab/schema.js: -------------------------------------------------------------------------------- 1 | import {Schema} from "prosemirror-model" 2 | import {schema as base} from "prosemirror-schema-basic" 3 | import {addListNodes} from "prosemirror-schema-list" 4 | 5 | const marks = base.spec.marks.addToEnd("user", { 6 | attrs: {user: {}}, 7 | parseDOM: [{tag: "span", getAttrs: dom => ({user: dom.getAttribute("data-user")})}], 8 | toDOM(node) { return ["span", {class: "author-" + node.attrs.user, "data-user": node.attrs.user}] } 9 | }) 10 | 11 | export const schema = new Schema({ 12 | nodes: addListNodes(base.spec.nodes, "paragraph block*", "block"), 13 | marks 14 | }) 15 | -------------------------------------------------------------------------------- /src/collab/client/fullpage.js: -------------------------------------------------------------------------------- 1 | import {getChatProsePadPlugin} from "./chat" 2 | import {commentsProsePadPlugin} from "./comment" 3 | import {ProsePad} from "./prosepad" 4 | import {Reporter} from "./reporter" 5 | import {getUsersProsePadPlugin} from "./users" 6 | 7 | const plugins = [ 8 | getChatProsePadPlugin({ 9 | messages: document.querySelector(".chat"), 10 | form: document.querySelector(".chatform") 11 | }), 12 | commentsProsePadPlugin, 13 | getUsersProsePadPlugin({ 14 | users: document.getElementById("users"), 15 | username: document.getElementById("username") 16 | }) 17 | ] 18 | 19 | const data = document.getElementById("data") 20 | const prosepad = new ProsePad(new Reporter(), plugins, document.getElementById("editor")) 21 | prosepad.loadData(JSON.parse(data.textContent), document.location) 22 | data.parentNode.removeChild(data) 23 | -------------------------------------------------------------------------------- /src/collab/client/reporter.js: -------------------------------------------------------------------------------- 1 | export class Reporter { 2 | constructor() { 3 | this.state = this.node = null 4 | this.setAt = 0 5 | } 6 | 7 | clearState() { 8 | if (this.state) { 9 | document.body.removeChild(this.node) 10 | this.state = this.node = null 11 | this.setAt = 0 12 | } 13 | } 14 | 15 | failure(err) { 16 | this.show("fail", err.toString()) 17 | } 18 | 19 | delay(err) { 20 | if (this.state == "fail") return 21 | this.show("delay", err.toString()) 22 | } 23 | 24 | show(type, message) { 25 | this.clearState() 26 | this.state = type 27 | this.setAt = Date.now() 28 | this.node = document.body.appendChild(document.createElement("div")) 29 | this.node.className = "ProseMirror-report ProseMirror-report-" + type 30 | this.node.textContent = message 31 | } 32 | 33 | success() { 34 | if (this.state == "fail" && this.setAt > Date.now() - 1000 * 10) 35 | setTimeout(() => this.success(), 5000) 36 | else 37 | this.clearState() 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PAGES:=$(shell find pages -name "*.html") 2 | 3 | ROOT:=$(shell if [ -d node_modules/prosemirror-model ]; then echo node_modules/; else echo ../node_modules/; fi) 4 | 5 | all: $(PAGES:pages/%=public/%) \ 6 | public/js/fullpage.js \ 7 | public/js/startpage.js \ 8 | public/css/editor.css 9 | 10 | public/%.html: pages/%.* templates/* lib/build.js 11 | mkdir -p $(dir $@) 12 | node lib/build.js $< 13 | 14 | lib/build.js: src/build/*.js rollup.config.js 15 | $(ROOT).bin/rollup -c 16 | 17 | public/js/fullpage.js: src/collab/client/*.js rollup.config.js 18 | $(ROOT).bin/rollup -c 19 | 20 | public/js/startpage.js: src/collab/client/*.js rollup.config.js 21 | $(ROOT).bin/rollup -c 22 | 23 | public/css/editor.css: $(ROOT)prosemirror-view/style/prosemirror.css \ 24 | $(ROOT)prosemirror-menu/style/menu.css \ 25 | $(ROOT)prosemirror-example-setup/style/style.css \ 26 | public/css/editor-base.css 27 | cat $^ > $@ 28 | 29 | clean: 30 | rm public/*.html public/js/fullpage.js public/js/startpage.js public/css/editor.css 31 | -------------------------------------------------------------------------------- /public/css/editor-base.css: -------------------------------------------------------------------------------- 1 | #editor, .editor { 2 | background: white; 3 | color: black; 4 | background-clip: padding-box; 5 | border-radius: 4px; 6 | border: 2px solid rgba(0, 0, 0, 0.2); 7 | padding: 5px 0; 8 | } 9 | 10 | .ProseMirror { 11 | padding: 4px 8px 4px 14px; 12 | line-height: 1.2; 13 | outline: none; 14 | overflow: auto; 15 | } 16 | 17 | .ProseMirror p { 18 | font-size: 1em; 19 | line-height: 1.2em; 20 | margin: 1.2em 0; 21 | } 22 | 23 | h1 { 24 | font-size: 2em; 25 | line-height: 1.2em; 26 | margin: 0.6em 0; 27 | text-decoration: underline; 28 | } 29 | 30 | h2 { 31 | font-size: 1.6em; 32 | line-height: 1.5em; 33 | margin: 0.75em 0; 34 | } 35 | 36 | h3 { 37 | font-size: 1.5em; 38 | line-height: 1.6em; 39 | margin: 0.8em 0; 40 | } 41 | 42 | h4, h5, h6 { 43 | font-size: 1.2em; 44 | line-height: 2em; 45 | margin: 1em 0; 46 | } 47 | 48 | .ProseMirror p:first-child, 49 | .ProseMirror h1:first-child, 50 | .ProseMirror h2:first-child, 51 | .ProseMirror h3:first-child, 52 | .ProseMirror h4:first-child, 53 | .ProseMirror h5:first-child, 54 | .ProseMirror h6:first-child { 55 | margin-top: 0; 56 | } 57 | -------------------------------------------------------------------------------- /pages/index.html: -------------------------------------------------------------------------------- 1 | <> 4 | 5 | 38 | 39 | 40 | <

> 41 |

42 | 43 |

44 | ProsePad is a service for collaboratively editing documents. 45 |

46 | 47 |

48 | 49 |

50 | Connected to: 51 | None (…) 52 | 53 | 54 |

55 |

56 | 57 | 58 | 59 | 60 | <> 61 | 62 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "prosepad", 3 | "version": "0.0.1", 4 | "description": "A collaborative editor based on ProseMirror", 5 | "main": "lib/server.js", 6 | "maintainers": [ 7 | { 8 | "name": "Adrian Heine", 9 | "email": "mail@adrianheine.de", 10 | "web": "https://adrianheine.de" 11 | } 12 | ], 13 | "dependencies": { 14 | "client-sessions": "^0.8.0", 15 | "crel": "^3.0.0", 16 | "mold-template": "^2.0.0", 17 | "negotiator": "^0.6.1", 18 | "prosemirror-collab": "^1.0.0", 19 | "prosemirror-commands": "^1.0.0", 20 | "prosemirror-example-setup": "^1.0.0", 21 | "prosemirror-history": "^1.0.0", 22 | "prosemirror-menu": "^1.0.0", 23 | "prosemirror-model": "^1.0.0", 24 | "prosemirror-schema-basic": "^1.0.0", 25 | "prosemirror-schema-list": "^1.0.0", 26 | "prosemirror-state": "^1.2.0", 27 | "prosemirror-transform": "^1.0.9", 28 | "prosemirror-view": "^1.0.0", 29 | "rollup": "^0.57.0", 30 | "rollup-plugin-buble": "0.19.2", 31 | "buble": "0.19.3", 32 | "rollup-plugin-commonjs": "9.1.x", 33 | "rollup-plugin-node-resolve": "^3.3.0", 34 | "rollup-pluginutils": "2.3.3", 35 | "tagged-union": "^1.1.0" 36 | }, 37 | "scripts": { 38 | "start": "node lib/server.js", 39 | "build": "rollup -c", 40 | "watch": "rollup -c -w", 41 | "install": "make" 42 | }, 43 | "license": "AGPL-3.0", 44 | "repository": { 45 | "type": "git", 46 | "url": "git://github.com/adrianheine/ProsePad.git" 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/collab/client/http.js: -------------------------------------------------------------------------------- 1 | // A simple wrapper for XHR. 2 | export function req(conf) { 3 | let req = new XMLHttpRequest(), aborted = false 4 | let result = new Promise((success, failure) => { 5 | req.open(conf.method, conf.url, true) 6 | req.addEventListener("load", () => { 7 | if (aborted) return 8 | if (req.status < 400) { 9 | success(req.responseText) 10 | } else { 11 | let text = req.responseText 12 | if (text && /html/.test(req.getResponseHeader("content-type"))) text = makePlain(text) 13 | let err = new Error("Request failed: " + req.statusText + (text ? "\n\n" + text : "")) 14 | err.status = req.status 15 | failure(err) 16 | } 17 | }) 18 | req.addEventListener("error", () => { if (!aborted) failure(new Error("Network error")) }) 19 | if (conf.headers) for (let header in conf.headers) req.setRequestHeader(header, conf.headers[header]) 20 | req.send(conf.body || null) 21 | }) 22 | result.abort = () => { 23 | if (!aborted) { 24 | req.abort() 25 | aborted = true 26 | } 27 | } 28 | return result 29 | } 30 | 31 | function makePlain(html) { 32 | var elt = document.createElement("div") 33 | elt.innerHTML = html 34 | return elt.textContent.trimLeft().replace(/\n[^]*/, "") 35 | } 36 | 37 | export function GET(url, type = "*/*") { 38 | return req({url, method: "GET", headers: {"Accept": type}}) 39 | } 40 | 41 | export function POST(url, body, type) { 42 | return req({url, method: "POST", body, headers: {"Content-Type": type}}) 43 | } 44 | -------------------------------------------------------------------------------- /rollup.config.js: -------------------------------------------------------------------------------- 1 | import buble from "rollup-plugin-buble" 2 | import nodeResolve from "rollup-plugin-node-resolve" 3 | import commonJS from "rollup-plugin-commonjs" 4 | 5 | const commonJsPlugin = commonJS({ 6 | include: 'node_modules/**', 7 | sourceMap: false 8 | }) 9 | 10 | const browserPlugins = [ 11 | buble({ 12 | exclude: "node_modules/**", 13 | namedFunctionExpressions: false 14 | }), 15 | nodeResolve({ 16 | main: true, 17 | browser: true 18 | }), 19 | commonJsPlugin 20 | ] 21 | 22 | const nodePlugins = [ 23 | buble({ 24 | exclude: "node_modules/**", 25 | target: { node: 4 }, 26 | transforms: { arrow: true } // Work around https://gitlab.com/Rich-Harris/buble/issues/187 27 | }), 28 | nodeResolve({ 29 | main: true 30 | }), 31 | commonJsPlugin 32 | ] 33 | 34 | export default [ 35 | { 36 | input: "src/collab/client/startpage.js", 37 | output: { 38 | file: "public/js/startpage.js", 39 | format: "iife" 40 | }, 41 | plugins: browserPlugins 42 | }, 43 | { 44 | input: "src/collab/client/fullpage.js", 45 | output: { 46 | file: "public/js/fullpage.js", 47 | format: "iife" 48 | }, 49 | plugins: browserPlugins 50 | }, 51 | { 52 | input: "src/collab/server/start.js", 53 | output: { 54 | file: "lib/server.js", 55 | format: "cjs" 56 | }, 57 | plugins: nodePlugins, 58 | external: ["crypto", "events", "url", "fs", "path", "http"] 59 | }, 60 | { 61 | input: "src/build/build.js", 62 | output: { 63 | file: "lib/build.js", 64 | format: "cjs" 65 | }, 66 | plugins: nodePlugins, 67 | external: ["url", "fs", "path", "http"] 68 | } 69 | ] 70 | -------------------------------------------------------------------------------- /src/collab/server/route.js: -------------------------------------------------------------------------------- 1 | import {parse} from "url" 2 | 3 | // A URL router for the server. 4 | export class Router { 5 | constructor() { this.routes = [] } 6 | 7 | add(method, url, handler) { 8 | this.routes.push({method, url, handler}) 9 | } 10 | 11 | // : (union, string) → union 12 | // Check whether a route pattern matches a given URL path. 13 | match(pattern, path) { 14 | if (typeof pattern == "string") { 15 | if (pattern == path) return [] 16 | } else if (pattern instanceof RegExp) { 17 | let match = pattern.exec(path) 18 | return match && match.slice(1) 19 | } else { 20 | let parts = path.slice(1).split("/") 21 | if (parts.length && !parts[parts.length - 1]) parts.pop() 22 | if (parts.length != pattern.length) return null 23 | let result = [] 24 | for (let i = 0; i < parts.length; i++) { 25 | let pat = pattern[i] 26 | if (pat) { 27 | if (pat != parts[i]) return null 28 | } else { 29 | result.push(parts[i]) 30 | } 31 | } 32 | return result 33 | } 34 | } 35 | 36 | // Resolve a request, letting the matching route write a response. 37 | resolve(request, response) { 38 | let parsed = parse(request.url, true) 39 | let path = parsed.pathname 40 | request.query = parsed.query 41 | 42 | return this.routes.some(route => { 43 | let match = route.method == request.method && this.match(route.url, path) 44 | if (!match) return false 45 | 46 | let urlParts = match.map(decodeURIComponent) 47 | route.handler(request, response, ...urlParts) 48 | return true 49 | }) 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /templates/editor.html: -------------------------------------------------------------------------------- 1 | <> 4 | 5 | 80 | 81 | 82 | 83 |

84 |

85 | 86 | 102 | 103 |

104 | 105 | 108 | 109 | 110 | <> 111 | 112 | -------------------------------------------------------------------------------- /src/collab/server/comments.js: -------------------------------------------------------------------------------- 1 | export class Comment { 2 | constructor(from, to, text, id) { 3 | this.from = from 4 | this.to = to 5 | this.text = text 6 | this.id = id 7 | } 8 | 9 | static fromJSON(json) { 10 | return new Comment(json.from, json.to, json.text, json.id) 11 | } 12 | } 13 | 14 | export class Comments { 15 | constructor(comments) { 16 | this.comments = comments || [] 17 | this.events = [] 18 | this.version = 0 19 | } 20 | 21 | mapThrough(mapping) { 22 | for (let i = this.comments.length - 1; i >= 0; i--) { 23 | let comment = this.comments[i] 24 | let from = mapping.map(comment.from, 1), to = mapping.map(comment.to, -1) 25 | if (from >= to) { 26 | this.comments.splice(i, 1) 27 | } else { 28 | comment.from = from 29 | comment.to = to 30 | } 31 | } 32 | } 33 | 34 | created(data) { 35 | this.comments.push(new Comment(data.from, data.to, data.text, data.id)) 36 | this.events.push({type: "create", id: data.id}) 37 | this.version++ 38 | } 39 | 40 | index(id) { 41 | for (let i = 0; i < this.comments.length; i++) 42 | if (this.comments[i].id == id) return i 43 | } 44 | 45 | deleted(id) { 46 | let found = this.index(id) 47 | if (found != null) { 48 | this.comments.splice(found, 1) 49 | this.version++ 50 | this.events.push({type: "delete", id: id}) 51 | return 52 | } 53 | } 54 | 55 | eventsAfter(startIndex) { 56 | let result = [] 57 | for (let i = startIndex; i < this.events.length; i++) { 58 | let event = this.events[i] 59 | if (event.type == "delete") { 60 | result.push(event) 61 | } else { 62 | let found = this.index(event.id) 63 | if (found != null) { 64 | let comment = this.comments[found] 65 | result.push({type: "create", 66 | id: event.id, 67 | text: comment.text, 68 | from: comment.from, 69 | to: comment.to}) 70 | } 71 | } 72 | } 73 | return result 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /src/collab/client/startpage.js: -------------------------------------------------------------------------------- 1 | import crel from "crel" 2 | 3 | import {commentsProsePadPlugin} from "./comment" 4 | import {ProsePad} from "./prosepad" 5 | import {Reporter} from "./reporter" 6 | import {GET} from "./http" 7 | import {getUsersProsePadPlugin, userString} from "./users" 8 | 9 | const report = new Reporter() 10 | let baseUrl = "" 11 | 12 | document.querySelector("#changedoc").addEventListener("click", e => { 13 | GET(baseUrl + "_docs", "application/json").then(data => showDocList(e.target, JSON.parse(data)), 14 | err => report.failure(err)) 15 | }) 16 | 17 | let docList 18 | function showDocList(node, list) { 19 | if (docList) docList.parentNode.removeChild(docList) 20 | 21 | let ul = docList = document.body.appendChild(crel("ul", {class: "doclist"})) 22 | list.forEach(doc => { 23 | ul.appendChild(crel("li", {"data-name": doc.id}, 24 | doc.id + " (" + userString(doc.users) + ")")) 25 | }) 26 | ul.appendChild(crel("li", {"data-new": "true", style: "border-top: 1px solid silver; margin-top: 2px"}, 27 | "Create a new document")) 28 | 29 | let rect = node.getBoundingClientRect() 30 | ul.style.top = (rect.bottom + 10 + pageYOffset - ul.offsetHeight) + "px" 31 | ul.style.left = (rect.left - 5 + pageXOffset) + "px" 32 | 33 | ul.addEventListener("click", e => { 34 | if (e.target.nodeName == "LI") { 35 | ul.parentNode.removeChild(ul) 36 | docList = null 37 | if (e.target.hasAttribute("data-name")) 38 | location = baseUrl + encodeURIComponent(e.target.getAttribute("data-name")) 39 | else 40 | newDocument() 41 | } 42 | }) 43 | } 44 | document.addEventListener("click", () => { 45 | if (docList) { 46 | docList.parentNode.removeChild(docList) 47 | docList = null 48 | } 49 | }) 50 | 51 | function newDocument() { 52 | let name = prompt("Name the new document", "") 53 | if (name) 54 | location = baseUrl + encodeURIComponent(name) 55 | } 56 | 57 | 58 | const plugins = [ 59 | commentsProsePadPlugin, 60 | getUsersProsePadPlugin({users: document.querySelector(".user-count")}) 61 | ] 62 | 63 | document.querySelector("#docname").textContent = "Example" 64 | const prosepad = window.prosepad = new ProsePad(report, plugins, document.getElementById("editor")) 65 | prosepad.start(baseUrl + "Example").then(() => prosepad.view.focus()) 66 | -------------------------------------------------------------------------------- /src/collab/client/users.js: -------------------------------------------------------------------------------- 1 | import {Plugin} from "prosemirror-state" 2 | 3 | class PluginState { 4 | constructor({version, curUser, users, changed = {}}) { 5 | this.version = version 6 | this.curUser = curUser 7 | this.users = users 8 | this.changed = changed 9 | } 10 | 11 | static init(config) { 12 | return new PluginState(config.users || { 13 | version: 0, 14 | curUser: "1", 15 | users: [ {id: "1", name: "Unnamed user", color: "lightsalmon", connected: true} ] 16 | }) 17 | } 18 | 19 | getUser(id) { 20 | return this.users.find(user => user.id == id) 21 | } 22 | 23 | updateCurUser(changed) { 24 | return new PluginState({version: this.version + 1, curUser: this.curUser, users: this.users, changed}) 25 | } 26 | 27 | getUpdates() { 28 | return this.changed 29 | } 30 | 31 | apply(action) { 32 | let newState 33 | if (action.type == "receive") { 34 | let {users, version} = action 35 | newState = users ? new PluginState({version, curUser: this.curUser, users}) : this 36 | if (this.changed.name) { 37 | let curUser = newState.getUser(this.curUser) 38 | if (curUser.name != this.changed.name) throw new Error("Update not applied") 39 | } 40 | } else { 41 | newState = this.updateCurUser({name: action.name}) 42 | } 43 | return newState 44 | } 45 | } 46 | 47 | export const userString = n => `${n} user${(n == 1 ? "" : "s")}` 48 | 49 | export const usersPlugin = new Plugin({ 50 | state: { 51 | init: PluginState.init, 52 | apply(tr, prev) { 53 | let users = tr.getMeta(usersPlugin) 54 | if (users) { 55 | return prev.apply(users) 56 | } else { 57 | return prev 58 | } 59 | } 60 | }, 61 | 62 | view(editorView) { 63 | let styleElement = document.createElement("style") 64 | document.head.appendChild(styleElement) 65 | 66 | let update = view => { 67 | const usersState = usersPlugin.getState(view.state) 68 | styleElement.innerHTML = usersState.users.map(user => `.author-${user.id} { background-color: ${user.color} }`).join("\n") 69 | } 70 | 71 | update(editorView) 72 | 73 | return { 74 | update, 75 | destroy: () => { 76 | styleElement.parentNode.removeChild(styleElement) 77 | } 78 | } 79 | } 80 | }) 81 | 82 | export const getUsersUiPlugin = ({users, username}) => new Plugin({ 83 | view(editorView) { 84 | let update = view => { 85 | const usersState = usersPlugin.getState(view.state) 86 | users.textContent = userString(usersState.users.filter(user => user.connected).length) 87 | if (username) username.value = usersState.getUser(usersState.curUser).name 88 | } 89 | 90 | if (username) username.onchange = e => { // FIXME: also debounced onkeyup 91 | editorView.dispatch(editorView.state.tr.setMeta(usersPlugin, {type: "update", name: username.value})) 92 | } 93 | 94 | update(editorView) 95 | 96 | return { 97 | update, 98 | destroy: () => { 99 | } 100 | } 101 | } 102 | }) 103 | 104 | export const getUsersProsePadPlugin = (domNodes = null) => ({ 105 | key: "users", 106 | 107 | proseMirrorPlugins(dispatch) { 108 | return domNodes ? [ 109 | usersPlugin, 110 | getUsersUiPlugin(domNodes) 111 | ] : [ usersPlugin ] 112 | }, 113 | 114 | getVersion(state) { 115 | return usersPlugin.getState(state).version 116 | }, 117 | 118 | receive(tr, {users, version}) { 119 | tr.setMeta(usersPlugin, {type: "receive", users, version}) 120 | }, 121 | 122 | getSendable(editState) { 123 | let updates = usersPlugin.getState(editState).getUpdates() 124 | return updates.name ? updates : null 125 | }, 126 | 127 | getMenuItem() { 128 | return null 129 | } 130 | }) 131 | -------------------------------------------------------------------------------- /src/collab/client/chat.js: -------------------------------------------------------------------------------- 1 | import crel from "crel" 2 | import {Plugin} from "prosemirror-state" 3 | 4 | import {usersPlugin} from "./users" 5 | 6 | class PluginState { 7 | constructor({unsent = 0, version, messages}) { 8 | this.unsent = unsent 9 | this.version = version 10 | this.messages = messages 11 | } 12 | 13 | unsentMessages() { 14 | return this.unsent ? this.messages.slice(-this.unsent) : [] 15 | } 16 | 17 | static init(config) { 18 | return new PluginState(config.chat || { 19 | unsent: 0, 20 | version: 0, 21 | messages: [] 22 | }) 23 | } 24 | } 25 | 26 | const pad = (s, n, p) => { 27 | const diff = n - s.length 28 | return diff > 0 ? new Array(diff + 1).join(p) + s : s 29 | } 30 | 31 | const getChatPlugin = ({messages, form}) => { 32 | let chatPlugin 33 | const addChatMessage = (state, dispatch, user, text) => { 34 | dispatch(state.tr.setMeta(chatPlugin, {type: "new", message: {date: new Date(state.tr.time).toISOString(), user, text}})) 35 | } 36 | 37 | chatPlugin = new Plugin({ 38 | state: { 39 | init: PluginState.init, 40 | apply(tr, prev) { 41 | let meta = tr.getMeta(chatPlugin) 42 | if (meta) { 43 | if (meta.type === "new") { 44 | let message = meta.message 45 | return new PluginState({unsent: prev.unsent + 1, version: prev.version + 1, messages: prev.messages.concat(message)}) 46 | } else { 47 | return new PluginState({version: meta.version, unsent: prev.unsent - meta.sent, messages: prev.messages.concat(meta.messages)}) 48 | } 49 | } else { 50 | return prev 51 | } 52 | } 53 | }, 54 | view(editorView) { 55 | let update = (editorView, oldEditorState) => { 56 | const editorState = editorView.state 57 | const scrolledDown = messages.scrollTop + messages.offsetHeight >= messages.scrollHeight 58 | messages.innerHTML = "" 59 | chatPlugin.getState(editorState).messages.forEach(({date, user, text}) => { 60 | date = new Date(date) 61 | messages.appendChild(crel("li", {class: `author-${user}`}, [ 62 | crel("span", {class: "author"}, 63 | usersPlugin.getState(editorState).getUser(user).name), 64 | ": ", 65 | crel("span", text), 66 | " (", 67 | crel("time", {title: date.toString(), datetime: date.toISOString()}, `${date.getHours()}:${pad(String(date.getMinutes()), 2, "0")}`), 68 | ")" 69 | ])) 70 | }) 71 | if (scrolledDown) messages.scrollTop = messages.scrollHeight 72 | } 73 | 74 | form.onsubmit = e => { 75 | let textInput = e.target.childNodes[1] 76 | if (textInput.value) { 77 | addChatMessage(editorView.state, editorView.dispatch, usersPlugin.getState(editorView.state).curUser, textInput.value) 78 | textInput.value = "" 79 | } 80 | e.preventDefault() 81 | } 82 | update(editorView, editorView.state) 83 | 84 | return { 85 | update, 86 | destroy: () => { 87 | } 88 | } 89 | } 90 | }) 91 | return chatPlugin 92 | } 93 | 94 | export const getChatProsePadPlugin = domNodes => { 95 | const chatPlugin = getChatPlugin(domNodes) 96 | return { 97 | key: "chat", 98 | 99 | proseMirrorPlugins(dispatch) { 100 | return [ 101 | chatPlugin 102 | ] 103 | }, 104 | 105 | getVersion(state) { 106 | return chatPlugin.getState(state).version 107 | }, 108 | 109 | receive(tr, {version, messages = []}, dataSent) { 110 | let sent = dataSent ? dataSent.messages.length : 0 111 | tr.setMeta(chatPlugin, {type: "receive", version, messages, sent}) 112 | }, 113 | 114 | getSendable(editState) { 115 | let events = chatPlugin.getState(editState).unsentMessages() 116 | return events.length > 0 ? {messages: events, version: chatPlugin.getState(editState).version} : null 117 | }, 118 | 119 | getMenuItem() { 120 | return null 121 | } 122 | } 123 | } 124 | -------------------------------------------------------------------------------- /src/collab/client/connection.js: -------------------------------------------------------------------------------- 1 | import {GET, POST} from "./http" 2 | import Union from "tagged-union" 3 | 4 | function badVersion(err) { 5 | return err.status == 400 && /invalid version/i.test(err) 6 | } 7 | 8 | const Action = new Union(["poll", "requestDone", "recover", "send", "detach"]) 9 | 10 | export class EditorConnection { 11 | constructor(report, url, editor) { 12 | this.report = report 13 | this.url = url 14 | this.state = "ready" 15 | this.request = null 16 | this.backOff = 0 17 | this.editor = editor 18 | } 19 | 20 | // All state changes go through this 21 | dispatch(action) { 22 | this.state = action.match({ 23 | poll: () => { 24 | this.poll() 25 | return "polling" 26 | }, 27 | recover: error => { 28 | if (error.status && error.status < 500) { 29 | this.report.failure(error) 30 | return null 31 | } else { 32 | this.recover(error) 33 | return "recovering" 34 | } 35 | }, 36 | send: sendable => { 37 | this.closeRequest() 38 | this.send(sendable) 39 | return "sending" 40 | }, 41 | detach: () => { 42 | if (this.state != "detached") this.report.failure("Document too big. Detached.") 43 | return "detached" 44 | }, 45 | requestDone: () => { 46 | this.report.success() 47 | this.backOff = 0 48 | return "ready" 49 | } 50 | }) 51 | } 52 | 53 | refresh() { 54 | let sendable 55 | if ((this.state == "polling" || this.state == "ready") && (sendable = this.editor.sendable())) { 56 | this.dispatch(Action.send(sendable)) 57 | } else if (this.state == "ready") { 58 | this.dispatch(Action.poll()) 59 | } 60 | } 61 | 62 | detach() { 63 | this.dispatch(Action.detach()) 64 | } 65 | 66 | // Send a request for events that have happened since the version 67 | // of the document that the client knows about. This request waits 68 | // for a new version of the document to be created if the client 69 | // is already up-to-date. 70 | poll() { 71 | let query = this.editor.getVersionQuery() 72 | this.run(GET(this.url + "/events?" + query, "application/json")).then( 73 | data => { 74 | this.editor.onEvents(data) 75 | if (this.state == "ready") this.dispatch(Action.poll()) 76 | }, 77 | err => { 78 | if (err.status == 410 || badVersion(err)) { 79 | // Too far behind. Revert to server state 80 | this.report.failure(err) 81 | this.editor.onBrokenConnection(err) 82 | } else if (err) { 83 | this.dispatch(Action.recover(err)) 84 | } 85 | } 86 | ) 87 | } 88 | 89 | // Send the given steps to the server 90 | send(sendData) { 91 | let json = JSON.stringify(sendData) 92 | this.run(POST(this.url + "/events", json, "application/json")).then( 93 | data => { 94 | this.editor.handlePostAnswer(data, sendData) 95 | if (this.state == "ready") this.dispatch(Action.poll()) 96 | }, 97 | err => { 98 | if (err.status == 409) { 99 | // The client's document conflicts with the server's version. 100 | // Poll for changes and then try again. 101 | this.backOff = 0 102 | this.dispatch(Action.poll()) 103 | } else if (badVersion(err)) { 104 | this.report.failure(err) 105 | this.editor.onBrokenConnection(err) 106 | } else { 107 | this.dispatch(Action.recover(err)) 108 | } 109 | } 110 | ) 111 | } 112 | 113 | // Try to recover from an error 114 | recover(err) { 115 | let newBackOff = this.backOff ? Math.min(this.backOff * 2, 6e4) : 200 116 | if (newBackOff > 1000 && this.backOff < 1000) this.report.delay(err) 117 | this.backOff = newBackOff 118 | setTimeout(() => { 119 | if (this.state == "recovering") this.dispatch(Action.poll()) 120 | }, this.backOff) 121 | } 122 | 123 | closeRequest() { 124 | if (this.request) { 125 | this.request.abort() 126 | this.request = null 127 | } 128 | } 129 | 130 | run(request) { 131 | return (this.request = request).then(data => { 132 | data = JSON.parse(data) 133 | this.dispatch(Action.requestDone()) 134 | return data 135 | }) 136 | } 137 | } 138 | -------------------------------------------------------------------------------- /src/collab/client/prosepad.js: -------------------------------------------------------------------------------- 1 | import {exampleSetup, buildMenuItems} from "prosemirror-example-setup" 2 | import {Step} from "prosemirror-transform" 3 | import {EditorState} from "prosemirror-state" 4 | import {EditorView} from "prosemirror-view" 5 | import {history} from "prosemirror-history" 6 | import {collab, receiveTransaction, sendableSteps, getVersion} from "prosemirror-collab" 7 | 8 | import {EditorConnection} from "./connection" 9 | import {GET} from "./http" 10 | import {schema} from "../schema" 11 | import {usersPlugin} from "./users" 12 | 13 | export class ConnectionAdapter { 14 | constructor(prosepad) { 15 | this.prosepad = prosepad 16 | } 17 | 18 | getVersionQuery() { 19 | const {state, plugins} = this.prosepad 20 | return "version=" + getVersion(state) + "&" + 21 | plugins.map(plugin => `${plugin.key}Version=${plugin.getVersion(state)}`).join("&") 22 | } 23 | 24 | onEvents(data) { 25 | const {state, plugins} = this.prosepad 26 | if (data.steps && (data.steps.length || plugins.some(plugin => data[plugin.key]))) { 27 | let tr = receiveTransaction(state, data.steps.map(j => Step.fromJSON(schema, j)), data.clientIDs) 28 | plugins.forEach(plugin => data[plugin.key] && plugin.receive(tr, data[plugin.key])) 29 | this.prosepad.dispatch(tr) 30 | } 31 | } 32 | 33 | sendable() { 34 | const {state, plugins} = this.prosepad 35 | const steps = sendableSteps(state) 36 | let nonNull = steps 37 | let sendable = plugins.reduce((res, plugin) => { 38 | let v = res[plugin.key] = plugin.getSendable(state) 39 | nonNull = nonNull || v 40 | return res 41 | }, { 42 | steps: steps ? steps.steps.map(s => s.toJSON()) : [], 43 | clientID: steps ? steps.clientID : 0 44 | }) 45 | if (nonNull) { 46 | sendable.version = getVersion(state) 47 | return sendable 48 | } 49 | } 50 | 51 | handlePostAnswer(data, sentData) { 52 | const {state, plugins} = this.prosepad 53 | const steps = sentData.steps.map(step => Step.fromJSON(schema, step)) 54 | let tr = steps.length > 0 55 | ? receiveTransaction(state, steps, repeat(sentData.clientID, steps.length)) 56 | : state.tr 57 | plugins.forEach(plugin => (data[plugin.key] || sentData[plugin.key]) && plugin.receive(tr, data[plugin.key], sentData[plugin.key])) 58 | this.prosepad.dispatch(tr) 59 | } 60 | 61 | onBrokenConnection(error) { 62 | this.prosepad.start(this.prosepad.connection.url) 63 | } 64 | } 65 | 66 | export class ProsePad { 67 | constructor(reporter, plugins, domNode) { 68 | this.plugins = plugins 69 | this.reporter = reporter 70 | this.domNode = domNode 71 | this.state = null 72 | this.view = null 73 | this.connection = null 74 | } 75 | 76 | // Load the document from the server and start up 77 | start(url) { 78 | return GET(url, "application/json").then( 79 | data => this.loadData(JSON.parse(data), url), 80 | err => { 81 | this.reporter.failure(err) 82 | return Promise.reject(err) 83 | } 84 | ) 85 | } 86 | 87 | loadData(data, url) { 88 | this.connection = new EditorConnection(this.reporter, url, new ConnectionAdapter(this)) 89 | this.newStateFrom(data) 90 | this.connection.refresh() 91 | } 92 | 93 | newStateFrom(data) { 94 | let menuContent = this.plugins.reduce((menu, plugin) => { 95 | let item = plugin.getMenuItem() 96 | if (item) menu.fullMenu[0].push(item) 97 | return menu 98 | }, buildMenuItems(schema)).fullMenu 99 | let config = this.plugins.reduce((config, plugin) => { 100 | config.plugins = config.plugins.concat(plugin.proseMirrorPlugins( 101 | transaction => this.dispatch(transaction) 102 | )) 103 | config[plugin.key] = data[plugin.key] 104 | return config 105 | }, { 106 | plugins: exampleSetup({schema, history: false, menuContent}).concat([ 107 | history({preserveItems: true}), 108 | collab({version: data.version}) 109 | ]), 110 | doc: schema.nodeFromJSON(data.doc) 111 | }) 112 | this.setState(EditorState.create(config)) 113 | } 114 | 115 | dispatch(transaction) { 116 | this.setState(this.state.apply(transaction)) 117 | if (!this.state) { 118 | return 119 | } 120 | if (this.state.doc.content.size > 40000) { 121 | this.connection.detach() 122 | } else { 123 | this.connection.refresh() 124 | } 125 | } 126 | 127 | setState(state) { 128 | this.state = state 129 | 130 | // Sync the editor with state 131 | if (this.state) { 132 | let userMark = schema.mark("user", {user: usersPlugin.getState(this.state).curUser}) 133 | this.state = this.state.apply(this.state.tr.addStoredMark(userMark)) 134 | if (this.view) 135 | this.view.updateState(this.state) 136 | else 137 | this.setView(new EditorView(this.domNode, { 138 | state: this.state, 139 | dispatchTransaction: transaction => this.dispatch(transaction) 140 | })) 141 | } else this.setView(null) 142 | } 143 | 144 | close() { 145 | this.connection.closeRequest() 146 | this.setView(null) 147 | } 148 | 149 | setView(view) { 150 | if (this.view) this.view.destroy() 151 | this.view = view 152 | } 153 | } 154 | 155 | function repeat(val, n) { 156 | let result = [] 157 | for (let i = 0; i < n; i++) result.push(val) 158 | return result 159 | } 160 | -------------------------------------------------------------------------------- /src/collab/client/comment.js: -------------------------------------------------------------------------------- 1 | import crel from "crel" 2 | import {MenuItem} from "prosemirror-menu" 3 | import {Plugin} from "prosemirror-state" 4 | import {Decoration, DecorationSet} from "prosemirror-view" 5 | 6 | class Comment { 7 | constructor(text, id) { 8 | this.id = id 9 | this.text = text 10 | } 11 | } 12 | 13 | function deco(from, to, comment) { 14 | return Decoration.inline(from, to, {class: "comment"}, {comment}) 15 | } 16 | 17 | class CommentState { 18 | constructor(version, decos, unsent) { 19 | this.version = version 20 | this.decos = decos 21 | this.unsent = unsent 22 | } 23 | 24 | findComment(id) { 25 | let current = this.decos.find() 26 | for (let i = 0; i < current.length; i++) 27 | if (current[i].spec.comment.id == id) return current[i] 28 | } 29 | 30 | commentsAt(pos) { 31 | return this.decos.find(pos, pos) 32 | } 33 | 34 | apply(tr) { 35 | let action = tr.getMeta(commentPlugin), actionType = action && action.type 36 | if (!action && !tr.docChanged) return this 37 | let base = this 38 | if (actionType == "receive") base = base.receive(action, tr.doc) 39 | let decos = base.decos, unsent = base.unsent 40 | decos = decos.map(tr.mapping, tr.doc) 41 | if (actionType == "newComment") { 42 | decos = decos.add(tr.doc, [deco(action.from, action.to, action.comment)]) 43 | unsent = unsent.concat(action) 44 | } else if (actionType == "deleteComment") { 45 | decos = decos.remove([this.findComment(action.comment.id)]) 46 | unsent = unsent.concat(action) 47 | } 48 | return new CommentState(base.version, decos, unsent) 49 | } 50 | 51 | receive({version, events, sent}, doc) { 52 | let set = this.decos 53 | for (let i = 0; i < events.length; i++) { 54 | let event = events[i] 55 | if (event.type == "delete") { 56 | let found = this.findComment(event.id) 57 | if (found) set = set.remove([found]) 58 | } else { // "create" 59 | if (!this.findComment(event.id)) 60 | set = set.add(doc, [deco(event.from, event.to, new Comment(event.text, event.id))]) 61 | } 62 | } 63 | return new CommentState(version, set, this.unsent.slice(sent)) 64 | } 65 | 66 | unsentEvents() { 67 | let result = [] 68 | for (let i = 0; i < this.unsent.length; i++) { 69 | let action = this.unsent[i] 70 | if (action.type == "newComment") { 71 | let found = this.findComment(action.comment.id) 72 | if (found) result.push({type: "create", id: action.comment.id, 73 | from: found.from, to: found.to, 74 | text: action.comment.text}) 75 | } else { 76 | result.push({type: "delete", id: action.comment.id}) 77 | } 78 | } 79 | return result 80 | } 81 | 82 | static init(config) { 83 | let decos = config.comments.comments.map(c => deco(c.from, c.to, new Comment(c.text, c.id))) 84 | return new CommentState(config.comments.version, DecorationSet.create(config.doc, decos), []) 85 | } 86 | } 87 | 88 | const commentPlugin = new Plugin({ 89 | state: { 90 | init: CommentState.init, 91 | apply(tr, prev) { return prev.apply(tr) } 92 | }, 93 | props: { 94 | decorations(state) { return this.getState(state).decos } 95 | } 96 | }) 97 | 98 | function randomID() { 99 | return Math.floor(Math.random() * 0xffffffff) 100 | } 101 | 102 | // Command for adding an annotation 103 | 104 | function addAnnotation(state, dispatch) { 105 | let sel = state.selection 106 | if (sel.empty) return false 107 | if (dispatch) { 108 | let text = prompt("Annotation text", "") 109 | if (text) 110 | dispatch(state.tr.setMeta(commentPlugin, {type: "newComment", from: sel.from, to: sel.to, comment: new Comment(text, randomID())})) 111 | } 112 | return true 113 | } 114 | 115 | const annotationIcon = { 116 | width: 1024, height: 1024, 117 | path: "M512 219q-116 0-218 39t-161 107-59 145q0 64 40 122t115 100l49 28-15 54q-13 52-40 98 86-36 157-97l24-21 32 3q39 4 74 4 116 0 218-39t161-107 59-145-59-145-161-107-218-39zM1024 512q0 99-68 183t-186 133-257 48q-40 0-82-4-113 100-262 138-28 8-65 12h-2q-8 0-15-6t-9-15v-0q-1-2-0-6t1-5 2-5l3-5t4-4 4-5q4-4 17-19t19-21 17-22 18-29 15-33 14-43q-89-50-141-125t-51-160q0-99 68-183t186-133 257-48 257 48 186 133 68 183z" 118 | } 119 | 120 | // Comment UI 121 | 122 | const commentUI = function(dispatch) { 123 | return new Plugin({ 124 | props: { 125 | decorations(state) { 126 | return commentTooltip(state, dispatch) 127 | } 128 | } 129 | }) 130 | } 131 | 132 | function commentTooltip(state, dispatch) { 133 | let sel = state.selection 134 | if (!sel.empty) return null 135 | let comments = commentPlugin.getState(state).commentsAt(sel.from) 136 | if (!comments.length) return null 137 | return DecorationSet.create(state.doc, [Decoration.widget(sel.from, renderComments(comments, dispatch, state))]) 138 | } 139 | 140 | function renderComments(comments, dispatch, state) { 141 | return crel("div", {class: "tooltip-wrapper"}, 142 | crel("ul", {class: "commentList"}, 143 | comments.map(c => renderComment(c.spec.comment, dispatch, state)))) 144 | } 145 | 146 | function renderComment(comment, dispatch, state) { 147 | let btn = crel("button", {class: "commentDelete", title: "Delete annotation"}, "×") 148 | btn.addEventListener("click", () => 149 | dispatch(state.tr.setMeta(commentPlugin, {type: "deleteComment", comment})) 150 | ) 151 | return crel("li", {class: "commentText"}, comment.text, btn) 152 | } 153 | 154 | export const commentsProsePadPlugin = { 155 | key: "comments", 156 | 157 | proseMirrorPlugins(dispatch) { 158 | return [ 159 | commentPlugin, 160 | commentUI(dispatch) 161 | ] 162 | }, 163 | 164 | getVersion(state) { 165 | return commentPlugin.getState(state).version 166 | }, 167 | 168 | receive(tr, {version, comments = []}, dataSent) { 169 | let sent = dataSent ? dataSent.length : 0 170 | tr.setMeta(commentPlugin, {type: "receive", version, events: comments, sent}) 171 | }, 172 | 173 | getSendable(editState) { 174 | let events = commentPlugin.getState(editState).unsentEvents() 175 | return events.length > 0 ? events : null 176 | }, 177 | 178 | getMenuItem() { 179 | return new MenuItem({ 180 | title: "Add an annotation", 181 | run: addAnnotation, 182 | select: state => addAnnotation(state), 183 | icon: annotationIcon 184 | }) 185 | } 186 | } 187 | -------------------------------------------------------------------------------- /public/css/site.css: -------------------------------------------------------------------------------- 1 | @font-face { 2 | font-family: 'Merriweather'; 3 | font-style: normal; 4 | font-weight: 700; 5 | src: local('Merriweather Bold'), local('Merriweather-Bold'), url(https://fonts.gstatic.com/s/merriweather/v13/ZvcMqxEwPfh2qDWBPxn6nnNuWYKPzoeKl5tYj8yhly0.woff2) format('woff2'); 6 | } 7 | @font-face { 8 | font-family: 'Source Sans Pro'; 9 | font-style: normal; 10 | font-weight: 400; 11 | src: local('Source Sans Pro'), local('SourceSansPro-Regular'), url(https://fonts.gstatic.com/s/sourcesanspro/v9/ODelI1aHBYDBqgeIAH2zlNV_2ngZ8dMf8fLgjYEouxg.woff2) format('woff2'); 12 | } 13 | @font-face { 14 | font-family: 'Source Sans Pro'; 15 | font-style: normal; 16 | font-weight: 600; 17 | src: local('Source Sans Pro Semibold'), local('SourceSansPro-Semibold'), url(https://fonts.gstatic.com/s/sourcesanspro/v9/toadOcfmlt9b38dHJxOBGCOFnW3Jk0f09zW_Yln67Ac.woff2) format('woff2'); 18 | } 19 | @font-face { 20 | font-family: 'Source Sans Pro'; 21 | font-style: italic; 22 | font-weight: 400; 23 | src: local('Source Sans Pro Italic'), local('SourceSansPro-It'), url(https://fonts.gstatic.com/s/sourcesanspro/v9/M2Jd71oPJhLKp0zdtTvoMxgy2Fsj5sj3EzlXpqVXRKo.woff2) format('woff2'); 24 | } 25 | 26 | html { 27 | background: black; 28 | overflow-y: auto; 29 | overflow-x: hidden; 30 | font-family: 'Source Sans Pro'; 31 | } 32 | 33 | body { 34 | margin: 0 0 5px; 35 | line-height: 1.45; 36 | background: white; 37 | position: relative; 38 | } 39 | 40 | .frontpage header, .frontpage article, .frontpage footer nav { 41 | max-width: 720px; 42 | margin: 0 auto; 43 | } 44 | 45 | h1, h2, h3, h4, h5 { font-family: Merriweather; font-weight: 700; } 46 | 47 | a { text-decoration: none } 48 | 49 | header > * { z-index: 2; position: relative; } 50 | 51 | .frontpage header { 52 | position: relative; 53 | padding: 62px 3px 0; 54 | margin-bottom: 40px; 55 | } 56 | 57 | header > h1 { 58 | text-align: center; 59 | margin: 63px 0 50px; 60 | } 61 | 62 | header nav, footer nav { 63 | display: flex; 64 | justify-content: space-between; 65 | flex-wrap: wrap; 66 | font-weight: 600; 67 | } 68 | 69 | strong { font-weight: 600; } 70 | 71 | nav a:link, nav a:visited, a.blocklink:link, a.blocklink:visited, code a:link, code a:visited, 72 | h2 a:link, h2 a:visited, h3 a:link, h3 a:visited, h4 a:link, h4 a:visited { 73 | color: inherit; 74 | } 75 | 76 | code, pre { font-size: 14px; } 77 | h2 code, h3 code { font-size: inherit; } 78 | pre { line-height: 22px; padding-left: 20px; } 79 | 80 | a.blocklink:hover { 81 | color: #0075ff; 82 | } 83 | 84 | nav a.active, a:link, a:visited { 85 | color: #0075ff; 86 | } 87 | 88 | a.logo { 89 | letter-spacing: -1.5px; 90 | font-size: 34px; 91 | line-height: 37px; 92 | } 93 | 94 | .navlinks { 95 | flex-grow: 1; 96 | font-size: 14px; 97 | display: flex; 98 | flex-wrap: wrap; 99 | justify-content: flex-end; 100 | align-items: flex-end; 101 | } 102 | 103 | footer .navlinks { 104 | align-items: center; 105 | } 106 | 107 | .navlinks > a { 108 | margin-left: 17px; 109 | padding-bottom: 3px; 110 | } 111 | 112 | .navlinks > a:hover { color: #0075ff; } 113 | 114 | article { 115 | padding: 10px 3px 100px; 116 | } 117 | 118 | footer { 119 | margin-bottom: 54px; 120 | padding: 14px 3px 0; 121 | color: white; 122 | background: black; 123 | } 124 | 125 | h2.hr { 126 | font-size: 12px; 127 | margin: 50px 0 37px; 128 | } 129 | 130 | hr, h2.hr:after { 131 | display: block; 132 | content: ""; 133 | border: none; 134 | border-bottom: 2px solid #e5e5e5; 135 | margin-top: 2px; 136 | } 137 | 138 | hr { 139 | margin: 45px 0 39px; 140 | } 141 | 142 | h2.above-list { 143 | font-size: 12px; 144 | line-height: 15px; 145 | margin-bottom: 37px; 146 | margin-top: 42px; 147 | } 148 | 149 | h2.module { 150 | margin-top: 250px; 151 | font-size: 28px; 152 | line-height: 30px; 153 | padding-top: 10px; 154 | border-bottom: 1px solid black; 155 | } 156 | 157 | @media screen and (max-width: 830px) { 158 | a.logo { 159 | padding-left: 38px; 160 | letter-spacing: -1px; 161 | background-size: 28px 28px; 162 | background-position: top left; 163 | background-repeat: no-repeat; 164 | font-size: 24px; 165 | line-height: 30px; 166 | } 167 | } 168 | 169 | dd p { margin: 0 } 170 | dd { margin-left: 20px } 171 | dt { 172 | padding-left: 35px; 173 | text-indent: -35px; 174 | } 175 | 176 | code { margin: 0 2px } 177 | 178 | .kind, .extends { 179 | font-weight: 600; 180 | font-family: "Source Sans Pro"; 181 | font-size: 14px; 182 | margin-bottom: -4px; 183 | } 184 | .extends code { 185 | color: black; 186 | } 187 | 188 | div.figure { margin: 1em; } 189 | .figure img { 190 | width: 400px; 191 | max-width: 90%; 192 | } 193 | 194 | .comment { background-color: #ff8 } 195 | .currentComment { background-color: #fe0 } 196 | 197 | .commentList, .commentText { 198 | display: block; 199 | padding: 0; 200 | margin: 0; 201 | } 202 | 203 | .tooltip-wrapper { 204 | display: inline-block; 205 | position: relative; 206 | width: 0; 207 | overflow: visible; 208 | vertical-align: bottom; 209 | } 210 | 211 | .ProseMirror ul.commentList { 212 | font-family: "Source Sans Pro"; 213 | font-size: 16px; 214 | width: 15em; 215 | position: absolute; 216 | top: calc(100% + 8px); 217 | left: -2em; 218 | font-size: 1rem; 219 | color: black; 220 | background: white; 221 | font-weight: normal; 222 | border: 1px solid #888; 223 | border-radius: 5px; 224 | z-index: 10; 225 | padding: 0; 226 | } 227 | 228 | ul.commentList::before { 229 | border: 5px solid #888; 230 | border-top-width: 0px; 231 | border-left-color: transparent; 232 | border-right-color: transparent; 233 | position: absolute; 234 | top: -5px; 235 | left: calc(2em - 6px); 236 | content: " "; 237 | height: 0; 238 | width: 0; 239 | } 240 | 241 | li.commentText { 242 | padding: 2px 20px 2px 5px; 243 | position: relative; 244 | pointer-events: auto; 245 | margin: 0; 246 | } 247 | 248 | li.commentText + li.commentText { 249 | border-top: 1px solid silver; 250 | } 251 | 252 | .commentDelete { 253 | position: absolute; 254 | right: 0; 255 | border: 0; 256 | font: inherit; 257 | display: inline; 258 | color: inherit; 259 | background: transparent; 260 | cursor: pointer; 261 | } 262 | 263 | .commentDelete:hover { 264 | color: #f88; 265 | } 266 | 267 | .ProseMirror-report { 268 | position: fixed; 269 | top: 0; right: 0; left: 0; 270 | border-width: 0; 271 | border-style: solid; 272 | border-bottom-width: 1px; 273 | padding: 3px 27px 5px; 274 | white-space: pre; 275 | z-index: 1000; 276 | } 277 | 278 | .ProseMirror-report-fail { 279 | background: rgb(255, 230, 230); 280 | border-color: rgb(200, 150, 150); 281 | } 282 | 283 | .ProseMirror-report-delay { 284 | background: rgb(255, 255, 200); 285 | border-color: rgb(200, 200, 120); 286 | } 287 | -------------------------------------------------------------------------------- /src/collab/server/instance.js: -------------------------------------------------------------------------------- 1 | import {readFileSync, writeFile} from "fs" 2 | 3 | import {Mapping} from "prosemirror-transform" 4 | 5 | import {schema} from "../schema" 6 | import {Comments, Comment} from "./comments" 7 | import {populateDefaultInstances} from "./defaultinstances" 8 | 9 | const MAX_STEP_HISTORY = 10000 10 | 11 | // A collaborative editing document instance. 12 | class Instance { 13 | constructor(id, doc, comments, users = [], chat = []) { 14 | this.id = id 15 | this.doc = doc || schema.node("doc", null, [schema.node("paragraph", null, [ 16 | schema.text("This is a collaborative test document. Start editing to make it more interesting!") 17 | ])]) 18 | this.comments = comments || new Comments 19 | // The version number of the document instance. 20 | this.version = 0 21 | this.steps = [] 22 | this.lastActive = Date.now() 23 | this.usersVersion = 0 24 | this.users = new Map(users.map(user => [user.id, user])) 25 | this.waiting = [] 26 | this.chat = {messages: chat, version: chat.length} 27 | 28 | this.collecting = null 29 | } 30 | 31 | stop() { 32 | if (this.collecting != null) clearInterval(this.collecting) 33 | } 34 | 35 | addEvents(version, steps, chat, comments, users, clientID, clientId) { 36 | this.checkVersion(version) 37 | if (this.version != version) return false 38 | let doc = this.doc, maps = [] 39 | for (let i = 0; i < steps.length; i++) { 40 | steps[i].clientID = clientID 41 | let result = steps[i].apply(doc) 42 | doc = result.doc 43 | maps.push(steps[i].getMap()) 44 | } 45 | this.doc = doc 46 | this.version += steps.length 47 | this.steps = this.steps.concat(steps) 48 | if (this.steps.length > MAX_STEP_HISTORY) 49 | this.steps = this.steps.slice(this.steps.length - MAX_STEP_HISTORY) 50 | 51 | this.comments.mapThrough(new Mapping(maps)) 52 | if (comments) for (let i = 0; i < comments.length; i++) { 53 | let event = comments[i] 54 | if (event.type == "delete") 55 | this.comments.deleted(event.id) 56 | else 57 | this.comments.created(event) 58 | } 59 | 60 | if (users) { 61 | Object.assign(this.users.get(clientId), users) 62 | ++this.usersVersion 63 | } 64 | 65 | if (chat) { 66 | this.chat.messages = this.chat.messages.concat(chat.messages) 67 | this.chat.version = chat.version 68 | } 69 | 70 | this.sendUpdates() 71 | scheduleSave() 72 | return {version: this.version, chat: {version: this.chat.version}, comments: {version: this.comments.version}, users: {users: users && Array.from(this.users.values()), version: this.usersVersion}} 73 | } 74 | 75 | sendUpdates() { 76 | while (this.waiting.length) this.waiting.pop().finish() 77 | } 78 | 79 | // : (Number) 80 | // Check if a document version number relates to an existing 81 | // document version. 82 | checkVersion(version) { 83 | if (version < 0 || version > this.version) { 84 | let err = new Error("Invalid version " + version) 85 | err.status = 400 86 | throw err 87 | } 88 | } 89 | 90 | // : (Number, Number) 91 | // Get events between a given document version and 92 | // the current document version. 93 | getEvents(version, chatVersion, commentVersion, usersVersion) { 94 | this.checkVersion(version) 95 | let startIndex = this.steps.length - (this.version - version) 96 | if (startIndex < 0) return false 97 | let commentStartIndex = this.comments.events.length - (this.comments.version - commentVersion) 98 | if (commentStartIndex < 0) return false 99 | 100 | return {steps: this.steps.slice(startIndex), 101 | chat: chatVersion != null ? {messages: this.chat.messages.slice(chatVersion)} : null, 102 | comment: this.comments.eventsAfter(commentStartIndex), 103 | users: usersVersion < this.usersVersion ? {users: Array.from(this.users.values()), version: this.usersVersion} : null} 104 | } 105 | 106 | collectUsers() { 107 | this.collecting = null 108 | let oldConnectedUsers = 0 109 | this.users.forEach(user => { 110 | if (user.connected) ++oldConnectedUsers 111 | user.connected = false 112 | }) 113 | for (let i = 0; i < this.waiting.length; i++) 114 | this._registerUser(this.waiting[i].clientId) 115 | 116 | if (oldConnectedUsers != this.waiting.length) { 117 | ++this.usersVersion 118 | this.sendUpdates() 119 | } 120 | } 121 | 122 | registerUser(clientId) { 123 | if (this._registerUser(clientId)) { 124 | ++this.usersVersion 125 | this.sendUpdates() 126 | } 127 | } 128 | 129 | _registerUser(clientId) { 130 | let user = this.users.get(clientId) 131 | if (!user) { 132 | const colors = ["lightsalmon", "lightblue", "#ffc7c7", "#fff1c7", 133 | "#c7ffd5", "#e3c7ff", "#c7ffff", "#ffc7f1", "#8fabff", "#c78fff", 134 | "#ff8fe3", "#d97979", 135 | "#d9c179", "#a9d979", "#79d991", "#79d9d9", "#7991d9", "#a979d9", 136 | "#d979c1", "#d9a9a9", "#d9cda9", "#c1d9a9", "#a9d9b5", "#a9d9d9", 137 | "#a9b5d9", "#c1a9d9", "#d9a9cd", "#4c9c82", "#12d1ad", "#2d8e80", 138 | "#7485c3", "#a091c7", "#3185ab", "#6818b4", "#e6e76d", "#a42c64", 139 | "#f386e5", "#4ecc0c", "#c0c236", "#693224", "#b5de6a", "#9b88fd", 140 | "#358f9b", "#496d2f", "#e267fe", "#d23056", "#1a1a64", "#5aa335", 141 | "#d722bb", "#86dc6c", "#b5a714", "#955b6a", "#9f2985", "#e3ffc7", 142 | "#c7d5ff", "#ff8f8f", "#ffe38f", "#c7ff8f", "#8fffab", "#8fffff"] 143 | user = {id: clientId, name: "Unnamed user", color: colors[this.users.size % colors.length], connected: false} 144 | this.users.set(user.id, user) 145 | } 146 | if (!user.connected) { 147 | user.connected = true 148 | if (this.collecting == null) 149 | this.collecting = setTimeout(() => this.collectUsers(), 5000) 150 | return true 151 | } 152 | return false 153 | } 154 | } 155 | 156 | const instances = Object.create(null) 157 | let instanceCount = 0 158 | let maxCount = 20 159 | 160 | let saveFile = "data/instances.json", json 161 | if (process.argv.indexOf("--fresh") == -1) { 162 | try { 163 | json = JSON.parse(readFileSync(saveFile, "utf8")) 164 | } catch (e) {} 165 | } 166 | 167 | if (json) { 168 | for (let prop in json) 169 | newInstance(prop, schema.nodeFromJSON(json[prop].doc), 170 | new Comments(json[prop].comments.map(c => Comment.fromJSON(c))), 171 | json[prop].users, json[prop].chat) 172 | } else { 173 | populateDefaultInstances(newInstance) 174 | } 175 | 176 | let saveTimeout = null, saveEvery = 1e4 177 | function scheduleSave() { 178 | if (saveTimeout != null) return 179 | saveTimeout = setTimeout(doSave, saveEvery) 180 | } 181 | function doSave() { 182 | saveTimeout = null 183 | let out = {} 184 | for (var prop in instances) 185 | out[prop] = { 186 | doc: instances[prop].doc.toJSON(), 187 | comments: instances[prop].comments.comments, 188 | users: Array.from(instances[prop].users.values()), 189 | chat: instances[prop].chat.messages 190 | } 191 | writeFile(saveFile, JSON.stringify(out)) 192 | } 193 | 194 | export function getInstance(id, clientId) { 195 | let inst = instances[id] || newInstance(id) 196 | if (clientId) inst.registerUser(clientId) 197 | inst.lastActive = Date.now() 198 | return inst 199 | } 200 | 201 | function newInstance(id, doc, comments, users, chat) { 202 | if (++instanceCount > maxCount) { 203 | let oldest = null 204 | for (let id in instances) { 205 | let inst = instances[id] 206 | if (!oldest || inst.lastActive < oldest.lastActive) oldest = inst 207 | } 208 | instances[oldest.id].stop() 209 | delete instances[oldest.id] 210 | --instanceCount 211 | } 212 | return instances[id] = new Instance(id, doc, comments, users, chat) 213 | } 214 | 215 | export function instanceInfo() { 216 | let found = [] 217 | for (let id in instances) 218 | found.push({id: id, users: Array.from(instances[id].users.values()).filter(user => user.connected).length}) 219 | return found 220 | } 221 | -------------------------------------------------------------------------------- /src/collab/server/server.js: -------------------------------------------------------------------------------- 1 | import sessions from "client-sessions" 2 | import {readFile} from "fs" 3 | import Negotiator from "negotiator" 4 | import {Step} from "prosemirror-transform" 5 | 6 | import mold from "../../mold" 7 | import {Router} from "./route" 8 | import {schema} from "../schema" 9 | import {getInstance, instanceInfo} from "./instance" 10 | 11 | // Object that represents an HTTP response. 12 | class Output { 13 | constructor(code, body, type) { 14 | this.code = code 15 | this.body = body 16 | this.type = type || "text/plain" 17 | } 18 | 19 | static json(data) { 20 | return new Output(200, JSON.stringify(data), "application/json") 21 | } 22 | 23 | // Write the response. 24 | resp(resp) { 25 | resp.writeHead(this.code, {"Content-Type": this.type}) 26 | resp.end(this.body) 27 | } 28 | } 29 | 30 | class LaterOutput { 31 | constructor(promise) { 32 | this.promise = promise 33 | } 34 | 35 | resp(resp) { 36 | this.promise.then(output => output.resp(resp)) 37 | .catch(err => { 38 | const output = new Output(500, String(err)) 39 | output.resp(resp) 40 | }) 41 | } 42 | } 43 | 44 | // : (stream.Readable, Function) 45 | // Invoke a callback with a stream's data. 46 | function readStreamAsJSON(stream, callback) { 47 | let data = "" 48 | stream.on("data", chunk => data += chunk) 49 | stream.on("end", () => { 50 | let result, error 51 | try { result = JSON.parse(data) } 52 | catch (e) { error = e } 53 | callback(error, result) 54 | }) 55 | stream.on("error", e => callback(e)) 56 | } 57 | 58 | const extensionsToMimeType = {css: "text/css", html: "text/html", js: "application/javascript"} 59 | 60 | const getOutputForFile = path => new LaterOutput( 61 | new Promise((resolve, reject) => 62 | readFile("public/" + path, (err, res) => { 63 | if (err) { 64 | return reject(err) 65 | } 66 | const extension = path.match(/\.(.+)$/) 67 | resolve(new Output(200, res, extension && extensionsToMimeType[extension[1]] || null)) 68 | }) 69 | ) 70 | ) 71 | 72 | function nonNegInteger(str) { 73 | let num = Number(str) 74 | if (!isNaN(num) && Math.floor(num) == num && num >= 0) return num 75 | let err = new Error("Not a non-negative integer: " + str) 76 | err.status = 400 77 | throw err 78 | } 79 | 80 | function validInstanceId(str) { 81 | str = str.trim() 82 | if (str[0] != "_" && str != "favicon.ico" && str != "") return str 83 | let err = new Error("Not a valid document id: " + str) 84 | err.status = 400 85 | throw err 86 | } 87 | 88 | // An object to assist in waiting for a collaborative editing 89 | // instance to publish a new version before sending the version 90 | // event data to the client. 91 | class Waiting { 92 | constructor(resp, inst, clientId, finish) { 93 | this.clientId = clientId 94 | const abort = () => { 95 | let found = inst.waiting.indexOf(this) 96 | if (found > -1) inst.waiting.splice(found, 1) 97 | } 98 | this.promise = new Promise((resolve, reject) => { 99 | this.finish = () => resolve(finish()) 100 | resp.setTimeout(1000 * 60 * 5, () => { 101 | abort() 102 | resolve(Output.json({})) 103 | }) 104 | }) 105 | resp.on("close", () => abort()) 106 | } 107 | } 108 | 109 | export default class ProsePadServer { 110 | constructor({cookie_secret}) { 111 | const router = this.router = new Router 112 | 113 | const COOKIE_NAME = "id_session" 114 | const getClientId = (middleware => (req, res) => new Promise((resolve, reject) => { 115 | middleware(req, res, err => { 116 | if (err) return reject(err) 117 | req[COOKIE_NAME].id = "id" in req[COOKIE_NAME] ? req[COOKIE_NAME].id : Math.floor(Math.random() * 0xFFFFFFFF) 118 | resolve(req[COOKIE_NAME].id) 119 | }) 120 | }))(sessions({ 121 | cookieName: COOKIE_NAME, 122 | secret: cookie_secret, 123 | duration: 24 * 60 * 60 * 1000, 124 | activeDuration: 1000 * 60 * 5 125 | })) 126 | 127 | // : (string, Array, Function) 128 | // Register a server route. 129 | function handle(method, url, f) { 130 | router.add(method, url, (req, resp, ...args) => { 131 | function finish() { 132 | let output 133 | try { 134 | output = f(...args, req, resp) 135 | } catch (err) { 136 | console.log(err.stack) 137 | output = new Output(err.status || 500, err.toString()) 138 | } 139 | if (output) output.resp(resp) 140 | } 141 | 142 | if (method == "PUT" || method == "POST") 143 | readStreamAsJSON(req, (err, val) => { 144 | if (err) new Output(500, err.toString()).resp(resp) 145 | else { args.unshift(val); finish() } 146 | }) 147 | else 148 | finish() 149 | }) 150 | } 151 | 152 | // Static resources 153 | 154 | handle("GET", "/", () => { 155 | return getOutputForFile("index.html") 156 | }) 157 | handle("GET", "/favicon.ico", () => { 158 | return getOutputForFile("favicon.ico") 159 | }) 160 | 161 | handle("GET", ["_resources", "js", null], (filename) => { 162 | return getOutputForFile("js/" + filename) 163 | }) 164 | handle("GET", ["_resources", "css", null], (filename) => { 165 | return getOutputForFile("css/" + filename) 166 | }) 167 | 168 | // The root endpoint outputs a list of the collaborative 169 | // editing document instances. 170 | handle("GET", ["_docs"], () => { 171 | return Output.json(instanceInfo()) 172 | }) 173 | 174 | const getViewData = (inst, clientId) => ({ 175 | doc: inst.doc.toJSON(), 176 | chat: inst.chat, 177 | users: {curUser: clientId, users: Array.from(inst.users.values()), version: inst.usersVersion}, 178 | version: inst.version, 179 | comments: inst.comments 180 | }) 181 | 182 | // Output the current state of a document instance. 183 | handle("GET", [null], (id, req, res) => { 184 | id = validInstanceId(id) 185 | return new LaterOutput(getClientId(req, res).then(clientId => { 186 | let inst = getInstance(id, clientId) 187 | const negotiator = new Negotiator(req) 188 | switch (negotiator.mediaType(["text/html", "application/json"])) { 189 | case "application/json": 190 | return Output.json(getViewData(inst, clientId)) 191 | case "text/html": 192 | return new Output(200, mold.dispatch("editor", { 193 | content: JSON.stringify(getViewData(inst, clientId)), 194 | docName: id 195 | }), "text/html") 196 | default: 197 | return new Output(406, "Not Acceptable") 198 | } 199 | })) 200 | }) 201 | 202 | function outputEvents(inst, data) { 203 | return Output.json({version: inst.version, 204 | steps: data.steps.map(s => s.toJSON()), 205 | clientIDs: data.steps.map(step => step.clientID), 206 | comments: data.comment.length ? {comments: data.comment, version: inst.comments.version} : null, 207 | chat: data.chat && data.chat.messages.length ? {messages: data.chat.messages, version: inst.chat.version} : null, 208 | users: data.users}) 209 | } 210 | 211 | // An endpoint for a collaborative document instance which 212 | // returns all events between a given version and the server's 213 | // current version of the document. 214 | handle("GET", [null, "events"], (id, req, resp) => { 215 | let version = nonNegInteger(req.query.version) 216 | let chatVersion = "chatVersion" in req.query ? nonNegInteger(req.query.chatVersion) : null 217 | let commentVersion = nonNegInteger(req.query.commentsVersion) 218 | let usersVersion = nonNegInteger(req.query.usersVersion) 219 | id = validInstanceId(id) 220 | 221 | return new LaterOutput(getClientId(req, resp).then(clientId => { 222 | let inst = getInstance(id, clientId) 223 | let data = inst.getEvents(version, chatVersion, commentVersion, usersVersion) 224 | if (data === false) 225 | return new Output(410, "History no longer available") 226 | // If the server version is greater than the given version, 227 | // return the data immediately. 228 | if (data.steps.length || data.comment.length || (data.chat && data.chat.messages.length)) 229 | return outputEvents(inst, data) 230 | // If the server version matches the given version, 231 | // wait until a new version is published to return the event data. 232 | let wait = new Waiting(resp, inst, clientId, () => { 233 | return outputEvents(inst, inst.getEvents(version, chatVersion, commentVersion, usersVersion)) 234 | }) 235 | inst.waiting.push(wait) 236 | return wait.promise 237 | })) 238 | }) 239 | 240 | // The event submission endpoint, which a client sends an event to. 241 | handle("POST", [null, "events"], (data, id, req, resp) => { 242 | let version = nonNegInteger(data.version) 243 | let steps = data.steps.map(s => Step.fromJSON(schema, s)) 244 | return new LaterOutput(getClientId(req, resp).then(clientId => { 245 | let result = getInstance(id, clientId).addEvents(version, steps, data.chat, data.comments, data.users, data.clientID, clientId) 246 | if (!result) 247 | return new Output(409, "Version not current") 248 | else 249 | return Output.json(result) 250 | })) 251 | }) 252 | } 253 | 254 | handle(req, resp) { 255 | return this.router.resolve(req, resp) 256 | } 257 | } 258 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------