├── src ├── config.ts ├── commands │ ├── hello.ts │ └── handler.ts └── index.ts ├── Dockerfile ├── tsconfig.json ├── config └── default.yaml ├── package.json ├── .gitignore ├── tslint.json ├── README.md └── LICENSE /src/config.ts: -------------------------------------------------------------------------------- 1 | import * as config from "config"; 2 | 3 | interface IConfig { 4 | homeserverUrl: string; 5 | accessToken: string; 6 | autoJoin: boolean; 7 | dataPath: string; 8 | encryption: boolean; 9 | } 10 | 11 | export default config; 12 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:14 AS builder 2 | 3 | WORKDIR /src 4 | COPY . /src 5 | 6 | RUN npm ci 7 | RUN npm run build 8 | 9 | FROM node:14 10 | 11 | ENV NODE_ENV=production 12 | WORKDIR /bot 13 | 14 | COPY --from=builder /src/lib /bot/lib 15 | COPY --from=builder /src/package*.json /bot 16 | COPY --from=builder /src/config /bot/config 17 | 18 | RUN npm ci 19 | 20 | VOLUME /bot/config 21 | 22 | CMD ["node", "lib/index.js"] 23 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "experimentalDecorators": true, 4 | "emitDecoratorMetadata": true, 5 | "module": "commonjs", 6 | "moduleResolution": "node", 7 | "target": "es2015", 8 | "noImplicitAny": false, 9 | "sourceMap": true, 10 | "outDir": "./lib", 11 | "types": [ 12 | "node" 13 | ] 14 | }, 15 | "include": [ 16 | "./src/**/*" 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /config/default.yaml: -------------------------------------------------------------------------------- 1 | # Where the homeserver's Client-Server API is located. Typically this 2 | # is where clients would be connecting to in order to send messages. 3 | homeserverUrl: "https://matrix.org" 4 | 5 | # An access token for the bot to use. Learn how to get an access token 6 | # at https://t2bot.io/docs/access_tokens 7 | accessToken: "YOUR_TOKEN_HERE" 8 | 9 | # Whether or not to autojoin rooms when invited. 10 | autoJoin: true 11 | 12 | # Location on disk for where to store various bot information. 13 | dataPath: "storage" 14 | 15 | # Set to false to disable encryption support. Encrypted data will be 16 | # stored under dataPath. 17 | encryption: true 18 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "matrix-bot-sdk-bot-template", 3 | "version": "0.1.0", 4 | "author": "TravisR", 5 | "license": "Apache-2.0", 6 | "description": "A template repository for bots made with the matrix-bot-sdk", 7 | "repository": { 8 | "type": "git", 9 | "url": "git+https://github.com/turt2live/matrix-bot-sdk-bot-template.git" 10 | }, 11 | "bugs": { 12 | "url": "https://github.com/turt2live/matrix-bot-sdk-bot-template/issues" 13 | }, 14 | "homepage": "https://github.com/turt2live/matrix-bot-sdk-bot-template#readme", 15 | "keywords": [ 16 | "matrix", 17 | "bot", 18 | "template" 19 | ], 20 | "main": "lib/index.js", 21 | "scripts": { 22 | "build": "tsc", 23 | "lint": "tslint --project ./tsconfig.json -t stylish", 24 | "start:dev": "npm run build && node lib/index.js" 25 | }, 26 | "dependencies": { 27 | "config": "^3.3.6", 28 | "escape-html": "^1.0.3", 29 | "js-yaml": "^4.1.0", 30 | "matrix-bot-sdk": "^0.6.0-beta.4" 31 | }, 32 | "devDependencies": { 33 | "@types/node": "^14.18.5", 34 | "tslint": "^6.1.3", 35 | "typescript": "^4.5.4" 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/commands/hello.ts: -------------------------------------------------------------------------------- 1 | import { MatrixClient, MentionPill, MessageEvent, MessageEventContent } from "matrix-bot-sdk"; 2 | import * as htmlEscape from "escape-html"; 3 | 4 | export async function runHelloCommand(roomId: string, event: MessageEvent, args: string[], client: MatrixClient) { 5 | // The first argument is always going to be us, so get the second argument instead. 6 | let sayHelloTo = args[1]; 7 | if (!sayHelloTo) sayHelloTo = event.sender; 8 | 9 | let text = `Hello ${sayHelloTo}!`; 10 | let html = `Hello ${htmlEscape(sayHelloTo)}!`; 11 | 12 | if (sayHelloTo.startsWith("@")) { 13 | // Awesome! The user supplied an ID so we can create a proper mention instead 14 | const mention = await MentionPill.forUser(sayHelloTo, roomId, client); 15 | text = `Hello ${mention.text}!`; 16 | html = `Hello ${mention.html}!`; 17 | } 18 | 19 | // Now send that message as a notice 20 | return client.sendMessage(roomId, { 21 | body: text, 22 | msgtype: "m.notice", 23 | format: "org.matrix.custom.html", 24 | formatted_body: html, 25 | }); 26 | } 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | config/* 2 | !config/default.yaml 3 | lib/ 4 | storage/ 5 | 6 | /.idea 7 | 8 | /db 9 | 10 | # Logs 11 | logs 12 | *.log 13 | npm-debug.log* 14 | yarn-debug.log* 15 | yarn-error.log* 16 | 17 | # Runtime data 18 | pids 19 | *.pid 20 | *.seed 21 | *.pid.lock 22 | 23 | # Directory for instrumented libs generated by jscoverage/JSCover 24 | lib-cov 25 | 26 | # Coverage directory used by tools like istanbul 27 | coverage 28 | 29 | # nyc test coverage 30 | .nyc_output 31 | 32 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 33 | .grunt 34 | 35 | # Bower dependency directory (https://bower.io/) 36 | bower_components 37 | 38 | # node-waf configuration 39 | .lock-wscript 40 | 41 | # Compiled binary addons (https://nodejs.org/api/addons.html) 42 | build/Release 43 | 44 | # Dependency directories 45 | node_modules/ 46 | jspm_packages/ 47 | 48 | # TypeScript v1 declaration files 49 | typings/ 50 | 51 | # Optional npm cache directory 52 | .npm 53 | 54 | # Optional eslint cache 55 | .eslintcache 56 | 57 | # Optional REPL history 58 | .node_repl_history 59 | 60 | # Output of 'npm pack' 61 | *.tgz 62 | 63 | # Yarn Integrity file 64 | .yarn-integrity 65 | 66 | # dotenv environment variables file 67 | .env 68 | 69 | # next.js build output 70 | .next 71 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { 2 | AutojoinRoomsMixin, ICryptoStorageProvider, 3 | LogLevel, 4 | LogService, 5 | MatrixClient, 6 | PantalaimonClient, 7 | RichConsoleLogger, RustSdkCryptoStorageProvider, 8 | SimpleFsStorageProvider 9 | } from "matrix-bot-sdk"; 10 | import * as path from "path"; 11 | import config from "./config"; 12 | import CommandHandler from "./commands/handler"; 13 | 14 | // First things first: let's make the logs a bit prettier. 15 | LogService.setLogger(new RichConsoleLogger()); 16 | 17 | // For now let's also make sure to log everything (for debugging) 18 | LogService.setLevel(LogLevel.DEBUG); 19 | 20 | // Also let's mute Metrics, so we don't get *too* much noise 21 | LogService.muteModule("Metrics"); 22 | 23 | // Print something so we know the bot is working 24 | LogService.info("index", "Bot starting..."); 25 | 26 | 27 | // This is the startup closure where we give ourselves an async context 28 | (async function () { 29 | // Prepare the storage system for the bot 30 | const storage = new SimpleFsStorageProvider(path.join(config.dataPath, "bot.json")); 31 | 32 | // Prepare a crypto store if we need that 33 | let cryptoStore: ICryptoStorageProvider; 34 | if (config.encryption) { 35 | cryptoStore = new RustSdkCryptoStorageProvider(path.join(config.dataPath, "encrypted")); 36 | } 37 | 38 | // Now create the client 39 | const client = new MatrixClient(config.homeserverUrl, config.accessToken, storage, cryptoStore); 40 | 41 | // Setup the autojoin mixin (if enabled) 42 | if (config.autoJoin) { 43 | AutojoinRoomsMixin.setupOnClient(client); 44 | } 45 | 46 | // Prepare the command handler 47 | const commands = new CommandHandler(client); 48 | await commands.start(); 49 | 50 | LogService.info("index", "Starting sync..."); 51 | await client.start(); // This blocks until the bot is killed 52 | })(); 53 | -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "rules": { 3 | "class-name": false, 4 | "comment-format": [ 5 | true 6 | ], 7 | "curly": false, 8 | "eofline": false, 9 | "forin": false, 10 | "indent": [ 11 | true, 12 | "spaces" 13 | ], 14 | "label-position": true, 15 | "max-line-length": false, 16 | "member-access": false, 17 | "member-ordering": [ 18 | true, 19 | "static-after-instance", 20 | "variables-before-functions" 21 | ], 22 | "no-arg": true, 23 | "no-bitwise": false, 24 | "no-console": false, 25 | "no-construct": true, 26 | "no-debugger": true, 27 | "no-duplicate-variable": true, 28 | "no-empty": false, 29 | "no-eval": true, 30 | "no-inferrable-types": true, 31 | "no-shadowed-variable": true, 32 | "no-string-literal": false, 33 | "no-switch-case-fall-through": true, 34 | "no-trailing-whitespace": true, 35 | "no-unused-expression": true, 36 | "no-use-before-declare": false, 37 | "no-var-keyword": true, 38 | "object-literal-sort-keys": false, 39 | "one-line": [ 40 | true, 41 | "check-open-brace", 42 | "check-catch", 43 | "check-else", 44 | "check-whitespace" 45 | ], 46 | "quotemark": false, 47 | "radix": true, 48 | "semicolon": [ 49 | "always" 50 | ], 51 | "triple-equals": [], 52 | "typedef-whitespace": [ 53 | true, 54 | { 55 | "call-signature": "nospace", 56 | "index-signature": "nospace", 57 | "parameter": "nospace", 58 | "property-declaration": "nospace", 59 | "variable-declaration": "nospace" 60 | } 61 | ], 62 | "variable-name": false, 63 | "whitespace": [ 64 | true, 65 | "check-branch", 66 | "check-decl", 67 | "check-operator", 68 | "check-separator", 69 | "check-type" 70 | ] 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `matrix-bot-sdk` Bot Templates 2 | 3 | A template for creating bots with [matrix-bot-sdk](https://www.npmjs.com/package/matrix-bot-sdk). 4 | 5 | ## Projects using this template 6 | 7 | - [matrix-zammad](https://github.com/Half-Shot/matrix-zammad) by [Half-Shot](https://github.com/Half-Shot) 8 | 9 | Want your project listed? [Edit this doc](https://github.com/turt2live/matrix-bot-sdk-bot-template/edit/master/README.md). 10 | 11 | ## Running / Building 12 | 13 | After clicking the 'use this template' button and cloning the repo, you'll need to install the dependencies 14 | and open an editor to get started. This assumes you have at least **NodeJS 14 or higher**. 15 | 16 | 1. Replace this README with something useful. 17 | 2. Update your project's details in `package.json`. 18 | 3. Run `npm install` to get the dependencies. 19 | 20 | To build it: `npm run build`. 21 | 22 | To run it: `npm run start:dev` 23 | 24 | To check the lint: `npm run lint` 25 | 26 | To build the Docker image: `docker build -t your-bot:latest .` 27 | 28 | To run the Docker image (after building): `docker run --rm -it -v $(pwd)/config:/bot/config your-bot:latest` 29 | *Note that this will require a `config/production.yaml` file to exist as the Docker container runs in production mode.* 30 | 31 | ### Configuration 32 | 33 | This template uses a package called `config` to manage configuration. The default configuration is offered 34 | as `config/default.yaml`. Copy/paste this to `config/development.yaml` and `config/production.yaml` and edit 35 | them accordingly for your environment. 36 | 37 | ## Project structure 38 | 39 | This is a somewhat opinionated template that is runnable out of the box. The project is TypeScript with 40 | a linter that matches the bot-sdk itself. All the good bits of the bot are under `src/`. 41 | 42 | ### `src/index.ts` 43 | 44 | This is where the bot's entry point is. Here you can see it reading the config, preparing the storage, 45 | and setting up other stuff that it'll use throughout its lifetime. Nothing in here should really require 46 | modification - most of the bot is elsewhere. 47 | 48 | ### `src/commands/handler.ts` 49 | 50 | When the bot receives a command (see `index.ts` for handoff) it gets processed here. The command structure 51 | is fairly manual, but a basic help menu and processing for a single command is there. 52 | 53 | ### `src/commands/hello.ts` 54 | 55 | This is the bot's `!bot hello` command. It doesn't do much, but it is an example. 56 | 57 | ### `src/config.ts` 58 | 59 | This is simply a typescript interface for your config so you can make use of types. 60 | 61 | ### `lib/` 62 | 63 | This is where the project's build files go. Not really much to see here. 64 | 65 | ### `storage/` 66 | 67 | This is the default storage location. Also not much to see here. 68 | 69 | ## Help! 70 | 71 | Come visit us in [#matrix-bot-sdk:t2bot.io](https://matrix.to/#/#matrix-bot-sdk:t2bot.io) on Matrix if you're 72 | having trouble with this template. 73 | 74 | ## Credits 75 | 76 | Credit to anoa's [matrix-nio template](https://github.com/anoadragon453/nio-template) for the README format. 77 | -------------------------------------------------------------------------------- /src/commands/handler.ts: -------------------------------------------------------------------------------- 1 | import { LogService, MatrixClient, MessageEvent, RichReply, UserID } from "matrix-bot-sdk"; 2 | import { runHelloCommand } from "./hello"; 3 | import * as htmlEscape from "escape-html"; 4 | 5 | // The prefix required to trigger the bot. The bot will also respond 6 | // to being pinged directly. 7 | export const COMMAND_PREFIX = "!bot"; 8 | 9 | // This is where all of our commands will be handled 10 | export default class CommandHandler { 11 | 12 | // Just some variables so we can cache the bot's display name and ID 13 | // for command matching later. 14 | private displayName: string; 15 | private userId: string; 16 | private localpart: string; 17 | 18 | constructor(private client: MatrixClient) { 19 | } 20 | 21 | public async start() { 22 | // Populate the variables above (async) 23 | await this.prepareProfile(); 24 | 25 | // Set up the event handler 26 | this.client.on("room.message", this.onMessage.bind(this)); 27 | } 28 | 29 | private async prepareProfile() { 30 | this.userId = await this.client.getUserId(); 31 | this.localpart = new UserID(this.userId).localpart; 32 | 33 | try { 34 | const profile = await this.client.getUserProfile(this.userId); 35 | if (profile && profile['displayname']) this.displayName = profile['displayname']; 36 | } catch (e) { 37 | // Non-fatal error - we'll just log it and move on. 38 | LogService.warn("CommandHandler", e); 39 | } 40 | } 41 | 42 | private async onMessage(roomId: string, ev: any) { 43 | const event = new MessageEvent(ev); 44 | if (event.isRedacted) return; // Ignore redacted events that come through 45 | if (event.sender === this.userId) return; // Ignore ourselves 46 | if (event.messageType !== "m.text") return; // Ignore non-text messages 47 | 48 | // Ensure that the event is a command before going on. We allow people to ping 49 | // the bot as well as using our COMMAND_PREFIX. 50 | const prefixes = [COMMAND_PREFIX, `${this.localpart}:`, `${this.displayName}:`, `${this.userId}:`]; 51 | const prefixUsed = prefixes.find(p => event.textBody.startsWith(p)); 52 | if (!prefixUsed) return; // Not a command (as far as we're concerned) 53 | 54 | // Check to see what the arguments were to the command 55 | const args = event.textBody.substring(prefixUsed.length).trim().split(' '); 56 | 57 | // Try and figure out what command the user ran, defaulting to help 58 | try { 59 | if (args[0] === "hello") { 60 | return runHelloCommand(roomId, event, args, this.client); 61 | } else { 62 | const help = "" + 63 | "!bot hello [user] - Say hello to a user.\n" + 64 | "!bot help - This menu\n"; 65 | 66 | const text = `Help menu:\n${help}`; 67 | const html = `Help menu:
${htmlEscape(help)}
`; 68 | const reply = RichReply.createFor(roomId, ev, text, html); // Note that we're using the raw event, not the parsed one! 69 | reply["msgtype"] = "m.notice"; // Bots should always use notices 70 | return this.client.sendMessage(roomId, reply); 71 | } 72 | } catch (e) { 73 | // Log the error 74 | LogService.error("CommandHandler", e); 75 | 76 | // Tell the user there was a problem 77 | const message = "There was an error processing your command"; 78 | return this.client.replyNotice(roomId, ev, message); 79 | } 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------