TYPO3 Copyright Header

Objective

This bash script makes a mass-update on all .php files of a TYPO3 CMS source directory and replaces the existing copyright header with a new one. It is possible to limit the number of files to process to a specific value (default: 100).

The script was used for the re-working and simplifing the copyright header in TYPO3 CMS' PHP files, see: issue 59535 on forge.typo3.org.

Installation

1. Create a new folder, for example copyright
2. Copy the following two files into this directory: copyright.sh and copyright-php-files.txt
3. Ensure, the script file is executable: chmod u+x copyright.sh
4. Clone (Git) the latest TYPO3 CMS source files into the directory copyright, e.g. copyright/typo3_src.git

Usage

Change into the copyright directory and execute the script copyright.sh:

cd copyright
./copyright.sh typo3_src.git 100

This will search for *.php files in typo3_src.git and replace the copyright header with the content of file copyright-php-files.txt. It stops after processing 100 files and creates a list of already processed files as file copyright.exclude (in order to prevent processing these files again).

Features And Considerations

• The script creates a file copyright.ignored which contains a list of files that were ignored during the last run (e.g. due to missing copyright headers)
• The script creates a file copyright.exclude which contains a list of files that were already processed
• The script excludes directories .git and contrib during the scan
• Copyright headers in *.php files must occur in the first 42 lines (see script source)
• Copyright headers must contain at least the words "copyright" and "typo3" (case insensitive)
• The script writes MD5 hashes of old headers in directory /tmp/typo3header/ to detect unique headers found

Author

Michael Schams <schams.net>