├── screenshot.png
├── .gitignore
├── src
    ├── renderer
    │   ├── images
    │   │   ├── cabal.png
    │   │   └── icon.png
    │   ├── styles
    │   │   └── style.css
    │   ├── views
    │   │   ├── avatar.js
    │   │   ├── 404.js
    │   │   ├── index.js
    │   │   ├── join.js
    │   │   ├── settings.js
    │   │   ├── peers.js
    │   │   ├── cabals.js
    │   │   └── messenger.js
    │   └── index.js
    └── main
    │   ├── index.js
    │   └── cabal-plumbing.js
├── .travis.yml
├── bin
    ├── release.js
    └── build-multi
├── CHANGELOG.md
├── README.md
├── webpack.config.js
├── package.json
└── LICENSE


/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cabal-club/cabal-desktop-mini/HEAD/screenshot.png


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | .nyc_output/
3 | coverage/
4 | dist/
5 | tmp/
6 | npm-debug.log*
7 | .DS_Store


--------------------------------------------------------------------------------
/src/renderer/images/cabal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cabal-club/cabal-desktop-mini/HEAD/src/renderer/images/cabal.png


--------------------------------------------------------------------------------
/src/renderer/images/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cabal-club/cabal-desktop-mini/HEAD/src/renderer/images/icon.png


--------------------------------------------------------------------------------
/src/renderer/styles/style.css:
--------------------------------------------------------------------------------
1 | html, body {
2 |   height: 100%;
3 | }
4 | 
5 | body {
6 |   overflow: hidden;
7 |   -webkit-app-region: drag;
8 | }


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | sudo: false
 2 | language: node_js
 3 | node_js:
 4 |   - '10'
 5 | 
 6 | os:
 7 |   - osx
 8 |   - linux
 9 |   - windows
10 | 
11 | script:
12 |   - npm rebuild
13 |   - npm run dist:multi
14 | 
15 | install:
16 |   - npm install
17 | 
18 | deploy:
19 |   provider: script
20 |   script: npm run dist:multi
21 |   on:
22 |     all_branches: true
23 |   skip_cleanup: true
24 |   file_glob: true
25 | 


--------------------------------------------------------------------------------
/src/renderer/views/avatar.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | var Identicon = require('identicon.js')
 3 | 
 4 | module.exports = function (key, style) {
 5 |   if (!key) return ''
 6 |   if (!style) style = {}
 7 |   var identicon = new Identicon(key, {
 8 |     saturation: style.saturation || 1,
 9 |     brightness: style.brightness || 0.15,
10 |     margin: style.margin || 0,
11 |     background: style.background || [255, 255, 255, 255]
12 |   }).toString()
13 |   return html`<img src="data:image/png;base64,${identicon}" class="${style.className || 'db br2 w2'}"/>`
14 | }
15 | 


--------------------------------------------------------------------------------
/bin/release.js:
--------------------------------------------------------------------------------
 1 | var fs = require('fs')
 2 | var path = require('path')
 3 | const { execSync } = require('child_process')
 4 | 
 5 | var version = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json'), 'utf8')).version
 6 | 
 7 | var assets = [
 8 |   `dist/cabal-desktop-mini-${version}-mac.dmg`,
 9 |   `dist/cabal-desktop-mini-${version}-windows.exe`,
10 |   `dist/cabal-desktop-mini_${version}_amd64.snap`,
11 |   `dist/cabal-desktop-mini-${version}-linux-x86_64.AppImage`
12 | ]
13 | 
14 | console.log('>>> Run this:')
15 | console.log(`gh-release --draft --assets ${assets.join(',')}`)
16 | 


--------------------------------------------------------------------------------
/src/renderer/views/404.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | 
 3 | var TITLE = 'Cabal Mini'
 4 | 
 5 | module.exports = view
 6 | 
 7 | function view (state, emit) {
 8 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
 9 |   return html`
10 |     <body class="sans-serif">
11 |       <h1 class="f-headline pa3 pa4-ns">
12 |         404 - route not found
13 |       </h1>
14 |       <a onclick=${() => navigate('/cabals')} class="pointer link black underline">
15 |         Back to main
16 |       </a>
17 |     </body>
18 |   `
19 | 
20 |   function navigate (location) {
21 |     emit(state.events.PUSHSTATE, location)
22 |   }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/renderer/views/index.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | 
 3 | var Icon = require('../images/cabal.png')
 4 | 
 5 | var TITLE = 'Cabal Mini'
 6 | 
 7 | module.exports = view
 8 | 
 9 | function view (state, emit) {
10 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
11 | 
12 |   setTimeout(function () {
13 |     navigate('/cabals')
14 |   }, 1000)
15 | 
16 |   //<img src=${Icon} class="w2 pointer mb5" />
17 |   return html`
18 |     <body class="sans-serif pa4 flex flex-column items-center justify-center">
19 | 
20 |     </body>
21 |   `
22 | 
23 |   function navigate (location) {
24 |     emit(state.events.PUSHSTATE, location)
25 |   }
26 | }
27 | 


--------------------------------------------------------------------------------
/bin/build-multi:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | docker run --rm -ti \
 4 |   --env-file <(env | grep -iE 'DEBUG|NODE_|ELECTRON_|YARN_|NPM_|CI|CIRCLE|TRAVIS_TAG|TRAVIS|TRAVIS_REPO_|TRAVIS_BUILD_|TRAVIS_BRANCH|TRAVIS_PULL_REQUEST_|APPVEYOR_|CSC_|GH_|GITHUB_|BT_|AWS_|STRIP|BUILD_') \
 5 |   --env ELECTRON_CACHE="/root/.cache/electron" \
 6 |   --env ELECTRON_BUILDER_CACHE="/root/.cache/electron-builder" \
 7 |   -v ${PWD}:/project \
 8 |   -v ${PWD##*/}-node-modules:/project/node_modules \
 9 |   -v ~/.cache/electron:/root/.cache/electron \
10 |   -v ~/.cache/electron-builder:/root/.cache/electron-builder \
11 |   electronuserland/builder:wine \
12 |   /bin/bash -c "uname -a && npm install && npm run dist:multi"
13 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | All notable changes to this project will be documented in this file.
 3 | 
 4 | ## [2.0.0] - 2019-05-22
 5 | ### Update 🎉
 6 | - Updates to cabal-core 5! This is a breaking change to support the latest fixes in cabal-core. Cabal users will need to use this version and up or cabal-cli at version 6.0.0+ going forward.
 7 | ### Added
 8 | - Cabal version information on cabal select screen
 9 | 
10 | ## [1.0.5] - 2019-05-08
11 | ### Added
12 | - Updates to latest cabal-core, including support for 1000 max feeds
13 | 
14 | ## [1.0.4] - 2019-02-24
15 | ### Fixed
16 | - Loading screen crash on Windows
17 | 
18 | ## [1.0.3] - 2019-02-23
19 | ### Fixed
20 | - Electron navigation issues
21 | ### Added
22 | - Up/down arrow key command to scroll through sent message history
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Cabal Desktop Mini
 2 | 
 3 | > A minimal desktop app for Cabal, the p2p/decentralized/offline-first chat platform.
 4 | 
 5 | <3 nikolaiwarner
 6 | 
 7 | <center><img src="screenshot.png"/></center>
 8 | 
 9 | ## Install
10 | 
11 | ### Download the latest release
12 | 
13 | https://github.com/nikolaiwarner/cabal-desktop-mini/releases/
14 | 
15 | ### Build from source
16 | 
17 | ```
18 | $ git clone https://github.com/nikolaiwarner/cabal-desktop-mini
19 | $ cd cabal-desktop-mini
20 | 
21 | $ npm install             # install dependencies
22 | $ npm start               # start the application
23 | ```
24 | 
25 | ## Distribute
26 | 
27 | build for current platform:
28 | 
29 | ```
30 | $ npm run build
31 | ```
32 | 
33 | build for [multiple platforms](https://www.electron.build/multi-platform-build#docker):
34 | 
35 | ```
36 | $ npm run dist
37 | ```
38 | 


--------------------------------------------------------------------------------
/src/renderer/index.js:
--------------------------------------------------------------------------------
 1 | var choo = require('choo')
 2 | var { ipcRenderer } = window.require('electron')
 3 | 
 4 | var Tachyons = require('tachyons/css/tachyons.min.css')
 5 | var Styles = require('./styles/style.css')
 6 | 
 7 | var cabalPorcelain = function (state, emitter) {
 8 |   state.cabalState = {}
 9 | 
10 |   ipcRenderer.on('cabal-state-update', (event, cabalState) => {
11 |     console.log({ cabalState })
12 |     state.cabalState = cabalState
13 |     emitter.emit('render')
14 |   })
15 |   ipcRenderer.on('cabal-messages-update', (event, data) => {
16 |     console.log({ data })
17 |     // state.cabalState = cabalState
18 |     emitter.emit('render')
19 |   })
20 | }
21 | 
22 | var app = choo()
23 | if (process.env.NODE_ENV !== 'production') {
24 |   app.use(require('choo-devtools')())
25 | }
26 | 
27 | app.use(cabalPorcelain)
28 | 
29 | app.route('/cabals', require('./views/cabals'))
30 | app.route('/join', require('./views/join'))
31 | app.route('/messenger', require('./views/messenger'))
32 | app.route('/peers', require('./views/peers'))
33 | app.route('/settings', require('./views/settings'))
34 | app.route('/*', require('./views/index'))
35 | 
36 | if (!module.parent) app.mount('body')
37 | else module.exports = app
38 | 


--------------------------------------------------------------------------------
/webpack.config.js:
--------------------------------------------------------------------------------
 1 | const path = require('path')
 2 | const webpack = require('webpack')
 3 | 
 4 | module.exports = {
 5 |   context: path.resolve(__dirname, 'src'),
 6 |   entry: [
 7 |     'react-hot-loader/patch',
 8 |     'webpack-dev-server/client?http://localhost:8080',
 9 |     'webpack/hot/only-dev-server',
10 |     './index.js'
11 |   ],
12 |   output: {
13 |     filename: 'bundle.js',
14 |     path: path.resolve(__dirname, 'dist'),
15 |     publicPath: '/'
16 |   },
17 |   devtool: 'inline-source-map',
18 |   devServer: {
19 |     hot: true,
20 |     contentBase: path.resolve(__dirname, 'dist'),
21 |     publicPath: '/'
22 |   },
23 |   module: {
24 |     rules: [
25 |       {
26 |         test: /\.js$/,
27 |         exclude: /node_modules/,
28 |         use: ['babel-loader'],
29 |         include: path.join(__dirname, 'src')
30 |       },
31 |       {
32 |         test: /\.css$/,
33 |         use: [
34 |           'style-loader',
35 |           'raw-loader'
36 |         ]
37 |       },
38 |       {
39 |         test: /\.(png|svg|jpg|gif)$/,
40 |         use: [
41 |           'file-loader'
42 |         ]
43 |       }
44 |     ]
45 |   },
46 |   plugins: [
47 |     new webpack.HotModuleReplacementPlugin(),
48 |     new webpack.NamedModulesPlugin()
49 |   ]
50 | }
51 | 


--------------------------------------------------------------------------------
/src/renderer/views/join.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | const { ipcRenderer } = window.require('electron')
 3 | 
 4 | var TITLE = 'Join A Cabal'
 5 | 
 6 | module.exports = function (state, emit) {
 7 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
 8 | 
 9 |   return html`
10 |     <body class="sans-serif">
11 |       <nav class="ph4 pt4">
12 |         <a class="f6 link br3 ph3 pv2 mb1 dib black dim ba b--black" onclick=${() => navigate('/cabals')}>⬅</a>
13 |       </nav>
14 |       <h1 class="ph4 f3 f2-m f1-l">${TITLE}</h1>
15 |       <form class="pa4 black-80">
16 |         <label for="key" class="f6 b db mb2">Cabal Key</label>
17 |         <input placeholder="cabal://" id="joinKeyInput" class="input-reset ba b--black-50 bw2 br3 pa2 mb3 db w-100" type="text" aria-describedby="key-desc">
18 |         <small id="key-desc" class="f6 black-60 db mb2"></small>
19 |         <a class="f6 link dim br3 ph3 pv2 mb1 dib white bg-black pointer" onclick=${joinCabal}>Join</a>
20 |       </form>
21 |     </body>
22 |   `
23 | 
24 |   function joinCabal () {
25 |     var key = document.getElementById('joinKeyInput').value
26 |     loadCabal(key)
27 |   }
28 | 
29 |   function loadCabal (key) {
30 |     ipcRenderer.sendSync('cabal-load-cabal', { key })
31 |     window.location.hash = 'messenger'
32 |   }
33 | 
34 |   function navigate (location) {
35 |     emit(state.events.PUSHSTATE, location)
36 |   }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/renderer/views/settings.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | const { ipcRenderer } = window.require('electron')
 3 | 
 4 | var TITLE = 'Settings'
 5 | 
 6 | module.exports = function (state, emit) {
 7 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
 8 | 
 9 |   state.cabalState = state.cabalState || {}
10 |   state.cabalState.currentUser = state.cabalState.user || { key: '' }
11 |   var currentUserName = state.cabalState.currentUser.name || state.cabalState.currentUser.key.substr(0, 6)
12 | 
13 |   return html`
14 |     <body class="sans-serif">
15 |       <nav class="ph4 pt4">
16 |         <a class="pointer f6 link br3 ph3 pv2 mb1 dib black dim ba b--black" onclick=${() => navigate('/messenger')}>⬅</a>
17 |       </nav>
18 |       <h1 class="ph4 f3 f2-m f1-l">${TITLE}</h1>
19 |       <div class="pa4 black-80">
20 |           <label for="name" class="f6 b db mb2">Nickname</label>
21 |           <input value="${currentUserName}" id="nickInput" class="input-reset ba b--black-50 bw2 br3 pa2 mb3 db w-100" type="text" aria-describedby="name-desc">
22 |           <small id="name-desc" class="f6 black-60 db mb2"></small>
23 |           <a class="f6 link dim br3 ph3 pv2 mb1 dib white bg-black pointer" onclick=${save}>Save</a>
24 |       </div>
25 |     </body>
26 |   `
27 | 
28 |   function navigate (location) {
29 |     emit(state.events.PUSHSTATE, location)
30 |   }
31 | 
32 |   function save () {
33 |     var nick = document.getElementById('nickInput').value
34 |     ipcRenderer.sendSync('cabal-publish-nick', { nick })
35 |   }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/renderer/views/peers.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | const { ipcRenderer } = window.require('electron')
 3 | 
 4 | var avatar = require('./avatar')
 5 | 
 6 | var TITLE = 'Peers'
 7 | 
 8 | module.exports = function (state, emit) {
 9 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
10 | 
11 |   state.cabalState = state.cabalState || {}
12 |   state.cabalState.currentUser = state.cabalState.user || { key: '' }
13 |   state.cabalState.users = state.cabalState.users || {}
14 | 
15 |   var users = Object.values(state.cabalState.users)
16 | 
17 |   users = users.sort(function (a, b) {
18 |     return (!!a.online === !!b.online) ? 0 : a.online ? -1 : 1
19 |   })
20 |   return html`
21 |     <body class="sans-serif">
22 |       <nav class="ph4 pt4">
23 |         <a class="f6 link br3 ph3 pv2 mb1 dib black dim ba b--black" onclick=${() => navigate('/messenger')}>⬅</a>
24 |       </nav>
25 |       <h1 class="ph4 f3 f2-m f1-l">${TITLE}</h1>
26 | 
27 |       <div class="pa4">
28 |         ${users.map((user) => {
29 |           return html`
30 |             <article class="dt w-100 b--black-05 pb3 mt2">
31 |               <div class="dtc v-top" style="width: 2.5rem">
32 |                 ${user.online ? '➤' : ''}
33 |               </div>
34 |               <div class="dtc v-top w1 pr1">
35 |                 ${avatar(user.key, { className: 'w1' })}
36 |               </div>
37 |               <div class="dtc v-mid pl1">
38 |                 <h1 class="f6 ttu tracked mt0">${user.name}</h1>
39 |               </div>
40 |             </article>
41 |           `
42 |         })}
43 |       </div>
44 |     </body>
45 |   `
46 | 
47 |   function navigate (location) {
48 |     emit(state.events.PUSHSTATE, location)
49 |   }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/main/index.js:
--------------------------------------------------------------------------------
 1 | var defaultMenu = require('electron-collection/default-menu')
 2 | const path = require('path')
 3 | const { app, BrowserWindow, ipcMain, Menu, shell } = require('electron')
 4 | const { format } = require('url')
 5 | 
 6 | var CabalPlumbing = require('./cabal-plumbing')
 7 | 
 8 | const isDevelopment = process.env.NODE_ENV !== 'production'
 9 | 
10 | var window
11 | 
12 | var windowStyles = {
13 |   width: 640,
14 |   height: 800,
15 |   frame: true,
16 |   titleBarStyle: 'hidden',
17 |   minWidth: 640,
18 |   minHeight: 480,
19 |   nodeIntegration: false
20 | }
21 | 
22 | var cabalPlumbing
23 | 
24 | app.setName('Cabal Mini')
25 | 
26 | app.requestSingleInstanceLock()
27 | app.on('second-instance', (event, argv, cwd) => {
28 |   app.quit()
29 | })
30 | 
31 | app.on('ready', function () {
32 |   window = new BrowserWindow(windowStyles)
33 | 
34 |   if (isDevelopment) {
35 |     window.webContents.openDevTools()
36 |   }
37 | 
38 |   if (isDevelopment) {
39 |     window.loadURL(`http://localhost:${process.env.ELECTRON_WEBPACK_WDS_PORT}`)
40 |   } else {
41 |     window.loadURL(format({
42 |       pathname: path.join(__dirname, 'index.html'),
43 |       protocol: 'file',
44 |       slashes: true
45 |     }))
46 |   }
47 | 
48 |   window.webContents.on('did-finish-load', function () {
49 |     window.show()
50 |     var menu = Menu.buildFromTemplate(defaultMenu(app, shell))
51 |     Menu.setApplicationMenu(menu)
52 |   })
53 | 
54 |   window.on('closed', function () {
55 |     window = null
56 |   })
57 | 
58 |   window.webContents.on('devtools-opened', () => {
59 |     window.focus()
60 |     setImmediate(() => {
61 |       window.focus()
62 |     })
63 |   })
64 | 
65 |   if (!cabalPlumbing) {
66 |     cabalPlumbing = CabalPlumbing({
67 |       incoming: ipcMain,
68 |       outgoing: window.webContents
69 |     })
70 |   } else {
71 |     cabalPlumbing.addListeners()
72 |   }
73 | })
74 | 
75 | app.on('window-all-closed', function () {
76 |   app.quit()
77 | })
78 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "cabal-desktop-mini",
 3 |   "version": "2.1.0",
 4 |   "description": "a minimal Cabal p2p offline-first desktop application",
 5 |   "private": true,
 6 |   "main": "main.js",
 7 |   "scripts": {
 8 |     "start": "electron-webpack dev",
 9 |     "compile": "electron-webpack",
10 |     "clean": "rimraf dist",
11 |     "build": "npm run compile && electron-builder",
12 |     "dist:multi": "npm run compile && electron-builder -mlw",
13 |     "dist": "./bin/build-multi",
14 |     "test": "standard && test-deps",
15 |     "postinstall": "npm run rebuild && electron-builder install-app-deps",
16 |     "rebuild": "cross-script npm rebuild --runtime=electron \"--target=$(electron -v)\" \"--abi=$(electron --abi)\" --disturl=https://atom.io/download/atom-shell --build-from-source",
17 |     "release": "node bin/release.js"
18 |   },
19 |   "productName": "Cabal Mini",
20 |   "repository": "nikolaiwarner/cabal-desktop-mini",
21 |   "author": "Cabal Club",
22 |   "license": "GPL-3.0",
23 |   "buildDependenciesFromSource": true,
24 |   "nodeGypRebuild": false,
25 |   "npmRebuild": false,
26 |   "build": {
27 |     "appId": "club.cabal.mini",
28 |     "protocols": [
29 |       {
30 |         "name": "cabal",
31 |         "schemes": [
32 |           "cabal"
33 |         ]
34 |       }
35 |     ],
36 |     "mac": {
37 |       "category": "public.app-category.utilities"
38 |     },
39 |     "dmg": {
40 |       "artifactName": "cabal-desktop-mini-${version}-mac.${ext}"
41 |     },
42 |     "linux": {
43 |       "target": [
44 |         "AppImage",
45 |         "snap"
46 |       ],
47 |       "category": "Network"
48 |     },
49 |     "appImage": {
50 |       "artifactName": "cabal-desktop-mini-${version}-linux-${arch}.${ext}"
51 |     },
52 |     "nsis": {
53 |       "artifactName": "cabal-desktop-mini-${version}-windows.${ext}"
54 |     }
55 |   },
56 |   "dependencies": {
57 |     "cabal-core": "^5.1.2",
58 |     "choo": "^6.13.3",
59 |     "choo-devtools": "^2.5.1",
60 |     "collect-stream": "^1.2.1",
61 |     "cross-script": "^1.0.5",
62 |     "dat-encoding": "^5.0.1",
63 |     "dat-node": "^3.5.15",
64 |     "discovery-swarm": "^5.1.4",
65 |     "electron-collection": "^1.2.0",
66 |     "gh-release": "^3.5.0",
67 |     "hypercore-crypto": "^1.0.0",
68 |     "identicon.js": "^2.3.3",
69 |     "js-yaml": "^3.13.1",
70 |     "mkdirp": "^0.5.1",
71 |     "moment": "^2.24.0",
72 |     "random-access-memory": "^3.1.1",
73 |     "source-map-support": "^0.5.12",
74 |     "tachyons": "^4.11.1"
75 |   },
76 |   "devDependencies": {
77 |     "cross-env": "^5.2.0",
78 |     "electron": "^4.2.2",
79 |     "electron-builder": "^20.40.2",
80 |     "electron-webpack": "^2.6.2",
81 |     "file-loader": "^3.0.1",
82 |     "rimraf": "^2.6.3",
83 |     "standard": "^12.0.1",
84 |     "webpack": "^4.32.0"
85 |   }
86 | }
87 | 


--------------------------------------------------------------------------------
/src/renderer/views/cabals.js:
--------------------------------------------------------------------------------
 1 | var html = require('choo/html')
 2 | const { clipboard, ipcRenderer, remote } = window.require('electron')
 3 | 
 4 | var avatar = require('./avatar')
 5 | 
 6 | var appVersion = remote.app.getVersion()
 7 | var cabalCoreVersion = '5'
 8 | var TITLE = 'Cabal Mini'
 9 | 
10 | // Get initial state
11 | ipcRenderer.sendSync('cabal-get-state')
12 | 
13 | module.exports = function (state, emit) {
14 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
15 | 
16 |   state.cabalState.cabals = state.cabalState.cabals || {}
17 | 
18 |   console.log(state)
19 | 
20 |   return html`
21 |     <body class="sans-serif">
22 |       <nav class="ph4 pt4">
23 |         <a style="opacity: 0" class="f6 link br3 ph3 pv2 mb1 dib white bg-black" onclick=${() => navigate('/cabals')}>Cabal</a>
24 |       </nav>
25 |       <h1 class="ph4 f3 f2-m f1-l">
26 |         ${TITLE}
27 |         <a onclick=${createCabal} class="hover-dark-pink pointer link black-50 b f6 f5-ns dib mh3 ttu" title="Create a new Cabal">NEW</a>
28 |         <a onclick=${() => navigate('/join')} class="hover-dark-pink pointer link black-50 b f6 f5-ns dib mr3 ttu" title="Join a Cabal">JOIN</a>
29 |       </h1>
30 | 
31 |       <div class="pa4">
32 |         ${Object.entries(state.cabalState.cabals).map((cabal) => {
33 |           var alias = cabal[0]
34 |           var key = cabal[1]
35 |           if (alias === key) {
36 |             alias = key.substr(0, 6)
37 |           }
38 |           return html`
39 |             <div class="flex b--black-05 pb3 mt2">
40 |               <div class="pointer v-mid" style="width: 2.5rem" onclick=${() => loadCabal(key)}>
41 |                 ${avatar(key)}
42 |               </div>
43 |               <div class="flex-auto v-mid pl1 pointer" onclick=${() => loadCabal(key)}>
44 |                 <h1 class="f3 ttu tracked mt1 link black hover-dark-pink">${alias}</h1>
45 |               </div>
46 |               <div onclick=${() => sendKeyToClipboard(key)} class="f6 bg-white hover-dark-pink pointer pa1 black-20">
47 |                 Share Cabal
48 |               </div>
49 |               <div onclick=${() => removeCabal(key)} class="f6 bg-white hover-dark-pink pointer pa1 black-10">
50 |                 Remove
51 |               </div>
52 |             </div>
53 |           `
54 |         })}
55 |       </div>
56 |       <div class="pa4 f6 hover-dark-pink black-20">
57 |         cabal mini version: ${appVersion}
58 |         <br>
59 |         cabal-core version: ${cabalCoreVersion}
60 |       </div>
61 |     </body>
62 |   `
63 | 
64 |   function createCabal () {
65 |     loadCabal()
66 |   }
67 | 
68 |   function navigate (location) {
69 |     emit(state.events.PUSHSTATE, location)
70 |   }
71 | 
72 |   function loadCabal (key) {
73 |     ipcRenderer.sendSync('cabal-load-cabal', { key })
74 |     navigate('/messenger')
75 |   }
76 | 
77 |   function removeCabal (key) {
78 |     ipcRenderer.sendSync('cabal-remove-cabal', { key })
79 |   }
80 | 
81 |   function sendKeyToClipboard (key) {
82 |     key = 'cabal://' + key
83 |     clipboard.writeText(key)
84 |     window.alert(key + '\n\nThe Cabal key was copied to your clipboard! Now give it to people you want to join your Cabal. Only people with the link can join.')
85 |   }
86 | }
87 | 


--------------------------------------------------------------------------------
/src/renderer/views/messenger.js:
--------------------------------------------------------------------------------
  1 | var html = require('choo/html')
  2 | var moment = require('moment')
  3 | var Component = require('choo/component')
  4 | const { ipcRenderer } = window.require('electron')
  5 | 
  6 | var avatar = require('./avatar')
  7 | 
  8 | var TITLE = 'Cabal Mini'
  9 | 
 10 | module.exports = function (state, emit) {
 11 |   if (state.title !== TITLE) emit(state.events.DOMTITLECHANGE, TITLE)
 12 |   state.sentMessageHistory = state.sentMessageHistory || []
 13 |   state.sentMessageHistoryScrollIndex = state.sentMessageHistoryScrollIndex || 0
 14 |   state.cabalState.key = state.cabalState.key || ''
 15 |   state.cabalState.channel = state.cabalState.channel || 'default'
 16 |   state.cabalState.channels = state.cabalState.channels || []
 17 |   state.cabalState.messages = state.cabalState.messages || []
 18 |   state.cabalState.currentUser = state.cabalState.user || { key: '' }
 19 |   state.cabalState.users = state.cabalState.users || {}
 20 | 
 21 |   var keyShort = state.cabalState.keyAlias || state.cabalState.key.substr(0, 6) || 'CABALS'
 22 |   var currentUserName = state.cabalState.currentUser.name || (state.cabalState.currentUser.key && state.cabalState.currentUser.key.substr(0, 6))
 23 |   var previousMessage = {}
 24 | 
 25 |   setTimeout(function () {
 26 |     scrollToBottom()
 27 |   }, 1000)
 28 | 
 29 |   return html`
 30 |     <body class="sans-serif flex flex-column">
 31 |       <nav class="ph4 pt4">
 32 |         <a style="opacity: 0" class="f6 link br3 ph3 pv2 mb1 dib white bg-black" onclick=${() => navigate('/cabals')}>Cabal</a>
 33 |       </nav>
 34 |       <h1 class="ph4 f3 f2-m f1-l">
 35 |         <a onclick=${() => navigate('/cabals')} class="hover-dark-pink pointer link black" title="Cabal">${TITLE}</a>
 36 |         <a onclick=${() => navigate('/cabals')} class="hover-dark-pink pointer link black-50 b f6 f5-ns dib mh3 ttu" title="${keyShort}">${keyShort}</a>
 37 |         <a onclick=${() => navigate('/settings')} class="hover-dark-pink pointer link black-50 b f6 f5-ns dib mr3 ttu" title="${state.cabalState.currentUser.key}">${currentUserName}</a>
 38 |         <a onclick=${() => navigate('/peers')} class="hover-dark-pink pointer link black-50 b f6 f5-ns dib mr3 ttu" title="Peers">PEERS</a>
 39 |       </h1>
 40 | 
 41 |       <nav class="ph4 w-100 pv3 bt bb b--black-10">
 42 |         ${state.cabalState.channels.map((channel) => {
 43 |           return html`<a class="hover-dark-pink pointer link ${channel === state.cabalState.channel ? 'black' : 'gray'} b f6 f5-ns dib mr3 ttu" title="${channel}" onclick=${function () { loadChannel(channel) }}>${channel}</a>`
 44 |         })}
 45 |         <a onclick=${onClickNewChannel} class="hover-dark-pink pointer link gray b f6 f5-ns dib mr3 ttu" title="New Channel">+</a>
 46 |       </nav>
 47 |       <article id="messages" class="pa4 flex-auto" style="overflow: scroll">
 48 |         ${state.cabalState.messages.map((message) => {
 49 |           var showAvatar = (previousMessage.key !== message.key)
 50 |           previousMessage = message
 51 |           var name = keyToUsername(message.key)
 52 |           var text = message.value.content.text
 53 |           var timestamp = message.value.timestamp
 54 |           var isEmote = message.value.type === 'chat/emote'
 55 |           return html`
 56 |             <article class="dt w-100 b--black-05 pb1 ${showAvatar ? 'mt3' : 'mt1'}">
 57 |               <div class="dtc v-top" style="width: 2.5rem">
 58 |                 ${showAvatar ? avatar(message.key) : ''}
 59 |               </div>
 60 |               <div class="dtc v-mid pl1">
 61 |                 <div class="flex">
 62 |                   ${showAvatar ? html`<h1 class="f7 fw9 ttu mb1 mt0" title=${message.key}>${name}</h1>` : ''}
 63 |                   <time class="f7 fw9 ttu mb1 mt0 ml2 black-30" style="${!showAvatar ? 'height: 0; opacity: 0' : ''}" title=${moment(timestamp).calendar()} datetime=${moment(timestamp).format()}>${moment(timestamp).format('h:mm A')}</time>
 64 |                 </div>
 65 |                 <p class="f5 fw5 mt0 mb0 black-70">
 66 |                   ${isEmote ? html`<span class="fw9 ttu">${name}</span>` : ''}
 67 |                   ${text}
 68 |                 </p>
 69 |               </div>
 70 |             </article>
 71 |           `
 72 |         })}
 73 |       </article>
 74 |       <div class="ph4">
 75 |         <input placeholder="Message #${state.cabalState.channel}" id="messageInput" onkeyup=${onMessageInputKeypress} class="input-reset ba b--black-50 bw2 br3 pa2 mb3 db w-100" type="text">
 76 |       </div>
 77 |     </body>
 78 |   `
 79 | 
 80 |   function scrollToBottom (force) {
 81 |     // if (!force && !this.shouldAutoScroll) return
 82 |     var messagesDiv = document.getElementById('messages')
 83 |     if (messagesDiv) {
 84 |       messagesDiv.scrollTop = messagesDiv.scrollHeight
 85 |     }
 86 |   }
 87 | 
 88 |   function onClickNewChannel () {
 89 |     var input = document.getElementById('messageInput')
 90 |     input.value = '/join '
 91 |     input.focus()
 92 |   }
 93 | 
 94 |   function onMessageInputKeypress (event) {
 95 |     event.preventDefault()
 96 |     // Enter key
 97 |     if (event.keyCode === 13) {
 98 |       sendMessage({})
 99 |     }
100 |     // Up arrow key
101 |     if (event.keyCode === 38) {
102 |       if (state.sentMessageHistory.length) {
103 |         state.sentMessageHistoryScrollIndex = state.sentMessageHistoryScrollIndex - 1
104 |         if (state.sentMessageHistoryScrollIndex >= 0) {
105 |           document.getElementById('messageInput').value = state.sentMessageHistory[state.sentMessageHistoryScrollIndex]
106 |         } else {
107 |           state.sentMessageHistoryScrollIndex = 0
108 |           document.getElementById('messageInput').value = ''
109 |         }
110 |       }
111 |     }
112 |     // Down arrow key
113 |     if (event.keyCode === 40) {
114 |       if (state.sentMessageHistory.length) {
115 |         state.sentMessageHistoryScrollIndex = state.sentMessageHistoryScrollIndex + 1
116 |         if (state.sentMessageHistoryScrollIndex <= state.sentMessageHistory.length - 1) {
117 |           document.getElementById('messageInput').value = state.sentMessageHistory[state.sentMessageHistoryScrollIndex]
118 |         } else {
119 |           state.sentMessageHistoryScrollIndex = state.sentMessageHistory.length
120 |           document.getElementById('messageInput').value = ''
121 |         }
122 |       }
123 |     }
124 |   }
125 | 
126 |   function buildCommands () {
127 |     var commands = {
128 |       nick: {
129 |         help: () => 'change your display name',
130 |         call: (arg) => {
131 |           if (arg === '') return
132 |           publishNick(arg)
133 |         }
134 |       },
135 |       emote: {
136 |         help: () => 'write an old-school text emote',
137 |         call: (arg) => {
138 |           sendMessage({
139 |             text: arg,
140 |             type: 'chat/emote'
141 |           })
142 |         }
143 |       },
144 |       join: {
145 |         help: () => 'join a new channel',
146 |         call: (arg) => {
147 |           if (arg === '') arg = 'default'
148 |           loadChannel(arg)
149 |         }
150 |       },
151 |       quit: {
152 |         help: () => 'exit the cabal process',
153 |         call: (arg) => {
154 |           // TODO
155 |           // process.exit(0)
156 |         }
157 |       },
158 |       topic: {
159 |         help: () => 'set the topic/description/`message of the day` for a channel',
160 |         call: (arg) => {
161 |           // TODO
162 |           // self.cabal.publishChannelTopic(self.channel, arg)
163 |         }
164 |       },
165 |       whoami: {
166 |         help: () => 'display your local user key',
167 |         call: (arg) => {
168 |           // TODO
169 |           // self.view.writeLine.bind(self.view)('Local user key: ' + self.cabal.client.user.key)
170 |         }
171 |       },
172 |       alias: {
173 |         help: () => 'set alias for the cabal',
174 |         call: (arg) => {
175 |           renameCabalAlias(arg)
176 |         }
177 |       },
178 |       add: {
179 |         help: () => 'add a cabal',
180 |         call: (arg) => {
181 |           addAnotherCabal(arg)
182 |         }
183 |       }
184 |     }
185 | 
186 |     // add aliases to commands
187 |     function alias (command, alias) {
188 |       commands[alias] = {
189 |         help: commands[command].help,
190 |         call: commands[command].call
191 |       }
192 |     }
193 |     alias('emote', 'me')
194 |     alias('join', 'j')
195 |     alias('nick', 'n')
196 |     alias('topic', 'motd')
197 |     alias('whoami', 'key')
198 |     alias('quit', 'exit')
199 | 
200 |     return commands
201 |   }
202 | 
203 |   function sendMessage (props) {
204 |     var text = props.text || document.getElementById('messageInput').value
205 |     text = text.trim()
206 |     state.sentMessageHistory.push(text)
207 |     if (state.sentMessageHistory.length > 1000) state.sentMessageHistory.shift()
208 |     state.sentMessageHistoryScrollIndex = state.sentMessageHistory.length
209 | 
210 |     var commandPattern = (/^\/(\w*)\s*(.*)/)
211 |     var match = commandPattern.exec(text)
212 |     var cmd = match ? match[1] : ''
213 |     var arg = match ? match[2] : ''
214 |     arg = arg.trim()
215 | 
216 |     var commands = buildCommands()
217 |     if (cmd in commands) {
218 |       commands[cmd].call(arg)
219 |     } else if (cmd) {
220 |       console.log(`${cmd} is not a command, type /help for commands`)
221 |     } else {
222 |       text = text.trim()
223 |       if (text !== '') {
224 |         ipcRenderer.sendSync('cabal-publish-message', {
225 |           channel: state.cabalState.channel,
226 |           text,
227 |           type: props.type
228 |         })
229 |       }
230 |     }
231 |   }
232 | 
233 |   function loadChannel (channel) {
234 |     ipcRenderer.sendSync('cabal-load-channel', { channel })
235 |   }
236 | 
237 |   function publishNick (nick) {
238 |     ipcRenderer.sendSync('cabal-publish-nick', { nick })
239 |   }
240 | 
241 |   function renameCabalAlias (alias) {
242 |     ipcRenderer.sendSync('cabal-rename-cabal-alias', {
243 |       alias,
244 |       key: state.cabalState.key
245 |     })
246 |   }
247 | 
248 |   function addAnotherCabal (key) {
249 |     ipcRenderer.sendSync('cabal-load-cabal', {
250 |       key
251 |     })
252 |   }
253 | 
254 |   function keyToUsername (key) {
255 |     key = key || ''
256 |     var users = state.cabalState.users || {}
257 |     if (users[key]) {
258 |       return users[key].name || key.substr(0, 6)
259 |     } else {
260 |       return (key && key.substr(0, 6)) || 'Unknown'
261 |     }
262 |   }
263 | 
264 |   function navigate (location) {
265 |     emit(state.events.PUSHSTATE, location)
266 |   }
267 | }
268 | 


--------------------------------------------------------------------------------
/src/main/cabal-plumbing.js:
--------------------------------------------------------------------------------
  1 | var CabalClassic = require('cabal-core')
  2 | // var CabalHyperswarm = require('cabal-core-hyperswarm')
  3 | var collect = require('collect-stream')
  4 | var crypto = require('hypercore-crypto')
  5 | var ram = require('random-access-memory')
  6 | var swarmClassic = require('cabal-core/swarm.js')
  7 | // var swarmHyper = require('cabal-core-hyperswarm/swarm.js')
  8 | var os = require('os')
  9 | var fs = require('fs')
 10 | var yaml = require('js-yaml')
 11 | var mkdirp = require('mkdirp')
 12 | 
 13 | const MAX_FEEDS = 1000
 14 | const MAX_MESSAGES = 1000
 15 | 
 16 | var Cabal = CabalClassic
 17 | var swarm = swarmClassic
 18 | 
 19 | var config
 20 | var homedir = os.homedir()
 21 | var rootdir = homedir + `/.cabal-desktop-mini/v${Cabal.databaseVersion}`
 22 | var rootconfig = `${rootdir}/config.yml`
 23 | var archivesdir = `${rootdir}/archives/`
 24 | 
 25 | // make sure the .cabal/v<databaseVersion> folder exists
 26 | mkdirp.sync(rootdir)
 27 | 
 28 | // create a default config in rootdir if it doesn't exist
 29 | if (!fs.existsSync(rootconfig)) {
 30 |   saveConfig({ cabals: [], aliases: {} })
 31 | }
 32 | 
 33 | // Attempt to load local or homedir config file
 34 | try {
 35 |   config = yaml.safeLoad(fs.readFileSync(rootconfig, 'utf8'))
 36 |   if (!config.cabals) { config.cabals = [] }
 37 |   if (!config.aliases) { config.aliases = {} }
 38 | } catch (e) {
 39 |   console.error(e)
 40 |   process.exit(1)
 41 | }
 42 | 
 43 | // if (config.hyperswarm) {
 44 | //   Cabal = CabalHyperswarm
 45 | //   swarm = swarmHyper
 46 | //   console.log('>>>>>>>>>> CABAL on HYPERSWARM >>>>>>>>>>')
 47 | // }
 48 | 
 49 | function saveConfig (config) {
 50 |   // make sure config is well-formatted (contains all config options)
 51 |   if (!config.cabals) { config.cabals = [] }
 52 |   if (!config.aliases) { config.aliases = {} }
 53 |   let data = yaml.safeDump(config, {
 54 |     sortKeys: true
 55 |   })
 56 |   fs.writeFileSync(rootconfig, data, 'utf8')
 57 | }
 58 | 
 59 | function CabalPlumbing (props) {
 60 |   if (!(this instanceof CabalPlumbing)) return new CabalPlumbing(props)
 61 |   var self = this
 62 | 
 63 |   self.props = props
 64 | 
 65 |   self.cabal = undefined
 66 |   self.messagesListener = undefined
 67 |   self.state = {
 68 |     cabals: config.aliases,
 69 |     key: undefined,
 70 |     channel: 'default',
 71 |     channels: [],
 72 |     user: {}
 73 |   }
 74 | 
 75 |   self.addListeners()
 76 | }
 77 | 
 78 | CabalPlumbing.prototype.addListeners = function (data) {
 79 |   var self = this
 80 |   self.removeListeners()
 81 |   self.incomingEvents = [
 82 |     {
 83 |       type: 'cabal-remove-cabal',
 84 |       func: (event, arg) => self.removeCabal(arg.key)
 85 |     },
 86 |     {
 87 |       type: 'cabal-rename-cabal-alias',
 88 |       func: (event, arg) => self.renameCabalAlias(arg.key, arg.alias)
 89 |     },
 90 |     {
 91 |       type: 'cabal-get-state',
 92 |       func: (event, arg) => self.getState()
 93 |     },
 94 |     {
 95 |       type: 'cabal-publish-nick',
 96 |       func: (event, arg) => self.publishNick(arg.nick)
 97 |     },
 98 |     {
 99 |       type: 'cabal-publish-message',
100 |       func: (event, arg) => self.publishMessage(arg)
101 |     },
102 |     {
103 |       type: 'cabal-load-channel',
104 |       func: (event, arg) => self.loadChannel(arg.channel)
105 |     },
106 |     {
107 |       type: 'cabal-load-cabal',
108 |       func: (event, arg) => self.loadCabal(arg.key)
109 |     }
110 |   ]
111 |   self.incomingEvents.forEach(function (event) {
112 |     event.listener = self.props.incoming.on(event.type, function (e, arg) {
113 |       console.log('==>', event.type, arg)
114 |       event.func(e, arg)
115 |       e.returnValue = arg
116 |     })
117 |   })
118 | }
119 | 
120 | CabalPlumbing.prototype.removeListeners = function (data) {
121 |   var self = this
122 |   if (self.incomingEvents && self.incomingEvents.length) {
123 |     self.incomingEvents.forEach(function (event) {
124 |       if (self.props.incoming) {
125 |         self.props.incoming.removeListener(event.type, event.listener)
126 |       }
127 |     })
128 |   }
129 | }
130 | 
131 | CabalPlumbing.prototype.updateFrontend = function (data) {
132 |   if (data) {
133 |     if (data.reason) {
134 |       console.log('***', data.reason)
135 |     }
136 |   }
137 |   this.state.keyAlias = this.getAliasByKey(this.state.key)
138 |   if (data.event && data.event.type) {
139 |     this.props.outgoing.send(data.extraEvent.type, data.extraEvent.data)
140 |   } else {
141 |     this.props.outgoing.send('cabal-state-update', this.state)
142 |   }
143 | }
144 | 
145 | CabalPlumbing.prototype.loadCabal = function (key, temp) {
146 |   var self = this
147 |   if (!key) {
148 |     key = crypto.keyPair().publicKey.toString('hex')
149 |   }
150 |   self.state.key = key.replace('cabal://', '').replace('cbl://', '').replace('dat://', '').replace(/\//g, '')
151 |   var storage
152 |   if (temp) {
153 |     storage = ram
154 |   } else {
155 |     storage = archivesdir + self.state.key
156 |     if (!Object.values(config.aliases).includes(self.state.key)) {
157 |       config.aliases[self.state.key] = self.state.key
158 |       self.state.cabals = config.aliases
159 |       saveConfig(config)
160 |     }
161 |   }
162 |   self.state.keyAlias = self.getAliasByKey(self.state.key)
163 |   self.cabal = Cabal(storage, self.state.key, { maxFeeds: MAX_FEEDS })
164 |   self.cabal.ready(function () {
165 |     swarm(self.cabal)
166 | 
167 |     self.updateFrontend({ reason: 'cabal db ready' })
168 | 
169 |     setTimeout(() => {
170 |       self.cabal.channels.get(function (err, channels) {
171 |         if (err) return
172 |         self.state.channels = channels
173 | 
174 |         self.updateFrontend({ reason: 'get channels' })
175 | 
176 |         self.loadChannel(self.state.channel)
177 | 
178 |         self.cabal.channels.events.on('add', function (channel) {
179 |           self.state.channels.push(channel)
180 |           self.state.channels.sort()
181 |           self.updateFrontend({ reason: 'added channel' })
182 |         })
183 |       })
184 | 
185 |       self.cabal.users.getAll(function (err, users) {
186 |         if (err) return
187 |         self.state.users = users
188 | 
189 |         updateLocalKey()
190 | 
191 |         self.cabal.users.events.on('update', function (key) {
192 |           self.cabal.users.get(key, function (err, user) {
193 |             if (err) return
194 |             self.state.users[key] = Object.assign(self.state.users[key] || {}, user)
195 |             if (self.state.user && key === self.state.user.key) self.state.user = self.state.users[key]
196 |             if (!self.state.user) updateLocalKey()
197 |             self.updateFrontend({ reason: 'get users' })
198 |             self.updateFrontend({
199 |               type: 'cabal-users-update',
200 |               data: {
201 |                 user: self.state.users[key]
202 |               }
203 |             })
204 |           })
205 | 
206 |           self.cabal.topics.events.on('update', function (msg) {
207 |             self.state.topic = msg.value.content.topic
208 |             self.updateFrontend({ reason: 'get topics' })
209 |           })
210 |         })
211 | 
212 |         self.cabal.on('peer-added', function (key) {
213 |           var found = false
214 |           Object.keys(self.state.users).forEach(function (k) {
215 |             if (k === key) {
216 |               self.state.users[k].online = true
217 |               found = true
218 |             }
219 |           })
220 |           if (!found) {
221 |             self.state.users[key] = {
222 |               key: key,
223 |               online: true
224 |             }
225 |           }
226 |           self.updateFrontend({ reason: 'peer added: ' + key })
227 |         })
228 |         self.cabal.on('peer-dropped', function (key) {
229 |           Object.keys(self.state.users).forEach(function (k) {
230 |             if (k === key) {
231 |               self.state.users[k].online = false
232 |               self.updateFrontend({ reason: 'peer dropped: ' + key })
233 |             }
234 |           })
235 |         })
236 | 
237 |         function updateLocalKey () {
238 |           self.cabal.getLocalKey(function (err, lkey) {
239 |             // set local key for local user
240 |             self.state.user.key = lkey
241 |             if (err) {
242 |               self.updateFrontend({ reason: 'get local key' })
243 |               return
244 |             }
245 |             // try to get more data for user
246 |             Object.keys(users).forEach(function (key) {
247 |               if (key === lkey) {
248 |                 self.state.user = users[key]
249 |                 self.state.user.local = true
250 |                 self.state.user.online = true
251 |               }
252 |             })
253 |             self.updateFrontend({ reason: 'get local key' })
254 |           })
255 |         }
256 |       })
257 |     }, 2000)
258 |   })
259 | }
260 | 
261 | CabalPlumbing.prototype.loadChannel = function (channel) {
262 |   var self = this
263 |   if (self.messagesListener) {
264 |     self.cabal.messages.events.removeListener(self.state.channel, self.messagesListener)
265 |     self.messagesListener = null
266 |   }
267 | 
268 |   // clear the old channel state
269 |   self.state.channel = channel
270 |   self.state.messages = []
271 |   self.state.topic = ''
272 |   self.updateFrontend({ reason: 'set fresh channel state' })
273 | 
274 |   var pending = 0
275 |   function onMessage () {
276 |     if (pending > 0) {
277 |       pending++
278 |       return
279 |     }
280 |     pending = 1
281 | 
282 |     var rs = self.cabal.messages.read(channel, { limit: MAX_MESSAGES, lt: '~' })
283 |     collect(rs, function (err, messages) {
284 |       if (err) return
285 | 
286 |       self.state.messages = []
287 |       messages.reverse()
288 |       messages.forEach(function (msg) {
289 |         self.state.messages.push(self.formatMessage(msg))
290 |       })
291 | 
292 |       self.updateFrontend({ reason: 'new messages' })
293 |       self.updateFrontend({
294 |         type: 'cabal-messages-update',
295 |         data: {
296 |           messages
297 |         }
298 |       })
299 | 
300 |       self.cabal.topics.get(channel, (err, topic) => {
301 |         if (err) return
302 |         if (topic) {
303 |           self.state.topic = topic
304 |           self.updateFrontend({ reason: 'get topic' })
305 |         }
306 |       })
307 | 
308 |       if (pending > 1) {
309 |         pending = 0
310 |         onMessage()
311 |       } else {
312 |         pending = 0
313 |       }
314 |     })
315 |   }
316 | 
317 |   self.cabal.messages.events.on(channel, onMessage)
318 |   self.messagesListener = onMessage
319 | 
320 |   onMessage()
321 | }
322 | 
323 | CabalPlumbing.prototype.getState = function () {
324 |   this.updateFrontend({ reason: 'get state' })
325 | }
326 | 
327 | CabalPlumbing.prototype.publishNick = function (nick) {
328 |   this.cabal.publishNick(nick)
329 | }
330 | 
331 | CabalPlumbing.prototype.formatMessage = function (message) {
332 |   return message
333 | }
334 | 
335 | CabalPlumbing.prototype.publishMessage = function (arg) {
336 |   this.cabal.publish({
337 |     type: arg.type || 'chat/text',
338 |     content: {
339 |       channel: this.state.channel,
340 |       text: arg.text
341 |     }
342 |   })
343 | }
344 | 
345 | CabalPlumbing.prototype.getAliasByKey = function (key, dontTruncate) {
346 |   var index = Object.values(config.aliases).indexOf(key)
347 |   var alias = Object.keys(config.aliases)[index]
348 |   if (alias && !dontTruncate && alias === key) {
349 |     alias = alias.substr(0, 6)
350 |   }
351 |   return alias
352 | }
353 | 
354 | CabalPlumbing.prototype.getKeyByAlias = function (alias) {
355 |   return config.aliases[alias]
356 | }
357 | 
358 | CabalPlumbing.prototype.renameCabalAlias = function (key, alias) {
359 |   var aliases = Object.keys(config.aliases)
360 |   var keys = Object.values(config.aliases)
361 |   aliases[keys.indexOf(key)] = alias
362 |   config.aliases = {}
363 |   aliases.forEach(function (alias, index) {
364 |     config.aliases[alias] = keys[index]
365 |   })
366 |   this.state.cabals = config.aliases
367 |   this.updateFrontend({ reason: 'renamed cabal' })
368 |   saveConfig(config)
369 | }
370 | 
371 | CabalPlumbing.prototype.removeCabal = function (key) {
372 |   var alias = this.getAliasByKey(key, true)
373 |   delete config.aliases[alias]
374 |   delete this.state.cabals[alias]
375 |   this.updateFrontend({ reason: 'removed cabal' })
376 |   saveConfig(config)
377 | }
378 | 
379 | module.exports = CabalPlumbing
380 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU AFFERO GENERAL PUBLIC LICENSE
  2 |                        Version 3, 19 November 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 |     <one line to give the program's name and a brief idea of what it does.>
633 |     Copyright (C) <year>  <name of author>
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 <https://www.gnu.org/licenses/>.
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 | <https://www.gnu.org/licenses/>.
662 | 


--------------------------------------------------------------------------------