├── .github └── FUNDING.yml ├── README.md ├── functions.php ├── ghost-meta.php └── license.txt /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: sc0ttkclark # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Ghost Meta 1.0 2 | 3 | ## Summary 4 | 5 | This plugin provides functionality to work with a `_ghost_meta` custom field value and be able to function with it as if it were the same as `get_post_meta()` using `get_ghost_meta()`. 6 | 7 | It can hold a ton of extra data which you may not want to clutter up the `wp_postmeta` table with. It also integrates with the core WordPress Metadata API to make it easy for other plugins to interact with it. 8 | 9 | It stores all ghost meta values into one meta key, which saves the number of meta records you may otherwise unnecessarily need to store. 10 | 11 | ## Example use-case 12 | 13 | If you have millions of posts to import into your app or site, but you don't need to reference the custom fields in filtering or searches -- this can really save you in terms of speed and efficiency. 14 | 15 | If you're using ElasticPress, this can really help you ensure that your ghost meta values will be indexable by Elasticsearch like regular custom fields. 16 | 17 | So what could have easily been 15 million postmeta rows for 15 custom fields on 1 million posts -- is now just 1 million postmeta rows with serialized data stored in each. 18 | 19 | ## ElasticPress Integration 20 | 21 | Ghost Meta comes with built-in integration with ElasticPress, so when it indexes your posts it will index your ghost meta just like it would regular custom fields. 22 | 23 | Try it out, use `'ep_integrate' => true` with your WP_Query calls and you'll still get to use `'meta_query'` as you would expect it to work, and it'll be glorious without the mess in your database. 24 | 25 | ## API 26 | 27 | ### Get ghost meta 28 | 29 | `$meta_value = get_ghost_meta( $object_id, $meta_key, $single );` 30 | 31 | ### Add ghost meta 32 | 33 | `add_ghost_meta( $object_id, $meta_key, $meta_value, $unique );` 34 | 35 | ### Update ghost meta 36 | 37 | `update_ghost_meta( $object_id, $meta_key, $meta_value, $prev_value );` 38 | 39 | ### Delete ghost meta 40 | 41 | `delete_ghost_meta( $object_id, $meta_key, $meta_value, $delete_all );` 42 | 43 | ### Specifying meta type 44 | 45 | By default, ghost meta uses `post` as the meta type. However, this can be changed using dot-syntax in `$meta_key`. 46 | 47 | For example, you can use `user.my_custom_field` to interact with the `my_custom_field` meta key on the `user` meta type. 48 | 49 | ### Create custom ghost meta-like functionality 50 | 51 | Extend Ghost_Meta and define your own meta type and meta key to store the data in, the code will do the rest. It may help you further separate multiple data stores as needed. 52 | 53 | ```php 54 | // Load My Custom Ghost Meta 55 | add_action( 'plugins_loaded', array( 'My_Custom_Ghost_Meta', 'get_instance' ), 11 ); 56 | 57 | class My_Custom_Ghost_Meta extends Ghost_Meta { 58 | 59 | /** 60 | * Custom meta type for Ghost meta. 61 | * 62 | * @param string 63 | */ 64 | public $meta_type = 'my_custom_ghost'; 65 | 66 | /** 67 | * Custom meta key for Ghost meta storage. 68 | * 69 | * @param string 70 | */ 71 | public $meta_key = '_my_custom_ghost_meta'; 72 | 73 | } 74 | ``` 75 | 76 | Example usage: `$meta_value = get_metadata( 'my_custom_ghost', $object_id, $meta_key, $single );` -------------------------------------------------------------------------------- /functions.php: -------------------------------------------------------------------------------- 1 | meta_type . '_metadata', array( $this, 'get_metadata' ) ) ) { 79 | add_filter( 'get_' . $this->meta_type . '_metadata', array( $this, 'get_metadata' ), 10, 4 ); 80 | } 81 | 82 | if ( ! has_filter( 'add_' . $this->meta_type . '_metadata', array( $this, 'add_metadata' ) ) ) { 83 | add_filter( 'add_' . $this->meta_type . '_metadata', array( $this, 'add_metadata' ), 10, 5 ); 84 | } 85 | 86 | if ( ! has_filter( 'update_' . $this->meta_type . '_metadata', array( $this, 'update_metadata' ) ) ) { 87 | add_filter( 'update_' . $this->meta_type . '_metadata', array( $this, 'update_metadata' ), 10, 5 ); 88 | } 89 | 90 | if ( ! has_filter( 'delete_' . $this->meta_type . '_metadata', array( $this, 'delete_metadata' ) ) ) { 91 | add_filter( 'delete_' . $this->meta_type . '_metadata', array( $this, 'delete_metadata' ), 10, 5 ); 92 | } 93 | 94 | if ( ! has_filter( 'ep_post_sync_args', array( $this, 'ep_post_sync_args' ) ) ) { 95 | add_filter( 'ep_post_sync_args', array( $this, 'ep_post_sync_args' ), 10, 2 ); 96 | } 97 | 98 | /** 99 | * @var $wpdb wpdb 100 | */ 101 | global $wpdb; 102 | 103 | // Add temporary table property to wpdb because 104 | // _get_meta_table isn't hookable and it's called too early 105 | // in add_metadata / update_metadata / delete_metadata 106 | $table_name = $this->meta_type . 'meta'; 107 | 108 | $wpdb->{$table_name} = $wpdb->prefix . $table_name; 109 | 110 | include_once 'functions.php'; 111 | 112 | } 113 | 114 | /** 115 | * Filter get_metadata for Ghost Meta. 116 | * 117 | * @param null|array|string $value The value get_metadata() should return - a single metadata value, 118 | * or an array of values. 119 | * @param int $object_id Object ID. 120 | * @param string $meta_key Meta key. 121 | * @param bool $single Whether to return only the first value of the specified $meta_key. 122 | * 123 | * @return array|string 124 | */ 125 | public function get_metadata( $value, $object_id, $meta_key, $single ) { 126 | 127 | $meta_info = $this->get_meta_info_from_key( $meta_key ); 128 | $meta_type = $meta_info['type']; 129 | $meta_key = $meta_info['key']; 130 | 131 | $meta = $this->get_ghost_meta( $meta_type, $object_id ); 132 | 133 | if ( ! $meta_key ) { 134 | return $meta; 135 | } 136 | 137 | if ( isset( $meta[ $meta_key ] ) ) { 138 | if ( $single ) { 139 | $value = maybe_unserialize( $meta[ $meta_key ][0] ); 140 | } else { 141 | $value = array_map( 'maybe_unserialize', $meta[ $meta_key ] ); 142 | } 143 | } elseif ( $single ) { 144 | $value = ''; 145 | } else { 146 | $value = array(); 147 | } 148 | 149 | return $value; 150 | 151 | } 152 | 153 | /** 154 | * Filter add_metadata for Ghost Meta. 155 | * 156 | * @param null|bool $check Whether to allow adding metadata for the given type. 157 | * @param int $object_id Object ID. 158 | * @param string $meta_key Meta key. 159 | * @param mixed $meta_value Meta value. Must be serializable if non-scalar. 160 | * @param bool $unique Whether the specified meta key should be unique 161 | * for the object. Optional. Default false. 162 | * 163 | * @return int|false The meta ID on success, false on failure. 164 | */ 165 | public function add_metadata( $check, $object_id, $meta_key, $meta_value, $unique = false ) { 166 | 167 | $_meta_key = $meta_key; 168 | 169 | $meta_info = $this->get_meta_info_from_key( $meta_key ); 170 | $meta_type = $meta_info['type']; 171 | $meta_key = $meta_info['key']; 172 | 173 | $meta = $this->get_ghost_meta( $meta_type, $object_id ); 174 | 175 | $_meta_value = $meta_value; 176 | $meta_value = maybe_serialize( $meta_value ); 177 | 178 | if ( ! isset( $meta[ $meta_key ] ) ) { 179 | $meta[ $meta_key ] = array(); 180 | } 181 | 182 | $meta[ $meta_key ][] = $meta_value; 183 | 184 | $check = $this->update_ghost_meta( $meta_type, $object_id, $meta ); 185 | 186 | if ( false !== $check ) { 187 | $check = 1; 188 | } 189 | 190 | $mid = 0; 191 | 192 | /** 193 | * Fires immediately after meta of a specific type is added. 194 | * 195 | * @since 1.0 196 | * 197 | * @param int $mid The meta ID after successful update. 198 | * @param int $object_id Object ID. 199 | * @param string $meta_key Meta key. 200 | * @param mixed $meta_value Meta value. 201 | */ 202 | do_action( 'added_' . $this->meta_type . '_meta', $mid, $object_id, $_meta_key, $_meta_value ); 203 | 204 | return $check; 205 | 206 | } 207 | 208 | /** 209 | * Filter update_metadata for Ghost Meta. 210 | * 211 | * @param null|bool $check Whether to allow updating metadata for the given type. 212 | * @param int $object_id Object ID. 213 | * @param string $meta_key Meta key. 214 | * @param mixed $meta_value Meta value. Must be serializable if non-scalar. 215 | * @param mixed $prev_value Optional. If specified, only update existing 216 | * metadata entries with the specified value. 217 | * Otherwise, update all entries. 218 | * 219 | * @return bool True on successful update, false on failure. 220 | */ 221 | public function update_metadata( $check, $object_id, $meta_key, $meta_value, $prev_value ) { 222 | 223 | $_meta_key = $meta_key; 224 | 225 | $meta_info = $this->get_meta_info_from_key( $meta_key ); 226 | $meta_type = $meta_info['type']; 227 | $meta_key = $meta_info['key']; 228 | 229 | $meta = $this->get_ghost_meta( $meta_type, $object_id ); 230 | 231 | $_meta_value = $meta_value; 232 | $meta_value = maybe_serialize( $meta_value ); 233 | 234 | if ( ! isset( $meta[ $meta_key ] ) ) { 235 | $meta[ $meta_key ] = array(); 236 | } 237 | 238 | $changed = false; 239 | 240 | if ( $prev_value ) { 241 | $prev_value = maybe_serialize( $prev_value ); 242 | 243 | // Update meta values if they match $prev_value 244 | foreach ( $meta[ $meta_key ] as $prev_meta_k => $prev_meta_v ) { 245 | if ( $prev_value == $prev_meta_v ) { 246 | if ( is_bool( $prev_meta_v ) && (boolean) $prev_value === $prev_meta_v ) { 247 | // Strict matching for booleans 248 | $meta[ $meta_key ][ $prev_meta_k ] = $meta_value; 249 | 250 | $changed = true; 251 | } elseif ( is_int( $prev_meta_v ) && (int) $prev_value === $prev_meta_v ) { 252 | // Strict matching for integers 253 | $meta[ $meta_key ][ $prev_meta_k ] = $meta_value; 254 | 255 | $changed = true; 256 | } else { 257 | // Loose matching like MySQL would do by default 258 | $meta[ $meta_key ][ $prev_meta_k ] = $meta_value; 259 | 260 | $changed = true; 261 | } 262 | } 263 | } 264 | } elseif ( 1 !== count( $meta[ $meta_key ] ) || $meta_value !== $meta[ $meta_key ][0] ) { 265 | // Handle changes only if the value does not match 266 | $changed = true; 267 | 268 | // Update default is to remove all meta values and set as one single value 269 | $meta[ $meta_key ] = array( 270 | $meta_value 271 | ); 272 | } 273 | 274 | $check = false; 275 | 276 | if ( $changed ) { 277 | $check = $this->update_ghost_meta( $meta_type, $object_id, $meta ); 278 | 279 | if ( false !== $check ) { 280 | $check = 1; 281 | } 282 | } 283 | 284 | $meta_id = 0; 285 | 286 | /** 287 | * Fires immediately after updating metadata of a specific type. 288 | * 289 | * @since 1.0 290 | * 291 | * @param int $meta_id ID of updated metadata entry. (not currently used) 292 | * @param int $object_id Object ID. 293 | * @param string $meta_key Meta key. 294 | * @param mixed $meta_value Meta value. 295 | */ 296 | do_action( 'updated_' . $this->meta_type . '_meta', $meta_id, $object_id, $_meta_key, $_meta_value ); 297 | 298 | return $check; 299 | 300 | } 301 | 302 | /** 303 | * Filter delete_metadata for Ghost Meta. 304 | * 305 | * @param null|bool $delete Whether to allow metadata deletion of the given type. 306 | * @param int $object_id Object ID. 307 | * @param string $meta_key Meta key. 308 | * @param mixed $meta_value Meta value. Must be serializable if non-scalar. 309 | * @param bool $delete_all Whether to delete the matching metadata entries 310 | * for all objects, ignoring the specified $object_id. 311 | * Default false. 312 | * 313 | * @return bool True on successful delete, false on failure. 314 | */ 315 | public function delete_metadata( $delete, $object_id, $meta_key, $meta_value, $delete_all ) { 316 | 317 | $_meta_key = $meta_key; 318 | 319 | $meta_info = $this->get_meta_info_from_key( $meta_key ); 320 | $meta_type = $meta_info['type']; 321 | $meta_key = $meta_info['key']; 322 | 323 | $meta = $this->get_ghost_meta( $meta_type, $object_id ); 324 | 325 | $delete = false; 326 | $changed = false; 327 | 328 | $_meta_value = $meta_value; 329 | 330 | $meta_ids = array(); 331 | 332 | if ( $delete_all ) { 333 | // Handle deleting all values in ghost meta for this key 334 | /** 335 | * @var $wpdb wpdb 336 | */ 337 | global $wpdb; 338 | 339 | $table = _get_meta_table( $meta_type ); 340 | $type_column = sanitize_key( $meta_type . '_id' ); 341 | 342 | if ( ! $table ) { 343 | return false; 344 | } 345 | 346 | // Build like value so we only get ghost meta for objects that have something that matches 347 | $like_value = sprintf( 348 | '%%s:%d:"%s"%%', // Example: %s:7:"example"% 349 | mb_strlen( $meta_key ), 350 | $wpdb->esc_like( $meta_key ) 351 | ); 352 | 353 | // Get all objects in this meta 354 | $object_ids_sql = $wpdb->prepare( 355 | " 356 | SELECT {$type_column} 357 | FROM {$table} 358 | WHERE 359 | meta_key = %s 360 | AND meta_value LIKE %s 361 | ", 362 | $this->meta_key, 363 | $like_value 364 | ); 365 | 366 | $object_ids = $wpdb->get_col( $object_ids_sql ); 367 | 368 | foreach ( $object_ids as $o_id ) { 369 | $check_deleted = $this->delete_metadata( null, $o_id, $_meta_key, $meta_value, false ); 370 | 371 | if ( $check_deleted ) { 372 | $delete = 1; 373 | } 374 | } 375 | } elseif ( isset( $meta[ $meta_key ] ) ) { 376 | if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value ) { 377 | // Handle deleting only values that match 378 | $meta_value = maybe_serialize( $meta_value ); 379 | 380 | // Update meta values if they match $prev_value 381 | foreach ( $meta[ $meta_key ] as $prev_meta_k => $prev_meta_v ) { 382 | if ( $meta_value == $prev_meta_v ) { 383 | if ( is_bool( $prev_meta_v ) && (boolean) $meta_value === $prev_meta_v ) { 384 | // Strict matching for booleans 385 | unset( $meta[ $meta_key ][ $prev_meta_k ] ); 386 | 387 | $changed = true; 388 | } elseif ( is_int( $prev_meta_v ) && (int) $meta_value === $prev_meta_v ) { 389 | // Strict matching for integers 390 | unset( $meta[ $meta_key ][ $prev_meta_k ] ); 391 | 392 | $changed = true; 393 | } else { 394 | // Loose matching like MySQL would do by default 395 | unset( $meta[ $meta_key ][ $prev_meta_k ] ); 396 | 397 | $changed = true; 398 | } 399 | } 400 | } 401 | 402 | // Rekey the values 403 | if ( $changed ) { 404 | $meta[ $meta_key ] = array_values( $meta[ $meta_key ] ); 405 | } 406 | } else { 407 | // Remove the whole array of data 408 | unset( $meta[ $meta_key ] ); 409 | 410 | $changed = true; 411 | } 412 | } 413 | 414 | if ( $changed ) { 415 | $delete = $this->update_ghost_meta( $meta_type, $object_id, $meta ); 416 | 417 | if ( false !== $delete ) { 418 | $delete = 1; 419 | } 420 | } 421 | 422 | /** 423 | * Fires immediately after deleting Ghost metadata. 424 | * 425 | * @since 1.0 426 | * 427 | * @param array $meta_ids An array of deleted metadata entry IDs. (not currently used) 428 | * @param int $object_id Object ID. 429 | * @param string $meta_key Meta key. 430 | * @param mixed $meta_value Meta value. 431 | */ 432 | do_action( 'deleted_' . $this->meta_type . '_meta', $meta_ids, $object_id, $_meta_key, $_meta_value ); 433 | 434 | return $delete; 435 | 436 | } 437 | 438 | /** 439 | * Hook into ElasticPress post arguments to add our ghost meta, just as if it were normal meta. 440 | * 441 | * @param array $post_args Post arguments to send to Elasticsearch. 442 | * @param int $post_id Post ID. 443 | * 444 | * @return array Post arguments to send to Elasticsearch. 445 | */ 446 | public function ep_post_sync_args( $post_args, $post_id ) { 447 | 448 | $meta = $this->get_ghost_meta( 'post', $post_id ); 449 | 450 | if ( ! empty( $meta ) ) { 451 | // Merge ghost meta values 452 | $post_args['post_meta'] = array_merge( $post_args['post_meta'], $meta ); 453 | } 454 | 455 | return $post_args; 456 | 457 | } 458 | 459 | /** 460 | * Get Ghost Meta from the object. 461 | * 462 | * @param string $meta_type Meta type. 463 | * @param int $object_id Object ID. 464 | * 465 | * @return array Ghost meta 466 | */ 467 | protected function get_ghost_meta( $meta_type, $object_id ) { 468 | 469 | $meta = get_metadata( $meta_type, $object_id, $this->meta_key, true ); 470 | 471 | if ( empty( $meta ) || ! is_array( $meta ) ) { 472 | $meta = array(); 473 | } 474 | 475 | return $meta; 476 | 477 | } 478 | 479 | /** 480 | * Update Ghost Meta for the object. 481 | * 482 | * @param string $meta_type Meta type. 483 | * @param int $object_id Object ID. 484 | * @param array $meta Ghost meta. 485 | * 486 | * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure. 487 | */ 488 | protected function update_ghost_meta( $meta_type, $object_id, $meta ) { 489 | 490 | return update_metadata( $meta_type, $object_id, $this->meta_key, $meta ); 491 | 492 | } 493 | 494 | /** 495 | * Get meta info from a meta key. 496 | * 497 | * Examples: some_meta_value, post.some_meta_value, user.some_meta_value 498 | * 499 | * @param string $meta_key Meta key 500 | * 501 | * @return array Meta info 502 | */ 503 | protected function get_meta_info_from_key( $meta_key ) { 504 | 505 | $meta_info = array( 506 | 'type' => 'post', 507 | 'key' => $meta_key, 508 | ); 509 | 510 | if ( false !== strpos( $meta_key, '.' ) ) { 511 | $meta_key_data = explode( '.', $meta_key ); 512 | 513 | if ( 2 === count( $meta_key_data ) ) { 514 | $meta_info['type'] = $meta_key_data[0]; 515 | $meta_info['key'] = $meta_key_data[1]; 516 | } 517 | } 518 | 519 | return $meta_info; 520 | 521 | } 522 | 523 | } -------------------------------------------------------------------------------- /license.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA 6 | 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | Preamble 11 | 12 | The licenses for most software are designed to take away your 13 | freedom to share and change it. By contrast, the GNU General Public 14 | License is intended to guarantee your freedom to share and change free 15 | software--to make sure the software is free for all its users. This 16 | General Public License applies to most of the Free Software 17 | Foundation's software and to any other program whose authors commit to 18 | using it. (Some other Free Software Foundation software is covered by 19 | the GNU Library General Public License instead.) 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 | this service if you wish), that you receive source code or can get it 26 | if you want it, that you can change the software or use pieces of it 27 | in new free programs; and that you know you can do these things. 28 | 29 | To protect your rights, we need to make restrictions that forbid 30 | anyone to deny you these rights or to ask you to surrender the rights. 31 | These restrictions translate to certain responsibilities for you if you 32 | distribute copies of the software, or if you modify it. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must give the recipients all the rights that 36 | you have. You must make sure that they, too, receive or can get the 37 | source code. And you must show them these terms so they know their 38 | rights. 39 | 40 | We protect your rights with two steps: (1) copyright the software, and 41 | (2) offer you this license which gives you legal permission to copy, 42 | distribute and/or modify the software. 43 | 44 | Also, for each author's protection and ours, we want to make certain 45 | that everyone understands that there is no warranty for this free 46 | software. If the software is modified by someone else and passed on, we 47 | want its recipients to know that what they have is not the original, so 48 | that any problems introduced by others will not reflect on the original 49 | authors' reputations. 50 | 51 | Finally, any free program is threatened constantly by software 52 | patents. We wish to avoid the danger that redistributors of a free 53 | program will individually obtain patent licenses, in effect making the 54 | program proprietary. To prevent this, we have made it clear that any 55 | patent must be licensed for everyone's free use or not licensed at all. 56 | 57 | The precise terms and conditions for copying, distribution and 58 | modification follow. 59 | 60 | GNU GENERAL PUBLIC LICENSE 61 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 62 | 63 | 0. This License applies to any program or other work which contains 64 | a notice placed by the copyright holder saying it may be distributed 65 | under the terms of this General Public License. The "Program", below, 66 | refers to any such program or work, and a "work based on the Program" 67 | means either the Program or any derivative work under copyright law: 68 | that is to say, a work containing the Program or a portion of it, 69 | either verbatim or with modifications and/or translated into another 70 | language. (Hereinafter, translation is included without limitation in 71 | the term "modification".) Each licensee is addressed as "you". 72 | 73 | Activities other than copying, distribution and modification are not 74 | covered by this License; they are outside its scope. The act of 75 | running the Program is not restricted, and the output from the Program 76 | is covered only if its contents constitute a work based on the 77 | Program (independent of having been made by running the Program). 78 | Whether that is true depends on what the Program does. 79 | 80 | 1. You may copy and distribute verbatim copies of the Program's 81 | source code as you receive it, in any medium, provided that you 82 | conspicuously and appropriately publish on each copy an appropriate 83 | copyright notice and disclaimer of warranty; keep intact all the 84 | notices that refer to this License and to the absence of any warranty; 85 | and give any other recipients of the Program a copy of this License 86 | along with the Program. 87 | 88 | You may charge a fee for the physical act of transferring a copy, and 89 | you may at your option offer warranty protection in exchange for a fee. 90 | 91 | 2. You may modify your copy or copies of the Program or any portion 92 | of it, thus forming a work based on the Program, and copy and 93 | distribute such modifications or work under the terms of Section 1 94 | above, provided that you also meet all of these conditions: 95 | 96 | a) You must cause the modified files to carry prominent notices 97 | stating that you changed the files and the date of any change. 98 | 99 | b) You must cause any work that you distribute or publish, that in 100 | whole or in part contains or is derived from the Program or any 101 | part thereof, to be licensed as a whole at no charge to all third 102 | parties under the terms of this License. 103 | 104 | c) If the modified program normally reads commands interactively 105 | when run, you must cause it, when started running for such 106 | interactive use in the most ordinary way, to print or display an 107 | announcement including an appropriate copyright notice and a 108 | notice that there is no warranty (or else, saying that you provide 109 | a warranty) and that users may redistribute the program under 110 | these conditions, and telling the user how to view a copy of this 111 | License. (Exception: if the Program itself is interactive but 112 | does not normally print such an announcement, your work based on 113 | the Program is not required to print an announcement.) 114 | 115 | These requirements apply to the modified work as a whole. If 116 | identifiable sections of that work are not derived from the Program, 117 | and can be reasonably considered independent and separate works in 118 | themselves, then this License, and its terms, do not apply to those 119 | sections when you distribute them as separate works. But when you 120 | distribute the same sections as part of a whole which is a work based 121 | on the Program, the distribution of the whole must be on the terms of 122 | this License, whose permissions for other licensees extend to the 123 | entire whole, and thus to each and every part regardless of who wrote it. 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 | --------------------------------------------------------------------------------