Draft: Shorter copyright header

[colinmollenhour]

Follow-up for #4467

This result was created with the following scripts:

pr4467.php

<?php

function processFile($filePath) {
    $content = file_get_contents($filePath);
    if ($content === false) {
        echo "Failed to read file: $filePath\n";
        return;
    }

    // Find all doc blocks
    preg_match_all('/\/\*\*(?:.*?)\*\//s', $content, $matches, PREG_OFFSET_CAPTURE);
    
    if (empty($matches[0])) {
        // No doc blocks found, create new one
        $newDocBlock = createNewDocBlock('');
        $content = "<?php\n" . $newDocBlock . "\n" . trim(preg_replace('/^<\?php\s*/s', '', $content));
    } else {
        // Process existing doc blocks
        $firstBlock = $matches[0][0][0];
        
        // Remove "This file is part of OpenMage" block
        $content = preg_replace('/\/\*\*.*?This file is part of OpenMage.*?\*\//s', '', $content);
        
        // Process second block if it exists
        $freeformText = '';
        if (isset($matches[0][1])) {
            $secondBlock = $matches[0][1][0];
            $secondBlockContent = preg_replace('/\/\*\*\s*|\s*\*\/$/s', '', $secondBlock);
            
            // Extract freeform text (everything before @)
            if (preg_match('/^\s*\*?(.*?)(?=\s*@|$)/s', $secondBlockContent, $textMatch)) {
                $freeformText = preg_replace('/^\s*\*\s*/m', '', trim($textMatch[1]));
                // Remove multiple asterisks
                $freeformText = preg_replace('/\*+\s*/', '', $freeformText);
            }
            
            // Extract existing annotations
            preg_match_all('/@\w+\s+[^\n]+/m', $secondBlockContent, $annotationMatches);
            $existingAnnotations = $annotationMatches[0] ?? [];
            
            // Remove the second block
            $content = str_replace($secondBlock, '', $content);
        }
        
        // Create new doc block
        $newDocBlock = createNewDocBlock($freeformText, $existingAnnotations);
        
        // Ensure PHP open tag is first, followed by doc block and code
        $content = preg_replace('/^\s*/', '', $content);
        $content = preg_replace('/^<\?php\s*/s', '', $content);
        $content = "<?php\n" . $newDocBlock . "\n" . trim($content);
    }
    
    // Write updated content back to file
    if (file_put_contents($filePath, $content) === false) {
        echo "Failed to write file: $filePath\n";
        return;
    }
    
    echo "Processed: $filePath\n";
}

function createNewDocBlock($freeformText, $existingAnnotations = []) {
    $block = "/**\n";
    
    // Add freeform text if it exists
    if (!empty($freeformText)) {
        $block .= " * " . trim($freeformText) . "\n *\n";
    }
    
    // Add required annotations
    $block .= " * @copyright For copyright and license information, read the COPYING.txt file.\n";
    $block .= " * @link /COPYING.txt\n";
    
    // Add @package if it existed before
    foreach ($existingAnnotations as $annotation) {
        if (strpos($annotation, '@package') === 0) {
            $block .= " * " . $annotation . "\n";
            break;
        }
    }
    
    // Add remaining annotations (except @copyright and @link)
    foreach ($existingAnnotations as $annotation) {
        if (strpos($annotation, '@copyright') === 0 || 
            strpos($annotation, '@link') === 0 || 
            strpos($annotation, '@package') === 0) {
            continue;
        }
        $block .= " * " . $annotation . "\n";
    }
    
    $block .= " */";
    return $block;
}

function processDirectory($path) {
    $iterator = new RecursiveIteratorIterator(
        new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS)
    );
    
    foreach ($iterator as $file) {
        if (!$file->isFile()) {
            continue;
        }
        
        $extension = strtolower($file->getExtension());
        if ($extension === 'php' || $extension === 'phtml') {
            processFile($file->getPathname());
        }
    }
}

// Usage
if ($argc !== 2) {
    echo "Usage: php script.php <directory_path>\n";
    exit(1);
}

$directoryPath = $argv[1];
if (!is_dir($directoryPath)) {
    echo "Error: Directory not found\n";
    exit(1);
}

processDirectory($directoryPath);

apply-pr4467.sh

#!/bin/bash
php pr4467.php app/code/
php pr4467.php lib
php pr4467.php shell
php pr4467.php tests

# delete @category
find app/code -name "*.php" -exec sed -i '/ \* @category/d' {} \;
find errors -name "*.phtml" -exec sed -i '/ \* @category/d' {} \;
find errors -name "*.php" -exec sed -i '/ \* @category/d' {} \;
find lib -name "*.php" -exec sed -i '/ \* @category/d' {} \;
find shell -name "*.php" -exec sed -i '/ \* @category/d' {} \;

# ensure file ends with a newline
find app/code -name "*.php" -type f -exec sed -i -e '$a\' {} \;
find errors -name "*.php" -type f -exec sed -i -e '$a\' {} \;
find errors -name "*.phtml" -type f -exec sed -i -e '$a\' {} \;
find lib -name "*.php" -type f -exec sed -i -e '$a\' {} \;
find shell -name "*.php" -type f -exec sed -i -e '$a\' {} \;

# add back @license line
find app/code -name "*.php" -type f -exec sed -i '/ \* @link \/COPYING.txt/a\ * @license Open Software License (OSL 3.0)' {} \;
find errors -name "*.php" -type f -exec sed -i '/ \* @link \/COPYING.txt/a\ * @license Open Software License (OSL 3.0)' {} \;
find errors -name "*.phtml" -type f -exec sed -i '/ \* @link \/COPYING.txt/a\ * @license Open Software License (OSL 3.0)' {} \;
find lib -name "*.php" -type f -exec sed -i '/ \* @link \/COPYING.txt/a\ * @license Open Software License (OSL 3.0)' {} \;
find shell -name "*.php" -type f -exec sed -i '/ \* @link \/COPYING.txt/a\ * @license Open Software License (OSL 3.0)' {} \;

# PHP CS Fixer
php vendor/bin/php-cs-fixer fix

# fix spacing
find app/code -name "*.php" -type f -exec sed -i 's/ \* @link \/COPYING.txt/\ * @link       \/COPYING.txt/' {} \;
find errors -name "*.php" -type f -exec sed -i 's/ \* @link \/COPYING.txt/\ * @link       \/COPYING.txt/' {} \;
find errors -name "*.phtml" -type f -exec sed -i 's/ \* @link \/COPYING.txt/\ * @link       \/COPYING.txt/' {} \;
find lib -name "*.php" -type f -exec sed -i 's/ \* @link \/COPYING.txt/\ * @link       \/COPYING.txt/' {} \;
find shell -name "*.php" -type f -exec sed -i 's/ \* @link \/COPYING.txt/\ * @link       \/COPYING.txt/' {} \;

find app/code -name "*.php" -type f -exec sed -i 's/ *\* *@license Open Software License (OSL 3.0)/\ * @license    Open Software License (OSL 3.0)/' {} \;
find errors -name "*.php" -type f -exec sed -i 's/ *\* *@license Open Software License (OSL 3.0)/\ * @license    Open Software License (OSL 3.0)/' {} \;
find errors -name "*.phtml" -type f -exec sed -i 's/ *\* *@license Open Software License (OSL 3.0)/\ * @license    Open Software License (OSL 3.0)/' {} \;
find lib -name "*.php" -type f -exec sed -i 's/ *\* *@license Open Software License (OSL 3.0)/\ * @license    Open Software License (OSL 3.0)/' {} \;
find shell -name "*.php" -type f -exec sed -i 's/ *\* *@license Open Software License (OSL 3.0)/\ * @license   Open Software License (OSL 3.0)/' {} \;

find app/code -name "*.php" -type f -exec sed -i 's/ \* @copyright For copyright and license information, read the COPYING.txt file\./ * @copyright  For copyright and license information, read the COPYING.txt file./' {} \;
find errors -name "*.php" -type f -exec sed -i 's/ \* @copyright For copyright and license information, read the COPYING.txt file\./ * @copyright  For copyright and license information, read the COPYING.txt file./' {} \;
find errors -name "*.phtml" -type f -exec sed -i 's/ \* @copyright For copyright and license information, read the COPYING.txt file\./ * @copyright  For copyright and license information, read the COPYING.txt file./' {} \;
find lib -name "*.php" -type f -exec sed -i 's/ \* @copyright For copyright and license information, read the COPYING.txt file\./ * @copyright  For copyright and license information, read the COPYING.txt file./' {} \;
find shell -name "*.php" -type f -exec sed -i 's/ \* @copyright For copyright and license information, read the COPYING.txt file\./ * @copyright  For copyright and license information, read the COPYING.txt file./' {} \;

[sreichel]

WOW. 🚀

[sreichel]

Looks good, only ...

• line endings changed?
• category-tag could be removed (edit: already done?)
• add tabs/spaces for aligmnent in docs

[colinmollenhour]

I pushed some more fixes - there are still a handful of cases that need to be updated (e.g. search for @category) but I need to do some other things today..

[sreichel]

but I need to do some other things today..

😄

Looks good so far. Thanks. Phpstan has to be checked ;(

[sonarqubecloud]

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sreichel]

Seems you have erased some other at-tags too.

• dataprovider in tests
• group in tests
• ...

A small changes went into work .... ;)

Finally ... this should either be adde th shell or better dev.

[sonarqubecloud]

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sreichel]

... followed-up by #4767