├── .github ├── funding.yml ├── ISSUE_TEMPLATE │ ├── Support_question.md │ ├── Feature_request.md │ └── Bug_report.md ├── pull_request_template.md └── workflows │ ├── main.yml │ └── coding-style.yml ├── .gitignore ├── phpstan.neon ├── composer.json ├── README.md ├── src └── PNGMetadata.php └── LICENSE /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: janbarasek 2 | custom: ["https://baraja.cz", "https://php.baraja.cz", "https://vue.baraja.cz"] 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | composer.phar 2 | /vendor/ 3 | 4 | # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control 5 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file 6 | # composer.lock 7 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Support_question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "🤗 Support Question" 3 | about: "If you have a question 💬" 4 | 5 | --- 6 | 7 | --------------^ Click "Preview" for a nicer view! 8 | We primarily use GitHub as an issue tracker; for usage and support questions, please check out https://php.baraja.cz. Thanks! 😁. 9 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | - bug fix / new feature? 2 | - BC break? yes/no 3 | 4 | 11 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "🚀 Feature Request" 3 | about: "I have a suggestion (and may want to implement it) 🙂" 4 | 5 | --- 6 | 7 | - Is your feature request related to a problem? Please describe. 8 | - Explain your intentions. 9 | - It's up to you to make a strong case to convince the project's developers of the merits of this feature. 10 | -------------------------------------------------------------------------------- /phpstan.neon: -------------------------------------------------------------------------------- 1 | includes: 2 | - vendor/phpstan/phpstan-nette/extension.neon 3 | - vendor/phpstan/phpstan-nette/rules.neon 4 | - vendor/spaze/phpstan-disallowed-calls/extension.neon 5 | - vendor/spaze/phpstan-disallowed-calls/disallowed-dangerous-calls.neon 6 | - vendor/spaze/phpstan-disallowed-calls/disallowed-execution-calls.neon 7 | 8 | parameters: 9 | checkGenericClassInNonGenericObjectType: false 10 | checkMissingIterableValueType: false 11 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "🐛 Bug Report" 3 | about: "If something isn't working as expected 🤔" 4 | 5 | --- 6 | 7 | Version: ?.?.? 8 | 9 | ### Bug Description 10 | ... A clear and concise description of what the bug is. A good bug report shouldn't leave others needing to chase you up for more information. 11 | 12 | ### Steps To Reproduce 13 | ... If possible a minimal demo of the problem ... 14 | 15 | ### Expected Behavior 16 | ... A clear and concise description of what you expected to happen. 17 | 18 | ### Possible Solution 19 | ... Only if you have suggestions on a fix for the bug 20 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Integrity check 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@master 11 | 12 | - name: Install PHP 13 | uses: shivammathur/setup-php@v2 14 | with: 15 | php-version: 8.1 16 | 17 | - name: Install composer deps 18 | run: | 19 | composer create-project nette/code-checker temp/code-checker ^3 --no-progress 20 | composer create-project nette/coding-standard temp/coding-standard ^3 --no-progress 21 | 22 | # Install app deps 23 | composer install --no-interaction --prefer-dist --ignore-platform-req=ext-gd 24 | 25 | - name: The PHP Security Checker 26 | uses: symfonycorp/security-checker-action@v5 27 | 28 | - name: Check PHPStan rules 29 | run: composer phpstan 30 | -------------------------------------------------------------------------------- /.github/workflows/coding-style.yml: -------------------------------------------------------------------------------- 1 | name: Coding Style 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | nette_cc: 7 | name: Nette Code Checker 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v3.1.0 11 | - uses: shivammathur/setup-php@v2 12 | with: 13 | php-version: 8.1 14 | coverage: none 15 | 16 | - run: composer create-project nette/code-checker temp/code-checker ^3 --no-progress 17 | - run: php temp/code-checker/code-checker --strict-types --no-progress 18 | 19 | nette_cs: 20 | name: Nette Coding Standard 21 | runs-on: ubuntu-latest 22 | steps: 23 | - uses: actions/checkout@v3.1.0 24 | - uses: shivammathur/setup-php@v2 25 | with: 26 | php-version: 8.1 27 | coverage: none 28 | 29 | - run: composer create-project nette/coding-standard temp/coding-standard ^3 --no-progress --ignore-platform-reqs 30 | - run: php temp/coding-standard/ecs check src 31 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "joserick/png-metadata", 3 | "description": "A PHP library for extract the metadata (XMP, EXIF) within a PNG format image.", 4 | "keywords": [ 5 | "metadata", 6 | "png", 7 | "exif", 8 | "xmp", 9 | "exiftool" 10 | ], 11 | "type": "library", 12 | "license": "GPL-3.0", 13 | "authors": [ 14 | { 15 | "name": "Jóse Erick Carreón", 16 | "email": "joserick.92@gmail.com", 17 | "homepage": "https://github.com/joserick" 18 | }, 19 | { 20 | "name": "Jan Barášek", 21 | "homepage": "https://baraja.cz" 22 | } 23 | ], 24 | "require": { 25 | "php": "^7.4 || ^8.0", 26 | "ext-exif": "*", 27 | "ext-gd": "*" 28 | }, 29 | "require-dev": { 30 | "phpstan/phpstan": "^0.12.74", 31 | "phpstan/phpstan-nette": "^0.12.14", 32 | "spaze/phpstan-disallowed-calls": "^1.1", 33 | "roave/security-advisories": "dev-master", 34 | "tracy/tracy": "^2.7" 35 | }, 36 | "autoload": { 37 | "psr-4": { 38 | "PNGMetadata\\": "src/" 39 | } 40 | }, 41 | "scripts": { 42 | "phpstan": [ 43 | "vendor/bin/phpstan analyse src -c phpstan.neon --level 6 --no-progress" 44 | ] 45 | }, 46 | "minimum-stability": "stable" 47 | } 48 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Welcome to PNGMetadata! 2 | ======================= 3 | 4 | PNGMetadata is a library which is able to extract the metadata of an image in png format. 5 | 6 | It is important to mention that PNGMetadata does **not** use the software ExifTool so it is completely native. 7 | 8 | ![PNGMetadata.gif](https://joserick.com/docs/pngmetadata/PNGMetadata.gif) 9 | ## Enjoying this package? [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/joserick) 10 | ## Requirements 11 | 12 | - PHP >= 7.4 13 | - XML PHP Extension 14 | - JSON PHP Extension 15 | - GD PHP Extension 16 | - EXIF PHP Extension 17 | 18 | ## Installation 19 | 20 | Use the package manager [Composer](https://getcomposer.org/) to install PNGMetadata. 21 | 22 | ```bash 23 | $ composer require joserick/png-metadata 24 | ``` 25 | 26 | ## Use 27 | 28 | ### Getting a PNGMetadata Instance 29 | 30 | ```php 31 | // include composer autoload 32 | require 'vendor/autoload.php'; 33 | 34 | // import the Joserick PNGMetadata 35 | use PNGMetadata\PNGMetadata; 36 | 37 | // build PNGMetadata object with a image path. 38 | $png_metadata = new PNGMetadata('Photo.png'); // return a 'ArrayObject' or 'Exception' 39 | ``` 40 | 41 | In case you don't want to see any **errors** (Exception) generated you can used the static function '**extract()**' which returns a 'false' in case of error. 42 | 43 | ```php 44 | $png_metadata = PNGMetadata::extract('Photo.png'); // return a 'ArrayObject' or 'False' 45 | ``` 46 | 47 | If you want work with simple array without any other function you can call to '**toArray()**'. 48 | 49 | ```php 50 | $png_metadata = new PNGMetadata('Photo.png'); 51 | $metadata_array = $png_metadata->toArray(); // return simple 'Array' 52 | //or 53 | $metadata_array = PNGMetadata::extract('Photo.png')->toArray(); // return simple 'Array' 54 | ``` 55 | 56 | ## Examples 57 | 58 | ### Example 1 - All 59 | 60 | Print all the metadata. 61 | 62 | ```php 63 | $png_metadata = new PNGMetadata('../Photo.png'); 64 | echo $png_metadata; // Print metadata in 2 colums. 65 | ``` 66 | 67 | Out: 68 | 69 | | Metadata | Value | 70 | |--|--| 71 | | exif:DateTime | 2019:09:08 23:01:23 | 72 | | exif:Make | SONY | 73 | | exif:MimeType | image/png | 74 | | ... | ... | 75 | 76 | ### Example 2 - Get Metadata 77 | 78 | Get specific metadata. 79 | 80 | ```php 81 | $png_metadata = new PNGMetadata(___DIR___.'/Photo.png'); 82 | echo $png_metadata->get('exif:DateTime'); // Return a value, a array or false. 83 | ``` 84 | 85 | ### Example 3 - Types 86 | 87 | Print the metadata types (IHDR, sRGB, BKGD, EXIF, XMP, CRS, DATE, DC, ICC, AUX, ...). 88 | 89 | ```php 90 | $png_metadata = new PNGMetadata('./Path/Photo.png'); 91 | // or 92 | $png_metadata = PNGMetadata::extract('./Path/Photo.png'); 93 | 94 | foreach($png_metadata as $key => $value){ 95 | echo $key . "
"; // Metadata types 96 | } 97 | ``` 98 | 99 | ## Extras Functions 100 | 101 | ### Get the thumbnail stored in the metadata! 102 | ```php 103 | $png_metadata = new PNGMetadata('../Photo.png'); 104 | // or 105 | $png_metadata = PNGMetadata::extract('../Photo.png'); 106 | 107 | $thumb = $png_metadata->getThumbnail(); 108 | 109 | if ($thumb !== false) { 110 | header('Content-Type: image/png'); 111 | imagepng($thumb); 112 | imagedestroy($thumb); 113 | } 114 | ``` 115 | 116 | ### Is PNG? 117 | ```php 118 | if (PNGMetadata::isPNG('./Photo_jpg.png')){ 119 | echo 'Yes, it is a PNG.'; 120 | }else{ 121 | echo 'No, it is not a PNG.' 122 | } 123 | ``` 124 | 125 | ### What type? 126 | | | | | | | | 127 | |:----------:|:----------:|:--------:|:-------:|:--------:|:-------:| 128 | | GIF(1) | JPEG(2) | PNG (3) | SWF(4) | PSD(5) | BMP(6) | 129 | | TIFF_II(7) | TIFF_MM(8) | JP2 (10) | JPX(11) | JB2(12) | SWC(13) | 130 | | IFF(14) | WBMP(15) | XBM(16) | ICO(17) | WEBP(18) | | 131 | 132 | ```php 133 | return PNGMetadata::getType('./Photo') == 1 // GIF? 134 | ``` 135 | 136 | ## License 137 | 138 | The GNU Public License (GPLv3). Please see [License File](https://github.com/joserick/PNGMetadata/blob/master/LICENSE) for more information. 139 | -------------------------------------------------------------------------------- /src/PNGMetadata.php: -------------------------------------------------------------------------------- 1 | checkPath($path); 88 | $this->extractChunks(); 89 | $this->extractXMP(); 90 | $this->extractTExif(); 91 | $this->extractExif(); 92 | $this->extractBKGD(); 93 | $this->extractRGB(); 94 | $this->extractIHDR(); 95 | ksort($this->metadata); 96 | 97 | parent::__construct($this->metadata); 98 | } 99 | 100 | 101 | /** 102 | * Return a new PNGMetadata. 103 | * 104 | * @param string $path Location of the image in disk. 105 | * @return PNGMetadata|null 106 | */ 107 | public static function extract(?string $path = null): ?self 108 | { 109 | try { 110 | return new self($path); 111 | } catch (\Throwable $e) { 112 | return null; 113 | } 114 | } 115 | 116 | 117 | /** 118 | * Return metadata as array. 119 | * 120 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 121 | * 122 | * @return array 123 | */ 124 | public function toArray(): array 125 | { 126 | return $this->metadata; 127 | } 128 | 129 | 130 | /** 131 | * Return a metadata specific. 132 | * 133 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 134 | * 135 | * @param string $string A string with structure, e.g. 'exif:THUMBNAIL:Compression'. 136 | * @return string|mixed[]|null 137 | */ 138 | public function get(string $string) 139 | { 140 | $return = &$this->metadata; 141 | foreach (explode(':', $string) as $key) { 142 | if (isset($return[$key])) { 143 | $return = &$return[$key]; 144 | } else { 145 | return null; 146 | } 147 | } 148 | 149 | return $return; 150 | } 151 | 152 | 153 | /** 154 | * Return the metadata with a string structura of two colums. 155 | */ 156 | public function __toString(): string 157 | { 158 | $data = $this->printVertical(); 159 | $max_len = max(array_map('strlen', array_keys($data))) + 10; 160 | $strings[] = str_pad('--Metadata--', $max_len) . '--Value--' . "\n"; 161 | 162 | foreach ($data as $key => $value) { 163 | $strings[] = str_pad(trim($key), $max_len) . $value . "\n"; 164 | } 165 | if (PHP_SAPI !== 'cli') { 166 | array_unshift($strings, '
');
167 | 			$strings[] = '
'; 168 | } 169 | 170 | return implode(' ', $strings); 171 | } 172 | 173 | 174 | /** 175 | * Check if file path is a PNG. 176 | * 177 | * @param string $path Location of the image in disk. 178 | */ 179 | public static function isPNG(string $path): bool 180 | { 181 | return self::getType($path) == IMAGETYPE_PNG; 182 | } 183 | 184 | 185 | /** 186 | * Get image type. 187 | * 188 | * @throws \InvalidArgumentException If argument path is empty or if the file path does not exist. 189 | * 190 | * @param string $path Location of the image in disk. 191 | * @return int|false 192 | */ 193 | public static function getType(string $path) 194 | { 195 | if (!$path) { 196 | throw new \InvalidArgumentException('The argument path is empty', 101); 197 | } elseif (!file_exists($path)) { 198 | throw new \InvalidArgumentException('The file path does not exist or it\'s inaccessible', 102); 199 | } 200 | 201 | return exif_imagetype($path); 202 | } 203 | 204 | 205 | /** 206 | * Get thumbnail resource. 207 | * 208 | * @see PNGMetadata::$exif_data Efix data formatted. 209 | * 210 | * @return \GdImage|false 211 | */ 212 | public function getThumbnail() 213 | { 214 | // Check if the Exif data is not null. 215 | if ($this->exif_data) { 216 | // Check if the Exif data contains a thumbnail 217 | if ($thumb = exif_thumbnail($this->exif_data)) { 218 | // Create an image resource from the thumbnail data 219 | $image = imagecreatefromstring($thumb); 220 | 221 | // Rewind the Exif data to the beginning 222 | rewind($this->exif_data); 223 | 224 | return $image; 225 | } 226 | } 227 | 228 | // No thumbnail found or error occurred 229 | return false; 230 | } 231 | 232 | 233 | /** 234 | * Check the file path and store it. 235 | * 236 | * @throws \InvalidArgumentException If the file path is not a PNG image. 237 | * 238 | * @param string $path Location of the image in disk. 239 | */ 240 | private function checkPath(string $path): void 241 | { 242 | if ($this->isPNG($path)) { 243 | $this->path = $path; 244 | } else { 245 | throw new \InvalidArgumentException('The file path isn\'t PNG', 103); 246 | } 247 | } 248 | 249 | 250 | /** 251 | * Extract metadata from a XML(XMP) as a array. 252 | * 253 | * @param \DOMElement|\DOMNode $node 254 | * @return mixed[]|string 255 | */ 256 | private function extractNodesXML($node) 257 | { 258 | $output = []; 259 | switch ($node->nodeType) { 260 | case 1: 261 | for ($i = 0; $i < $node->childNodes->length; $i++) { 262 | $child = $node->childNodes->item($i); 263 | if ($child !== null) { 264 | $childValues = $this->extractNodesXML($child); 265 | // if the node has a tag name, it is not a text node 266 | if (isset($child->tagName)) { 267 | [$prefixTagName, $suffixTagName] = explode(':', $child->tagName); 268 | if (is_array($childValues)) { 269 | if (\in_array($prefixTagName, $this->tagsXMP, true)) { 270 | if (!isset($output[$suffixTagName])) { 271 | $output[$suffixTagName] = []; 272 | } 273 | $output[$suffixTagName] = $this->arrayMerge($output[$suffixTagName], $childValues); 274 | } else { 275 | $output = $this->arrayMerge($output, $childValues); 276 | } 277 | // if the node has a prefix and the prefix is in the list of prefixes, it is a XMP tag 278 | // if the node has a suffix and the suffix is in the list of suffixes, it is a XMP tag 279 | } elseif ( 280 | \in_array($prefixTagName, $this->prefSuffXMP, true) 281 | || \in_array($prefixTagName, $this->tagsXMP, true) 282 | ) { 283 | if (\in_array($suffixTagName, $this->prefSuffXMP, true)) { 284 | $output[] = $childValues; 285 | } else { 286 | $output[$suffixTagName][] = $childValues; 287 | } 288 | // if the node has a prefix and the prefix is not in the list of prefixes, it is not a XMP tag 289 | } else { 290 | $output[$prefixTagName][$suffixTagName][] = $childValues; 291 | } 292 | // if the node does not have a tag name, it is a text node 293 | } elseif ($childValues || $childValues === '0') { 294 | $output = is_array($childValues) 295 | ? implode(', ', $childValues) 296 | : (string) $childValues; 297 | } 298 | } 299 | } 300 | if (is_array($output) && $node->attributes->length) { 301 | $output = $this->arrayMerge($output, (array) $node->attributes); 302 | } 303 | break; 304 | case 4: 305 | case 3: 306 | $output = trim($node->textContent); 307 | break; 308 | } 309 | 310 | return $output; 311 | } 312 | 313 | 314 | /** 315 | * Join the metadata keys until they reach their value. 316 | * 317 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 318 | * 319 | * @param string $lastKey Key string from the previous array. 320 | * @param string[]|null $array Value from the previous array that is a array. 321 | * @return mixed[] 322 | */ 323 | private function printVertical(string $lastKey = '', ?array $array = null): array 324 | { 325 | // Create a new array to store the result. 326 | $columns = []; 327 | 328 | // If the key is not empty, add a colon to the end of the key. 329 | if ($lastKey !== '') { 330 | $lastKey .= ':'; 331 | } 332 | 333 | // Traverse the array. 334 | foreach ($array ?: $this->metadata as $key => $value) { 335 | // If the value is a array, call the function recursively. 336 | if (is_array($value)) { 337 | // If the value is an indexed array, merge the key and value together. 338 | if (isset($value[0])) { 339 | $columns[] = [$lastKey . $key => implode(',', $value)]; 340 | } else { 341 | // If the value is a associative array, call the function recursively. 342 | $columns[] = $this->printVertical($lastKey . $key, $value); 343 | } 344 | } else { 345 | // If the value is not an array, merge the key and value together. 346 | $columns[] = [$lastKey . $key => $value]; 347 | } 348 | } 349 | 350 | // Return the merged result. 351 | return array_merge(...$columns); 352 | } 353 | 354 | 355 | /** 356 | * Extract the data chunks more important. 357 | * 358 | * @see PNGMetadata::$path Location of the image in disk. 359 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 360 | * @throws \InvalidArgumentException If the provided argument is not a PNG image. 361 | */ 362 | private function extractChunks(): void 363 | { 364 | // Open the image file in binary mode. 365 | $content = fopen($this->path, 'rb'); 366 | 367 | // Verify that the file is a PNG file. 368 | if (fread($content, 8) !== "\x89PNG\x0d\x0a\x1a\x0a") { 369 | throw new \InvalidArgumentException('Invalid PNG file signature, path "' . $this->path . '" given.', 104); 370 | } 371 | 372 | // The PNG image is composed of a series of chunks. Each chunk is composed of 373 | // a 4-byte length, a 4-byte type, a variable number of data bytes, and a 374 | // 4-byte CRC. 375 | $chunkHeader = fread($content, 8); 376 | while ($chunkHeader) { 377 | $chunk = unpack('Nsize/a4type', $chunkHeader); 378 | if ($chunk['type'] === 'IEND') { 379 | break; 380 | } 381 | // Read the chunk data. 382 | if ($chunk['type'] === 'tEXt') { 383 | // For the tEXt chunk, the data is a keyword and a text string. 384 | $this->chunks[$chunk['type']][] = explode("\0", fread($content, $chunk['size'])); 385 | fseek($content, 4, SEEK_CUR); 386 | } else { 387 | if ( 388 | $chunk['type'] === 'eXIf' 389 | || $chunk['type'] === 'sRGB' 390 | || $chunk['type'] === 'iTXt' 391 | || $chunk['type'] === 'bKGD' 392 | ) { 393 | // For the eXIf, sRGB, iTXt, and bKGD chunks, the data is a byte 394 | // sequence. 395 | $lastOffset = ftell($content); 396 | $this->chunks[$chunk['type']] = fread($content, $chunk['size']); 397 | fseek($content, $lastOffset, SEEK_SET); 398 | } elseif ($chunk['type'] === 'IHDR') { 399 | // For the IHDR chunk, the data is a series of fields. 400 | $lastOffset = ftell($content); 401 | for ($i = 0; $i < 6; $i++) { 402 | $this->chunks[$chunk['type']][] = fread($content, ($i > 1 ? 1 : 4)); 403 | } 404 | fseek($content, $lastOffset, SEEK_SET); 405 | } 406 | fseek($content, $chunk['size'] + 4, SEEK_CUR); 407 | } 408 | $chunkHeader = fread($content, 8); 409 | } 410 | fclose($content); 411 | } 412 | 413 | 414 | /** 415 | * Extract IHDR type from iHDR chunk as a array. 416 | * 417 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 418 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 419 | */ 420 | private function extractIHDR(): void 421 | { 422 | if (isset($this->chunks['IHDR'])) { 423 | // Create a array that will be used to associate the chunk data with the corresponding metadata name. 424 | $ihdr = [ 425 | 'ImageWidth', 426 | 'ImageHeight', 427 | 'BitDepth', 428 | [ 429 | 0 => 'Grayscale', 430 | 2 => 'RGB', 431 | 3 => 'Palette', 432 | 4 => 'Grayscale with Alpha', 433 | 6 => 'RGB with Alpha', 434 | 8 => 'ColorType', 435 | ], [ 436 | 0 => 'Deflate/Inflate', 437 | 8 => 'Compression', 438 | ], [ 439 | 0 => 'Adaptive', 440 | 8 => 'Filter', 441 | ], [ 442 | 0 => 'Noninterlaced', 443 | 1 => 'Adam7 Interlace', 444 | 8 => 'Interlace', 445 | ], 446 | ]; 447 | 448 | // Loop through each chunk data. 449 | foreach ($this->chunks['IHDR'] as $key => $value) { 450 | // Check if the current chunk data is not the first two bytes of the chunk. 451 | if ($key > 1) { 452 | // Check if the current chunk data is the third byte of the chunk. 453 | if ($key === 2) { 454 | // Add the metadata name (in the $ihdr array) corresponding to the chunk data and the value of the chunk data. 455 | $this->metadata['IHDR'][$ihdr[$key]] = ord($value); 456 | } else { 457 | // Add the metadata name (in the $ihdr array) corresponding to the chunk data and the value of the chunk data. 458 | $this->metadata['IHDR'][$ihdr[$key][8]] = $ihdr[$key][ord($value)]; 459 | } 460 | } else { 461 | // Add the metadata name (in the $ihdr array) corresponding to the chunk data and the value of the chunk data. 462 | $this->metadata['IHDR'][$ihdr[$key]] = unpack('Ni', $value)['i']; 463 | } 464 | } 465 | } 466 | } 467 | 468 | 469 | /** 470 | * Extract KGD type from bKGD chunk as a array. 471 | * 472 | * The format of bKGD chunk is: 473 | * - For indexed-color images: 1 byte. 474 | * - For grayscale images: 2 bytes. 475 | * - For truecolor images: 6 bytes. 476 | * 477 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 478 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 479 | */ 480 | private function extractBKGD(): void 481 | { 482 | if (isset($this->chunks['bKGD'])) { 483 | // If the length of bKGD chunk is less than 2, it is an indexed-color images. 484 | // Otherwise it is a grayscale or truecolor images. 485 | $this->metadata['bKGD'] = implode(' ', unpack(strlen($this->chunks['bKGD']) < 2 ? 'C' : 'n*', $this->chunks['bKGD'])); 486 | } 487 | } 488 | 489 | 490 | /** 491 | * Extract RGB type from sRGB chunk as a array. 492 | * 493 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 494 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 495 | */ 496 | private function extractRGB(): void 497 | { 498 | if (isset($this->chunks['sRGB'])) { 499 | // $rgb is an array with 4 possible values 500 | $rgb = ['Perceptual', 'Relative Colorimetric', 'Saturation', 'Absolute Colorimetric']; 501 | // Unpack the sRGB chunk data as a byte 502 | $unpacked = unpack('C', $this->chunks['sRGB']); 503 | // Set the sRGB value to the value of $rgb that matches the byte 504 | $this->metadata['sRGB'] = $rgb[end($unpacked)] ?? 'Unknown'; 505 | } 506 | } 507 | 508 | 509 | /** 510 | * Extract Exif data from eXIf chunk as a array. 511 | * 512 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 513 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 514 | */ 515 | private function extractExif(): void 516 | { 517 | // Check if eXIf chunk exists. 518 | if (isset($this->chunks['eXIf'])) { 519 | // Open eXIf chunk data as a memory stream. 520 | $this->exif_data = fopen('php://memory', 'r+b'); 521 | // Write eXIf chunk data to the memory stream. 522 | fwrite($this->exif_data, $this->chunks['eXIf']); 523 | // Set the pointer of memory stream to the beginning of the stream. 524 | rewind($this->exif_data); 525 | 526 | // Read Exif data from memory stream. 527 | $this->metadata['exif'] = array_replace( 528 | $this->metadata['exif'] ?? [], 529 | exif_read_data($this->exif_data, null, true), 530 | ); 531 | 532 | // Set the pointer of memory stream to the beginning of the stream. 533 | rewind($this->exif_data); 534 | } 535 | } 536 | 537 | 538 | /** 539 | * Extract Exif data form tEXt chunk as a array. 540 | * 541 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 542 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 543 | */ 544 | private function extractTExif(): void 545 | { 546 | // Check if the tEXt chunk is present in the PNG file. 547 | if (isset($this->chunks['tEXt']) && is_array($this->chunks['tEXt'])) { 548 | 549 | // Loop over all tEXt chunks. 550 | foreach ($this->chunks['tEXt'] as $exif) { 551 | 552 | // Split the key into parts. 553 | [$group, $tag, $tag2] = array_pad(explode(':', $exif[0]), 3, null); 554 | 555 | // Convert the thumbnail key to uppercase. 556 | if ($tag === 'thumbnail') { 557 | $tag = strtoupper($tag); 558 | } 559 | 560 | // Store the value in the metadata array. 561 | $this->metadata[$group][$tag] = ($tag2 ? [$tag2 => $exif[1]] : $exif[1]); 562 | } 563 | } 564 | } 565 | 566 | 567 | /** 568 | * Extract XMP data from iTXt chunk as a array. 569 | * 570 | * @throws \Exception If the iTXt chunck has not 'x:xmpmeta' string. 571 | * @see PNGMetadata::$chunks For the property whose chunks data are storage. 572 | * @see PNGMetadata::$metadata For the property whose metadata are storage. 573 | */ 574 | private function extractXMP(): void 575 | { 576 | if (isset($this->chunks['iTXt']) && strncmp($this->chunks['iTXt'], 'XML:com.adobe.xmp', 17) === 0) { 577 | // create a new DOMDocument instance 578 | $dom = new \DOMDocument('1.0', 'UTF-8'); 579 | // set the preserveWhiteSpace property to false to remove white space 580 | $dom->preserveWhiteSpace = false; 581 | // set the formatOutput property to false to remove extra line breaks 582 | $dom->formatOutput = false; 583 | // set the substituteEntities property to false to prevent entity substitution 584 | $dom->substituteEntities = false; 585 | // load the XML data from the string 586 | $dom->loadXML(ltrim(substr($this->chunks['iTXt'], 17), "\x00")); 587 | // set the encoding to UTF-8 588 | $dom->encoding = 'UTF-8'; 589 | // check if the root node of the XML document is of type x:xmpmeta 590 | if ($dom->documentElement->nodeName !== 'x:xmpmeta') { 591 | error_log('ExtractRoot node must be of type x:xmpmeta.'); 592 | 593 | return; 594 | } 595 | // extract the metadata from the XML document 596 | if (!empty($result = $this->flatten($this->extractNodesXML($dom->documentElement)))) { 597 | // store the metadata in the PNGMetadata::$metadata property 598 | $this->metadata['xmp'] = $result; 599 | } 600 | } 601 | } 602 | 603 | 604 | /** 605 | * Extract the properties with the key '0' and insert them in the first level of the array. 606 | * 607 | * @param mixed[] $array Matrix that contains the proprietary. 608 | * @return mixed[] 609 | */ 610 | private function flatten(array $array): array 611 | { 612 | // Loop through each key in the array 613 | foreach ($array as $key => $value) { 614 | // If the value is an array 615 | if (is_array($value)) { 616 | // If the array has only one key, and that key is 0 617 | if (isset($value[0]) && \count($value) === 1) { 618 | // Set the value of this key to be the value of key 0 619 | $array[$key] = $value[0]; 620 | // If the new value is an array, call flatten again to flatten it 621 | if (is_array($array[$key])) { 622 | $array[$key] = $this->flatten($array[$key]); 623 | } 624 | } else { 625 | // If the array doesn't have only one key, call flatten again to flatten it 626 | $array[$key] = $this->flatten($value); 627 | } 628 | } 629 | } 630 | 631 | return $array; 632 | } 633 | 634 | 635 | /** 636 | * Merge one or more arrays more string concatenation. 637 | * 638 | * @param mixed[] $baseArray Array where the attributes will be inserted. 639 | * @param mixed[] $array Matrix that contains the attributes. 640 | * @return mixed[] 641 | */ 642 | private function arrayMerge(array $baseArray, array $array): array 643 | { 644 | // Loop through the array to be merged. 645 | foreach ($array as $key => $value) { 646 | // If the value is an object, get the value of the object. 647 | if (is_object($value)) { 648 | $value = $value->value; 649 | } 650 | 651 | // If the key already exists in the base array, merge the values. 652 | if (isset($baseArray[$key])) { 653 | // If the value is an array, merge the arrays. 654 | if (is_array($value)) { 655 | $baseArray[$key] = $this->arrayMerge($baseArray[$key], $array[$key]); 656 | } elseif ($baseArray[$key] !== $value) { 657 | // If the value is not an array, concatenate the values. 658 | $baseArray[$key] .= ',' . $value; 659 | } 660 | } else { 661 | // If the key does not exist, create the key and set the value. 662 | $baseArray[$key] = $value; 663 | } 664 | } 665 | 666 | return $baseArray; 667 | } 668 | } 669 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------