Download the PHP package dmk/mkcleaner without Composer

On this page you can find all versions of the php package dmk/mkcleaner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of dmk/mkcleaner

Informations about the package mkcleaner

MK Cleaner

TYPO3 compatibility Latest Stable Version Total Downloads Build Status License

What does it do?

This extension cleans files by removing most of the metadata according to the BSI guidelines. This is a important step when it comes to security so no sensitive information is leaked. This is done with mat2 (https://0xacab.org/jvoisin/mat2), exiftool (https://exiftool.org/) and qpdf (https://github.com/qpdf/qpdf) in the moment. You need to install/provide those commands on the server CLI. If some command is not available system-wide the path can be configured with $GLOBALS['TYPO3_CONF_VARS']['SYS']['binSetup'] or $GLOBALS['TYPO3_CONF_VARS']['SYS']['binPath'].

Check the logs for errors after uploading files etc.

As soon as everything is setup almost every file that is added/replaced with the TYPO3 FAL API will be cleaned. Furthermore there is a scheduler job that can be used for an initial cleanup of desired folders.

Adding a custom cleaner

A custom cleaner can be added in ext_localconf.php like this:

Every cleaner needs to implement DMK\Mkcleaner\Cleaner\CleanerInterface. Please take a look at the existing cleaners.

Drawbacks

Please keep in mind that neither of the tools is perfect and might break files or leave metadata present. For example pdf files sometimes loose all links or svg files have changed content when mat2 would be used. Therefore pdf files are cleaned with exiftool and qpdf instead of mat2 and svg files are omitted completely. Please take care of having svg files without metadata yourself.

Changelog

v12.0.1: Optimized description v12.0.0: Compatibility for TYPO3 11.5 and 12.4 only v8.0.2: add some error handling v8.0.1: resolve symlinks v8.0.0: initial release

All versions of mkcleaner with dependencies

PHP Build Version
Package Version
Requires typo3/cms-core Version ^11.5 || ^12.4
php Version ^8.1 || ^8.2 || ^8.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dmk/mkcleaner contains the following files

Loading the files please wait ....