├── .gitignore ├── Configuration ├── page.tsconfig ├── Services.yaml ├── JavaScriptModules.php ├── Extbase │ └── Persistence │ │ └── Classes.php └── TCA │ └── Overrides │ └── sys_file.php ├── Resources ├── Public │ ├── Css │ │ └── ExtendedUpload.css │ ├── JavaScript │ │ └── ExtendedUpload.js │ └── Icons │ │ └── Extension.svg └── Private │ └── Language │ ├── de.locallang.xlf │ ├── locallang.xlf │ └── locallang_be.xlf ├── ext_tables.sql ├── Classes ├── Domain │ ├── Repository │ │ ├── FileStorageRepository.php │ │ └── FileRepository.php │ └── Model │ │ ├── File.php │ │ └── FileStorage.php ├── Event │ └── Listener │ │ ├── AfterFileListRendered.php │ │ ├── AfterFileAdded.php │ │ └── AfterFileReplaced.php ├── Command │ └── CompressImagesCommand.php └── Service │ └── CompressImageService.php ├── .github └── workflows │ ├── phpcs.yml │ └── ter-release.yml ├── ext_emconf.php ├── ext_conf_template.txt ├── composer.json ├── README.md ├── rector.php ├── CHANGELOG.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .ddev 3 | vendor/ 4 | .Build/ 5 | /composer.lock 6 | -------------------------------------------------------------------------------- /Configuration/page.tsconfig: -------------------------------------------------------------------------------- 1 | templates.typo3/cms-filelist.1729713584 = schmitzal/tinyimg:Resources/Private 2 | -------------------------------------------------------------------------------- /Resources/Public/Css/ExtendedUpload.css: -------------------------------------------------------------------------------- 1 | .tinyimg-compressing { 2 | display: none; 3 | } 4 | 5 | .uploading .upload-queue-progress-bar { 6 | background-color: orange; 7 | } -------------------------------------------------------------------------------- /ext_tables.sql: -------------------------------------------------------------------------------- 1 | # 2 | # Table structure for table 'sys_file' 3 | # 4 | CREATE TABLE sys_file ( 5 | compressed SMALLINT(5) UNSIGNED DEFAULT '0' NOT NULL, 6 | compress_error text 7 | ); 8 | -------------------------------------------------------------------------------- /Configuration/Services.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | _defaults: 3 | autowire: true 4 | autoconfigure: true 5 | public: false 6 | 7 | Schmitzal\Tinyimg\: 8 | resource: '../Classes/*' 9 | exclude: '../Classes/Domain/Model/*' 10 | -------------------------------------------------------------------------------- /Configuration/JavaScriptModules.php: -------------------------------------------------------------------------------- 1 | [ 5 | 'backend', 6 | 'filelist', 7 | ], 8 | 'imports' => [ 9 | '@schmitzal/tinyimg/' => 'EXT:tinyimg/Resources/Public/JavaScript/', 10 | ], 11 | ]; 12 | -------------------------------------------------------------------------------- /Configuration/Extbase/Persistence/Classes.php: -------------------------------------------------------------------------------- 1 | [ 8 | 'tableName' => 'sys_file_storage' 9 | ], 10 | File::class => [ 11 | 'tableName' => 'sys_file' 12 | ] 13 | ]; 14 | -------------------------------------------------------------------------------- /Resources/Private/Language/de.locallang.xlf: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
5 | 6 | 7 | Bild wird komprimiert... 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /Classes/Domain/Repository/FileStorageRepository.php: -------------------------------------------------------------------------------- 1 | getQuerySettings()->setRespectStoragePage(false); 14 | 15 | return $query; 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /.github/workflows/phpcs.yml: -------------------------------------------------------------------------------- 1 | name: PHPCS Lint 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | branches: 9 | - main 10 | 11 | jobs: 12 | phpcs: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Check out the code 17 | uses: actions/checkout@v3 18 | 19 | - name: Set up PHP 20 | uses: shivammathur/setup-php@v2 21 | with: 22 | php-version: '8.3' 23 | extensions: mbstring, xml 24 | 25 | - name: Install dependencies 26 | run: composer install 27 | 28 | - name: Run PHPCS 29 | run: ./vendor/bin/phpcs --standard=PSR12 Classes/ -------------------------------------------------------------------------------- /ext_emconf.php: -------------------------------------------------------------------------------- 1 | 'tinyimg', 5 | 'description' => 'Image compression for all pngs and jpgs uploaded to the backend (using the tinypng API)', 6 | 'category' => 'plugin', 7 | 'author' => 'Alessandro Schmitz', 8 | 'author_email' => 'alessandro.schmitz@open.de', 9 | 'author_company' => 'OPEN Digitalgruppe GmbH', 10 | 'state' => 'stable', 11 | 'version' => '1.8.0', 12 | 'constraints' => [ 13 | 'depends' => [ 14 | 'typo3' => '13.4.0-13.4.99', 15 | ], 16 | 'conflicts' => [ 17 | ], 18 | 'suggests' => [ 19 | ], 20 | ], 21 | ]; -------------------------------------------------------------------------------- /Configuration/TCA/Overrides/sys_file.php: -------------------------------------------------------------------------------- 1 | [ 9 | 'exclude' => true, 10 | 'label' => 'Compressed', 11 | 'config' => [ 12 | 'type' => 'check', 13 | 'default' => 0 14 | ] 15 | ], 16 | 'compress_error' => [ 17 | 'exclude' => true, 18 | 'label' => 'Compression Error', 19 | 'config' => [ 20 | 'type' => 'text', 21 | 'default' => '' 22 | ] 23 | ] 24 | ]; 25 | 26 | ExtensionManagementUtility::addTCAcolumns('sys_file', $sysFileColumns); 27 | ExtensionManagementUtility::addToAllTCAtypes('sys_file', 'compress_error'); 28 | -------------------------------------------------------------------------------- /Resources/Public/JavaScript/ExtendedUpload.js: -------------------------------------------------------------------------------- 1 | const uploaderTriggers = document.querySelectorAll('.t3js-drag-uploader-trigger'); 2 | 3 | uploaderTriggers.forEach(function (trigger) { 4 | trigger.addEventListener('updateProgress', function (event) { 5 | let me = event.detail[0]; 6 | const percentage = event.detail[1]; 7 | 8 | if (percentage === '100%' && me.file.type.match(/image\/(jpg|jpeg|png)$/i)) { 9 | me.progressPercentage.textContent = ''; 10 | me.updateMessage(TYPO3.lang["tinyimg.compressingLabel"]); 11 | me.row.classList.add('compressing'); 12 | } 13 | }); 14 | 15 | trigger.addEventListener('uploadSuccess', function (event) { 16 | let me = event.detail[0]; 17 | 18 | if (me.file.type.match(/image\/(jpg|jpeg|png)$/i)) { 19 | me.row.classList.remove('compressing'); 20 | } 21 | }); 22 | }); 23 | -------------------------------------------------------------------------------- /Classes/Event/Listener/AfterFileListRendered.php: -------------------------------------------------------------------------------- 1 | pageRenderer->loadJavaScriptModule('@schmitzal/tinyimg/ExtendedUpload.js'); 22 | $this->pageRenderer->addCssFile('EXT:tinyimg/Resources/Public/Css/ExtendedUpload.css'); 23 | $this->pageRenderer->addInlineLanguageLabelFile('EXT:tinyimg/Resources/Private/Language/locallang.xlf'); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /Classes/Event/Listener/AfterFileAdded.php: -------------------------------------------------------------------------------- 1 | compressImageService->initializeCompression($event->getFile()); 27 | return $event; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /Resources/Private/Language/locallang.xlf: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
5 | 6 | 7 | Image is getting compressed... 8 | 9 | 10 | Folder excluded from compression ("%s") 11 | 12 | 13 | running in debugMode, no compression 14 | 15 | 16 | compression failed with message "%s" 17 | 18 | 19 | Tinyimg saved you about %s of your file size! 20 | 21 | 22 | Compression 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /Classes/Event/Listener/AfterFileReplaced.php: -------------------------------------------------------------------------------- 1 | compressImageService->initializeCompression($event->getFile()); 27 | return $event; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /Resources/Public/Icons/Extension.svg: -------------------------------------------------------------------------------- 1 | 2 | 4 | 9 | 10 | EXT:tinyimg 11 | 12 | 13 | 14 | 17 | 18 | -------------------------------------------------------------------------------- /Classes/Domain/Model/File.php: -------------------------------------------------------------------------------- 1 | storage; 14 | } 15 | 16 | public function setStorage(int $storage): void 17 | { 18 | $this->storage = $storage; 19 | } 20 | 21 | public function isCompressed(): bool 22 | { 23 | return $this->compressed; 24 | } 25 | 26 | public function setCompressed(bool $compressed): void 27 | { 28 | $this->compressed = $compressed; 29 | } 30 | 31 | public function getCompressError(): string 32 | { 33 | return $this->compressError; 34 | } 35 | 36 | public function setCompressError(string $compressError): void 37 | { 38 | $this->compressError = $compressError; 39 | } 40 | 41 | public function resetCompressError(): void 42 | { 43 | $this->setCompressError(''); 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /ext_conf_template.txt: -------------------------------------------------------------------------------- 1 | # cat=basic/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:apiKey 2 | apiKey = 3 | 4 | # cat=basic/enable; type=boolean; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:debug 5 | debug = 0 6 | 7 | # cat=basic/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:excludeFolders 8 | excludeFolders = 9 | 10 | ## CDN USAGE ## 11 | # cat=cdn/enable; type=boolean; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:useCdn 12 | useCdn = 13 | 14 | # cat=cdn/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:bucket 15 | bucket = 16 | 17 | # cat=cdn/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:key 18 | key = 19 | 20 | # cat=cdn/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:secret 21 | secret = 22 | 23 | # cat=cdn/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:region 24 | region = 25 | 26 | # cat=cdn/enable; type=string; label=LLL:EXT:tinyimg/Resources/Private/Language/locallang_be.xlf:version 27 | version = 2006-03-01 28 | -------------------------------------------------------------------------------- /.github/workflows/ter-release.yml: -------------------------------------------------------------------------------- 1 | name: TER release 2 | 3 | on: 4 | push: 5 | tags: 6 | - '*' 7 | 8 | jobs: 9 | ter-release: 10 | name: TER release 11 | runs-on: ubuntu-latest 12 | env: 13 | TYPO3_EXTENSION_KEY: 'tinyimg' 14 | REPOSITORY_URL: 'https://github.com/schmitzal/tinyimg' 15 | TYPO3_API_TOKEN: ${{ secrets.TYPO3_API_TOKEN }} 16 | TYPO3_API_USERNAME: ${{ secrets.TYPO3_API_USERNAME }} 17 | TYPO3_API_PASSWORD: ${{ secrets.TYPO3_API_PASSWORD }} 18 | 19 | steps: 20 | - name: Get the version 21 | id: get_version 22 | run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//} 23 | 24 | - name: Setup PHP 25 | uses: shivammathur/setup-php@v2 26 | with: 27 | php-version: '8.3' 28 | extensions: intl, mbstring, xml, soap, zip, curl 29 | 30 | - name: Install EXT:tailor 31 | run: composer global require typo3/tailor --prefer-dist --no-progress --no-suggest 32 | 33 | - name: Upload EXT:${{ env.EXTENSION_KEY }} as ${{ steps.get_version.outputs.VERSION }} to TER 34 | run: php ~/.composer/vendor/bin/tailor ter:publish ${{ steps.get_version.outputs.VERSION }} --artefact=${{ env.REPOSITORY_URL }}/archive/${{ steps.get_version.outputs.VERSION }}.zip --comment="${{ env.REPOSITORY_URL }}/blob/${{ steps.get_version.outputs.VERSION }}/CHANGELOG.md" 35 | -------------------------------------------------------------------------------- /Resources/Private/Language/locallang_be.xlf: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
5 | 6 | 7 | API key:Please insert your Tinyfy API key 8 | 9 | 10 | CDN Usage: Check if you want the files to be pushed to your Amazon S3 bucket (aus_driver_amazon_s3 required!) 11 | 12 | 13 | Enter the AWS S3 bucket name 14 | 15 | 16 | Enter you AWS S3 secret 17 | 18 | 19 | Enter your AWS S3 key 20 | 21 | 22 | Enter the region used in AWS S3 23 | 24 | 25 | Enter the AWS version 26 | 27 | 28 | Enable or disable debugging mode. Stops extension from compressing images. Use in development mode to avoid waisting compressions. 29 | 30 | 31 | Comma-separated list of folders which should be excluded from compression. Relative from storage (e.g. fileadmin), starting with "/" (e.g. "/user_upload,/folder_under_fileadmin") 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "schmitzal/tinyimg", 3 | "description": "Image compression for all pngs and jpgs uploaded to the backend (using the tinypng API)", 4 | "type": "typo3-cms-extension", 5 | "version": "1.8.0", 6 | "keywords": [ 7 | "image", 8 | "compression", 9 | "tinypng", 10 | "tinyjpg", 11 | "tinify" 12 | ], 13 | "license": "GPL-3.0-or-later", 14 | "authors": [ 15 | { 16 | "name": "Alessandro Schmitz", 17 | "role": "Developer", 18 | "homepage": "https://www.open.de/" 19 | } 20 | ], 21 | "support": { 22 | "issues": "https://github.com/schmitzal/tinyimg/issues" 23 | }, 24 | "require": { 25 | "php": "^8.3", 26 | "typo3/cms-core": "^13.4", 27 | "typo3/cms-extbase": "*", 28 | "typo3/cms-filelist": "*", 29 | "tinify/tinify": "^1.6" 30 | }, 31 | "require-dev": { 32 | "squizlabs/php_codesniffer": "~3.10", 33 | "ssch/typo3-rector": "^v2.10" 34 | }, 35 | "autoload": { 36 | "psr-4": { 37 | "Schmitzal\\Tinyimg\\": "Classes" 38 | } 39 | }, 40 | "replace": { 41 | "typo3-ter/tinyimg": "self.version" 42 | }, 43 | "extra": { 44 | "typo3/cms": { 45 | "cms-package-dir": ".Build/typo3/cms", 46 | "extension-key": "tinyimg", 47 | "web-dir": ".Build/Web", 48 | "Package": { 49 | "partOfMinimalUsableSystem": true 50 | } 51 | } 52 | }, 53 | "config": { 54 | "allow-plugins": { 55 | "typo3/cms-composer-installers": true, 56 | "typo3/class-alias-loader": true 57 | } 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /Classes/Domain/Model/FileStorage.php: -------------------------------------------------------------------------------- 1 | name; 20 | } 21 | 22 | public function setName(string $name): void 23 | { 24 | $this->name = $name; 25 | } 26 | 27 | public function getDescription(): string 28 | { 29 | return $this->description; 30 | } 31 | 32 | public function setDescription(string $description): void 33 | { 34 | $this->description = $description; 35 | } 36 | 37 | public function isDefault(): bool 38 | { 39 | return $this->default; 40 | } 41 | 42 | public function setDefault(bool $default): void 43 | { 44 | $this->default = $default; 45 | } 46 | 47 | public function isBrowsable(): bool 48 | { 49 | return $this->browsable; 50 | } 51 | 52 | public function setBrowsable(bool $browsable): void 53 | { 54 | $this->browsable = $browsable; 55 | } 56 | 57 | public function isPublic(): bool 58 | { 59 | return $this->public; 60 | } 61 | 62 | public function setPublic(bool $public): void 63 | { 64 | $this->public = $public; 65 | } 66 | 67 | public function isWritable(): bool 68 | { 69 | return $this->writable; 70 | } 71 | 72 | public function setWritable(bool $writable): void 73 | { 74 | $this->writable = $writable; 75 | } 76 | 77 | public function isOnline(): bool 78 | { 79 | return $this->online; 80 | } 81 | 82 | public function setOnline(bool $online): void 83 | { 84 | $this->online = $online; 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TYPO3 Extension tinyimg 2 | Image compression for all pngs and jpgs uploaded to the backend (using the tinypng API) 3 | 4 | ## What does it do? 5 | It's a small extension, that hooks (using events) into the TYPO3 file upload and compresses every jpg or png uploaded to the backend using the tinify API: https://tinypng.com/developers 6 | 7 | This API can reduce up to 80% of the file size of your images, which will increase your page speed. Without loosing quality. 8 | 9 | ## Installation 10 | `composer require schmitzal/tinyimg` 11 | 12 | ## Configuration 13 | 1. Create an API key* at https://tinypng.com/developers 14 | 2. Enter the API key* in the extension configuration 15 | 3. Disables compression in extension settings if desired, so you won't lose compressions during development and testing 16 | 4. Have a nice day :) 17 | 18 | _*Note that the tinify API is limited to 500 compressions per month. 19 | If you need more, there is a paid version which can be activated in your dashboard (where you got your API key)_ 20 | 21 | ## Setup for already existing projects 22 | This extension contains a command which runs through all file storages and compresses 100 images in it on each run. Depending on the size of these images this takes a while. 23 | 24 | Make sure to have an updated index. TYPO3 comes with an index updater as a scheduler task called "File Abstraction Layer: Update storage index (scheduler)". 25 | 26 | Also be aware that the tinify API is limited to 500 free compressions (see note above). So on huge websites it will be reached quickly. 27 | 28 | ## TypoScript reference 29 | 30 | Configuration has been moved to extension settings 31 | 32 | ## Contribution 33 | Bugs and feature requests are welcome. Feel free to create an [issue](https://github.com/schmitzal/tinyimg/issues), and I'll have a look at it as soon as possible. 34 | 35 | Code improvements are also highly appreciated. 36 | 37 | ## Sponsoring 38 | This extension is powered by [OPEN Digitalgruppe GmbH](https://www.open.de/). 39 | Most of the time working on this extension is at work, so my thanks go to Open. :) 40 | -------------------------------------------------------------------------------- /rector.php: -------------------------------------------------------------------------------- 1 | withPaths([ 17 | __DIR__ . '/Classes', 18 | __DIR__ . '/Configuration', 19 | ]) 20 | // uncomment to reach your current PHP version 21 | // ->withPhpSets() 22 | ->withPhpVersion(PhpVersion::PHP_83) 23 | ->withSets([ 24 | Typo3SetList::CODE_QUALITY, 25 | Typo3SetList::GENERAL, 26 | Typo3LevelSetList::UP_TO_TYPO3_13, 27 | ]) 28 | # To have a better analysis from PHPStan, we teach it here some more things 29 | ->withPHPStanConfigs([ 30 | Typo3Option::PHPSTAN_FOR_RECTOR_PATH 31 | ]) 32 | ->withRules([ 33 | AddVoidReturnTypeWhereNoReturnRector::class, 34 | ConvertImplicitVariablesToExplicitGlobalsRector::class, 35 | ]) 36 | ->withConfiguredRule(ExtEmConfRector::class, [ 37 | ExtEmConfRector::PHP_VERSION_CONSTRAINT => '8.1.0-8.3.99', 38 | ExtEmConfRector::TYPO3_VERSION_CONSTRAINT => '13.4.0-13.4.99', 39 | ExtEmConfRector::ADDITIONAL_VALUES_TO_BE_REMOVED => [] 40 | ]) 41 | # If you use withImportNames(), you should consider excluding some TYPO3 files. 42 | ->withSkip([ 43 | // @see https://github.com/sabbelasichon/typo3-rector/issues/2536 44 | __DIR__ . '/**/Configuration/ExtensionBuilder/*', 45 | NameImportingPostRector::class => [ 46 | 'ext_localconf.php', // This line can be removed since TYPO3 11.4, see https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.4/Important-94280-MoveContentsOfExtPhpIntoLocalScopes.html 47 | 'ext_tables.php', // This line can be removed since TYPO3 11.4, see https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.4/Important-94280-MoveContentsOfExtPhpIntoLocalScopes.html 48 | 'ClassAliasMap.php', 49 | ] 50 | ]) 51 | ; 52 | -------------------------------------------------------------------------------- /Classes/Domain/Repository/FileRepository.php: -------------------------------------------------------------------------------- 1 | getQuerySettings()->setRespectStoragePage(false); 21 | 22 | return $query; 23 | } 24 | 25 | /** 26 | * @throws InvalidQueryException 27 | */ 28 | public function findAllNonCompressedInStorageWithLimit( 29 | FileStorage $storage, 30 | int $limit = 100, 31 | array $excludeFolders = [] 32 | ): QueryResultInterface { 33 | $query = $this->createQuery(); 34 | 35 | $excludeFoldersConstraints = []; 36 | foreach ($excludeFolders as $excludeFolder) { 37 | $excludeFoldersConstraints[] = $query->logicalNot( 38 | $query->like('identifier', $excludeFolder . '%') 39 | ); 40 | } 41 | 42 | $query->matching( 43 | $query->logicalAnd( 44 | ...array_merge( 45 | [ 46 | $query->equals('storage', $storage), 47 | $query->equals('compressed', false), 48 | $query->equals('missing', false), 49 | $query->logicalOr( 50 | $query->equals('compress_error', null), 51 | $query->equals('compress_error', ''), 52 | ), 53 | $query->in( 54 | 'mime_type', 55 | [ 56 | 'image/png', 57 | 'image/jpeg', 58 | ] 59 | ), 60 | ], 61 | $excludeFoldersConstraints 62 | ) 63 | ) 64 | ); 65 | $query->setLimit($limit); 66 | 67 | return $query->execute(); 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ### 1.8.0 4 | * **[FEATURE]** Make extension compatible with TYPO3 13, including full refactoring and dropping TYPO3 10, 11 and 12 support 5 | 6 | ### 1.7.0 7 | * **[FEATURE]** Add support for TYPO3 12 - drop support for TYPO3 9 - Thanks to @achimfritz 8 | * **[CHANGE]** Move TypoScript configuration to extension configuration 9 | * **[FIX]** Avoid error while checking if a file exists if using CDN 10 | * **[FIX]** Move TCA Modifications from ext_tables.php to TCA overrides 11 | * **[FIX]** Prevent access of undefined array key in compression service 12 | 13 | ### 1.6.1 14 | * **[FIX]** Fix PHP 8.0 issue with sys_file TCA - Thanks to @bmack 15 | * **[CHANGE]** Use secure composer dependencies e.g. TYPO3 11.5 not 11.4 16 | 17 | ### 1.6.0 18 | * **[FEATURE]** Add support for TYPO3 11 - drop support for TYPO3 8 - Thanks to @achimfritz 19 | * **[FIX]** Prevent cache flushing when no files found 20 | * **[FIX]** Change return value of compression command to avoid exceptions with different symfony/console versions 21 | 22 | ### 1.5.4 23 | * **[FIX]** Add compatibility condition for compression command to avoid event not found exception for TYPO3 version lower 10 24 | 25 | ### 1.5.3 26 | * **[FIX]** Add correct return type to compress command 27 | * **[FIX]** Remove deprecated replace and add extension key in composer json 28 | 29 | ### 1.5.2 30 | * **[FIX]** Clear file information cache before calculating saved percentage after compression 31 | * **[CHANGE]** Set typo3/cms-core dependency to security fixed versions 32 | 33 | ### 1.5.1 34 | * **[FIX]** Set correct field definition and add event for cleanupProcessedFilesPostFileReplace 35 | 36 | ### 1.5.0 37 | * **[FEATURE]** Add support for TYPO3 10.0 - Thanks to @achimfritz, @davidsteeb and @bmack from @b13 GmbH 38 | * **[CHANGE]** Drop support for TYPO3 7.6 39 | * **[CHANGE]** Rename TypoScript setup file 40 | * **[CHANGE]** Add compression errors and optimize flash messages 41 | 42 | ### 1.4.0 43 | * **[FEATURE]** Add option to exclude specific folders from compression - Thanks to @achimfritz, @davidsteeb and @bmack from @b13 GmbH 44 | 45 | ### 1.3.0 46 | * **[FEATURE]** Add support for TYPO3 9.5 47 | * **[CHANGE]** Drop support of non composer installation 48 | * **[BUGFIX]** Remove folder parameter from compression service call in the compression command controller 49 | 50 | ### 1.2.0 51 | * **[FEATURE]** Add support for extension "aus_driver_amazon_s3" - Thanks to Andreas Hoffmeyer for the patch 52 | * **[BUGFIX]** Show the right filesize after upload by updating the file information in the database 53 | * **[FEATURE]** Add a compression bar after file has been uploaded & show a message when compression is done with the percentage saved 54 | * **[FEATURE]** Add an extbase command controller which loops through all file storage and compresses all images recursively in it 55 | 56 | ### 1.1.0 57 | * **[RELEASE]** Version 1.1.0 including support for TYPO3 7.6 58 | * **[FEATURE]** Add debugging mode 59 | * **[CLEANUP]** Removed tinypng assets from readme and changed extension icon 60 | 61 | ### 1.0.1 62 | * **[CLEANUP]** Small code improvements 63 | 64 | ### 1.0.0 65 | * **[RELEASE]** First version including image compression for every uploaded jpg and png. 66 | -------------------------------------------------------------------------------- /Classes/Command/CompressImagesCommand.php: -------------------------------------------------------------------------------- 1 | addArgument( 52 | 'limit', 53 | InputArgument::OPTIONAL, 54 | 'limit of files to compress', 55 | self::DEFAULT_LIMIT_TO_PROCESS 56 | ); 57 | } 58 | 59 | /** 60 | * @throws InvalidQueryException 61 | * @throws IllegalObjectTypeException 62 | * @throws FileDoesNotExistException 63 | * @throws UnknownObjectException 64 | * @throws ExtensionConfigurationPathDoesNotExistException 65 | * @throws ExtensionConfigurationExtensionNotConfiguredException 66 | * @throws NoSuchCacheGroupException 67 | * @throws Exception 68 | */ 69 | protected function execute(InputInterface $input, OutputInterface $output): int 70 | { 71 | $limit = (int)$input->getArgument('limit'); 72 | $settings = (GeneralUtility::makeInstance(ExtensionConfiguration::class))->get('tinyimg'); 73 | /** @var FileStorage $fileStorage */ 74 | foreach ($this->fileStorageRepository->findAll() as $fileStorage) { 75 | $excludeFolders = GeneralUtility::trimExplode(',', (string)($settings['excludeFolders'] ?? ''), true); 76 | $files = $this->fileRepository->findAllNonCompressedInStorageWithLimit( 77 | $fileStorage, 78 | $limit, 79 | $excludeFolders 80 | ); 81 | if ($files->count() > 0) { 82 | $this->compressImages($files); 83 | $this->clearPageCache(); 84 | } 85 | } 86 | 87 | return 0; 88 | } 89 | 90 | /** 91 | * @throws FileDoesNotExistException 92 | * @throws IllegalObjectTypeException 93 | * @throws UnknownObjectException 94 | * @throws Exception 95 | */ 96 | protected function compressImages(QueryResultInterface $files): void 97 | { 98 | $fileDeletionAspect = GeneralUtility::makeInstance(FileDeletionAspect::class); 99 | /** @var File $file */ 100 | foreach ($files as $file) { 101 | if ($file instanceof File) { 102 | $file = $this->resourceFactory->getFileObject($file->getUid()); 103 | $this->compressImageService->initializeCompression($file); 104 | $fileDeletionAspect->cleanupProcessedFilesPostFileReplace( 105 | new AfterFileReplacedEvent($file, '') 106 | ); 107 | } 108 | } 109 | } 110 | 111 | /** 112 | * Remove all processed files, so they get generated again after being compressed 113 | * @throws NoSuchCacheGroupException 114 | */ 115 | protected function clearPageCache(): void 116 | { 117 | $cacheManager = GeneralUtility::makeInstance(CacheManager::class); 118 | $cacheManager->flushCachesInGroup('pages'); 119 | } 120 | } 121 | -------------------------------------------------------------------------------- /Classes/Service/CompressImageService.php: -------------------------------------------------------------------------------- 1 | extConf = (GeneralUtility::makeInstance(ExtensionConfiguration::class))->get('tinyimg'); 44 | 45 | if (ExtensionManagementUtility::isLoaded('aus_driver_amazon_s3')) { 46 | $this->initCdn(); 47 | } 48 | 49 | \Tinify\setKey($this->getApiKey()); 50 | } 51 | 52 | public function initCdn(): void 53 | { 54 | /** @var S3Client client */ 55 | $this->client = S3Client::factory( 56 | [ 57 | 'region' => $this->extConf['region'], 58 | 'version' => $this->extConf['version'], 59 | 'credentials' => [ 60 | 'key' => $this->extConf['key'], 61 | 'secret' => $this->extConf['secret'], 62 | ], 63 | ] 64 | ); 65 | } 66 | 67 | /** 68 | * @throws IllegalObjectTypeException 69 | * @throws UnknownObjectException 70 | * @throws Exception 71 | */ 72 | public function initializeCompression(File $file): void 73 | { 74 | $this->initAction(); 75 | 76 | if ($this->isFileInExcludeFolder($file)) { 77 | return; 78 | } 79 | 80 | if ( 81 | !in_array( 82 | strtolower($file->getMimeType()), 83 | [ 84 | 'image/png', 85 | 'image/jpeg', 86 | ], 87 | true 88 | ) 89 | ) { 90 | return; 91 | } 92 | 93 | if ((int)($this->extConf['debug'] ?? 1) === 0) { 94 | try { 95 | if (!$this->getUseCdn()) { 96 | $this->assureFileExists($file); 97 | } 98 | $originalFileSize = $file->getSize(); 99 | if ($this->checkForAmazonCdn($file)) { 100 | $fileSize = $this->pushToTinyPngAndStoreToCdn($file); 101 | } else { 102 | $publicUrl = $this->getPublicPath() . urldecode($file->getPublicUrl()); 103 | $source = \Tinify\fromFile($publicUrl); 104 | $source->toFile($publicUrl); 105 | $fileSize = $this->setCompressedForCurrentFile($file); 106 | } 107 | if ((int)$fileSize !== 0) { 108 | $percentageSaved = (int)(100 - ((100 / $originalFileSize) * $fileSize)); 109 | $this->addMessageToFlashMessageQueue( 110 | 'success', 111 | [0 => $percentageSaved . '%'], 112 | ContextualFeedbackSeverity::INFO 113 | ); 114 | } 115 | $this->updateFileInformation($file); 116 | } catch (\Exception $e) { 117 | $this->saveError($file, $e); 118 | $this->addMessageToFlashMessageQueue( 119 | 'compressionFailed', 120 | [0 => $e->getMessage()], 121 | ContextualFeedbackSeverity::WARNING 122 | ); 123 | } 124 | } else { 125 | $this->addMessageToFlashMessageQueue('debugMode', [], ContextualFeedbackSeverity::INFO); 126 | } 127 | } 128 | 129 | /** 130 | * Check if the aus driver extension exists and is loaded. 131 | * Additionally, it checks if CDN is actually set and 132 | * your located in the CDN section of the file list 133 | */ 134 | public function checkForAmazonCdn(File $file): bool 135 | { 136 | return ExtensionManagementUtility::isLoaded('aus_driver_amazon_s3') && 137 | $this->getUseCdn() && 138 | $this->checkIfFolderIsCdn($file); 139 | } 140 | 141 | /** 142 | * Creates a temp file from original resource. 143 | * Pushes the temp image file to tinypng compression service. 144 | * Overrides the original temp file with the compressed on. 145 | * Puts the compressed temp image to the actual storeage in file list -> CDN 146 | * Deletes old temp file. 147 | * @throws \Exception 148 | */ 149 | public function pushToTinyPngAndStoreToCdn(File $file): int 150 | { 151 | // get the image 152 | // no PATH_site as file will be provided by absolute URL of the bucket or the CDN 153 | $publicUrl = $file->getPublicUrl(); 154 | 155 | // get the temp file and prefix with current time 156 | $tempFile = $this->getPublicPath() . 'typo3temp' . DIRECTORY_SEPARATOR . time() . '_' . $this->getCdnFileName( 157 | $publicUrl 158 | ); 159 | 160 | $source = \Tinify\fromFile($publicUrl); 161 | 162 | // move to temp folder 163 | $source->toFile($tempFile); 164 | 165 | // upload to CDN 166 | $splFileObject = new \SplFileObject($tempFile); 167 | $fileSize = $splFileObject->getSize(); 168 | $this->client->putObject( 169 | [ 170 | 'Bucket' => $this->extConf['bucket'], 171 | 'Key' => $file->getIdentifier(), 172 | 'SourceFile' => $tempFile, 173 | ] 174 | ); 175 | // remove temp file 176 | GeneralUtility::unlink_tempfile($tempFile); 177 | return (int)$fileSize; 178 | } 179 | 180 | /** 181 | * This only works if file does not exist 182 | */ 183 | public function checkIfFolderIsCdn(File $file): bool 184 | { 185 | // if this is string, then we know, that there is already a file in the folder 186 | // In this case you have to check if the object in the bucket exists 187 | if (is_string($file->getParentFolder())) { 188 | return $this->client->doesObjectExist( 189 | $this->extConf['bucket'], 190 | $file->getIdentifier() 191 | ); 192 | } 193 | 194 | return $file->getParentFolder()->getStorage()->getDriverType() === 'AusDriverAmazonS3'; 195 | } 196 | 197 | public function getCdnFileName(string $fileName): string 198 | { 199 | return preg_replace('/^.*\/(.*)$/', '$1', $fileName); 200 | } 201 | 202 | protected function getPublicPath(): string 203 | { 204 | return Environment::getPublicPath() . '/'; 205 | } 206 | 207 | protected function getAbsoluteFileName(File $file): string 208 | { 209 | return urldecode( 210 | rtrim(Environment::getPublicPath(), '/') . '/' . ltrim($file->getPublicUrl(), '/') 211 | ); 212 | } 213 | 214 | /** 215 | * @throws \Exception 216 | */ 217 | protected function assureFileExists(File $file): void 218 | { 219 | $absFileName = $this->getAbsoluteFileName($file); 220 | if (file_exists($absFileName) === false) { 221 | throw new \RuntimeException('Tinyimg: File does not exist: ' . $absFileName, 1575270381); 222 | } 223 | if ((int)filesize($absFileName) === 0) { 224 | throw new \RuntimeException('Tinyimg: Filesize is 0: ' . $absFileName, 1575270380); 225 | } 226 | } 227 | 228 | /** 229 | * @throws Exception 230 | */ 231 | protected function isFileInExcludeFolder(File $file): bool 232 | { 233 | if (!empty($this->extConf['excludeFolders'])) { 234 | $excludeFolders = GeneralUtility::trimExplode(',', $this->extConf['excludeFolders'], true); 235 | $identifier = $file->getIdentifier(); 236 | foreach ($excludeFolders as $excludeFolder) { 237 | if (str_starts_with($identifier, $excludeFolder)) { 238 | $this->addMessageToFlashMessageQueue( 239 | 'folderExcluded', 240 | [0 => $excludeFolder], 241 | ContextualFeedbackSeverity::INFO 242 | ); 243 | return true; 244 | } 245 | } 246 | } 247 | return false; 248 | } 249 | 250 | protected function getApiKey(): string 251 | { 252 | return (string)$this->extConf['apiKey']; 253 | } 254 | 255 | protected function getUseCdn(): bool 256 | { 257 | return (bool)$this->extConf['useCdn']; 258 | } 259 | 260 | protected function updateFileInformation(File $file): void 261 | { 262 | $storage = $file->getStorage(); 263 | $fileIndexer = GeneralUtility::makeInstance(Indexer::class, $storage); 264 | $fileIndexer->updateIndexEntry($file); 265 | } 266 | 267 | /** 268 | * @throws IllegalObjectTypeException 269 | * @throws UnknownObjectException 270 | */ 271 | protected function setCompressedForCurrentFile(File $file): ?int 272 | { 273 | /** @var \Schmitzal\Tinyimg\Domain\Model\File $extbaseFileObject */ 274 | $extbaseFileObject = $this->fileRepository->findByUid($file->getUid()); 275 | $extbaseFileObject->setCompressed(true); 276 | $extbaseFileObject->resetCompressError(); 277 | $this->fileRepository->update($extbaseFileObject); 278 | $this->persistenceManager->persistAll(); 279 | try { 280 | clearstatcache(); 281 | $splFileObject = new \SplFileObject($this->getAbsoluteFileName($file)); 282 | return (int)$splFileObject->getSize(); 283 | } catch (\Exception) { 284 | return null; 285 | } 286 | } 287 | 288 | protected function isCli(): bool 289 | { 290 | return Environment::isCli(); 291 | } 292 | 293 | /** 294 | * @throws Exception 295 | */ 296 | protected function addMessageToFlashMessageQueue( 297 | string $key, 298 | array $replaceMarkers = [], 299 | ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::ERROR 300 | ): void { 301 | if ($this->isCli()) { 302 | return; 303 | } 304 | 305 | $message = LocalizationUtility::translate( 306 | 'LLL:EXT:tinyimg/Resources/Private/Language/locallang.xlf:flashMessage.message.' . $key, 307 | null, 308 | $replaceMarkers 309 | ); 310 | $flashMessage = GeneralUtility::makeInstance( 311 | FlashMessage::class, 312 | $message, 313 | LocalizationUtility::translate( 314 | 'LLL:EXT:tinyimg/Resources/Private/Language/locallang.xlf:flashMessage.title' 315 | ), 316 | $severity, 317 | true 318 | ); 319 | 320 | $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class); 321 | $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier(); 322 | $defaultFlashMessageQueue->enqueue($flashMessage); 323 | } 324 | 325 | /** 326 | * @throws UnknownObjectException 327 | * @throws IllegalObjectTypeException 328 | */ 329 | protected function saveError(File $file, \Exception $e): void 330 | { 331 | /** @var \Schmitzal\Tinyimg\Domain\Model\File $extbaseFileObject */ 332 | $extbaseFileObject = $this->fileRepository->findByUid($file->getUid()); 333 | $extbaseFileObject->setCompressed(false); 334 | $extbaseFileObject->setCompressError($e->getCode() . ' : ' . $e->getMessage()); 335 | $this->fileRepository->update($extbaseFileObject); 336 | $this->persistenceManager->persistAll(); 337 | } 338 | } 339 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------