89 | );
90 | }
91 |
--------------------------------------------------------------------------------
/.sass-lint.yml:
--------------------------------------------------------------------------------
1 | options:
2 | formatter: stylish
3 | files:
4 | include: 'src/**/*.scss'
5 | rules:
6 | # Extends
7 | extends-before-mixins: 2
8 | extends-before-declarations: 2
9 | placeholder-in-extend: 2
10 |
11 | # Mixins
12 | mixins-before-declarations: 2
13 |
14 | # Line Spacing
15 | one-declaration-per-line: 2
16 | empty-line-between-blocks: 2
17 | single-line-per-selector: 2
18 |
19 | # Disallows
20 | no-attribute-selectors: 0
21 | no-color-keywords: 2
22 | no-color-literals: 2
23 | no-combinators: 0
24 | no-css-comments: 2
25 | no-debug: 2
26 | no-disallowed-properties: 2
27 | no-duplicate-properties: 2
28 | no-empty-rulesets: 2
29 | no-extends: 2
30 | no-ids: 2
31 | no-important: 2
32 | no-invalid-hex: 2
33 | no-mergeable-selectors: 2
34 | no-misspelled-properties: 2
35 | no-qualifying-elements:
36 | - 2
37 | -
38 | allow-element-with-attribute: true
39 | allow-element-with-class: true
40 | no-trailing-whitespace: 2
41 | no-trailing-zero: 2
42 | no-transition-all: 2
43 | no-universal-selectors: 2
44 | no-url-protocols: 2
45 | no-vendor-prefixes:
46 | - 2
47 | - ignore-non-standard: true
48 | no-warn: 2
49 | property-units: 2
50 |
51 | # Nesting
52 | force-attribute-nesting: 0
53 | force-element-nesting: 0
54 | force-pseudo-nesting: 0
55 |
56 | # Name Formats
57 | class-name-format:
58 | - 2
59 | -
60 | convention: ^([A-Z][a-z]+)+(-[a-z]+([A-Z][a-z]*)*)?(--[a-z]+([A-Z][a-z]*)*)?|is([A-Z][a-z]*)+$
61 | convention-explanation: must follow css-bliss rules, i.e. ModuleName[-elementName][--modifierName] | isStateName
62 | function-name-format: 2
63 | id-name-format: 2
64 | mixin-name-format: 2
65 | placeholder-name-format: 2
66 | variable-name-format:
67 | - 2
68 | -
69 | convention: ^(([A-Z][a-z]+)+-)?[a-z]+([A-Z][a-z]*)*(--[a-z]+([A-Z][a-z]*)*)?$
70 | convention-explanation: must follow css-bliss rules, i.e. [ModuleName-]variableName[--modifierName]
71 |
72 | # Style Guide
73 | attribute-quotes: 2
74 | bem-depth: 2
75 | border-zero:
76 | - 2
77 | -
78 | convention: none
79 | brace-style: 2
80 | clean-import-paths: 2
81 | empty-args: 2
82 | hex-length: 2
83 | hex-notation: 2
84 | indentation:
85 | - 2
86 | -
87 | size: 'tab'
88 | leading-zero:
89 | - 2
90 | -
91 | include: true
92 | nesting-depth: 0
93 | property-sort-order:
94 | - 2
95 | -
96 | order: smacss
97 | pseudo-element: 2
98 | quotes: 2
99 | shorthand-values:
100 | - 2
101 | -
102 | allowed-shorthands:
103 | - [1, 2]
104 | url-quotes: 2
105 | variable-for-property: 2
106 | zero-unit: 2
107 |
108 | # Inner Spacing
109 | space-after-comma: 2
110 | space-before-colon: 2
111 | space-after-colon: 2
112 | space-before-brace: 2
113 | space-before-bang: 2
114 | space-after-bang: 2
115 | space-between-parens: 2
116 | space-around-operator: 2
117 |
118 | # Final Items
119 | trailing-semicolon: 2
120 | final-newline: 2
121 |
--------------------------------------------------------------------------------
/src/components/StorageEdit.js:
--------------------------------------------------------------------------------
1 | import classNames from 'classnames';
2 | import numeral from 'numeral';
3 | import { useState } from 'react';
4 | import { useMutationSetRawData, useQueryRawData } from '../data/queries';
5 | import { formatIsoDate } from '../utils/date';
6 | import LinkButton from './LinkButton';
7 |
8 | export default function StorageEdit() {
9 | const { isLoading, isFetching, data: rawData } = useQueryRawData({ keepPreviousData: true });
10 |
11 | const setRawDataMutation = useMutationSetRawData();
12 |
13 | const [value, setValue] = useState(rawData);
14 | const [prevRawData, setPrevRawData] = useState(rawData);
15 | // if rawData is updated by restoring a file, update the textarea
16 | if (rawData !== prevRawData) {
17 | setValue(rawData);
18 | setPrevRawData(rawData);
19 | }
20 |
21 | const [showTextarea, setShowTextarea] = useState(false);
22 |
23 | if (isLoading) {
24 | return null;
25 | }
26 |
27 | const isDirty = value !== rawData;
28 |
29 | const handleToggleTextarea = () => {
30 | setShowTextarea(showTextarea => !showTextarea);
31 | };
32 |
33 | const handleChange = e => {
34 | setValue(e.target.value);
35 | };
36 |
37 | const handleSave = () => {
38 | setRawDataMutation.mutate(value);
39 | };
40 |
41 | const handleUpload = () => {
42 | const input = document.createElement('input');
43 | input.type = 'file';
44 | input.accept = '.json';
45 | input.addEventListener('change', () => {
46 | const reader = new FileReader();
47 | reader.onload = () => {
48 | setRawDataMutation.mutate(reader.result);
49 | };
50 | reader.readAsText(input.files[0]);
51 | }, { once: true });
52 | input.click();
53 | };
54 |
55 | const handleDownload = () => {
56 | const blob = new Blob([rawData], { type: 'application/json' });
57 | const a = document.createElement('a');
58 | a.href = URL.createObjectURL(blob);
59 | const now = Date.now();
60 | a.download = `mediadb-backup-${formatIsoDate(now)}-${now}.json`;
61 | a.click();
62 | };
63 |
64 | return (
65 |
115 | );
116 | }
117 |
--------------------------------------------------------------------------------
/src/styles/modules/_CompactTable.scss:
--------------------------------------------------------------------------------
1 | @import '../functions';
2 | @import '../theme';
3 |
4 | .CompactTable {
5 | $root: &;
6 |
7 | $fontSize: $Theme-fontSize--larger;
8 |
9 | $base: $Theme-background;
10 | $stripe: $Theme-background--grey;
11 | $hover: $Theme-background--highlight;
12 | $border: $Theme-borderColor--light;
13 |
14 | $cellPaddingY: 4px;
15 | $cellPaddingX: 9px;
16 |
17 | $thumbnailCellWidth: 70px;
18 |
19 | width: 100%;
20 | font-size: $fontSize;
21 | border-collapse: collapse;
22 |
23 | p {
24 | margin: 0;
25 | }
26 |
27 | tr {
28 | background-color: $base;
29 | }
30 |
31 | td,
32 | th {
33 | padding: $cellPaddingY $cellPaddingX;
34 | border: none;
35 | line-height: 1.4em;
36 | }
37 |
38 | td {
39 | &:not(:first-of-type) {
40 | border-left: $Theme-borderWidth solid $border;
41 | }
42 | }
43 |
44 | th {
45 | border-bottom: $Theme-borderWidth solid $border;
46 | }
47 |
48 | &--stripe {
49 | tbody tr:nth-of-type(odd) {
50 | background-color: $stripe;
51 | }
52 | }
53 |
54 | &--hover {
55 | tbody tr:hover {
56 | background-color: $hover;
57 | }
58 | }
59 |
60 | &--alignColumnsForItemList {
61 | td,
62 | th {
63 | &:nth-of-type(1), // thumbnail
64 | &:nth-of-type(3), // creator
65 | &:nth-of-type(4), // genres
66 | &:nth-of-type(5), // characters
67 | &:nth-of-type(9) { // production status
68 | text-align: center;
69 | }
70 |
71 | &:nth-of-type(2), // title + tags
72 | &:nth-of-type(6), // notes
73 | &:nth-of-type(7) { // date
74 | text-align: left;
75 | }
76 |
77 | &:nth-of-type(8) { // length
78 | text-align: right;
79 | }
80 |
81 | // make notes column take up all extra space
82 | &:nth-of-type(6) {
83 | width: 100%;
84 | }
85 |
86 | // fixed width for thumbnail column to avoid resizing as images load
87 | &:nth-of-type(1) {
88 | min-width: $thumbnailCellWidth;
89 | }
90 | }
91 | }
92 |
93 | &--alignColumnsForHistoryList {
94 | td,
95 | th {
96 | &:nth-of-type(1), // changes
97 | &:nth-of-type(2), // date
98 | &:nth-of-type(3) { // selected indicator
99 | text-align: left;
100 | }
101 |
102 | // make changes column take up all extra space
103 | &:nth-of-type(1) {
104 | width: 100%;
105 | }
106 | }
107 | }
108 |
109 | &-item {
110 | cursor: default;
111 | user-select: none;
112 |
113 | &--autowrap {
114 | &:not(:hover) {
115 | max-height: 1.75em;
116 | overflow: hidden;
117 | word-break: break-all;
118 |
119 | p {
120 | position: relative;
121 |
122 | &::after {
123 | position: absolute;
124 | top: 0;
125 | right: 0;
126 | bottom: 1.8em;
127 | left: calc(100% - 25%);
128 | background: fade-in($base);
129 | content: '';
130 | pointer-events: none;
131 |
132 | #{$root}--stripe tr:nth-of-type(odd) & {
133 | background: fade-in($stripe);
134 | }
135 |
136 | #{$root}--hover tr:hover & {
137 | background: fade-in($hover);
138 | }
139 | }
140 | }
141 | }
142 | }
143 |
144 | &--truncate {
145 | max-width: 350px;
146 |
147 | p {
148 | text-overflow: ellipsis;
149 | overflow: hidden;
150 | }
151 | }
152 |
153 | &--nowrap {
154 | white-space: nowrap;
155 | }
156 |
157 | &--small {
158 | font-size: smaller;
159 | }
160 | }
161 |
162 | &-tinyThumbnail {
163 | max-width: #{$thumbnailCellWidth - 2 * $cellPaddingX};
164 | max-height: 20px;
165 | margin-top: -8px;
166 | margin-bottom: -6px;
167 | }
168 | }
169 |
--------------------------------------------------------------------------------
/webpack.config.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable import/no-commonjs, import/order */
2 | const { join } = require('path');
3 | const BellOnBundlerErrorPlugin = require('bell-on-bundler-error-plugin');
4 | const InertEntryPlugin = require('inert-entry-webpack-plugin');
5 | const NyanProgressPlugin = require('nyan-progress-webpack-plugin');
6 | const ZipPlugin = require('zip-webpack-plugin');
7 | const sass = require('sass');
8 |
9 | module.exports = (env, { mode }) => ({
10 | entry: 'extricate-loader!interpolate-loader!./src/manifest.json',
11 | output: {
12 | path: join(__dirname, 'dist'),
13 | filename: 'manifest.json',
14 | },
15 | performance: false,
16 | devtool: mode === 'production' ? false : 'inline-cheap-source-map',
17 | module: {
18 | rules: [{
19 | test: /\.entry\.js$/,
20 | use: [
21 | { loader: 'spawn-loader', options: { name: '[name].js' } },
22 | ],
23 | }, {
24 | test: /\.js$/,
25 | exclude: join(__dirname, 'node_modules'),
26 | use: [
27 | {
28 | loader: 'babel-loader',
29 | options: {
30 | presets: [
31 | ['@babel/preset-react', {
32 | runtime: 'automatic',
33 | }],
34 | mode === 'production' && ['babel-preset-minify', {
35 | booleans: false,
36 | builtIns: false,
37 | flipComparisons: false,
38 | mangle: false,
39 | }],
40 | ].filter(x => x),
41 | plugins: [
42 | ['babel-plugin-transform-define', {
43 | 'process.env.NODE_ENV': mode,
44 | 'typeof window': 'object',
45 | }],
46 |
47 | mode === 'production' && '@babel/plugin-transform-react-constant-elements',
48 | ].filter(x => x),
49 | comments: mode !== 'production',
50 | compact: mode === 'production',
51 | babelrc: false,
52 | },
53 | },
54 | ],
55 | }, {
56 | test: /\.js$/,
57 | include: join(__dirname, 'node_modules'),
58 | exclude: /snudown-js/,
59 | use: [
60 | {
61 | loader: 'babel-loader',
62 | options: {
63 | presets: [
64 | mode === 'production' && ['babel-preset-minify', {
65 | booleans: false,
66 | builtIns: false,
67 | flipComparisons: false,
68 | mangle: false,
69 | }],
70 | ].filter(x => x),
71 | plugins: [
72 | ['babel-plugin-transform-define', {
73 | 'process.env.NODE_ENV': mode,
74 | 'typeof window': 'object',
75 | }],
76 |
77 | mode === 'production' && '@babel/plugin-transform-react-constant-elements',
78 | ].filter(x => x),
79 | comments: false,
80 | compact: true,
81 | babelrc: false,
82 | },
83 | },
84 | ],
85 | }, {
86 | test: /\.scss$/,
87 | use: [
88 | { loader: 'file-loader', options: { name: '[name].css', esModule: false } },
89 | { loader: 'extricate-loader', options: { resolve: '\\.js$' } },
90 | { loader: 'css-loader', options: { esModule: false } },
91 | { loader: 'sass-loader', options: { implementation: sass } },
92 | ],
93 | }, {
94 | test: /\.css$/,
95 | use: [
96 | { loader: 'file-loader', options: { name: '[name].css', esModule: false } },
97 | { loader: 'extricate-loader', options: { resolve: '\\.js$' } },
98 | { loader: 'css-loader', options: { esModule: false } },
99 | ],
100 | }, {
101 | test: /\.html$/,
102 | use: [
103 | { loader: 'file-loader', options: { name: '[name].[ext]', esModule: false } },
104 | { loader: 'extricate-loader', options: { resolve: '/html-loader/.+\\.js$' } },
105 | { loader: 'html-loader' },
106 | ],
107 | }, {
108 | test: /\.(png|svg|woff2?|ttf|eot)$/,
109 | use: [
110 | { loader: 'file-loader', options: { name: '[name].[ext]', esModule: false } },
111 | ],
112 | }],
113 | },
114 | optimization: {
115 | minimize: false,
116 | },
117 | plugins: [
118 | new InertEntryPlugin(),
119 | new BellOnBundlerErrorPlugin(),
120 | new NyanProgressPlugin(),
121 |
122 | mode === 'production' && new ZipPlugin({ filename: 'media-db.zip' }),
123 | ].filter(x => x),
124 | });
125 |
--------------------------------------------------------------------------------
/src/data/provider.js:
--------------------------------------------------------------------------------
1 | // import { requestPermissionForUrl } from '../api/permissions';
2 | import { property } from '../utils/object';
3 |
4 | const UrlType = {
5 | json: 'json',
6 | doc: 'doc',
7 | };
8 |
9 | const Path = {
10 | props: 'props',
11 | select: 'select',
12 | map: 'map',
13 | index: 'index',
14 | reverse: 'reverse',
15 | replace: 'replace',
16 | lowercase: 'lowercase',
17 | parseInt: 'parseInt',
18 | relativeUrl: 'relativeUrl',
19 | };
20 |
21 | function parseOptions(provider) {
22 | const { infoCallback } = provider;
23 |
24 | const options = /*: {
25 | urlRegex: string,
26 | idTemplate: string,
27 | fetchUrls: { [Root]: { type: UrlType, urlTemplate: string, headers?: { [string]: string } } },
28 | properties: { [string]: [Root, ...{ [Path]: object }] },
29 | } */ JSON.parse(infoCallback);
30 |
31 | return options;
32 | }
33 |
34 | export function runProviderForId(provider, url) {
35 | const {
36 | urlRegex,
37 | idTemplate,
38 | } = parseOptions(provider);
39 |
40 | const matches = new RegExp(urlRegex, 'i').exec(url);
41 | if (!matches) {
42 | return false;
43 | }
44 |
45 | const id = substitutePlaceholders(idTemplate, matches);
46 |
47 | return id;
48 | }
49 |
50 | export async function runProvider(provider, url, signal /*: AbortSignal */) {
51 | const {
52 | urlRegex,
53 | idTemplate,
54 | fetchUrls,
55 | properties,
56 | } = parseOptions(provider);
57 |
58 | const matches = new RegExp(urlRegex, 'i').exec(url);
59 | if (!matches) {
60 | return false;
61 | }
62 |
63 | const id = substitutePlaceholders(idTemplate, matches);
64 |
65 | const fetching = Object.entries(fetchUrls).map(async ([prop, { type, urlTemplate, headers }]) => {
66 | const urlToFetch = substitutePlaceholders(urlTemplate, matches);
67 | // Disabled because Chrome Web Store review is obnoxious when you request host permissions.
68 | // Needs the following in the manifest: "host_permissions": ["https://*/*"],
69 | // await requestPermissionForUrl(urlToFetch);
70 | const res = await fetch(urlToFetch, { headers, signal });
71 | if (!res.ok) {
72 | throw new Error(`Failed request to '${urlToFetch}': ${res.status}`);
73 | }
74 | let parsed;
75 | switch (type) {
76 | case UrlType.json:
77 | parsed = await res.json();
78 | break;
79 | case UrlType.doc: {
80 | const text = await res.text();
81 | parsed = new DOMParser().parseFromString(text, 'text/html');
82 | break;
83 | }
84 | default:
85 | throw new Error(`Invalid url type: '${type}'`);
86 | }
87 | return [prop, parsed];
88 | });
89 |
90 | const fetched = Object.fromEntries(await Promise.all(fetching));
91 |
92 | const props = Object.entries(properties).map(([prop, [root, ...paths]]) => {
93 | const init = fetched[root];
94 | if (!init) {
95 | throw new Error(`Path based on missing property '${root}'`);
96 | }
97 | const value = paths.reduce((v, path) => traversePath(v, path, matches), init);
98 | const flattened = flattenArray(value);
99 | return [prop, flattened];
100 | });
101 |
102 | return {
103 | ...Object.fromEntries(props),
104 | id,
105 | };
106 | }
107 |
108 | function substitutePlaceholders(template, substitutions) {
109 | return template.replace(/\$(\d+)/g, (match, index) => substitutions[index]);
110 | }
111 |
112 | function traversePath(value, path, matches) {
113 | const [[type, arg], ...rest] = Object.entries(path);
114 |
115 | if (rest.length > 0) {
116 | throw new Error(`Path component has extraneous properties: ${JSON.stringify(rest)}`);
117 | }
118 |
119 | // types which operate on entire arrays
120 | switch (type) {
121 | case Path.index: {
122 | const index /*: number */ = arg;
123 | return value[index];
124 | }
125 | case Path.reverse: {
126 | return value.slice().reverse();
127 | }
128 | default:
129 | break;
130 | }
131 |
132 | if (Array.isArray(value)) {
133 | return value.map(v => traversePath(v, path, matches));
134 | }
135 |
136 | // types which operate on individual elements
137 | switch (type) {
138 | case Path.props: {
139 | const props /*: string[] */ = arg;
140 | return property(value, props);
141 | }
142 | case Path.select: {
143 | const selector /*: string */ = arg;
144 | return Array.from(value.querySelectorAll(selector));
145 | }
146 | case Path.map: {
147 | const mapping /*: { [string]: string } */ = arg;
148 | return mapping[value] || value;
149 | }
150 | case Path.replace: {
151 | const [regex, to, flags] /*: [string, string, ?string] */ = arg;
152 | const from = new RegExp(regex, flags || '');
153 | return value && value.replace(from, to);
154 | }
155 | case Path.lowercase: {
156 | return value && value.toLowerCase();
157 | }
158 | case Path.parseInt: {
159 | return value && parseInt(value, 10);
160 | }
161 | case Path.relativeUrl: {
162 | const baseUrlTemplate /*: string */ = arg;
163 | return value && new URL(value, substitutePlaceholders(baseUrlTemplate, matches)).href;
164 | }
165 | default:
166 | throw new Error(`Invalid path type: '${type}'`);
167 | }
168 | }
169 |
170 | function flattenArray(value) {
171 | if (Array.isArray(value)) {
172 | return value.join(', ');
173 | }
174 | return value;
175 | }
176 |
--------------------------------------------------------------------------------
/src/data/queries.js:
--------------------------------------------------------------------------------
1 | import { QueryClient, useMutation, useQuery } from '@tanstack/react-query';
2 | import { activeTab } from '../api/tabs';
3 | import * as productionStatusTypes from '../constants/productionStatusTypes';
4 | import * as q from '../constants/queryTypes';
5 | import * as statusTypes from '../constants/statusTypes';
6 | import { randomId } from '../utils/string';
7 | import {
8 | addItem,
9 | addProvider,
10 | getItem,
11 | getItemHistory,
12 | getItemHistoryAt,
13 | getItems,
14 | getItemsWithStatus,
15 | getProvider,
16 | getProviders,
17 | getRawData,
18 | removeProvider,
19 | setRawData,
20 | updateItem,
21 | updateProvider,
22 | } from './database';
23 | import { runProvider, runProviderForId } from './provider';
24 |
25 | export const queryClient = new QueryClient({
26 | defaultOptions: {
27 | queries: {
28 | networkMode: 'always', // no connection used
29 | cacheTime: Infinity, // cache unused query results forever
30 | staleTime: Infinity, // never consider query results stale
31 | retry: false, // retries don't help any of our (local) requests
32 | refetchOnReconnect: false, // we don't perform any uncacheable network requests
33 | refetchOnWindowFocus: 'always', // ensure consistency when using multiple tabs
34 | },
35 | mutations: {
36 | networkMode: 'always', // no connection used
37 | cacheTime: Infinity, // cache unused mutation results forever
38 | retry: false, // retries don't help any of our (local) requests
39 | },
40 | },
41 | });
42 |
43 | // Queries
44 |
45 | export function useQueryActiveTab(options = {}) {
46 | return useQuery([q.ACTIVE_TAB], () => activeTab(), {
47 | refetchOnWindowFocus: false, // we only have permission to get active tab during initial open, can't refetch
48 | ...options,
49 | });
50 | }
51 |
52 | export function useQueryItem(id, options = {}) {
53 | return useQuery([q.ITEM, id], () => getItem(id), options);
54 | }
55 |
56 | export function useQueryItemHistory(id, options = {}) {
57 | return useQuery([q.ITEM, id, 'history'], () => getItemHistory(id), options);
58 | }
59 |
60 | export function useQueryItemHistoryAt(id, date, options = {}) {
61 | return useQuery([q.ITEM, id, 'history', date], () => getItemHistoryAt(id, date), options);
62 | }
63 |
64 | export function useQueryItems(options = {}) {
65 | return useQuery([q.ITEMS], () => getItems(), options);
66 | }
67 |
68 | export function useQueryItemsWithStatus(status, options = {}) {
69 | return useQuery([q.ITEMS, 'status', status], () => getItemsWithStatus(status), options);
70 | }
71 |
72 | export function useQueryIdFromProvider(url, options = {}) {
73 | return useQuery([q.FROM_PROVIDER, url, 'id'], async () => {
74 | const providers = await getProviders();
75 | for (const provider of providers) {
76 | const result = runProviderForId(provider, url);
77 | if (result) {
78 | return result;
79 | }
80 | }
81 | return null;
82 | }, options);
83 | }
84 |
85 | export function useQueryItemFromProvider(url, options = {}) {
86 | return useQuery([q.FROM_PROVIDER, url, 'item'], async ({ signal }) => {
87 | const providers = await getProviders();
88 | for (const provider of providers) {
89 | const result = await runProvider(provider, url, signal); // eslint-disable-line no-await-in-loop
90 | if (result) {
91 | console.info('Provider returned:', result); // eslint-disable-line no-console
92 | return result;
93 | }
94 | }
95 | return null;
96 | }, options);
97 | }
98 |
99 | export function useQueryProvider(id, options = {}) {
100 | return useQuery([q.PROVIDER, id], () => getProvider(id), options);
101 | }
102 |
103 | export function useQueryProviders(options = {}) {
104 | return useQuery([q.PROVIDERS], () => getProviders(), options);
105 | }
106 |
107 | export function useQueryRawData(options = {}) {
108 | return useQuery([q.RAW_DATA], async () => JSON.stringify(await getRawData()), options);
109 | }
110 |
111 | // Mutations
112 |
113 | export function useMutationAddItem(url) {
114 | return useMutation(async info => {
115 | const item = {
116 | // defaults (may be overridden by the provider)
117 | thumbnail: null,
118 | tinyThumbnail: null,
119 | title: '',
120 | creator: '',
121 | genres: '',
122 | characters: '',
123 | length: 0,
124 | productionStatus: productionStatusTypes.COMPLETE,
125 |
126 | ...info,
127 |
128 | // always provided by us (along with `date` and `statusDate` handled by the db)
129 | url,
130 | status: statusTypes.PENDING,
131 | notes: '',
132 | tags: '',
133 | };
134 | await addItem(info.id, item);
135 | return item;
136 | }, {
137 | onSuccess: item => {
138 | queryClient.invalidateQueries([q.ITEM, item.id]);
139 | queryClient.invalidateQueries([q.ITEMS]);
140 | queryClient.invalidateQueries([q.RAW_DATA]);
141 | },
142 | });
143 | }
144 |
145 | export function useMutationUpdateItem(id) {
146 | return useMutation(async patch => {
147 | await updateItem(id, patch);
148 | }, {
149 | onSuccess: () => {
150 | queryClient.invalidateQueries([q.ITEM, id]);
151 | queryClient.invalidateQueries([q.ITEMS]);
152 | queryClient.invalidateQueries([q.RAW_DATA]);
153 | },
154 | });
155 | }
156 |
157 | export function useMutationAddProvider() {
158 | return useMutation(async () => {
159 | const id = randomId();
160 | await addProvider(id);
161 | }, {
162 | onSuccess: () => {
163 | queryClient.invalidateQueries([q.FROM_PROVIDER]);
164 | queryClient.invalidateQueries([q.PROVIDERS]);
165 | queryClient.invalidateQueries([q.RAW_DATA]);
166 | },
167 | });
168 | }
169 |
170 | export function useMutationUpdateProvider(id) {
171 | return useMutation(async patch => {
172 | await updateProvider(id, patch);
173 | }, {
174 | onSuccess: () => {
175 | queryClient.invalidateQueries([q.FROM_PROVIDER]);
176 | queryClient.invalidateQueries([q.PROVIDER, id]);
177 | queryClient.invalidateQueries([q.PROVIDERS]);
178 | queryClient.invalidateQueries([q.RAW_DATA]);
179 | },
180 | });
181 | }
182 |
183 | export function useMutationRemoveProvider(id) {
184 | return useMutation(async () => {
185 | await removeProvider(id);
186 | }, {
187 | onSuccess: () => {
188 | queryClient.invalidateQueries([q.FROM_PROVIDER]);
189 | queryClient.invalidateQueries([q.PROVIDER, id]);
190 | queryClient.invalidateQueries([q.PROVIDERS]);
191 | queryClient.invalidateQueries([q.RAW_DATA]);
192 | },
193 | });
194 | }
195 |
196 | export function useMutationSetRawData() {
197 | return useMutation(async rawData => {
198 | await setRawData(JSON.parse(rawData));
199 | }, {
200 | onSuccess: () => {
201 | queryClient.invalidateQueries([q.ITEM]);
202 | queryClient.invalidateQueries([q.ITEMS]);
203 | queryClient.invalidateQueries([q.FROM_PROVIDER]);
204 | queryClient.invalidateQueries([q.PROVIDER]);
205 | queryClient.invalidateQueries([q.PROVIDERS]);
206 | queryClient.invalidateQueries([q.RAW_DATA]);
207 | },
208 | });
209 | }
210 |
--------------------------------------------------------------------------------
/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "parserOptions": {
3 | "ecmaVersion": "latest",
4 | "sourceType": "module",
5 | "ecmaFeatures": {
6 | "jsx": true
7 | }
8 | },
9 | "plugins": [
10 | "@tanstack/eslint-plugin-query",
11 | "eslint-plugin-react",
12 | "eslint-plugin-react-hooks",
13 | "eslint-plugin-consistent-return-legacy",
14 | "eslint-plugin-filenames",
15 | "eslint-plugin-import"
16 | ],
17 | "settings": {
18 | "react": {
19 | "version": "detect"
20 | },
21 | "import/ignore": [
22 | "node_modules",
23 | "\\.(json|png|html|scss)$"
24 | ],
25 | "import/resolver": "webpack"
26 | },
27 | "env": {
28 | "browser": true,
29 | "webextensions": true,
30 | "node": true,
31 | "es6": true
32 | },
33 | "extends": [
34 | "eslint:all",
35 | "plugin:@tanstack/eslint-plugin-query/recommended",
36 | "plugin:react/all",
37 | "plugin:react-hooks/recommended"
38 | ],
39 | "rules": {
40 | "react/destructuring-assignment": 0,
41 | "react/forbid-component-props": 0,
42 | "react/forbid-foreign-prop-types": 0,
43 | "react/jsx-curly-brace-presence": [2, { "props": "never", "children": "ignore" }],
44 | "react/jsx-curly-newline": 0,
45 | "react/jsx-filename-extension": 0,
46 | "react/jsx-indent": [2, "tab"],
47 | "react/jsx-indent-props": [2, "tab"],
48 | "react/jsx-max-depth": 0,
49 | "react/jsx-max-props-per-line": 0,
50 | "react/jsx-newline": [2, { "prevent": true }],
51 | "react/jsx-no-bind": 0,
52 | "react/jsx-one-expression-per-line": 0,
53 | "react/jsx-sort-props": 0,
54 | "react/jsx-sort-default-props": 0,
55 | "react/jsx-tag-spacing": [2, { "closingSlash": "never", "beforeSelfClosing": "never", "afterOpening": "never" }],
56 | "react/jsx-wrap-multilines": [2, { "arrow": false }],
57 | "react/no-set-state": 0,
58 | "react/prefer-stateless-function": 0,
59 | "react/prop-types": 0,
60 | "react/react-in-jsx-scope": 0,
61 | "react/require-default-props": 0,
62 | "react/require-optimization": 0,
63 | "react/sort-prop-types": 0,
64 |
65 | "react-hooks/exhaustive-deps": 2,
66 |
67 | "consistent-return-legacy/consistent-return": 2,
68 |
69 | "filenames/match-regex": 0,
70 | "filenames/match-exported": 2,
71 | "filenames/no-index": 0,
72 |
73 | "import/default": 2,
74 | "import/export": 2,
75 | "import/exports-last": 0,
76 | "import/extensions": [2, "always", { "js": "never" }],
77 | "import/first": 2,
78 | "import/max-dependencies": 0,
79 | "import/named": 2,
80 | "import/namespace": 2,
81 | "import/newline-after-import": 2,
82 | "import/no-absolute-path": 2,
83 | "import/no-amd": 2,
84 | "import/no-anonymous-default-export": 0,
85 | "import/no-commonjs": 2,
86 | "import/no-deprecated": 2,
87 | "import/no-duplicates": 2,
88 | "import/no-dynamic-require": 2,
89 | "import/no-extraneous-dependencies": 2,
90 | "import/no-internal-modules": 0,
91 | "import/no-mutable-exports": 2,
92 | "import/no-named-as-default-member": 2,
93 | "import/no-named-as-default": 2,
94 | "import/no-named-default": 2,
95 | "import/no-namespace": 0,
96 | "import/no-nodejs-modules": 0,
97 | "import/no-restricted-paths": 0,
98 | "import/no-unassigned-import": 2,
99 | "import/no-unresolved": 2,
100 | "import/order": [2, {
101 | "groups": ["builtin", "external", "parent", "sibling", "index"],
102 | "newlines-between": "never",
103 | "alphabetize": { "order": "asc", "caseInsensitive": false }
104 | }],
105 | "import/prefer-default-export": 0,
106 | "import/unambiguous": 0,
107 |
108 | "no-bitwise": 0,
109 | "no-confusing-arrow": 0,
110 | "no-empty-function": [2, { "allow": ["arrowFunctions", "methods"] }],
111 | "no-extra-parens": [2, "functions"], // "all" conflicts with no-return-assign and some other rules, unfortunately
112 | "no-implicit-coercion": [2, { "boolean": false }],
113 | "no-inline-comments": 0,
114 | "no-inner-declarations": 0, // ES6 has block-scoped functions
115 | "no-invalid-this": 0,
116 | "linebreak-style": 0,
117 | "no-plusplus": 0,
118 | "no-process-env": 0,
119 | "no-process-exit": 2,
120 | "no-prototype-builtins": 0,
121 | "no-restricted-imports": 0,
122 | "no-restricted-modules": 0,
123 | "no-restricted-syntax": 0,
124 | "no-shadow": 0,
125 | "no-sync": 0,
126 | "no-tabs": 0,
127 | "no-ternary": 0,
128 | "no-underscore-dangle": 0,
129 | "no-use-before-define": [2, "nofunc"],
130 | "no-magic-numbers": 0,
131 |
132 | "array-bracket-newline": 0,
133 | "array-callback-return": 0,
134 | "array-element-newline": 0,
135 | "arrow-parens": [2, "as-needed"],
136 | "brace-style": [2, "1tbs", { "allowSingleLine": true }],
137 | "callback-return": 0,
138 | "capitalized-comments": 0,
139 | "class-methods-use-this": 0,
140 | "comma-dangle": [2, "always-multiline"],
141 | "consistent-return": 0, // see consistent-return-legacy/consistent-return-legacy
142 | "consistent-this": [2, "this"], // do not alias `this`, use arrow functions
143 | "curly": [2, "multi-line"],
144 | "dot-location": [2, "property"],
145 | "func-style": 0,
146 | "function-call-argument-newline": [2, "consistent"],
147 | "function-paren-newline": 0,
148 | "generator-star-spacing": [2, { "before": false, "after": true }],
149 | "id-length": 0,
150 | "implicit-arrow-linebreak": 0,
151 | "indent": [2, "tab", { "SwitchCase": 1 }],
152 | "init-declarations": 0,
153 | "line-comment-position": 0,
154 | "lines-around-comment": [2, { "allowBlockStart": true }],
155 | "max-classes-per-file": 0,
156 | "max-depth": 0,
157 | "max-len": 0,
158 | "max-lines": 0,
159 | "max-lines-per-function": 0,
160 | "max-nested-callbacks": [2, 5],
161 | "max-params": 0,
162 | "max-statements": 0,
163 | "multiline-comment-style": [2, "separate-lines"],
164 | "multiline-ternary": 0,
165 | "new-cap": 2,
166 | "newline-after-var": [0, "never"],
167 | "newline-before-return": 0,
168 | "newline-per-chained-call": 0,
169 | "object-curly-newline": 0,
170 | "object-curly-spacing": [2, "always"],
171 | "object-property-newline": [2, { "allowMultiplePropertiesPerLine": true }],
172 | "one-var": [2, { "initialized": "never" }],
173 | "one-var-declaration-per-line": [2, "initializations"],
174 | "operator-assignment": [2, "always"],
175 | "operator-linebreak": [2, "after"],
176 | "padded-blocks": [2, "never"],
177 | "prefer-arrow-callback": 0,
178 | "prefer-named-capture-group": 0,
179 | "prefer-reflect": [2, { "exceptions": ["getOwnPropertyNames"] }],
180 | "quote-props": [2, "as-needed"],
181 | "quotes": [2, "single"],
182 | "id-match": 0,
183 | "id-blacklist": 0,
184 | "require-jsdoc": 0,
185 | "require-unicode-regexp": 0,
186 | "sort-keys": 0,
187 | "sort-vars": 0,
188 | "sort-imports": [2, { "ignoreDeclarationSort": true }], // only sort within `import { a, b, c }`; declarations are handled by import/order above
189 | "space-before-function-paren": [2, {
190 | "anonymous": "never",
191 | "named": "never",
192 | "asyncArrow": "always"
193 | }],
194 | "spaced-comment": [2, "always", { "markers": [":", "::"] }],
195 | "strict": [2, "never"], // Babel inserts it for us
196 | "valid-jsdoc": [2, { "requireParamDescription": false, "prefer": { "return": "returns" } }],
197 | "vars-on-top": 0,
198 | "wrap-iife": [2, "inside"],
199 | "yoda": [2, "never", { "exceptRange": true }]
200 | }
201 | }
202 |
--------------------------------------------------------------------------------
/src/data/database.js:
--------------------------------------------------------------------------------
1 | import { openDB, unwrap } from 'idb';
2 | import * as productionStatusTypes from '../constants/productionStatusTypes';
3 | import * as statusTypes from '../constants/statusTypes';
4 | import { distinctBy, sortBy } from '../utils/array';
5 | import { pipe } from '../utils/function';
6 | import { structuralEq } from '../utils/object';
7 |
8 | const idbReady = openDB('MediaDB', 1, {
9 | upgrade(db /* , oldVersion, newVersion, transaction */) {
10 | const media = db.createObjectStore('media', { keyPath: ['id', 'date'] });
11 | media.createIndex('date', 'date');
12 |
13 | const provider = db.createObjectStore('provider', { keyPath: 'id' });
14 | provider.createIndex('createdDate', 'createdDate', { unique: true });
15 | },
16 | });
17 |
18 | async function transaction(storeNames, mode, callback) {
19 | const idb = await idbReady;
20 | const tx = idb.transaction(storeNames, mode);
21 | let result;
22 | try {
23 | result = await callback(tx);
24 | } catch (e) {
25 | if (tx.error) {
26 | // eslint-disable-next-line no-console
27 | console.error('Overridden error during transaction:', e);
28 | throw tx.error;
29 | } else {
30 | tx.abort();
31 | throw e;
32 | }
33 | }
34 | tx.commit();
35 | return result;
36 | }
37 |
38 | // db.media (Item)
39 |
40 | function validateItem(item) {
41 | const validItemFields = [
42 | 'id', 'url',
43 | 'thumbnail', 'tinyThumbnail', 'title', 'creator', 'genres', 'characters', 'notes', 'tags', 'length', 'status', 'productionStatus',
44 | 'statusDate', 'date',
45 | ];
46 | const invalidFields = Object.keys(item).filter(key => !validItemFields.includes(key));
47 | if (invalidFields.length > 0) {
48 | throw new Error(`Extraneous item fields: ${invalidFields.join(', ')}`);
49 | }
50 |
51 | if (typeof item.id !== 'string' || item.id.length === 0) {
52 | throw new Error(`Invalid item id '${item.id}', must be a nonempty string`);
53 | }
54 |
55 | if (typeof item.url !== 'string' || item.url.length === 0) {
56 | throw new Error(`Invalid item url '${item.url}', must be a nonempty string`);
57 | }
58 |
59 | if (item.thumbnail !== null && (typeof item.thumbnail !== 'string' || item.thumbnail.length === 0)) {
60 | throw new Error(`Invalid item thumbnail '${item.thumbnail}', must be null or a nonempty string`);
61 | }
62 |
63 | if (item.tinyThumbnail !== null && (typeof item.tinyThumbnail !== 'string' || item.tinyThumbnail.length === 0)) {
64 | throw new Error(`Invalid item tinyThumbnail '${item.tinyThumbnail}', must be null or a nonempty string`);
65 | }
66 |
67 | for (const key of ['title', 'creator', 'genres', 'characters', 'notes', 'tags']) {
68 | if (typeof item[key] !== 'string') {
69 | throw new Error(`Invalid item ${key} '${item[key]}', must be a string`);
70 | }
71 | }
72 |
73 | if (!Number.isInteger(item.length)) {
74 | throw new Error(`Invalid item length '${item.length}', must be an integer`);
75 | }
76 |
77 | const validStatusTypes = Object.values(statusTypes);
78 | if (!validStatusTypes.includes(item.status)) {
79 | throw new Error(`Invalid item status '${item.status}', must be one of ${validStatusTypes.join(', ')}`);
80 | }
81 |
82 | const validProductionStatusTypes = Object.values(productionStatusTypes);
83 | if (!validProductionStatusTypes.includes(item.productionStatus)) {
84 | throw new Error(`Invalid item production status '${item.productionStatus}', must be one of ${validProductionStatusTypes.join(', ')}`);
85 | }
86 |
87 | if (!Number.isInteger(item.statusDate)) {
88 | throw new Error(`Invalid item statusDate '${item.statusDate}', must be an integer`);
89 | }
90 |
91 | if (!Number.isInteger(item.date)) {
92 | throw new Error(`Invalid item date '${item.date}', must be an integer`);
93 | }
94 | }
95 |
96 | export function getItem(id) {
97 | return transaction(['media'], 'readonly', async tx => {
98 | // seek through all versions with this id in reverse order by date, i.e. get the most recent version
99 | const cursor = await tx.store.openCursor(IDBKeyRange.bound([id, -Infinity], [id, Infinity]), 'prev');
100 | if (!cursor) {
101 | throw new Error(`Could not find item with id: ${id}`);
102 | }
103 | return cursor.value;
104 | });
105 | }
106 |
107 | export function getItemHistory(id) {
108 | return transaction(['media'], 'readonly', async tx => {
109 | const history = await tx.store.getAll(IDBKeyRange.bound([id, -Infinity], [id, Infinity]));
110 | return history;
111 | });
112 | }
113 |
114 | export function getItemHistoryAt(id, date) {
115 | return transaction(['media'], 'readonly', async tx => {
116 | const item = await tx.store.get([id, date]);
117 | if (!item) {
118 | throw new Error(`Could not find item history with id: ${id}, date: ${date}`);
119 | }
120 | return item;
121 | });
122 | }
123 |
124 | export function getItems() {
125 | return transaction(['media'], 'readonly', async tx => {
126 | const items = await tx.store.index('date').getAll(IDBKeyRange.bound(-Infinity, Infinity));
127 | return pipe(
128 | items,
129 | items => items.reverse(),
130 | items => distinctBy(items, item => item.id),
131 | items => sortBy(items, item => item.statusDate),
132 | );
133 | });
134 | }
135 |
136 | export async function getItemsWithStatus(status) {
137 | // this could be implemented more efficiently with an index on `status`
138 | // (but it's nontrivial--a naive index would include previous versions of items that used to have the desired status but not longer do)
139 | const items = await getItems();
140 | return items.filter(item => item.status === status);
141 | }
142 |
143 | export function addItem(id, item) {
144 | const now = Date.now();
145 | return transaction(['media'], 'readwrite', async tx => {
146 | const cursor = await tx.store.openCursor(IDBKeyRange.bound([id, -Infinity], [id, Infinity]), 'prev');
147 | if (cursor) {
148 | throw new Error(`Tried to add item with in-use id: ${id}`);
149 | }
150 | const newItem = {
151 | ...item,
152 | id,
153 | date: now,
154 | statusDate: now,
155 | };
156 | validateItem(newItem);
157 | await tx.store.add(newItem);
158 | });
159 | }
160 |
161 | export function updateItem(id, patch) {
162 | return transaction(['media'], 'readwrite', async tx => {
163 | const cursor = await tx.store.openCursor(IDBKeyRange.bound([id, -Infinity], [id, Infinity]), 'prev');
164 | if (!cursor) {
165 | throw new Error(`Tried to update non-extant item with id: ${id}`);
166 | }
167 | const existing = cursor.value;
168 | if ('id' in patch && patch.id !== existing.id) {
169 | throw new Error(`Tried to change id of item to: ${patch.id}`);
170 | }
171 | if ('url' in patch && patch.url !== existing.url) {
172 | throw new Error(`Tried to change url of item to: ${patch.url}`);
173 | }
174 | const updated = { ...existing, ...patch };
175 | if (structuralEq(existing, updated)) {
176 | // nothing changed, don't create a new version
177 | return;
178 | }
179 | // something changed, make a new version with new date
180 | updated.date = Date.now();
181 | if (updated.status !== existing.status) {
182 | // status changed, update the statusDate
183 | updated.statusDate = updated.date;
184 | }
185 | // add the new version
186 | validateItem(updated);
187 | await tx.store.add(updated);
188 | });
189 | }
190 |
191 | // db.provider (Provider)
192 |
193 | function validateProvider(provider) {
194 | const validProviderFields = [
195 | 'id', 'infoCallback', 'createdDate',
196 | ];
197 | const invalidFields = Object.keys(provider).filter(key => !validProviderFields.includes(key));
198 | if (invalidFields.length > 0) {
199 | throw new Error(`Extraneous provider fields: ${invalidFields.join(', ')}`);
200 | }
201 |
202 | if (typeof provider.id !== 'string' || provider.id.length === 0) {
203 | throw new Error(`Invalid provider id '${provider.id}', must be a nonempty string`);
204 | }
205 |
206 | if (typeof provider.infoCallback !== 'string') {
207 | throw new Error(`Invalid provider infoCallback '${provider.infoCallback}', must be a string`);
208 | }
209 |
210 | if (!Number.isInteger(provider.createdDate)) {
211 | throw new Error(`Invalid provider createdDate '${provider.createdDate}', must be an integer`);
212 | }
213 | }
214 |
215 | export function getProvider(id) {
216 | return transaction(['provider'], 'readonly', async tx => {
217 | const provider = await tx.store.get(id);
218 | if (!provider) {
219 | throw new Error(`Could not find provider with id: ${id}`);
220 | }
221 | return provider;
222 | });
223 | }
224 |
225 | export function getProviders() {
226 | return transaction(['provider'], 'readonly', async tx => {
227 | const providers = await tx.store.index('createdDate').getAll();
228 | return providers;
229 | });
230 | }
231 |
232 | export function addProvider(id) {
233 | const now = Date.now();
234 | return transaction(['provider'], 'readwrite', async tx => {
235 | const provider = { id, infoCallback: '', createdDate: now };
236 | validateProvider(provider);
237 | await tx.store.add(provider);
238 | });
239 | }
240 |
241 | export function updateProvider(id, patch) {
242 | return transaction(['provider'], 'readwrite', async tx => {
243 | const cursor = await tx.store.openCursor(IDBKeyRange.only(id));
244 | if (!cursor) {
245 | throw new Error(`Tried to update non-extant provider with id: ${id}`);
246 | }
247 | const existing = cursor.value;
248 | if ('id' in patch && patch.id !== existing.id) {
249 | throw new Error(`Tried to change id of provider (to ${patch.id})`);
250 | }
251 | if ('createdDate' in patch && patch.createdDate !== existing.createdDate) {
252 | throw new Error(`Tried to change createdDate of provider (to ${patch.id})`);
253 | }
254 | const updated = { ...existing, ...patch };
255 | validateProvider(updated);
256 | await cursor.update(updated);
257 | });
258 | }
259 |
260 | export function removeProvider(id) {
261 | return transaction(['provider'], 'readwrite', async tx => {
262 | await tx.store.delete(id);
263 | });
264 | }
265 |
266 | // Bulk imports/exports
267 |
268 | export function getRawData() {
269 | return transaction(['media', 'provider'], 'readonly', async tx => {
270 | const media = await tx.objectStore('media').getAll();
271 | const provider = await tx.objectStore('provider').getAll();
272 | const backup = {
273 | version: 1,
274 | tables: {
275 | media,
276 | provider,
277 | },
278 | };
279 | return backup;
280 | });
281 | }
282 |
283 | export async function setRawData(backup) {
284 | let media, provider;
285 | if (Array.isArray(backup)) {
286 | // Version 0: no version flag, toplevel array of media, no providers
287 | media = backup;
288 | } else if ('version' in backup) {
289 | switch (backup.version) {
290 | case 1:
291 | // Version 1: media + provider
292 | ({ tables: { media, provider } } = backup);
293 | break;
294 | default:
295 | throw new Error(`Invalid backup version: ${backup.version}`);
296 | }
297 | } else {
298 | throw new Error('Unrecognised backup format');
299 | }
300 |
301 | await transaction(['media', 'provider'], 'readwrite', async tx => {
302 | if (media) {
303 | const store = tx.objectStore('media');
304 | await store.clear();
305 | // use raw add operations to avoid overhead of listening to onsuccess
306 | // see https://stackoverflow.com/a/52555073
307 | const rawStore = unwrap(store);
308 | for (const item of media.slice(0, -1)) {
309 | rawStore.add(item);
310 | }
311 | // ...but listen on last item to ensure we get exception for bad data
312 | for (const lastItem of media.slice(-1)) {
313 | // eslint-disable-next-line no-await-in-loop
314 | await store.add(lastItem);
315 | }
316 | }
317 | if (provider) {
318 | const store = tx.objectStore('provider');
319 | await store.clear();
320 | for (const p of provider) {
321 | // eslint-disable-next-line no-await-in-loop
322 | await store.add(p);
323 | }
324 | }
325 | });
326 | }
327 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------