├── package.json
├── .github
└── workflows
│ └── npm-publish.yml
├── tsconfig.json
├── src
└── index.ts
├── README.md
├── .gitignore
└── LICENSE
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "author": {
3 | "name": "Rakheyl",
4 | "url": "https://github.com/rakheyl/"
5 | },
6 | "bugs": {
7 | "url": "https://github.com/rakheyl/snowflake-uuid/issues"
8 | },
9 | "description": "Twitter's Snowflake generator implementation for NodeJS",
10 | "engines": {
11 | "node": ">=12.0.0"
12 | },
13 | "files": [
14 | "/dist"
15 | ],
16 | "homepage": "https://github.com/rakheyl/snowflake-uuid#readme",
17 | "keywords": [
18 | "snowflake",
19 | "uuid",
20 | "id"
21 | ],
22 | "license": "GPL-3.0-or-later",
23 | "main": "./dist/index.js",
24 | "name": "snowflake-uuid",
25 | "repository": {
26 | "type": "git",
27 | "url": "git+https://github.com/rakheyl/snowflake-uuid.git"
28 | },
29 | "scripts": {
30 | "build": "npx tsc",
31 | "test": "npx tsc && node ./dist/index.js"
32 | },
33 | "types": "./dist/index.d.ts",
34 | "version": "1.0.0",
35 | "devDependencies": {
36 | "typescript": "^4.4.2"
37 | }
38 | }
--------------------------------------------------------------------------------
/.github/workflows/npm-publish.yml:
--------------------------------------------------------------------------------
1 | # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
3 |
4 | name: Node.js Package
5 |
6 | on:
7 | release:
8 | types: [created]
9 |
10 | jobs:
11 | build:
12 | runs-on: ubuntu-latest
13 | steps:
14 | - uses: actions/checkout@v2
15 | - uses: actions/setup-node@v2
16 | with:
17 | node-version: 14
18 | - run: npm install
19 | - run: npm test
20 |
21 | publish-gpr:
22 | needs: build
23 | runs-on: ubuntu-latest
24 | permissions:
25 | contents: read
26 | packages: write
27 | steps:
28 | - uses: actions/checkout@v2
29 | - uses: actions/setup-node@v2
30 | with:
31 | node-version: 14
32 | - run: node -e "const fs=require('fs');const path=require('path');const pkg=require('./package.json');pkg.name='@rakheyl/'+pkg.name;fs.writeFileSync(path.join(__dirname,'./package.json'),JSON.stringify(pkg));"
33 | - run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
34 | - run: npm install
35 | - run: npm run build
36 | - run: npm publish --access public --registry=https://npm.pkg.github.com
37 | env:
38 | NPM_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39 |
40 | publish-npm:
41 | needs: [build, publish-gpr]
42 | runs-on: ubuntu-latest
43 | steps:
44 | - uses: actions/checkout@v2
45 | - uses: actions/setup-node@v2
46 | with:
47 | node-version: 14
48 | registry-url: "https://registry.npmjs.org"
49 | - run: npm install
50 | - run: npm run build
51 | - run: npm publish --access public
52 | env:
53 | NODE_AUTH_TOKEN: ${{ secrets.NPM_SECRET }}
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
4 | "module": "CommonJS" /* Specify what module code is generated. */,
5 | "resolveJsonModule": true /* Enable importing .json files */,
6 | "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
7 | "outDir": "./dist" /* Specify an output folder for all emitted files. */,
8 | "removeComments": true /* Disable emitting comments. */,
9 | "newLine": "lf" /* Set the newline character for emitting files. */,
10 | "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
11 | "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
12 | "strict": true /* Enable all strict type-checking options. */,
13 | "noImplicitAny": true /* Enable error reporting for expressions and declarations with an implied `any` type.. */,
14 | "strictNullChecks": true /* When type checking, take into account `null` and `undefined`. */,
15 | "strictFunctionTypes": true /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */,
16 | "strictBindCallApply": true /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */,
17 | "strictPropertyInitialization": true /* Check for class properties that are declared but not set in the constructor. */,
18 | "noImplicitThis": true /* Enable error reporting when `this` is given the type `any`. */,
19 | "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
20 | "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */,
21 | "noUnusedParameters": true /* Raise an error when a function parameter isn't read */
22 | },
23 | "include": ["./src"]
24 | }
25 |
--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | type Snowflake = bigint | number;
4 |
5 | interface WorkerOptions {
6 | epoch?: Snowflake;
7 | workerIdBits?: Snowflake;
8 | datacenterIdBits?: Snowflake;
9 | sequence?: Snowflake;
10 | sequenceBits?: Snowflake;
11 | }
12 |
13 | export class Worker {
14 | #epoch: bigint;
15 | #workerId: bigint;
16 | #workerIdBits: bigint;
17 | #maxWorkerId: bigint;
18 | #datacenterId: bigint;
19 | #datacenterIdBits: bigint;
20 | #maxDatacenterId: bigint;
21 | #sequence: bigint;
22 | #sequenceBits: bigint;
23 | #workerIdShift: bigint;
24 | #datacenterIdShift: bigint;
25 | #timestampLeftShift: bigint;
26 | #sequenceMask: bigint;
27 | #lastTimestamp: bigint = -1n;
28 |
29 | constructor(workerId: Snowflake = 0n, datacenterId: Snowflake = 0n, options?: WorkerOptions) {
30 | // Epoch
31 | this.#epoch = BigInt(options?.epoch ?? 1609459200000);
32 |
33 | // Worker
34 | this.#workerId = BigInt(workerId);
35 | this.#workerIdBits = BigInt(options?.workerIdBits ?? 5);
36 | this.#maxWorkerId = -1n ^ (-1n << this.#workerIdBits);
37 | if (this.#workerId < 0 || this.#workerId > this.#maxWorkerId) {
38 | throw new Error(
39 | 'With ' +
40 | this.#workerIdBits.toString() +
41 | " bits, worker id can't be greater than " +
42 | this.#maxWorkerId.toString() +
43 | ' or less than 0',
44 | );
45 | }
46 |
47 | // Datacenter
48 | this.#datacenterId = BigInt(datacenterId);
49 | this.#datacenterIdBits = BigInt(options?.datacenterIdBits ?? 5);
50 | this.#maxDatacenterId = -1n ^ (-1n << this.#datacenterIdBits);
51 | if (this.#datacenterId > this.#maxDatacenterId || this.#datacenterId < 0) {
52 | throw new Error(
53 | 'With ' +
54 | this.#datacenterIdBits.toString() +
55 | " bits, datacenter id can't be greater than " +
56 | this.#maxDatacenterId.toString() +
57 | ' or less than 0',
58 | );
59 | }
60 |
61 | // Sequence
62 | this.#sequence = BigInt(options?.sequence ?? 0);
63 | this.#sequenceBits = BigInt(options?.sequenceBits ?? 12);
64 | this.#sequenceMask = -1n ^ (-1n << this.#sequenceBits);
65 |
66 | // Shift
67 | this.#workerIdShift = this.#sequenceBits;
68 | this.#datacenterIdShift = this.#sequenceBits + this.#workerIdBits;
69 | this.#timestampLeftShift = this.#sequenceBits + this.#workerIdBits + this.#datacenterIdBits;
70 | }
71 |
72 | get workerId(): bigint {
73 | return this.#workerId;
74 | }
75 |
76 | get datacenterId(): bigint {
77 | return this.#datacenterId;
78 | }
79 |
80 | get currentSequence(): bigint {
81 | return this.#sequence;
82 | }
83 |
84 | get lastTimestamp(): bigint {
85 | return this.#lastTimestamp;
86 | }
87 |
88 | nextId(): bigint {
89 | let timestamp = Worker.now();
90 |
91 | if (timestamp < this.#lastTimestamp) {
92 | throw new Error(
93 | "Clock moved backwards. Can't generate new ID for " +
94 | (this.#lastTimestamp - timestamp).toString() +
95 | 'milliseconds.',
96 | );
97 | }
98 |
99 | if (timestamp === this.#lastTimestamp) {
100 | this.#sequence = (this.#sequence + 1n) & this.#sequenceMask;
101 | if (this.#sequence === 0n) {
102 | timestamp = this.tilNextMillis(this.#lastTimestamp);
103 | }
104 | } else {
105 | this.#sequence = 0n;
106 | }
107 |
108 | this.#lastTimestamp = timestamp;
109 |
110 | return (
111 | ((timestamp - this.#epoch) << this.#timestampLeftShift) |
112 | (this.#datacenterId << this.#datacenterIdShift) |
113 | (this.#workerId << this.#workerIdShift) |
114 | this.#sequence
115 | );
116 | }
117 |
118 | tilNextMillis(lastTimestamp: bigint): bigint {
119 | let timestamp;
120 |
121 | do {
122 | timestamp = Worker.now();
123 | } while (timestamp <= lastTimestamp);
124 |
125 | return timestamp;
126 | }
127 |
128 | static now(): bigint {
129 | return BigInt(Date.now());
130 | }
131 | }
132 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
22 |
23 | # Snowflake-UUID
24 |
25 | [Twitter's Snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) generator for NodeJS.
26 |
27 | - Speedy
28 | - Lightweight
29 | - Zero dependencies
30 |
31 | Snowflake-UUID can generate unique Id numbers at high scale with some simple guarantees.
32 |
33 | ## Installing
34 |
35 | ```
36 | npm install snowflake-uuid
37 | // or
38 | yarn add snowflake-uuid
39 | // or
40 | pnpm add snowflake-uuid
41 | ```
42 |
43 | ## Example
44 |
45 | ```js
46 | import { Worker } from 'snowflake-uuid';
47 | // const { Worker } = require('snowflake-uuid');
48 |
49 | const generator = new Worker(0, 1, {
50 | workerIdBits: 5,
51 | datacenterIdBits: 5,
52 | sequenceBits: 12,
53 | });
54 |
55 | generator.nextId(); // 87559690812260352n
56 | generator.nextId().toString(); // 87559690833231872
57 |
58 | generator.getCurrentSequence(); // 0n
59 | generator.getDatacenterId(); // 1n
60 | generator.getLastTimestamp(); // 1630335057075n
61 | generator.getWorkerId(); // 0n
62 | ```
63 |
64 | Generated IDs are [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) and can be easily converted into strings.
65 |
66 | ## Constructor Options
67 |
68 | | Property | Description | Optional? | Type | Default Value |
69 | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | --------- | ---------------- | ------------- |
70 | | workerId | Id for the worker | Yes | Number or BigInt | 0 |
71 | | datacenterId | Identifier of the datacenter to which the worker belongs | Yes | Number or BigInt | 0 |
72 | | options | Custom options for the worker | Yes | Object | undefined |
73 | | options.epoch | Custom epoch for timestamp generation. By default, the number of milliseconds since the first second of 2021 | Yes | Number or BigInt | 1609459200000 |
74 | | options.workerIdBits | Number of usable bits for Worker Id. 5 by default, allows up to 31 Workers | Yes | Number or BigInt | 5 |
75 | | options.datacenterIdBits | Number of usable bits for Datacenter Id. 5 by default, allows up to 31 Datacenters | Yes | Number or BigInt | 5 |
76 | | options.sequence | For every Id that is generated on that process, this number is incremented | Yes | Number or BigInt | 0 |
77 | | options.sequenceBits | Number of usable bits for Sequence Id. 12 by default, allows up to 4095 generations per millisecond per Worker per Datacenter | Yes | Number or BigInt | 12 |
78 |
79 | ## Useful Links
80 |
81 | - [Twitter's Snowflake repository](https://github.com/twitter-archive/snowflake/tree/snowflake-2010)
82 | - [Announcing Snowflake](https://blog.twitter.com/engineering/en_us/a/2010/announcing-snowflake.html)
83 | - [Twitter Ids](https://developer.twitter.com/en/docs/twitter-ids)
84 | - [The GitHub repo](https://github.com/rakheyl/snowflake-uuid)
85 | - [The NPM package](https://www.npmjs.com/package/snowflake-uuid)
86 |
87 | ## License
88 |
89 | Refer to the [LICENSE](LICENSE) file.
90 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Created by https://www.toptal.com/developers/gitignore/api/vim,git,node,linux,windows,sublimetext,visualstudio,webstorm+all,visualstudiocode,macos
2 | # Edit at https://www.toptal.com/developers/gitignore?templates=vim,git,node,linux,windows,sublimetext,visualstudio,webstorm+all,visualstudiocode,macos
3 |
4 | ### Git ###
5 | # Created by git for backups. To disable backups in Git:
6 | # $ git config --global mergetool.keepBackup false
7 | *.orig
8 |
9 | # Created by git when using merge tools for conflicts
10 | *.BACKUP.*
11 | *.BASE.*
12 | *.LOCAL.*
13 | *.REMOTE.*
14 | *_BACKUP_*.txt
15 | *_BASE_*.txt
16 | *_LOCAL_*.txt
17 | *_REMOTE_*.txt
18 |
19 | ### Linux ###
20 | *~
21 |
22 | # temporary files which can be created if a process still has a handle open of a deleted file
23 | .fuse_hidden*
24 |
25 | # KDE directory preferences
26 | .directory
27 |
28 | # Linux trash folder which might appear on any partition or disk
29 | .Trash-*
30 |
31 | # .nfs files are created when an open file is removed but is still being accessed
32 | .nfs*
33 |
34 | ### macOS ###
35 | # General
36 | .DS_Store
37 | .AppleDouble
38 | .LSOverride
39 |
40 | # Icon must end with two \r
41 | Icon
42 |
43 |
44 | # Thumbnails
45 | ._*
46 |
47 | # Files that might appear in the root of a volume
48 | .DocumentRevisions-V100
49 | .fseventsd
50 | .Spotlight-V100
51 | .TemporaryItems
52 | .Trashes
53 | .VolumeIcon.icns
54 | .com.apple.timemachine.donotpresent
55 |
56 | # Directories potentially created on remote AFP share
57 | .AppleDB
58 | .AppleDesktop
59 | Network Trash Folder
60 | Temporary Items
61 | .apdisk
62 |
63 | ### Node ###
64 | # Logs
65 | logs
66 | *.log
67 | npm-debug.log*
68 | yarn-debug.log*
69 | yarn-error.log*
70 | lerna-debug.log*
71 | .pnpm-debug.log*
72 |
73 | # Diagnostic reports (https://nodejs.org/api/report.html)
74 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
75 |
76 | # Runtime data
77 | pids
78 | *.pid
79 | *.seed
80 | *.pid.lock
81 |
82 | # Directory for instrumented libs generated by jscoverage/JSCover
83 | lib-cov
84 |
85 | # Coverage directory used by tools like istanbul
86 | coverage
87 | *.lcov
88 |
89 | # nyc test coverage
90 | .nyc_output
91 |
92 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
93 | .grunt
94 |
95 | # Bower dependency directory (https://bower.io/)
96 | bower_components
97 |
98 | # node-waf configuration
99 | .lock-wscript
100 |
101 | # Compiled binary addons (https://nodejs.org/api/addons.html)
102 | build/Release
103 |
104 | # Dependency directories
105 | node_modules/
106 | jspm_packages/
107 |
108 | # Snowpack dependency directory (https://snowpack.dev/)
109 | web_modules/
110 |
111 | # TypeScript cache
112 | *.tsbuildinfo
113 |
114 | # Optional npm cache directory
115 | .npm
116 |
117 | # Optional eslint cache
118 | .eslintcache
119 |
120 | # Microbundle cache
121 | .rpt2_cache/
122 | .rts2_cache_cjs/
123 | .rts2_cache_es/
124 | .rts2_cache_umd/
125 |
126 | # Optional REPL history
127 | .node_repl_history
128 |
129 | # Output of 'npm pack'
130 | *.tgz
131 |
132 | # Yarn Integrity file
133 | .yarn-integrity
134 |
135 | # dotenv environment variables file
136 | .env
137 | .env.test
138 | .env.production
139 |
140 | # parcel-bundler cache (https://parceljs.org/)
141 | .cache
142 | .parcel-cache
143 |
144 | # Next.js build output
145 | .next
146 | out
147 |
148 | # Nuxt.js build / generate output
149 | .nuxt
150 | dist
151 |
152 | # Gatsby files
153 | .cache/
154 | # Comment in the public line in if your project uses Gatsby and not Next.js
155 | # https://nextjs.org/blog/next-9-1#public-directory-support
156 | # public
157 |
158 | # vuepress build output
159 | .vuepress/dist
160 |
161 | # Serverless directories
162 | .serverless/
163 |
164 | # FuseBox cache
165 | .fusebox/
166 |
167 | # DynamoDB Local files
168 | .dynamodb/
169 |
170 | # TernJS port file
171 | .tern-port
172 |
173 | # Stores VSCode versions used for testing VSCode extensions
174 | .vscode-test
175 |
176 | # yarn v2
177 | .yarn/cache
178 | .yarn/unplugged
179 | .yarn/build-state.yml
180 | .yarn/install-state.gz
181 | .pnp.*
182 |
183 | ### SublimeText ###
184 | # Cache files for Sublime Text
185 | *.tmlanguage.cache
186 | *.tmPreferences.cache
187 | *.stTheme.cache
188 |
189 | # Workspace files are user-specific
190 | *.sublime-workspace
191 |
192 | # Project files should be checked into the repository, unless a significant
193 | # proportion of contributors will probably not be using Sublime Text
194 | # *.sublime-project
195 |
196 | # SFTP configuration file
197 | sftp-config.json
198 | sftp-config-alt*.json
199 |
200 | # Package control specific files
201 | Package Control.last-run
202 | Package Control.ca-list
203 | Package Control.ca-bundle
204 | Package Control.system-ca-bundle
205 | Package Control.cache/
206 | Package Control.ca-certs/
207 | Package Control.merged-ca-bundle
208 | Package Control.user-ca-bundle
209 | oscrypto-ca-bundle.crt
210 | bh_unicode_properties.cache
211 |
212 | # Sublime-github package stores a github token in this file
213 | # https://packagecontrol.io/packages/sublime-github
214 | GitHub.sublime-settings
215 |
216 | ### Vim ###
217 | # Swap
218 | [._]*.s[a-v][a-z]
219 | !*.svg # comment out if you don't need vector files
220 | [._]*.sw[a-p]
221 | [._]s[a-rt-v][a-z]
222 | [._]ss[a-gi-z]
223 | [._]sw[a-p]
224 |
225 | # Session
226 | Session.vim
227 | Sessionx.vim
228 |
229 | # Temporary
230 | .netrwhist
231 | # Auto-generated tag files
232 | tags
233 | # Persistent undo
234 | [._]*.un~
235 |
236 | ### VisualStudioCode ###
237 | .vscode/*
238 | !.vscode/settings.json
239 | !.vscode/tasks.json
240 | !.vscode/launch.json
241 | !.vscode/extensions.json
242 | *.code-workspace
243 |
244 | # Local History for Visual Studio Code
245 | .history/
246 |
247 | ### VisualStudioCode Patch ###
248 | # Ignore all local history of files
249 | .history
250 | .ionide
251 |
252 | ### WebStorm+all ###
253 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
254 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
255 |
256 | # User-specific stuff
257 | .idea/**/workspace.xml
258 | .idea/**/tasks.xml
259 | .idea/**/usage.statistics.xml
260 | .idea/**/dictionaries
261 | .idea/**/shelf
262 |
263 | # AWS User-specific
264 | .idea/**/aws.xml
265 |
266 | # Generated files
267 | .idea/**/contentModel.xml
268 |
269 | # Sensitive or high-churn files
270 | .idea/**/dataSources/
271 | .idea/**/dataSources.ids
272 | .idea/**/dataSources.local.xml
273 | .idea/**/sqlDataSources.xml
274 | .idea/**/dynamic.xml
275 | .idea/**/uiDesigner.xml
276 | .idea/**/dbnavigator.xml
277 |
278 | # Gradle
279 | .idea/**/gradle.xml
280 | .idea/**/libraries
281 |
282 | # Gradle and Maven with auto-import
283 | # When using Gradle or Maven with auto-import, you should exclude module files,
284 | # since they will be recreated, and may cause churn. Uncomment if using
285 | # auto-import.
286 | # .idea/artifacts
287 | # .idea/compiler.xml
288 | # .idea/jarRepositories.xml
289 | # .idea/modules.xml
290 | # .idea/*.iml
291 | # .idea/modules
292 | # *.iml
293 | # *.ipr
294 |
295 | # CMake
296 | cmake-build-*/
297 |
298 | # Mongo Explorer plugin
299 | .idea/**/mongoSettings.xml
300 |
301 | # File-based project format
302 | *.iws
303 |
304 | # IntelliJ
305 | out/
306 |
307 | # mpeltonen/sbt-idea plugin
308 | .idea_modules/
309 |
310 | # JIRA plugin
311 | atlassian-ide-plugin.xml
312 |
313 | # Cursive Clojure plugin
314 | .idea/replstate.xml
315 |
316 | # Crashlytics plugin (for Android Studio and IntelliJ)
317 | com_crashlytics_export_strings.xml
318 | crashlytics.properties
319 | crashlytics-build.properties
320 | fabric.properties
321 |
322 | # Editor-based Rest Client
323 | .idea/httpRequests
324 |
325 | # Android studio 3.1+ serialized cache file
326 | .idea/caches/build_file_checksums.ser
327 |
328 | ### WebStorm+all Patch ###
329 | # Ignores the whole .idea folder and all .iml files
330 | # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
331 |
332 | .idea/
333 |
334 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
335 |
336 | *.iml
337 | modules.xml
338 | .idea/misc.xml
339 | *.ipr
340 |
341 | # Sonarlint plugin
342 | .idea/sonarlint
343 |
344 | ### Windows ###
345 | # Windows thumbnail cache files
346 | Thumbs.db
347 | Thumbs.db:encryptable
348 | ehthumbs.db
349 | ehthumbs_vista.db
350 |
351 | # Dump file
352 | *.stackdump
353 |
354 | # Folder config file
355 | [Dd]esktop.ini
356 |
357 | # Recycle Bin used on file shares
358 | $RECYCLE.BIN/
359 |
360 | # Windows Installer files
361 | *.cab
362 | *.msi
363 | *.msix
364 | *.msm
365 | *.msp
366 |
367 | # Windows shortcuts
368 | *.lnk
369 |
370 | ### VisualStudio ###
371 | ## Ignore Visual Studio temporary files, build results, and
372 | ## files generated by popular Visual Studio add-ons.
373 | ##
374 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
375 |
376 | # User-specific files
377 | *.rsuser
378 | *.suo
379 | *.user
380 | *.userosscache
381 | *.sln.docstates
382 |
383 | # User-specific files (MonoDevelop/Xamarin Studio)
384 | *.userprefs
385 |
386 | # Mono auto generated files
387 | mono_crash.*
388 |
389 | # Build results
390 | [Dd]ebug/
391 | [Dd]ebugPublic/
392 | [Rr]elease/
393 | [Rr]eleases/
394 | x64/
395 | x86/
396 | [Ww][Ii][Nn]32/
397 | [Aa][Rr][Mm]/
398 | [Aa][Rr][Mm]64/
399 | bld/
400 | [Bb]in/
401 | [Oo]bj/
402 | [Ll]og/
403 | [Ll]ogs/
404 |
405 | # Visual Studio 2015/2017 cache/options directory
406 | .vs/
407 | # Uncomment if you have tasks that create the project's static files in wwwroot
408 | #wwwroot/
409 |
410 | # Visual Studio 2017 auto generated files
411 | Generated\ Files/
412 |
413 | # MSTest test Results
414 | [Tt]est[Rr]esult*/
415 | [Bb]uild[Ll]og.*
416 |
417 | # NUnit
418 | *.VisualState.xml
419 | TestResult.xml
420 | nunit-*.xml
421 |
422 | # Build Results of an ATL Project
423 | [Dd]ebugPS/
424 | [Rr]eleasePS/
425 | dlldata.c
426 |
427 | # Benchmark Results
428 | BenchmarkDotNet.Artifacts/
429 |
430 | # .NET Core
431 | project.lock.json
432 | project.fragment.lock.json
433 | artifacts/
434 |
435 | # ASP.NET Scaffolding
436 | ScaffoldingReadMe.txt
437 |
438 | # StyleCop
439 | StyleCopReport.xml
440 |
441 | # Files built by Visual Studio
442 | *_i.c
443 | *_p.c
444 | *_h.h
445 | *.ilk
446 | *.meta
447 | *.obj
448 | *.iobj
449 | *.pch
450 | *.pdb
451 | *.ipdb
452 | *.pgc
453 | *.pgd
454 | *.rsp
455 | *.sbr
456 | *.tlb
457 | *.tli
458 | *.tlh
459 | *.tmp
460 | *.tmp_proj
461 | *_wpftmp.csproj
462 | *.tlog
463 | *.vspscc
464 | *.vssscc
465 | .builds
466 | *.pidb
467 | *.svclog
468 | *.scc
469 |
470 | # Chutzpah Test files
471 | _Chutzpah*
472 |
473 | # Visual C++ cache files
474 | ipch/
475 | *.aps
476 | *.ncb
477 | *.opendb
478 | *.opensdf
479 | *.sdf
480 | *.cachefile
481 | *.VC.db
482 | *.VC.VC.opendb
483 |
484 | # Visual Studio profiler
485 | *.psess
486 | *.vsp
487 | *.vspx
488 | *.sap
489 |
490 | # Visual Studio Trace Files
491 | *.e2e
492 |
493 | # TFS 2012 Local Workspace
494 | $tf/
495 |
496 | # Guidance Automation Toolkit
497 | *.gpState
498 |
499 | # ReSharper is a .NET coding add-in
500 | _ReSharper*/
501 | *.[Rr]e[Ss]harper
502 | *.DotSettings.user
503 |
504 | # TeamCity is a build add-in
505 | _TeamCity*
506 |
507 | # DotCover is a Code Coverage Tool
508 | *.dotCover
509 |
510 | # AxoCover is a Code Coverage Tool
511 | .axoCover/*
512 | !.axoCover/settings.json
513 |
514 | # Coverlet is a free, cross platform Code Coverage Tool
515 | coverage*.json
516 | coverage*.xml
517 | coverage*.info
518 |
519 | # Visual Studio code coverage results
520 | *.coverage
521 | *.coveragexml
522 |
523 | # NCrunch
524 | _NCrunch_*
525 | .*crunch*.local.xml
526 | nCrunchTemp_*
527 |
528 | # MightyMoose
529 | *.mm.*
530 | AutoTest.Net/
531 |
532 | # Web workbench (sass)
533 | .sass-cache/
534 |
535 | # Installshield output folder
536 | [Ee]xpress/
537 |
538 | # DocProject is a documentation generator add-in
539 | DocProject/buildhelp/
540 | DocProject/Help/*.HxT
541 | DocProject/Help/*.HxC
542 | DocProject/Help/*.hhc
543 | DocProject/Help/*.hhk
544 | DocProject/Help/*.hhp
545 | DocProject/Help/Html2
546 | DocProject/Help/html
547 |
548 | # Click-Once directory
549 | publish/
550 |
551 | # Publish Web Output
552 | *.[Pp]ublish.xml
553 | *.azurePubxml
554 | # Note: Comment the next line if you want to checkin your web deploy settings,
555 | # but database connection strings (with potential passwords) will be unencrypted
556 | *.pubxml
557 | *.publishproj
558 |
559 | # Microsoft Azure Web App publish settings. Comment the next line if you want to
560 | # checkin your Azure Web App publish settings, but sensitive information contained
561 | # in these scripts will be unencrypted
562 | PublishScripts/
563 |
564 | # NuGet Packages
565 | *.nupkg
566 | # NuGet Symbol Packages
567 | *.snupkg
568 | # The packages folder can be ignored because of Package Restore
569 | **/[Pp]ackages/*
570 | # except build/, which is used as an MSBuild target.
571 | !**/[Pp]ackages/build/
572 | # Uncomment if necessary however generally it will be regenerated when needed
573 | #!**/[Pp]ackages/repositories.config
574 | # NuGet v3's project.json files produces more ignorable files
575 | *.nuget.props
576 | *.nuget.targets
577 |
578 | # Nuget personal access tokens and Credentials
579 | nuget.config
580 |
581 | # Microsoft Azure Build Output
582 | csx/
583 | *.build.csdef
584 |
585 | # Microsoft Azure Emulator
586 | ecf/
587 | rcf/
588 |
589 | # Windows Store app package directories and files
590 | AppPackages/
591 | BundleArtifacts/
592 | Package.StoreAssociation.xml
593 | _pkginfo.txt
594 | *.appx
595 | *.appxbundle
596 | *.appxupload
597 |
598 | # Visual Studio cache files
599 | # files ending in .cache can be ignored
600 | *.[Cc]ache
601 | # but keep track of directories ending in .cache
602 | !?*.[Cc]ache/
603 |
604 | # Others
605 | ClientBin/
606 | ~$*
607 | *.dbmdl
608 | *.dbproj.schemaview
609 | *.jfm
610 | *.pfx
611 | *.publishsettings
612 | orleans.codegen.cs
613 |
614 | # Including strong name files can present a security risk
615 | # (https://github.com/github/gitignore/pull/2483#issue-259490424)
616 | #*.snk
617 |
618 | # Since there are multiple workflows, uncomment next line to ignore bower_components
619 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
620 | #bower_components/
621 |
622 | # RIA/Silverlight projects
623 | Generated_Code/
624 |
625 | # Backup & report files from converting an old project file
626 | # to a newer Visual Studio version. Backup files are not needed,
627 | # because we have git ;-)
628 | _UpgradeReport_Files/
629 | Backup*/
630 | UpgradeLog*.XML
631 | UpgradeLog*.htm
632 | ServiceFabricBackup/
633 | *.rptproj.bak
634 |
635 | # SQL Server files
636 | *.mdf
637 | *.ldf
638 | *.ndf
639 |
640 | # Business Intelligence projects
641 | *.rdl.data
642 | *.bim.layout
643 | *.bim_*.settings
644 | *.rptproj.rsuser
645 | *- [Bb]ackup.rdl
646 | *- [Bb]ackup ([0-9]).rdl
647 | *- [Bb]ackup ([0-9][0-9]).rdl
648 |
649 | # Microsoft Fakes
650 | FakesAssemblies/
651 |
652 | # GhostDoc plugin setting file
653 | *.GhostDoc.xml
654 |
655 | # Node.js Tools for Visual Studio
656 | .ntvs_analysis.dat
657 |
658 | # Visual Studio 6 build log
659 | *.plg
660 |
661 | # Visual Studio 6 workspace options file
662 | *.opt
663 |
664 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
665 | *.vbw
666 |
667 | # Visual Studio LightSwitch build output
668 | **/*.HTMLClient/GeneratedArtifacts
669 | **/*.DesktopClient/GeneratedArtifacts
670 | **/*.DesktopClient/ModelManifest.xml
671 | **/*.Server/GeneratedArtifacts
672 | **/*.Server/ModelManifest.xml
673 | _Pvt_Extensions
674 |
675 | # Paket dependency manager
676 | .paket/paket.exe
677 | paket-files/
678 |
679 | # FAKE - F# Make
680 | .fake/
681 |
682 | # CodeRush personal settings
683 | .cr/personal
684 |
685 | # Python Tools for Visual Studio (PTVS)
686 | __pycache__/
687 | *.pyc
688 |
689 | # Cake - Uncomment if you are using it
690 | # tools/**
691 | # !tools/packages.config
692 |
693 | # Tabs Studio
694 | *.tss
695 |
696 | # Telerik's JustMock configuration file
697 | *.jmconfig
698 |
699 | # BizTalk build output
700 | *.btp.cs
701 | *.btm.cs
702 | *.odx.cs
703 | *.xsd.cs
704 |
705 | # OpenCover UI analysis results
706 | OpenCover/
707 |
708 | # Azure Stream Analytics local run output
709 | ASALocalRun/
710 |
711 | # MSBuild Binary and Structured Log
712 | *.binlog
713 |
714 | # NVidia Nsight GPU debugger configuration file
715 | *.nvuser
716 |
717 | # MFractors (Xamarin productivity tool) working folder
718 | .mfractor/
719 |
720 | # Local History for Visual Studio
721 | .localhistory/
722 |
723 | # BeatPulse healthcheck temp database
724 | healthchecksdb
725 |
726 | # Backup folder for Package Reference Convert tool in Visual Studio 2017
727 | MigrationBackup/
728 |
729 | # Ionide (cross platform F# VS Code tools) working folder
730 | .ionide/
731 |
732 | # Fody - auto-generated XML schema
733 | FodyWeavers.xsd
734 |
735 | # VS Code files for those working on multiple tools
736 |
737 | # Local History for Visual Studio Code
738 |
739 | # Windows Installer files from build outputs
740 |
741 | # JetBrains Rider
742 | *.sln.iml
743 |
744 | ### VisualStudio Patch ###
745 | # Additional files built by Visual Studio
746 |
747 | # End of https://www.toptal.com/developers/gitignore/api/vim,git,node,linux,windows,sublimetext,visualstudio,webstorm+all,visualstudiocode,macos
--------------------------------------------------------------------------------
/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 |
635 | Copyright (C)
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 | Copyright (C)
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 |
--------------------------------------------------------------------------------
6 | 
