├── .travis.yml ├── .npmignore ├── test └── test.js ├── publish.sh ├── .gitignore ├── package.json ├── .eslintrc.json ├── README.md ├── index.js └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | 3 | node_js: 4 | - stable 5 | 6 | install: 7 | - npm install 8 | 9 | script: 10 | - npm run lint 11 | - npm run cover 12 | 13 | # Send coverage data to Coveralls 14 | after_script: "cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js" -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | #node 2 | node_modules 3 | 4 | #tests 5 | test 6 | coverage 7 | 8 | #build tools 9 | .travis.yml 10 | .jenkins.yml 11 | .codeclimate.yml 12 | 13 | #linters 14 | .jscsrc 15 | .jshintrc 16 | .eslintrc* 17 | 18 | #editor settings 19 | .editorconfig 20 | 21 | #typedefs 22 | typedefs.js -------------------------------------------------------------------------------- /test/test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const {expect} = require('chai'); 4 | const ChaturbateController = require('../index'); 5 | 6 | describe('ChaturbateController', () => { 7 | it('should be exported', () => { 8 | expect(ChaturbateController).to.not.equal(undefined); 9 | }); 10 | }); 11 | -------------------------------------------------------------------------------- /publish.sh: -------------------------------------------------------------------------------- 1 | #/bin/bash 2 | 3 | #yarn lint || exit 0; 4 | yarn test || exit 0; 5 | 6 | VERSION="$(node -p "require('./package.json').version")" 7 | CURRENT_VERSION="$(npm info . version)" 8 | COMMENT= 9 | 10 | git add . || exit 1 11 | git status 12 | 13 | echo "Comment (${CURRENT_VERSION} -> ${VERSION}): " 14 | read COMMENT 15 | 16 | git commit -m "${COMMENT}" || exit 1 17 | 18 | if [ "${VERSION}" != "${CURRENT_VERSION}" ]; then 19 | echo "creating new git tag for ${VERSION}" 20 | git tag "v${VERSION}" || exit 1 21 | else 22 | echo "skipping git tag" 23 | fi 24 | 25 | git push origin master --tags || exit 1 26 | 27 | if [ "${VERSION}" != "${CURRENT_VERSION}" ]; then 28 | echo "${CURRENT_VERSION} -> ${VERSION}" 29 | npm publish --access=public 30 | else 31 | echo "Versions are the same, not publishing" 32 | fi -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | yarn.lock 14 | package-lock.json 15 | 16 | # Directory for instrumented libs generated by jscoverage/JSCover 17 | lib-cov 18 | 19 | # Coverage directory used by tools like istanbul 20 | coverage 21 | 22 | # nyc test coverage 23 | .nyc_output 24 | 25 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 26 | .grunt 27 | 28 | # Bower dependency directory (https://bower.io/) 29 | bower_components 30 | 31 | # node-waf configuration 32 | .lock-wscript 33 | 34 | # Compiled binary addons (http://nodejs.org/api/addons.html) 35 | build/Release 36 | 37 | # Dependency directories 38 | node_modules/ 39 | jspm_packages/ 40 | 41 | # Typescript v1 declaration files 42 | typings/ 43 | 44 | # Optional npm cache directory 45 | .npm 46 | 47 | # Optional eslint cache 48 | .eslintcache 49 | 50 | # Optional REPL history 51 | .node_repl_history 52 | 53 | # Output of 'npm pack' 54 | *.tgz 55 | 56 | # Yarn Integrity file 57 | .yarn-integrity 58 | 59 | # dotenv environment variables file 60 | .env 61 | 62 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@paulallen87/chaturbate-controller", 3 | "version": "1.2.1", 4 | "description": "A module for tracking the state of a Chaturbate profile.", 5 | "main": "index.js", 6 | "engines": { 7 | "node": ">=8.0.0" 8 | }, 9 | "scripts": { 10 | "lint": "node_modules/.bin/eslint . --ext js --ignore-path .gitignore", 11 | "lint:fix": "node_modules/.bin/eslint --fix . --ext js --ignore-path .gitignore", 12 | "test": "node_modules/.bin/mocha --reporter spec", 13 | "cover": "node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- -R spec test/*" 14 | }, 15 | "repository": { 16 | "type": "git", 17 | "url": "git+https://github.com/paulallen87/chaturbate-controller.git" 18 | }, 19 | "keywords": [ 20 | "chaturbate" 21 | ], 22 | "author": "“Paul Allen <“paul.allen.87.555@gmail.com”>", 23 | "license": "GPL-3.0", 24 | "bugs": { 25 | "url": "https://github.com/paulallen87/chaturbate-controller/issues" 26 | }, 27 | "homepage": "https://github.com/paulallen87/chaturbate-controller#readme", 28 | "devDependencies": { 29 | "chai": "^4.2.0", 30 | "coveralls": "^3.0.2", 31 | "eslint": "^5.7.0", 32 | "eslint-config-google": "^0.11.0", 33 | "eslint-plugin-jsdoc": "^3.9.1", 34 | "eslint-plugin-node": "^7.0.1", 35 | "istanbul": "next", 36 | "mocha": "^5.2.0" 37 | }, 38 | "dependencies": { 39 | "@paulallen87/chaturbate-events": "^1.2.1", 40 | "@paulallen87/chaturbate-panel-parser": "^1.2.1", 41 | "cheerio": "^1.0.0-rc.2", 42 | "debug": "^4.1.0" 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "eslint:all", 4 | "google", 5 | "plugin:node/recommended" 6 | ], 7 | "parserOptions": { 8 | "ecmaVersion": 2017 9 | }, 10 | "env": { 11 | "node": true, 12 | "es6": true, 13 | "browser": true, 14 | "mocha": true 15 | }, 16 | "plugins": [ 17 | "node", 18 | "jsdoc" 19 | ], 20 | "rules": { 21 | "valid-jsdoc": "error", 22 | "require-jsdoc": ["error", { 23 | "require": { 24 | "FunctionDeclaration": true, 25 | "MethodDefinition": true, 26 | "ClassDeclaration": true, 27 | "ArrowFunctionExpression": true 28 | } 29 | }], 30 | "node/exports-style": ["error", "module.exports"], 31 | "jsdoc/check-param-names": 2, 32 | "jsdoc/check-tag-names": 2, 33 | "jsdoc/check-types": 2, 34 | "jsdoc/newline-after-description": 2, 35 | "jsdoc/require-description-complete-sentence": 2, 36 | "jsdoc/require-example": 0, 37 | "jsdoc/require-hyphen-before-param-description": 2, 38 | "jsdoc/require-param": 2, 39 | "jsdoc/require-param-description": 0, 40 | "jsdoc/require-param-type": 2, 41 | "jsdoc/require-returns-description": 0, 42 | "jsdoc/require-returns-type": 2, 43 | "indent": "off", 44 | "max-lines": "off", 45 | "no-undefined": "off", 46 | "padded-blocks": "off", 47 | "no-underscore-dangle": "off", 48 | "arrow-body-style": "off", 49 | "object-curly-newline": "off", 50 | "object-shorthand": "off", 51 | "no-sync": "off", 52 | "strict": "warn", 53 | "max-statements": "off", 54 | "max-params": "off", 55 | "id-length": "off", 56 | "no-warning-comments": "warn", 57 | "sort-keys": "off", 58 | "array-element-newline": "off", 59 | "newline-per-chained-call": "off", 60 | "no-magic-numbers": "off", 61 | "dot-location": "off", 62 | "no-ternary": "off", 63 | "multiline-ternary": "off", 64 | "no-extra-parens": "off", 65 | "no-irregular-whitespace": "off", 66 | "no-empty-function": "off" 67 | }, 68 | "settings": { 69 | "jsdoc": { 70 | "tagNamePreference": { 71 | "returns": "return", 72 | "augments": "extends", 73 | "class": "constructor" 74 | } 75 | } 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Chaturbate Controller 2 | ========= 3 | 4 | ![build status](https://travis-ci.org/paulallen87/chaturbate-controller.svg?branch=master) 5 | ![coverage status](https://coveralls.io/repos/github/paulallen87/chaturbate-controller/badge.svg?branch=master) 6 | ![dependencies](https://img.shields.io/david/paulallen87/chaturbate-controller.svg) 7 | ![dev dependencies](https://img.shields.io/david/dev/paulallen87/chaturbate-controller.svg) 8 | ![npm version](https://img.shields.io/npm/v/@paulallen87/chaturbate-controller.svg) 9 | 10 | 11 | A client for storing and parsing chaturbate-browser events. 12 | 13 | The events are published from the [chaturbate-browser](https://github.com/paulallen87/chaturbate-browser) module. Then they are transformed by the [chaturbate-events](https://github.com/paulallen87/chaturbate-events) module. Then this modules handles them to interpret the state of the chaturbate profile 14 | 15 | All chaturbate events from [chaturbate-events](https://github.com/paulallen87/chaturbate-events) are proxied through this module. Any events containing a [User Object](#user-obects) will be enhanced with a "isHost" attribute. 16 | 17 | ## Installation 18 | 19 | ```shell 20 | npm install @paulallen87/chaturbate-controller 21 | ``` 22 | 23 | ## Usage 24 | 25 | ```javascript 26 | const browser = new ChaturbateBrowser(); 27 | const controller = new ChaturbateController(browser); 28 | 29 | controller.on('room_message', (e) => { 30 | console.log(`${e.user.username}: ${e.message}`); 31 | }) 32 | 33 | controller.on('tip', (e) => { 34 | console.log(`${e.user.username} tipped ${e.amount} tokens`); 35 | }) 36 | 37 | await browser.start(); 38 | 39 | browser.profile(''); 40 | 41 | setTimeout(() => browser.stop(), 10 * 1000); 42 | ``` 43 | 44 | ## Properties 45 | * **state** (string) 46 | * **modelStatus** (string) 47 | * **appInfo** (Object) 48 | * **room** (string) 49 | * **gender** (string) 50 | * **welcomeMessage** (string) 51 | * **subject** (string) 52 | * **spyPrice** (number) 53 | * **viewCount** (number) 54 | * **panel** (Object) 55 | * **groupsEnabled** (boolean) 56 | * **groupPrice** (number) 57 | * **groupNumUsersRequired** (number) 58 | * **groupNumUsersWaiting** (number) 59 | * **privatesEnabled** (boolean) 60 | * **privatePrice** (number) 61 | 62 | ## Events 63 | 64 | ### **state_change** 65 | Called when the browser hook is initialized. 66 | 67 | ##### states 68 | * INIT 69 | * CONNECTING 70 | * CONNECTED 71 | * JOINED 72 | * LEAVE 73 | * KICKED 74 | * DISCONNECTED 75 | * ERROR 76 | * FAIL 77 | * OFFLINE 78 | 79 | ### **model_status_change** 80 | 81 | ##### statuses 82 | * PUBLIC 83 | * AWAY 84 | * PRIVATE 85 | * GROUP 86 | 87 | ### **goal_progress** / **goal_reached** 88 | 89 | ##### params 90 | * **hasGoal** (boolean) 91 | * **hasMultipleGoals** (boolean) 92 | * **goalAmount** (number) 93 | * **goalCurrent** (number) 94 | * **goalRemaining** (number) 95 | * **goalCount** (number) 96 | * **goalTotal** (number) 97 | * **tipBiggestUsername** (string) 98 | * **tipBiggestAmount** (number) 99 | * **tipRecentUsername** (string) 100 | * **tipRecentAmount** (number) 101 | * **tipperCount** (number) 102 | 103 | ## Chaturbate Events 104 | 105 | All events from [chaturbate-events](https://github.com/paulallen87/chaturbate-events#events) are proxies through this module. 106 | 107 | ## User Objects 108 | 109 | User Objects from [tip](https://github.com/paulallen87/chaturbate-events#tip), [room_leave](https://github.com/paulallen87/chaturbate-events#room_leave), [room_join](https://github.com/paulallen87/chaturbate-events#room_join), and [room_message](https://github.com/paulallen87/chaturbate-events#room_message) events are enhanced with an **isHost** attribute. 110 | 111 | See [chaturbate-events](https://github.com/paulallen87/chaturbate-events#user-objects) for more details. 112 | 113 | ## Tests 114 | 115 | ```shell 116 | npm test 117 | ``` -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const debug = require("debug")("chaturbate:controller"); 4 | const { EventEmitter } = require("events"); 5 | const cheerio = require("cheerio"); 6 | 7 | const ChaturbateEvents = require("@paulallen87/chaturbate-events"); 8 | const panelParser = require("@paulallen87/chaturbate-panel-parser"); 9 | 10 | /** 11 | * Controller states. 12 | * 13 | * @enum {string} 14 | */ 15 | const State = { 16 | /** The websocket is connected. */ 17 | CONNECTED: "CONNECTED", 18 | 19 | /** The websocket is connecting. */ 20 | CONNECTING: "CONNECTING", 21 | 22 | /** The websocket has disconnected. */ 23 | DISCONNECTED: "DISCONNECTED", 24 | 25 | /** The websocket has thrown an error. */ 26 | ERROR: "ERROR", 27 | 28 | /** The websocket has filed to authenticate. */ 29 | FAIL: "FAIL", 30 | 31 | /** The controller is initializing. */ 32 | INIT: "INIT", 33 | 34 | /** The websocket has successfully joined the room. */ 35 | JOINED: "JOINED", 36 | 37 | /** You have been kicked from the room. */ 38 | KICKED: "KICKED", 39 | 40 | /** You have left the room. */ 41 | LEAVE: "LEAVE", 42 | 43 | /** The room is offline. */ 44 | OFFLINE: "OFFLINE" 45 | }; 46 | 47 | /** 48 | * Model states. 49 | * 50 | * @enum {string} 51 | */ 52 | const ModelStatus = { 53 | /** The model is away from the room. */ 54 | AWAY: "AWAY", 55 | 56 | /** The model is in a group show. */ 57 | GROUP: "GROUP", 58 | 59 | /** The model is in a hidden show. */ 60 | HIDDEN: "HIDDEN", 61 | 62 | /** The model is in a private show. */ 63 | PRIVATE: "PRIVATE", 64 | 65 | /** The model is in a public show. */ 66 | PUBLIC: "PUBLIC" 67 | }; 68 | 69 | /** 70 | * Transforms Panel HTML into an object. 71 | * 72 | * @param {string} html 73 | * @return {Object} 74 | * @private 75 | */ 76 | const _transformPanelHtml = html => { 77 | const $ = cheerio.load(html); 78 | 79 | const transformed = $("tr").map((index, el) => { 80 | let label = $(el) 81 | .find("th") 82 | .text(); 83 | label = label.replace(/\s*\n\s*/g, ""); 84 | label = label.replace(/\s*:\s*$/g, ""); 85 | label = label.replace(/\s*-\s*$/g, ""); 86 | 87 | let value = $(el) 88 | .find("td") 89 | .text(); 90 | value = value.replace(/\s*\n\s*/g, ""); 91 | 92 | return { 93 | label: label, 94 | value: value 95 | }; 96 | }); 97 | 98 | return transformed.get(); 99 | }; 100 | 101 | /** 102 | * A controller for tracking chaturbate events and states. 103 | */ 104 | class ChaturbateController extends EventEmitter { 105 | /** 106 | * Constructor. 107 | * 108 | * @param {ChaturbateBrowser} browser 109 | * @constructor 110 | * @extends EventEmitter 111 | */ 112 | constructor(browser) { 113 | super(); 114 | this._browser = browser; 115 | 116 | this._events = new ChaturbateEvents(browser); 117 | this._events.on("init", e => this._onInit(e)); 118 | this._events.on("socket_open", () => this._onSocketOpen()); 119 | this._events.on("socket_error", e => this._onSocketError(e)); 120 | this._events.on("socket_close", e => this._onSocketClose(e)); 121 | 122 | this._api = {}; 123 | this._hooks = {}; 124 | 125 | // State 126 | this._state = null; 127 | this._modelStatus = null; 128 | this._appInfo = []; 129 | this._goal = null; 130 | 131 | // General 132 | this.room = null; 133 | this.gender = null; 134 | this.welcomeMessage = null; 135 | this.subject = null; 136 | this.spyPrice = 0; 137 | this.viewCount = 0; 138 | 139 | // Ui 140 | this.panel = []; 141 | 142 | // Group shows 143 | this.groupsEnabled = false; 144 | this.groupPrice = 0; 145 | this.groupNumUsersRequired = 0; 146 | this.groupNumUsersWaiting = 0; 147 | 148 | // Private shows 149 | this.privatesEnabled = false; 150 | this.privatePrice = 0; 151 | 152 | this._initEventHooks(); 153 | this._patchEvents(); 154 | } 155 | 156 | /** 157 | * Gets a list of supported event names. 158 | * 159 | * @type {Array} 160 | */ 161 | get eventNames() { 162 | return this._events.names.concat([ 163 | "model_status_change", 164 | "state_change", 165 | "goal_progress", 166 | "goal_reached" 167 | ]); 168 | } 169 | 170 | /** 171 | * Getter for the current state of the controller. 172 | * 173 | * @type {State} 174 | */ 175 | get state() { 176 | return this._state; 177 | } 178 | 179 | /** 180 | * Setter for the current state of the controller. 181 | * 182 | * @param {State} val 183 | * @ignore 184 | */ 185 | set state(val) { 186 | if (this._state !== val) { 187 | debug(`state changed to ${val}`); 188 | this._state = val; 189 | this.emit("state_change", { state: val }); 190 | } 191 | } 192 | 193 | /** 194 | * Getter for the current model status. 195 | * 196 | * @type {ModelStatus} 197 | */ 198 | get modelStatus() { 199 | return this._modelStatus; 200 | } 201 | 202 | /** 203 | * Setter for the current model status. 204 | * 205 | * @param {ModelStatus} val 206 | * @ignore 207 | */ 208 | set modelStatus(val) { 209 | if (this._modelStatus !== val) { 210 | debug(`model status changed to ${val}`); 211 | this._modelStatus = val; 212 | this.emit("model_status_change", { status: val }); 213 | } 214 | } 215 | 216 | /** 217 | * Getter for the current panel app (not bot). 218 | * 219 | * @type {string} 220 | */ 221 | get panelApp() { 222 | if (!this.appInfo) return undefined; 223 | if (!this.appInfo.length) return undefined; 224 | return this.appInfo[0].name; 225 | } 226 | 227 | /** 228 | * Getter for the current panel app (not bot). 229 | * 230 | * @type {Object} 231 | */ 232 | get goal() { 233 | return this._goal; 234 | } 235 | 236 | /** 237 | * Getter for the current panel app (not bot). 238 | * 239 | * @param {Object} val 240 | * @ignore 241 | */ 242 | set goal(val) { 243 | this._checkGoal(this._goal, val); 244 | this._goal = val; 245 | } 246 | 247 | /** 248 | * Getter for the current room settings. 249 | * 250 | * @type {Object} 251 | */ 252 | get settings() { 253 | return { 254 | state: this.state, 255 | room: this.room, 256 | welcomeMessage: this.welcomeMessage, 257 | subject: this.subject, 258 | gender: this.gender, 259 | viewCount: this.viewCount, 260 | spyPrice: this.spyPrice, 261 | groupsEnabled: this.groupsEnabled, 262 | groupPrice: this.groupPrice, 263 | groupNumUsersRequired: this.groupNumUsersRequired, 264 | groupNumUsersWaiting: this.groupNumUsersWaiting, 265 | privatesEnabled: this.privatesEnabled, 266 | privatePrice: this.privatePrice, 267 | modelStatus: this.modelStatus, 268 | panel: this.panel, 269 | appInfo: this.appInfo, 270 | goal: this.goal 271 | }; 272 | } 273 | 274 | /** 275 | * Getter for API endpoints. 276 | * 277 | * @type {Object} 278 | */ 279 | get api() { 280 | return this._api; 281 | } 282 | 283 | /** 284 | * Setter for API endpoints. 285 | * 286 | * @param {Object} settings 287 | * @ignore 288 | */ 289 | set api(settings) { 290 | this._api = { 291 | getPanelUrl: settings.get_panel_url 292 | }; 293 | } 294 | 295 | /** 296 | * Getter for current app info. 297 | * 298 | * @type {Object} 299 | */ 300 | get appInfo() { 301 | return this._appInfo; 302 | } 303 | 304 | /** 305 | * Setter for current app info. 306 | * 307 | * @param {string} val 308 | * @ignore 309 | */ 310 | set appInfo(val) { 311 | this._appInfo = val.split(",").map(app => { 312 | const [name, url] = app.split("|"); 313 | if (!url) return {}; 314 | // eslint-disable-next-line no-unused-vars 315 | const [unused, slot] = url.match(/\?slot=(\d+)/); 316 | return { 317 | name: name, 318 | url: url, 319 | slot: slot 320 | }; 321 | }); 322 | } 323 | 324 | /** 325 | * Called when the websocket is initialized. 326 | * 327 | * @param {Object} e 328 | * @private 329 | */ 330 | async _onInit(e) { 331 | if (this.state === null) { 332 | this.state = State.INIT; 333 | } 334 | 335 | if (e.chatSettings) { 336 | this.welcomeMessage = e.chatSettings.welcome_message || ""; 337 | this.spyPrice = e.chatSettings.spy_price || 0; 338 | this.privatePrice = e.chatSettings.private_price || 0; 339 | this.groupNumUsersRequired = 340 | e.chatSettings.num_users_required_for_group_show || 0; 341 | this.groupNumUsersWaiting = 342 | e.chatSettings.num_users_waiting_for_group_show || 0; 343 | this.groupPrice = e.chatSettings.group_price || 0; 344 | this.subject = e.chatSettings.current_subject || ""; 345 | this.gender = e.chatSettings.broadcaster_gender || ""; 346 | this.appInfo = e.chatSettings.app_info_json || ""; 347 | 348 | this.api = e.chatSettings; 349 | this.panel = _transformPanelHtml( 350 | await this._browser.fetch(this.api.getPanelUrl, { 351 | _: new Date().getTime() 352 | }) 353 | ); 354 | this.goal = panelParser(this.panelApp, this.panel); 355 | } 356 | 357 | if (e.settings) { 358 | this.groupsEnabled = Boolean(e.settings.groups_enabled); 359 | this.privatesEnabled = Boolean(e.settings.privates_enabled); 360 | this.room = e.settings.room || e.settings.room_owner_nick || ""; 361 | 362 | if (e.settings.connecting) { 363 | this.state = State.CONNECTING; 364 | } 365 | 366 | if (e.settings.connected) { 367 | this.state = State.CONNECTED; 368 | } 369 | } 370 | 371 | if (e.initializerSettings) { 372 | this.modelStatus = ( 373 | e.initializerSettings.model_status || "" 374 | ).toUpperCase(); 375 | 376 | if (e.initializerSettings.joined) { 377 | this.state = State.JOINED; 378 | } 379 | } 380 | 381 | debug(this.settings); 382 | this.emit("init", this.settings); 383 | } 384 | 385 | /** 386 | * Called when the websocket is opened. 387 | * 388 | * @private 389 | */ 390 | _onSocketOpen() { 391 | this.state = State.CONNECTING; 392 | } 393 | 394 | /** 395 | * Called when the websocket throws an error. 396 | * 397 | * @private 398 | */ 399 | _onSocketError() { 400 | this.state = State.ERROR; 401 | } 402 | 403 | /** 404 | * Called when the websocket closes. 405 | * 406 | * @private 407 | */ 408 | _onSocketClose() { 409 | this.state = State.DISCONNECTED; 410 | } 411 | 412 | /** 413 | * Creates hooks for websock messages. 414 | * 415 | * @private 416 | */ 417 | _initEventHooks() { 418 | this._hooks = { 419 | auth: this._onHookAuth, 420 | joined_room: this._onHookJoinedRoom, 421 | leave_room: this._onHookLeaveRoom, 422 | personally_kicked: this._onHookPersonallyKicked, 423 | away_mode_cancel: this._onHookAwayModeCancel, 424 | app_tab_refresh: this._onHookAppTabRefresh, 425 | clear_app: this._onHookClearApp, 426 | refresh_panel: this._onHookRefreshPanel, 427 | settings_update: this._onHookSettingsUpdate, 428 | title_change: this._onHookTitleChange, 429 | private_show_approved: this._onHookPrivateShowApproved, 430 | private_show_cancel: this._onHookPrivateShowCancel, 431 | group_show_approve: this._onHookGroupShowApprove, 432 | group_show_cancel: this._onHookGroupShowCancel, 433 | group_show_request: this._onHookGroupShowRequest, 434 | hidden_show_status_change: this._onHookHiddenShowStatusChange, 435 | room_count: this._onHookRoomCount, 436 | room_entry: this._onHookRoomEntry, 437 | room_leave: this._onHookRoomLeave, 438 | room_message: this._onHookRoomMessage, 439 | tip: this._onHookTip 440 | }; 441 | } 442 | 443 | /** 444 | * Attaches hooks specific websock messages. 445 | * 446 | * @private 447 | */ 448 | _patchEvents() { 449 | this.eventNames.forEach(name => { 450 | this._events.on(name, async e => { 451 | let result = e; 452 | if (this._hooks[name]) { 453 | debug(`hooked event ${name}`); 454 | try { 455 | result = await this._hooks[name].call(this, e); 456 | debug(result); 457 | } catch (err) { 458 | debug(`hook failed for ${name}`); 459 | debug(e); 460 | } 461 | } 462 | this.emit(name, result); 463 | }); 464 | }); 465 | } 466 | 467 | /** 468 | * Manually checks for Goal events. 469 | * 470 | * @param {Object} oldGoal 471 | * @param {Object} newGoal 472 | */ 473 | _checkGoal(oldGoal, newGoal) { 474 | if (!oldGoal || !newGoal) return; 475 | 476 | if (newGoal.goalCurrent !== oldGoal.goalCurrent) { 477 | this.emit("goal_progress", newGoal); 478 | } 479 | 480 | if (newGoal.hasMultipleGoals) { 481 | if (newGoal.goalCount > oldGoal.goalCount) { 482 | this.emit("goal_reached", newGoal); 483 | } 484 | } else if (!newGoal.goalRemaining && oldGoal.goalRemaining) { 485 | this.emit("goal_reached", newGoal); 486 | } 487 | } 488 | 489 | /** 490 | * Hooks the Auth event. 491 | * 492 | * @param {Object} e 493 | * @return {Object} 494 | */ 495 | _onHookAuth(e) { 496 | if (e.success) { 497 | this.state = State.CONNECTED; 498 | } else { 499 | this.state = State.FAIL; 500 | } 501 | return e; 502 | } 503 | 504 | /** 505 | * Hooks the Join Room event. 506 | * 507 | * @param {Object} e 508 | * @return {Object} 509 | */ 510 | _onHookJoinedRoom(e) { 511 | this.state = State.JOINED; 512 | return e; 513 | } 514 | 515 | /** 516 | * Hooks the Leave Room event. 517 | * 518 | * @param {Object} e 519 | * @return {Object} 520 | */ 521 | _onHookLeaveRoom(e) { 522 | this.state = State.LEAVE; 523 | return e; 524 | } 525 | 526 | /** 527 | * Hooks the Personally Kicked event. 528 | * 529 | * @param {Object} e 530 | * @return {Object} 531 | */ 532 | _onHookPersonallyKicked(e) { 533 | this.state = State.KICKED; 534 | return e; 535 | } 536 | 537 | /** 538 | * Hooks the App Tab Refresh event. 539 | * 540 | * @param {Object} e 541 | * @return {Object} 542 | */ 543 | async _onHookAppTabRefresh(e) { 544 | // Reload the page to get the new apps 545 | if (this.room && this.room.length) { 546 | await this._browser.profile(this.room); 547 | } 548 | 549 | const html = await this._browser.fetch(this.api.getPanelUrl); 550 | this.panel = _transformPanelHtml(html); 551 | this.goal = panelParser(this.panelApp, this.panel); 552 | return { 553 | panel: this.panel, 554 | goal: this.goal 555 | }; 556 | } 557 | 558 | /** 559 | * Hooks the App Clear event. 560 | * 561 | * @param {Object} e 562 | * @return {Object} 563 | */ 564 | async _onHookClearApp(e) { 565 | const html = await this._browser.fetch(this.api.getPanelUrl); 566 | this.panel = _transformPanelHtml(html); 567 | this.goal = panelParser(this.panelApp, this.panel); 568 | return { 569 | panel: this.panel, 570 | goal: this.goal 571 | }; 572 | } 573 | 574 | /** 575 | * Hooks the Refresh Panel event. 576 | * 577 | * @param {Object} e 578 | * @return {Object} 579 | */ 580 | async _onHookRefreshPanel(e) { 581 | const html = await this._browser.fetch(this.api.getPanelUrl); 582 | this.panel = _transformPanelHtml(html); 583 | this.goal = panelParser(this.panelApp, this.panel); 584 | return { 585 | panel: this.panel, 586 | goal: this.goal 587 | }; 588 | } 589 | 590 | /** 591 | * Hooks the Away Mode Cancel event. 592 | * 593 | * @param {Object} e 594 | * @return {Object} 595 | */ 596 | _onHookAwayModeCancel(e) { 597 | this.modelStatus = ModelStatus.PUBLIC; 598 | return e; 599 | } 600 | 601 | /** 602 | * Hooks the Settings Update event. 603 | * 604 | * @param {Object} e 605 | * @return {Object} 606 | */ 607 | _onHookSettingsUpdate(e) { 608 | this.spyPrice = e.spyPrice; 609 | this.privatePrice = e.privatePrice; 610 | this.privatesEnabled = e.privatesEnabled; 611 | this.groupNumUsersRequired = e.minimumUsersForGroupShow; 612 | this.groupPrice = e.groupPrice; 613 | this.groupsEnabled = e.allowGroups; 614 | return e; 615 | } 616 | 617 | /** 618 | * Hooks the Title Change event. 619 | * 620 | * @param {Object} e 621 | * @return {Object} 622 | */ 623 | _onHookTitleChange(e) { 624 | if (e.title === "") { 625 | e.title = this.subject; 626 | } else { 627 | this.subject = e.title; 628 | } 629 | return e; 630 | } 631 | 632 | /** 633 | * Hooks the Private Show Approve event. 634 | * 635 | * @param {Object} e 636 | * @return {Object} 637 | */ 638 | _onHookPrivateShowApproved(e) { 639 | this.modelStatus = ModelStatus.PRIVATE; 640 | this.privatePrice = e.tokensPerMinute; 641 | return e; 642 | } 643 | 644 | /** 645 | * Hooks the Private Show Cancel event. 646 | * 647 | * @param {Object} e 648 | * @return {Object} 649 | */ 650 | _onHookPrivateShowCancel(e) { 651 | this.modelStatus = ModelStatus.AWAY; 652 | return e; 653 | } 654 | 655 | /** 656 | * Hooks the Group Show Approve event. 657 | * 658 | * @param {Object} e 659 | * @return {Object} 660 | */ 661 | _onHookGroupShowApprove(e) { 662 | this.modelStatus = ModelStatus.GROUP; 663 | this.groupPrice = e.tokensPerMinute; 664 | return e; 665 | } 666 | 667 | /** 668 | * Hooks the Group Show Cancel event. 669 | * 670 | * @param {Object} e 671 | * @return {Object} 672 | */ 673 | _onHookGroupShowCancel(e) { 674 | this.modelStatus = ModelStatus.AWAY; 675 | return e; 676 | } 677 | 678 | /** 679 | * Hooks the Group Show Request event. 680 | * 681 | * @param {Object} e 682 | * @return {Object} 683 | */ 684 | _onHookGroupShowRequest(e) { 685 | this.groupNumUsersRequired = e.usersRequired; 686 | this.groupNumUsersWaiting = e.usersWaiting; 687 | this.groupPrice = e.tokensPerMinute; 688 | return e; 689 | } 690 | 691 | /** 692 | * Hooks the Hidden Show Status Change event. 693 | * 694 | * @param {Object} e 695 | * @return {Object} 696 | */ 697 | _onHookHiddenShowStatusChange(e) { 698 | this.modelStatus = e.isStarting ? ModelStatus.HIDDEN : ModelStatus.PUBLIC; 699 | return e; 700 | } 701 | 702 | /** 703 | * Hooks the Room Count event. 704 | * 705 | * @param {Object} e 706 | * @return {Object} 707 | */ 708 | _onHookRoomCount(e) { 709 | this.viewCount = e.count; 710 | return e; 711 | } 712 | 713 | /** 714 | * Hooks the Room Entry event. 715 | * 716 | * @param {Object} e 717 | * @return {Object} 718 | */ 719 | _onHookRoomEntry(e) { 720 | e.user.isHost = e.user.username === this.room; 721 | return e; 722 | } 723 | 724 | /** 725 | * Hooks the Room Leave event. 726 | * 727 | * @param {Object} e 728 | * @return {Object} 729 | */ 730 | _onHookRoomLeave(e) { 731 | e.user.isHost = e.user.username === this.room; 732 | return e; 733 | } 734 | 735 | /** 736 | * Hooks the Room Message event. 737 | * 738 | * @param {Object} e 739 | * @return {Object} 740 | */ 741 | _onHookRoomMessage(e) { 742 | e.user.isHost = e.user.username === this.room; 743 | return e; 744 | } 745 | 746 | /** 747 | * Hooks the Tip event. 748 | * 749 | * @param {Object} e 750 | * @return {Object} 751 | */ 752 | _onHookTip(e) { 753 | e.user.isHost = e.user.username === this.room; 754 | return e; 755 | } 756 | } 757 | 758 | module.exports = ChaturbateController; 759 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------