├── .gitignore ├── .editoconfig ├── composer.json ├── CHANGELOG.md ├── .phpcs.xml.dist ├── README.md ├── class-gamajo-template-loader.php └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | vendor/ 2 | /composer.lock 3 | -------------------------------------------------------------------------------- /.editoconfig: -------------------------------------------------------------------------------- 1 | # This file is for unifying the coding style for different editors and IDEs 2 | # editorconfig.org 3 | 4 | # WordPress Coding Standards 5 | # http://make.wordpress.org/core/handbook/coding-standards/ 6 | 7 | root = true 8 | 9 | [*] 10 | charset = utf-8 11 | end_of_line = lf 12 | insert_final_newline = true 13 | trim_trailing_whitespace = true 14 | indent_style = tab 15 | 16 | [{.*rc,*.json,*.yml}] 17 | indent_style = space 18 | indent_size = 2 19 | 20 | [*.txt] 21 | end_of_line = crlf 22 | 23 | [*.md] 24 | trim_trailing_whitespace = false 25 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gamajo/template-loader", 3 | "description": "A class for your WordPress plugin, to allow loading template parts with fallback through the child theme > parent theme > plugin", 4 | "keywords": [ 5 | "wordpress", 6 | "templates" 7 | ], 8 | "homepage": "https://github.com/GaryJones/Gamajo-Template-Loader", 9 | "license": "GPL-2.0-or-later", 10 | "authors": [ 11 | { 12 | "name": "Gary Jones", 13 | "homepage": "https://gamajo.com", 14 | "role": "Developer" 15 | } 16 | ], 17 | "require": { 18 | "php": ">=5.2.4" 19 | }, 20 | "require-dev": { 21 | "php": ">=7.1", 22 | "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4", 23 | "phpcompatibility/phpcompatibility-wp": "^2", 24 | "roave/security-advisories": "dev-master", 25 | "squizlabs/php_codesniffer": "^3.3", 26 | "wp-coding-standards/wpcs": "^1" 27 | }, 28 | "suggest": { 29 | "coenjacobs/mozart": "Easily wrap this library with your own prefix, to prevent collisions when multiple plugins use this library" 30 | }, 31 | "config": { 32 | "sort-packages": true 33 | }, 34 | "autoload": { 35 | "classmap": [ 36 | "class-gamajo-template-loader.php" 37 | ] 38 | }, 39 | "support": { 40 | "issues": "https://github.com/GaryJones/Gamajo-Template-Loader/issues" 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log for Gamajo Template Loader 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | 9 | ## [1.3.1] - 2018-09-24 10 | 11 | - Fix coding standards. 12 | 13 | ## [1.3.0] - 2017-03-24 14 | 15 | - Add prefixed get_template_part filter. 16 | - Add a template cache to store previously located template paths. 17 | - Add a custom data variable name cache, so `unset_template_data()` can remove all custom references. 18 | - Update `set_template_data()` and `unset_template_data()` to become fluent methods. 19 | - Remove array type hint from `set_template_data()` argument. 20 | - Update documentation. 21 | 22 | ## [1.2.0] - 2016-03-26 23 | 24 | - Support adding custom template data. 25 | - Add check around class definition if class exists. 26 | - Added `composer.json`. 27 | - Fix code standards. 28 | - Improve README. 29 | - Move example meal planner class into README. 30 | 31 | ## [1.1.0] - 2014-03-08 32 | 33 | - Fix bug so that the more specific template is preferred. 34 | - Cache template path in a local variable. 35 | - Change access to `locate_template()` method to public. 36 | - Add `$plugin_template_directory` property. 37 | - Initialise `$templates` variable. 38 | - Add check if class exists in example code. 39 | - Improve README 40 | 41 | ## 1.0.0 - 2013-12-09 42 | 43 | - Initial release. 44 | 45 | [1.3.1]: https://github.com/GaryJones/Gamajo-Template-Loader/compare/1.3.0...1.3.1 46 | [1.3.0]: https://github.com/GaryJones/Gamajo-Template-Loader/compare/1.2.0...1.3.0 47 | [1.2.0]: https://github.com/GaryJones/Gamajo-Template-Loader/compare/1.1.0...1.2.0 48 | [1.1.0]: https://github.com/GaryJones/Gamajo-Template-Loader/compare/1.0.0...1.1.0 49 | -------------------------------------------------------------------------------- /.phpcs.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | Custom ruleset for Gamajo Template Loader. 4 | 5 | 6 | 7 | 8 | 9 | . 10 | 12 | ./vendor/ 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 22 | 23 | 25 | 26 | 27 | 29 | 30 | 31 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gamajo Template Loader 2 | 3 | [![Code Climate](https://codeclimate.com/github/GaryJones/Gamajo-Template-Loader/badges/gpa.svg)](https://codeclimate.com/github/GaryJones/Gamajo-Template-Loader) 4 | 5 | A class to copy into your WordPress plugin, to allow loading template parts with fallback through the child theme > parent theme > plugin. 6 | 7 | ## Description 8 | 9 | Easy Digital Downloads, WooCommerce, and Events Calendar plugins, amongst others, allow you to add files to your theme to override the default templates that come with the plugin. As a developer, adding this convenience in to your own plugin can be a little tricky. 10 | 11 | The `get_template_part()` function in WordPress was never really designed with plugins in mind, since it relies on `locate_template()` which only checks child and parent themes. So we can add in a final fallback that uses the templates in the plugin, we have to use a custom `locate_template()` function, and a custom `get_template_part()` function. The solution here just wraps them up as a class for convenience. 12 | 13 | ## Installation 14 | 15 | This isn't a WordPress plugin on its own, so the usual instructions don't apply. Instead: 16 | 17 | ### Manually install class 18 | 1. Copy [`class-gamajo-template-loader.php`](class-gamajo-template-loader.php) into your plugin. It can be into a file in the plugin root, or better, an `includes` directory. 19 | 20 | or: 21 | 22 | ### Install class via Composer 23 | 1. Tell Composer to install this class as a dependency: `composer require gamajo/template-loader` 24 | 2. Recommended: Install the Mozart package: `composer require coenjacobs/mozart --dev` and [configure it](https://github.com/coenjacobs/mozart#configuration). 25 | 3. The class is now renamed to use your own prefix, to prevent collisions with other plugins bundling this class. 26 | 27 | ## Implement class 28 | 1. Create a new file, such as `class-your-plugin-template-loader.php`, in the same directory. 29 | 2. Create a class in that file that extends `Gamajo_Template_Loader` (or the new prefixed name, if you installed via Composer/Mozart). You can see the Meal Planner Template Loader example class below as a starting point if it helps. 30 | 3. Override the class properties to suit your plugin. You could also override the `get_templates_dir()` method if it isn't right for you. 31 | 4. You can now instantiate your custom template loader class, and use it to call the `get_template_part()` method. This could be within a shortcode callback, or something you want theme developers to include in their files. 32 | 33 | ~~~php 34 | // Template loader instantiated elsewhere, such as the main plugin file. 35 | $meal_planner_template_loader = new Meal_Planner_Template_Loader(); 36 | ~~~ 37 | * Use it to call the `get_template_part()` method. This could be within a shortcode callback, or something you want theme developers to include in their files. 38 | 39 | ~~~php 40 | $meal_planner_template_loader->get_template_part( 'recipe' ); 41 | ~~~ 42 | * If you want to pass data to the template, call the `set_template_data()` method with an array before calling `get_template_part()`. `set_template_data()` returns the loader object to allow for method chaining. 43 | 44 | ~~~php 45 | $data = array( 'foo' => 'bar', 'baz' => 'boom' ); 46 | $meal_planner_template_loader 47 | ->set_template_data( $data ) 48 | ->get_template_part( 'recipe' ); 49 | ~~~ 50 | 51 | The value of `bar` is now available inside the recipe template as `$data->foo`. 52 | 53 | If you wish to use a different variable name, add a second parameter to `set_template_data()`: 54 | 55 | ~~~php 56 | $data = array( 'foo' => 'bar', 'baz' => 'boom' ); 57 | $meal_planner_template_loader 58 | ->set_template_data( $data, 'context' ) 59 | ->get_template_part( 'recipe', 'ingredients' ); 60 | ~~~ 61 | 62 | The value of `bar` is now available inside the recipe template as `$context->foo`. 63 | 64 | This will try to load up `wp-content/themes/my-theme/meal-planner/recipe-ingredients.php`, or `wp-content/themes/my-theme/meal-planner/recipe.php`, then fallback to `wp-content/plugins/meal-planner/templates/recipe-ingredients.php` or `wp-content/plugins/meal-planner/templates/recipe.php`. 65 | 66 | * You can also pass the template loader object into the template as well: 67 | ~~~php 68 | $template_loader = new Your_Template_Loader(); 69 | $template_loader->set_template_data( 70 | array( 71 | 'template_loader' => $template_loader, 72 | // Optional other data as needed. 73 | ) 74 | ); 75 | ~~~ 76 | Then in the template you can use: 77 | ~~~php 78 | $data->template_loader->get_template_part( 'recipe' ); 79 | ~~~ 80 | ### Meal Planner Example Class 81 | 82 | ```php 83 | unset_template_data(); 97 | } 98 | 99 | /** 100 | * Retrieve a template part. 101 | * 102 | * @since 1.0.0 103 | * 104 | * @param string $slug Template slug. 105 | * @param string $name Optional. Template variation name. Default null. 106 | * @param bool $load Optional. Whether to load template. Default true. 107 | * @return string 108 | */ 109 | public function get_template_part( $slug, $name = null, $load = true ) { 110 | // Execute code for this part. 111 | do_action( 'get_template_part_' . $slug, $slug, $name ); 112 | do_action( $this->filter_prefix . '_get_template_part_' . $slug, $slug, $name ); 113 | 114 | // Get files names of templates, for given slug and name. 115 | $templates = $this->get_template_file_names( $slug, $name ); 116 | 117 | // Return the part that is found. 118 | return $this->locate_template( $templates, $load, false ); 119 | } 120 | 121 | /** 122 | * Make custom data available to template. 123 | * 124 | * Data is available to the template as properties under the `$data` variable. 125 | * i.e. A value provided here under `$data['foo']` is available as `$data->foo`. 126 | * 127 | * When an input key has a hyphen, you can use `$data->{foo-bar}` in the template. 128 | * 129 | * @since 1.2.0 130 | * 131 | * @param mixed $data Custom data for the template. 132 | * @param string $var_name Optional. Variable under which the custom data is available in the template. 133 | * Default is 'data'. 134 | * @return Gamajo_Template_Loader 135 | */ 136 | public function set_template_data( $data, $var_name = 'data' ) { 137 | global $wp_query; 138 | 139 | $wp_query->query_vars[ $var_name ] = (object) $data; 140 | 141 | // Add $var_name to custom variable store if not default value. 142 | if ( 'data' !== $var_name ) { 143 | $this->template_data_var_names[] = $var_name; 144 | } 145 | 146 | return $this; 147 | } 148 | 149 | /** 150 | * Remove access to custom data in template. 151 | * 152 | * Good to use once the final template part has been requested. 153 | * 154 | * @since 1.2.0 155 | * 156 | * @return Gamajo_Template_Loader 157 | */ 158 | public function unset_template_data() { 159 | global $wp_query; 160 | 161 | // Remove any duplicates from the custom variable store. 162 | $custom_var_names = array_unique( $this->template_data_var_names ); 163 | 164 | // Remove each custom data reference from $wp_query. 165 | foreach ( $custom_var_names as $var ) { 166 | if ( isset( $wp_query->query_vars[ $var ] ) ) { 167 | unset( $wp_query->query_vars[ $var ] ); 168 | } 169 | } 170 | 171 | return $this; 172 | } 173 | 174 | /** 175 | * Given a slug and optional name, create the file names of templates. 176 | * 177 | * @since 1.0.0 178 | * 179 | * @param string $slug Template slug. 180 | * @param string $name Template variation name. 181 | * @return array 182 | */ 183 | protected function get_template_file_names( $slug, $name ) { 184 | $templates = array(); 185 | if ( isset( $name ) ) { 186 | $templates[] = $slug . '-' . $name . '.php'; 187 | } 188 | $templates[] = $slug . '.php'; 189 | 190 | /** 191 | * Allow template choices to be filtered. 192 | * 193 | * The resulting array should be in the order of most specific first, to least specific last. 194 | * e.g. 0 => recipe-instructions.php, 1 => recipe.php 195 | * 196 | * @since 1.0.0 197 | * 198 | * @param array $templates Names of template files that should be looked for, for given slug and name. 199 | * @param string $slug Template slug. 200 | * @param string $name Template variation name. 201 | */ 202 | return apply_filters( $this->filter_prefix . '_get_template_part', $templates, $slug, $name ); 203 | } 204 | 205 | /** 206 | * Retrieve the name of the highest priority template file that exists. 207 | * 208 | * Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which 209 | * inherit from a parent theme can just overload one file. If the template is 210 | * not found in either of those, it looks in the theme-compat folder last. 211 | * 212 | * @since 1.0.0 213 | * 214 | * @param string|array $template_names Template file(s) to search for, in order. 215 | * @param bool $load If true the template file will be loaded if it is found. 216 | * @param bool $require_once Whether to require_once or require. Default true. 217 | * Has no effect if $load is false. 218 | * @return string The template filename if one is located. 219 | */ 220 | public function locate_template( $template_names, $load = false, $require_once = true ) { 221 | 222 | // Use $template_names as a cache key - either first element of array or the variable itself if it's a string. 223 | $cache_key = is_array( $template_names ) ? $template_names[0] : $template_names; 224 | 225 | // If the key is in the cache array, we've already located this file. 226 | if ( isset( $this->template_path_cache[ $cache_key ] ) ) { 227 | $located = $this->template_path_cache[ $cache_key ]; 228 | } else { 229 | 230 | // No file found yet. 231 | $located = false; 232 | 233 | // Remove empty entries. 234 | $template_names = array_filter( (array) $template_names ); 235 | $template_paths = $this->get_template_paths(); 236 | 237 | // Try to find a template file. 238 | foreach ( $template_names as $template_name ) { 239 | // Trim off any slashes from the template name. 240 | $template_name = ltrim( $template_name, '/' ); 241 | 242 | // Try locating this template file by looping through the template paths. 243 | foreach ( $template_paths as $template_path ) { 244 | if ( file_exists( $template_path . $template_name ) ) { 245 | $located = $template_path . $template_name; 246 | // Store the template path in the cache. 247 | $this->template_path_cache[ $cache_key ] = $located; 248 | break 2; 249 | } 250 | } 251 | } 252 | } 253 | 254 | if ( $load && $located ) { 255 | load_template( $located, $require_once ); 256 | } 257 | 258 | return $located; 259 | } 260 | 261 | /** 262 | * Return a list of paths to check for template locations. 263 | * 264 | * Default is to check in a child theme (if relevant) before a parent theme, so that themes which inherit from a 265 | * parent theme can just overload one file. If the template is not found in either of those, it looks in the 266 | * theme-compat folder last. 267 | * 268 | * @since 1.0.0 269 | * 270 | * @return mixed|void 271 | */ 272 | protected function get_template_paths() { 273 | $theme_directory = trailingslashit( $this->theme_template_directory ); 274 | 275 | $file_paths = array( 276 | 10 => trailingslashit( get_template_directory() ) . $theme_directory, 277 | 100 => $this->get_templates_dir(), 278 | ); 279 | 280 | // Only add this conditionally, so non-child themes don't redundantly check active theme twice. 281 | if ( get_stylesheet_directory() !== get_template_directory() ) { 282 | $file_paths[1] = trailingslashit( get_stylesheet_directory() ) . $theme_directory; 283 | } 284 | 285 | /** 286 | * Allow ordered list of template paths to be amended. 287 | * 288 | * @since 1.0.0 289 | * 290 | * @param array $var Default is directory in child theme at index 1, parent theme at 10, and plugin at 100. 291 | */ 292 | $file_paths = apply_filters( $this->filter_prefix . '_template_paths', $file_paths ); 293 | 294 | // Sort the file paths based on priority. 295 | ksort( $file_paths, SORT_NUMERIC ); 296 | 297 | return array_map( 'trailingslashit', $file_paths ); 298 | } 299 | 300 | /** 301 | * Return the path to the templates directory in this plugin. 302 | * 303 | * May be overridden in subclass. 304 | * 305 | * @since 1.0.0 306 | * 307 | * @return string 308 | */ 309 | protected function get_templates_dir() { 310 | return trailingslashit( $this->plugin_directory ) . $this->plugin_template_directory; 311 | } 312 | } 313 | } 314 | -------------------------------------------------------------------------------- /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 | {description} 294 | Copyright (C) {year} {fullname} 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 | {signature of Ty Coon}, 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 | --------------------------------------------------------------------------------