37 |
38 | );
39 | }
40 |
--------------------------------------------------------------------------------
/block.json:
--------------------------------------------------------------------------------
1 | {
2 | "apiVersion": 2,
3 | "name": "tabor/post-reading-time",
4 | "title": "Reading Time",
5 | "category": "theme",
6 | "description": "Display the estimated reading time for this post.",
7 | "keywords": [ "tabor", "minutes", "date"],
8 | "textdomain": "post-reading-time-block",
9 | "attributes": {
10 | "textAlign": {
11 | "type": "string"
12 | }
13 | },
14 | "usesContext": [ "postId" ],
15 | "supports": {
16 | "html": false,
17 | "color": {
18 | "background": false,
19 | "__experimentalDefaultControls": {
20 | "text": true
21 | }
22 | },
23 | "typography": {
24 | "fontSize": true,
25 | "lineHeight": true,
26 | "__experimentalFontFamily": true,
27 | "__experimentalFontWeight": true,
28 | "__experimentalFontStyle": true,
29 | "__experimentalTextTransform": true,
30 | "__experimentalLetterSpacing": true,
31 | "__experimentalDefaultControls": {
32 | "fontSize": true
33 | }
34 | }
35 | },
36 | "editorScript": "file:./build/index.js"
37 | }
38 |
--------------------------------------------------------------------------------
/readme.txt:
--------------------------------------------------------------------------------
1 | === Reading Time Block ===
2 | Contributors: richtabor
3 | Tags: gutenberg, block, blocks, reading, minutes
4 | Tested up to: 5.9
5 | Stable tag: 0.0.0
6 | License: GPL-2.0-or-later
7 | License URI: https://www.gnu.org/licenses/gpl-2.0.html
8 |
9 | A block to add an estimated reading time of a post.
10 |
11 | == Description ==
12 |
13 | A block to add an estimated reading time of a post.
14 |
15 | == Installation ==
16 | 1. Upload the `post-reading-time-block` folder to your `/wp-content/plugins/` directory or alternatively upload the post-reading-time-block.zip file via the plugin page of WordPress by clicking 'Add New' and selecting the zip from your local computer.
17 | 2. Activate the plugin through the 'Plugins' menu in WordPress.
18 | 3. Search for the block within the Gutenberg block editor.
19 |
20 | == Frequently Asked Questions ==
21 | = Where can I send feedback or ideas? =
22 | Please reach out via the official [plugin support forum](https://wordpress.org/support/plugin/post-reading-time-block).
23 |
24 | = Who's Rich Tabor? =
25 | As a WordPress entrepreneur, designer and developer all wrapped up in one, [@richard_tabor](http://twitter.com/richard_tabor) is recognized as one of the top leaders in this post-Gutenberg era of WordPress. His design chops have topped the 2018 Automattic Design Awards and led him to found CoBlocks – a top-notch set of page builder blocks and tools for Gutenberg, ThemeBeans – a premier WordPress theme shop and [Iceberg](https://useiceberg.com/?utm_source=wp-org&utm_medium=reading-time-block&utm_campaign=readme-faq) – a markdown editor for Gutenberg.
26 |
27 | == Changelog ==
28 |
29 | = 0.1.0 =
30 | * Initial release
31 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "post-reading-time-block",
3 | "version": "0.0.0",
4 | "description": "Display the estimated reading time for this post.",
5 | "author": {
6 | "name": "richtabor",
7 | "url": "https://richtabor.com",
8 | "role": "developer"
9 | },
10 | "repository": {
11 | "type": "git",
12 | "url": "https://github.com/richtabor/reading-time-block"
13 | },
14 | "license": "GPL-2.0-or-later",
15 | "main": "build/index.js",
16 | "scripts": {
17 | "build": "./bin/build-plugin-zip.sh",
18 | "build:assets": "wp-scripts build",
19 | "format": "wp-scripts format",
20 | "lint:css": "wp-scripts lint-style",
21 | "lint:js": "wp-scripts lint-js",
22 | "start": "wp-scripts start",
23 | "packages-update": "wp-scripts packages-update",
24 | "release:patch": "git push && npm version patch --no-git-tag-version && npm run replace:version && git add -u && npm run commit:version && npm run make:tag && npm run commit:tag",
25 | "release:minor": "git push && npm version minor --no-git-tag-version && npm run replace:version && git add -u && npm run commit:version && npm run make:tag && npm run commit:tag",
26 | "replace:version": "replace-in-files --regex='Stable tag: \\d+\\.\\d+\\.\\d+' --replacement='Stable tag: '${npm_package_version}'' readme.txt && replace-in-files --regex='Version: \\d+\\.\\d+\\.\\d+' --replacement='Version: '${npm_package_version}'' *.php && git push",
27 | "commit:version": "git commit -m 'Version bump to '${npm_package_version}''",
28 | "make:tag": "git tag ${npm_package_version}",
29 | "commit:tag": "git push --tags"
30 | },
31 | "dependencies": {
32 | "@wordpress/block-editor": "^6.1.1",
33 | "@wordpress/blocks": "^9.1.1",
34 | "@wordpress/i18n": "^4.1.1",
35 | "replace-in-files-cli": "^1.0.0"
36 | },
37 | "devDependencies": {
38 | "@wordpress/scripts": "^16.1.1",
39 | "@wordpress/eslint-plugin": "^5.1.0"
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
1 | /**
2 | * WordPress dependencies
3 | */
4 | import { registerBlockType } from '@wordpress/blocks';
5 | import { SVG, Path, G } from '@wordpress/components';
6 |
7 | /**
8 | * Internal dependencies
9 | */
10 | import metadata from '../block.json';
11 | import edit from './edit';
12 |
13 | /**
14 | * Every block starts by registering a new block type definition.
15 | *
16 | * @see https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/
17 | */
18 | registerBlockType( 'tabor/post-reading-time', {
19 | ...metadata,
20 | icon: (
21 |
24 | ),
25 | edit,
26 | } );
27 |
--------------------------------------------------------------------------------
/post-reading-time-block.php:
--------------------------------------------------------------------------------
1 | 'tabor_post_reading_time_block_render',
28 | ) );
29 | }
30 | add_action( 'init', 'tabor_post_reading_time_block_init' );
31 |
32 | /**
33 | * Renders the `tabor/post-reading-time` block on the server.
34 | *
35 | * @param array $attributes Block attributes.
36 | * @param string $content Block default content.
37 | * @param WP_Block $block Block instance.
38 | * @return string Returns the filtered post date for the current post wrapped inside "time" tags.
39 | */
40 | function tabor_post_reading_time_block_render( $attributes, $content, $block ) {
41 |
42 | if ( ! isset( $block->context['postId'] ) ) {
43 | return;
44 | }
45 |
46 | $post_ID = $block->context['postId'];
47 | $align_class_name = empty( $attributes['textAlign'] ) ? '' : "has-text-align-{$attributes['textAlign']}";
48 | $wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $align_class_name ) );
49 |
50 | $content = get_post_field( 'post_content', $post_ID );
51 | $word_count = str_word_count( strip_tags( $content ) );
52 | $readingtime = ceil( $word_count / 200 );
53 |
54 | $text = __( 'min read', 'post-reading-time-block' );
55 | $totalreadingtime = $readingtime . ' ' . $text;
56 |
57 | return sprintf(
58 | '
%2$s
',
59 | $wrapper_attributes,
60 | esc_html( $totalreadingtime ),
61 | );
62 | }
63 |
64 |
--------------------------------------------------------------------------------
/bin/build-plugin-zip.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | # Exit if any command fails.
4 | set -e
5 |
6 | # Change to the expected directory.
7 | cd "$(dirname "$0")"
8 | cd ..
9 |
10 | # Enable nicer messaging for build status.
11 | BLUE_BOLD='\033[1;34m';
12 | GREEN_BOLD='\033[1;32m';
13 | RED_BOLD='\033[1;31m';
14 | YELLOW_BOLD='\033[1;33m';
15 | COLOR_RESET='\033[0m';
16 | error () {
17 | echo -e "\n${RED_BOLD}$1${COLOR_RESET}\n"
18 | }
19 | status () {
20 | echo -e "\n${BLUE_BOLD}$1${COLOR_RESET}\n"
21 | }
22 | success () {
23 | echo -e "\n${GREEN_BOLD}$1${COLOR_RESET}\n"
24 | }
25 | warning () {
26 | echo -e "\n${YELLOW_BOLD}$1${COLOR_RESET}\n"
27 | }
28 |
29 | status "Time to build the plugin"
30 |
31 | if [ -z "$NO_CHECKS" ]; then
32 | # Make sure there are no changes in the working tree. Release builds should be
33 | # traceable to a particular commit and reliably reproducible. (This is not
34 | # totally true at the moment because we download nightly vendor scripts).
35 | changed=
36 | if ! git diff --exit-code > /dev/null; then
37 | changed="file(s) modified"
38 | elif ! git diff --cached --exit-code > /dev/null; then
39 | changed="file(s) staged"
40 | fi
41 | if [ ! -z "$changed" ]; then
42 | git status
43 | error "ERROR: Cannot build plugin zip with dirty working tree. ☝️
44 | Commit your changes and try again."
45 | exit 1
46 | fi
47 |
48 | # Do a dry run of the repository reset. Prompting the user for a list of all
49 | # files that will be removed should prevent them from losing important files!
50 | status "Resetting the repository to pristine condition. ✨"
51 | to_clean=$(git clean -xdf --exclude="local.json" --dry-run)
52 | if [ ! -z "$to_clean" ]; then
53 | echo $to_clean
54 | warning "🚨 About to delete everything above! Is this okay? 🚨"
55 | echo -n "[y]es/[N]o: "
56 | read answer
57 | if [ "$answer" != "${answer#[Yy]}" ]; then
58 | # Remove ignored files to reset repository to pristine condition. Previous
59 | # test ensures that changed files abort the plugin build.
60 | status "Cleaning working directory... 🛀"
61 | git clean -xdf --exclude="local.json"
62 | else
63 | error "Fair enough; aborting. Tidy up your repo and try again. 🙂"
64 | exit 1
65 | fi
66 | fi
67 | fi
68 |
69 | # Run the build; generating translation files.
70 | status "Installing dependencies..."
71 | PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true npm install
72 |
73 | status "Generating build..."
74 | npm run build:assets
75 |
76 | mkdir -p dist
77 |
78 | build_files=$(ls build/*.{js,asset.php})
79 |
80 | # Generate the plugin zip file.
81 | status "Creating archive... 🤐"
82 |
83 | zip -r ./dist/post-reading-time-block.zip \
84 | block.json \
85 | post-reading-time-block.php \
86 | license.txt \
87 | $build_files \
88 | readme.txt
89 |
90 | # Reset `post-reading-time-block.php`.
91 | git checkout post-reading-time-block.php
92 |
93 | # Unzip plugin zip file
94 | unzip ./dist/post-reading-time-block.zip -d "./dist/post-reading-time-block/"
95 |
96 | success "Done. You've built the plugin!"
97 |
--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
1 | {
2 | "_readme": [
3 | "This file locks the dependencies of your project to a known state",
4 | "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
5 | "This file is @generated automatically"
6 | ],
7 | "content-hash": "417093921ef53d447376c744176ed74e",
8 | "packages": [],
9 | "packages-dev": [
10 | {
11 | "name": "dealerdirect/phpcodesniffer-composer-installer",
12 | "version": "v0.5.0",
13 | "source": {
14 | "type": "git",
15 | "url": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer.git",
16 | "reference": "e749410375ff6fb7a040a68878c656c2e610b132"
17 | },
18 | "dist": {
19 | "type": "zip",
20 | "url": "https://api.github.com/repos/Dealerdirect/phpcodesniffer-composer-installer/zipball/e749410375ff6fb7a040a68878c656c2e610b132",
21 | "reference": "e749410375ff6fb7a040a68878c656c2e610b132",
22 | "shasum": ""
23 | },
24 | "require": {
25 | "composer-plugin-api": "^1.0",
26 | "php": "^5.3|^7",
27 | "squizlabs/php_codesniffer": "^2|^3"
28 | },
29 | "require-dev": {
30 | "composer/composer": "*",
31 | "phpcompatibility/php-compatibility": "^9.0",
32 | "sensiolabs/security-checker": "^4.1.0"
33 | },
34 | "type": "composer-plugin",
35 | "extra": {
36 | "class": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin"
37 | },
38 | "autoload": {
39 | "psr-4": {
40 | "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/"
41 | }
42 | },
43 | "notification-url": "https://packagist.org/downloads/",
44 | "license": [
45 | "MIT"
46 | ],
47 | "authors": [
48 | {
49 | "name": "Franck Nijhof",
50 | "email": "franck.nijhof@dealerdirect.com",
51 | "homepage": "http://www.frenck.nl",
52 | "role": "Developer / IT Manager"
53 | }
54 | ],
55 | "description": "PHP_CodeSniffer Standards Composer Installer Plugin",
56 | "homepage": "http://www.dealerdirect.com",
57 | "keywords": [
58 | "PHPCodeSniffer",
59 | "PHP_CodeSniffer",
60 | "code quality",
61 | "codesniffer",
62 | "composer",
63 | "installer",
64 | "phpcs",
65 | "plugin",
66 | "qa",
67 | "quality",
68 | "standard",
69 | "standards",
70 | "style guide",
71 | "stylecheck",
72 | "tests"
73 | ],
74 | "time": "2018-10-26T13:21:45+00:00"
75 | },
76 | {
77 | "name": "squizlabs/php_codesniffer",
78 | "version": "dev-master",
79 | "source": {
80 | "type": "git",
81 | "url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
82 | "reference": "d2574b9185cdde7185132647d0c9121da3e59f90"
83 | },
84 | "dist": {
85 | "type": "zip",
86 | "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/d2574b9185cdde7185132647d0c9121da3e59f90",
87 | "reference": "d2574b9185cdde7185132647d0c9121da3e59f90",
88 | "shasum": ""
89 | },
90 | "require": {
91 | "ext-simplexml": "*",
92 | "ext-tokenizer": "*",
93 | "ext-xmlwriter": "*",
94 | "php": ">=5.4.0"
95 | },
96 | "require-dev": {
97 | "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
98 | },
99 | "bin": [
100 | "bin/phpcs",
101 | "bin/phpcbf"
102 | ],
103 | "type": "library",
104 | "extra": {
105 | "branch-alias": {
106 | "dev-master": "3.x-dev"
107 | }
108 | },
109 | "notification-url": "https://packagist.org/downloads/",
110 | "license": [
111 | "BSD-3-Clause"
112 | ],
113 | "authors": [
114 | {
115 | "name": "Greg Sherwood",
116 | "role": "lead"
117 | }
118 | ],
119 | "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
120 | "homepage": "https://github.com/squizlabs/PHP_CodeSniffer",
121 | "keywords": [
122 | "phpcs",
123 | "standards"
124 | ],
125 | "time": "2021-05-27T06:21:27+00:00"
126 | },
127 | {
128 | "name": "wp-coding-standards/wpcs",
129 | "version": "2.3.0",
130 | "source": {
131 | "type": "git",
132 | "url": "https://github.com/WordPress/WordPress-Coding-Standards.git",
133 | "reference": "7da1894633f168fe244afc6de00d141f27517b62"
134 | },
135 | "dist": {
136 | "type": "zip",
137 | "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/7da1894633f168fe244afc6de00d141f27517b62",
138 | "reference": "7da1894633f168fe244afc6de00d141f27517b62",
139 | "shasum": ""
140 | },
141 | "require": {
142 | "php": ">=5.4",
143 | "squizlabs/php_codesniffer": "^3.3.1"
144 | },
145 | "require-dev": {
146 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || ^0.6",
147 | "phpcompatibility/php-compatibility": "^9.0",
148 | "phpcsstandards/phpcsdevtools": "^1.0",
149 | "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
150 | },
151 | "suggest": {
152 | "dealerdirect/phpcodesniffer-composer-installer": "^0.6 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically."
153 | },
154 | "type": "phpcodesniffer-standard",
155 | "notification-url": "https://packagist.org/downloads/",
156 | "license": [
157 | "MIT"
158 | ],
159 | "authors": [
160 | {
161 | "name": "Contributors",
162 | "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors"
163 | }
164 | ],
165 | "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions",
166 | "keywords": [
167 | "phpcs",
168 | "standards",
169 | "wordpress"
170 | ],
171 | "time": "2020-05-13T23:57:56+00:00"
172 | }
173 | ],
174 | "aliases": [],
175 | "minimum-stability": "dev",
176 | "stability-flags": [],
177 | "prefer-stable": false,
178 | "prefer-lowest": false,
179 | "platform": [],
180 | "platform-dev": [],
181 | "plugin-api-version": "1.1.0"
182 | }
183 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 |
294 | Copyright (C)
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | , 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
--------------------------------------------------------------------------------