├── .npmignore ├── test ├── mocha.opts └── index.js ├── .editorconfig ├── .babelrc ├── .travis.yml ├── .github └── ISSUE_TEMPLATE │ └── Feature_request.md ├── .eslintrc.json ├── .esdoc.json ├── .gitignore ├── ReadMe.md ├── package.json ├── source └── index.js └── LICENSE /.npmignore: -------------------------------------------------------------------------------- 1 | .editorconfig 2 | .eslintrc.json 3 | .babelrc 4 | test/ 5 | .esdoc.json 6 | docs/ 7 | .github/ 8 | .travis.yml 9 | -------------------------------------------------------------------------------- /test/mocha.opts: -------------------------------------------------------------------------------- 1 | --require @babel/register 2 | --require @babel/polyfill 3 | --require should-sinon 4 | --no-timeouts 5 | --colors 6 | --inline-diffs 7 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 4 7 | end_of_line = lf 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | [ 4 | "@babel/preset-env", 5 | { 6 | "targets": { 7 | "node": "6.3.0" 8 | } 9 | } 10 | ] 11 | ], 12 | "plugins": [ 13 | "dynamic-import-node", 14 | "@babel/plugin-transform-runtime" 15 | ] 16 | } 17 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | branches: 2 | only: 3 | - master 4 | 5 | language: node_js 6 | node_js: 7 | - lts/* 8 | cache: 9 | directories: 10 | - node_modules 11 | 12 | install: 13 | - npm install 14 | script: 15 | - npm run docs 16 | - cd ${FOLDER} 17 | - git init 18 | - git config user.name ${UID} 19 | - git config user.email ${EMAIL} 20 | - git add . 21 | - git commit -m "${MESSAGE}" 22 | - git push --force --quiet https://${TOKEN}@${GIT_URI}.git master:gh-pages 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | 5 | --- 6 | 7 | **Is your feature request related to a problem? Please describe.** 8 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 9 | 10 | **Describe the solution you'd like** 11 | A clear and concise description of what you want to happen. 12 | 13 | **Describe alternatives you've considered** 14 | A clear and concise description of any alternative solutions or features you've considered. 15 | 16 | **Additional context** 17 | Add any other context or screenshots about the feature request here. 18 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "es6": true, 4 | "node": true, 5 | "mocha": true 6 | }, 7 | "parser": "babel-eslint", 8 | "parserOptions": { 9 | "ecmaVersion": 8, 10 | "sourceType": "module" 11 | }, 12 | "extends": "eslint:recommended", 13 | "rules": { 14 | "indent": [ 15 | "error", 4, {"SwitchCase": 1} 16 | ], 17 | "linebreak-style": ["error", "unix"], 18 | "quotes": ["error", "single"], 19 | "semi": ["error", "always"], 20 | "no-cond-assign": "off", 21 | "no-console": ["error", { 22 | "allow": ["info", "warn", "error", "time", "timeEnd"] 23 | }] 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /.esdoc.json: -------------------------------------------------------------------------------- 1 | { 2 | "index": "./ReadMe.md", 3 | "source": "./source", 4 | "destination": "./docs", 5 | "plugins": [ 6 | { 7 | "name": "esdoc-standard-plugin", 8 | "option": { 9 | "test": { 10 | "source": "./test", 11 | "interfaces": ["describe", "it"], 12 | "includes": ["\\.js$"] 13 | } 14 | } 15 | }, 16 | { 17 | "name": "esdoc-ecmascript-proposal-plugin", 18 | "option": { 19 | "all": true 20 | } 21 | }, 22 | { 23 | "name": "esdoc-external-nodejs-plugin", 24 | "option": { 25 | "enable": true 26 | } 27 | } 28 | ] 29 | } 30 | -------------------------------------------------------------------------------- /.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 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | # NPM production code 64 | dist/ 65 | docs/ 66 | -------------------------------------------------------------------------------- /ReadMe.md: -------------------------------------------------------------------------------- 1 | # Puppeteer browser 2 | 3 | Multiple **Web browser** controller based on [Puppeteer API][1], wraps [`puppeteer`][2], [`puppeteer-fx`][3] & [`puppeteer-ie`][4] in one package. 4 | 5 | [![NPM Dependency](https://david-dm.org/EasyWebApp/puppeteer-browser.svg)](https://david-dm.org/EasyWebApp/puppeteer-browser) 6 | [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FEasyWebApp%2Fpuppeteer-browser.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FEasyWebApp%2Fpuppeteer-browser?ref=badge_shield) 7 | [![Build Status](https://travis-ci.com/EasyWebApp/puppeteer-browser.svg?branch=master)](https://travis-ci.com/EasyWebApp/puppeteer-browser) 8 | 9 | [![NPM](https://nodei.co/npm/puppeteer-browser.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/puppeteer-browser/) 10 | 11 | ([Windows users please note](https://github.com/TechQuery/Puppeteer-IE#installation)) 12 | 13 | 14 | 15 | ## Use as a Test runner 16 | 17 | Create `your_script.js` 18 | 19 | ```JavaScript 20 | import PuppeteerBrowser from 'puppeteer-browser'; 21 | 22 | (async () => { 23 | 24 | const page = await PuppeteerBrowser.getPage( 25 | 'path/to/start/server', 'path/to/open/page' 26 | ); 27 | 28 | console.log(await page.title()); 29 | })(); 30 | ``` 31 | 32 | then run one command below in your terminal 33 | 34 | ```Shell 35 | # Chrome 36 | node your_script 37 | 38 | # Firefox 39 | npm set PUPPETEER_BROWSER firefox && node your_script 40 | 41 | # Internet Explorer 42 | npm set PUPPETEER_BROWSER IE && node your_script 43 | ``` 44 | [ Notice ] Option started with `--inspect` in the command-line will disable Headless mode. 45 | 46 | 47 | 48 | ## Use as a developing viewer 49 | 50 | `directories.lib` field of `package.json` or `process.cwd()` will be watched. 51 | 52 | [Example from WebCell DevCLI](https://github.com/EasyWebApp/DevCLI/blob/master/source/index.js#L60) 53 | 54 | 55 | 56 | ## API Document 57 | 58 | - Online: [URL](https://web-cell.tk/puppeteer-browser) or `npm docs` 59 | 60 | - Offline: `npm start` 61 | 62 | 63 | 64 | ## License 65 | 66 | [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FEasyWebApp%2Fpuppeteer-browser.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FEasyWebApp%2Fpuppeteer-browser?ref=badge_large) 67 | 68 | 69 | 70 | [1]: https://pptr.dev/#?product=Puppeteer&version=v1.5.0 71 | [2]: https://pptr.dev/ 72 | [3]: https://github.com/autonome/puppeteer-fx 73 | [4]: https://tech-query.me/Puppeteer-IE/ 74 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "puppeteer-browser", 3 | "version": "0.3.8", 4 | "description": "Multiple Web browser controller based on Puppeteer API", 5 | "keywords": [ 6 | "Web", 7 | "browser", 8 | "Puppeteer", 9 | "testing", 10 | "automation" 11 | ], 12 | "author": "shiy2008@gmail.com", 13 | "license": "Apache-2.0", 14 | "homepage": "https://web-cell.tk/puppeteer-browser", 15 | "repository": { 16 | "type": "git", 17 | "url": "git+https://github.com/EasyWebApp/puppeteer-browser.git" 18 | }, 19 | "bugs": { 20 | "url": "https://github.com/EasyWebApp/puppeteer-browser/issues" 21 | }, 22 | "main": "dist/index.js", 23 | "module": "source/index.js", 24 | "directories": { 25 | "lib": "source/" 26 | }, 27 | "engines": { 28 | "node": "^6.3.0" 29 | }, 30 | "scripts": { 31 | "lint": "eslint source/ test/ --fix", 32 | "pack": "babel source/ -d dist/ -s", 33 | "test": "mocha --exit", 34 | "debug": "mocha --inspect-brk", 35 | "build": "npm test && npm run lint && npm run pack && esdoc", 36 | "prepublishOnly": "npm run build", 37 | "preinstall": "npm set puppeteer_skip_chromium_download true", 38 | "install": "app-find chrome firefox -c", 39 | "docs": "esdoc", 40 | "start": "esdoc && web-server docs/ -o" 41 | }, 42 | "husky": { 43 | "hooks": { 44 | "pre-commit": "npm run build && git add ." 45 | } 46 | }, 47 | "dependencies": { 48 | "@babel/polyfill": "^7.2.5", 49 | "@babel/runtime": "^7.3.4", 50 | "@tech_query/node-toolkit": "^0.9.3", 51 | "chokidar": "^2.1.2", 52 | "fs-match": "^1.3.5", 53 | "koapache": "^1.0.6", 54 | "promisify-node": "^0.5.0", 55 | "puppeteer": "1.5.0", 56 | "puppeteer-fx": "0.0.4", 57 | "qrcode": "^1.3.3" 58 | }, 59 | "optionalDependencies": { 60 | "puppeteer-ie": "^0.5.7" 61 | }, 62 | "devDependencies": { 63 | "@babel/cli": "^7.2.3", 64 | "@babel/core": "^7.3.4", 65 | "@babel/plugin-transform-runtime": "^7.3.4", 66 | "@babel/preset-env": "^7.3.4", 67 | "@babel/register": "^7.0.0", 68 | "active-win": "^3.0.1", 69 | "babel-eslint": "^10.0.1", 70 | "babel-plugin-dynamic-import-node": "^2.2.0", 71 | "desktop-env": "^3.0.0", 72 | "esdoc": "^1.1.0", 73 | "esdoc-ecmascript-proposal-plugin": "^1.0.0", 74 | "esdoc-external-nodejs-plugin": "^1.0.0", 75 | "esdoc-standard-plugin": "^1.0.0", 76 | "eslint": "^5.15.1", 77 | "find-process": "^1.2.1", 78 | "husky": "^1.3.1", 79 | "mocha": "^6.0.2", 80 | "should": "^13.2.3", 81 | "should-sinon": "0.0.6", 82 | "sinon": "^7.2.7" 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /test/index.js: -------------------------------------------------------------------------------- 1 | import PuppeteerBrowser from '../source/index'; 2 | 3 | import { equal, notEqual } from 'should'; 4 | 5 | import { spy } from 'sinon'; 6 | 7 | import desktopEnv from 'desktop-env'; 8 | 9 | import activeWin from 'active-win'; 10 | 11 | import processOf from 'find-process'; 12 | 13 | import promisify from 'promisify-node'; 14 | 15 | const { mkdir, writeFile, appendFile, unlink, rmdir } = promisify('fs'); 16 | 17 | 18 | function wait(second) { 19 | 20 | return new Promise(resolve => setTimeout(resolve, second * 1000)); 21 | } 22 | 23 | async function isActiveWindow(page, yes = true) { 24 | 25 | const assert = yes ? equal : notEqual; 26 | 27 | const window = await activeWin(), path = PuppeteerBrowser.executablePath(); 28 | 29 | if ( window.owner.path ) 30 | assert(path, window.owner.path); 31 | else 32 | assert(path.match( /([^/]+)(\.\w+)?$/ )[1], window.owner.name); 33 | } 34 | 35 | 36 | describe('Static methods', () => { 37 | 38 | const file = 'test/example/test.js'; var GUI; 39 | 40 | before(async () => { 41 | 42 | await mkdir('test/example'); 43 | 44 | GUI = ('N/A' !== await desktopEnv()); 45 | }); 46 | 47 | /** 48 | * @test {PuppeteerBrowser.watch} 49 | */ 50 | it('Watch files changing', async () => { 51 | 52 | const onChange = spy(); 53 | 54 | await writeFile(file, ''); 55 | 56 | PuppeteerBrowser.watch('test/example/', onChange); 57 | 58 | await wait( 1 ); 59 | 60 | await appendFile(file, 'test'); 61 | 62 | await wait( 1 ); 63 | 64 | onChange.should.be.calledOnce(); 65 | }); 66 | 67 | /** 68 | * @test {PuppeteerBrowser.getBrowser} 69 | * @test {PuppeteerBrowser.getPage} 70 | */ 71 | it('Open a background page', async () => { 72 | 73 | const page = await PuppeteerBrowser.getPage('docs/'); 74 | 75 | const browser = await PuppeteerBrowser.getBrowser(); 76 | 77 | const task = await processOf('pid', browser.process().pid); 78 | 79 | if (! process.env.npm_lifecycle_script.includes('--inspect')) 80 | task[0].cmd.should.containEql('--headless'); 81 | 82 | if ( GUI ) await isActiveWindow(page, false); 83 | 84 | await browser.close(); 85 | }); 86 | 87 | /** 88 | * @test {PuppeteerBrowser.getPage} 89 | */ 90 | it('Open a preview page', async () => { 91 | 92 | if (! GUI) 93 | return console.info( 94 | 'Can\'t test Browser window without Desktop environment' 95 | ); 96 | 97 | const page = await PuppeteerBrowser.getPage('docs/', null, () => { }); 98 | 99 | await isActiveWindow( page ); 100 | 101 | await page.browser().close(); 102 | }); 103 | 104 | 105 | after(async () => { 106 | 107 | await unlink( file ); 108 | 109 | await rmdir('test/example'); 110 | }); 111 | }); 112 | -------------------------------------------------------------------------------- /source/index.js: -------------------------------------------------------------------------------- 1 | import {packageOf} from '@tech_query/node-toolkit'; 2 | 3 | import {resolve} from 'url'; 4 | 5 | import WebServer from 'koapache'; 6 | 7 | import {watch} from 'chokidar'; 8 | 9 | import {toString} from 'qrcode'; 10 | 11 | import promisify from 'promisify-node'; 12 | 13 | const QRCode = promisify( toString ); 14 | 15 | 16 | 17 | const { env } = process, config = (packageOf('./test') || '').meta; 18 | 19 | const NPM_command = env.npm_lifecycle_script; 20 | 21 | var server, browser, page; 22 | 23 | 24 | /** 25 | * Wrapper of `Puppeteer` class 26 | */ 27 | export default class PuppeteerBrowser { 28 | /** 29 | * @protected 30 | * 31 | * @param {string} [root] - Root path of the static site 32 | * 33 | * @return {Object} Server information 34 | */ 35 | static async getServer(root) { 36 | 37 | return server || ( 38 | server = await (new WebServer(root || '.')).workerHost() 39 | ); 40 | } 41 | 42 | /** 43 | * @type {string} 44 | */ 45 | static get browserName() { 46 | 47 | return (env.npm_config_PUPPETEER_BROWSER || 'chrome').trim(); 48 | } 49 | 50 | /** 51 | * @type {string} 52 | */ 53 | static get moduleName() { 54 | 55 | return 'puppeteer' + (map => { 56 | 57 | for (let name in map) 58 | if (name === this.browserName) return map[name]; 59 | 60 | return ''; 61 | })({ 62 | chrome: '', 63 | firefox: '-fx', 64 | IE: '-ie' 65 | }); 66 | } 67 | 68 | /** 69 | * @param {Object} [options] - https://pptr.dev/#?product=Puppeteer&version=v1.5.0&show=api-puppeteerlaunchoptions 70 | * 71 | * @return {Browser} 72 | */ 73 | static async launch(options) { 74 | 75 | const Puppeteer = (await import( this.moduleName )).default; 76 | 77 | return await Puppeteer.launch( options ); 78 | } 79 | 80 | /** 81 | * @return {string} https://pptr.dev/#?product=Puppeteer&version=v1.5.0&show=api-puppeteerexecutablepath 82 | */ 83 | static executablePath() { 84 | 85 | return env['npm_config_' + this.browserName]; 86 | } 87 | 88 | /** 89 | * @protected 90 | * 91 | * @param {boolean} [visible] - Browser visibility 92 | * (Visible mode will run slowly for seeing clearly) 93 | * @return {Browser} 94 | */ 95 | static async getBrowser(visible) { 96 | 97 | if ( browser ) return browser; 98 | 99 | visible = (visible != null) ? 100 | visible : NPM_command.includes('--inspect'); 101 | 102 | browser = await this.launch({ 103 | executablePath: this.executablePath(), 104 | headless: ! visible, 105 | slowMo: visible ? 100 : 0 106 | }); 107 | 108 | return browser.on('disconnected', () => browser = page = null); 109 | } 110 | 111 | /** 112 | * After files changed, the page will be focused & reloaded 113 | * 114 | * @param {string} path - Directory to watch recursively 115 | * @param {function} onChange - Call on files changed 116 | * 117 | * @return {FSWatcher} 118 | */ 119 | static watch(path, onChange) { 120 | 121 | var listen; 122 | 123 | async function refresh() { 124 | 125 | await onChange(); 126 | 127 | if ( page ) { 128 | 129 | await page.bringToFront(); 130 | 131 | await page.reload(); 132 | 133 | console.info(`[ Reload ] ${page.url()}`); 134 | } 135 | 136 | listen = false; 137 | } 138 | 139 | return watch( path ).on('change', () => { 140 | 141 | if (! listen) { 142 | 143 | listen = true; 144 | 145 | process.nextTick( refresh ); 146 | } 147 | }); 148 | } 149 | 150 | /** 151 | * @param {?string} root - Root path to start Web server, default to be `process.cwd()` 152 | * @param {?string} path - Path to open Web page 153 | * @param {function} [fileChange] - Do something between files changed & page reload 154 | * (Browser will be visible) 155 | * @return {Page} Resolve after `DOMContentLoaded` event fired 156 | */ 157 | static async getPage(root, path, fileChange) { 158 | 159 | if ( page ) return page; 160 | 161 | path = path || '.'; 162 | 163 | fileChange = (fileChange instanceof Function) ? fileChange : null; 164 | 165 | const server = path.indexOf('http') && await this.getServer( root ); 166 | 167 | const URI = resolve(`http://${server.address}:${server.port}/`, path); 168 | 169 | if ( fileChange ) console.info(await QRCode( URI )); 170 | 171 | page = await (await this.getBrowser( fileChange )).newPage(); 172 | 173 | await page.on('close', () => page = null).goto(server ? URI : path, { 174 | waitUntil: 'domcontentloaded' 175 | }); 176 | 177 | if ( fileChange ) 178 | this.watch(config.directories.lib || root, fileChange); 179 | 180 | return page; 181 | } 182 | } 183 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------