manageForeignResources.php

Go to the documentation of this file.

<?php
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\ResourceLoader\ForeignResourceManager;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
class ManageForeignResources extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( <<<TEXT
Manage foreign resources registered with ResourceLoader.
 
This helps developers with downloading, verifying, and updating local copies of
upstream libraries registered as ResourceLoader modules. See
https://www.mediawiki.org/wiki/Foreign_resources
 
Use the "update" action to download urls specified in foreign-resources.yaml,
and unpack them to the resources directory. This will also verify them against
the integrity hashes.
 
Use the "verify" action to verify the files currently in the resources directory
match what "update" would replace them with. This is effectively a dry-run and
will not change any module resources on disk.
 
Use the "make-sri" action to compute an integrity hash for upstreams that do not
publish one themselves. Add or update the urls foreign-resources.yaml as needed,
but omit (or leave empty) the "integrity" key. Then, run the "make-sri" action
for the module and copy the integrity into the file. Then, you can use "verify"
or "update" normally.
 
The "make-cdx" option generates a CycloneDX SBOM file.
TEXT
        );
        $this->addArg( 'action', 'One of "update", "verify", "make-sri" or "make-cdx"', true );
        $this->addArg( 'module', 'Name of a single module (Default: all)', false );
        $this->addOption( 'extension', 'Manage foreign resources for the given extension, instead of core',
            false, true );
        $this->addOption( 'skin', 'Manage foreign resources for the given skin, instead of core',
            false, true );
        $this->addOption( 'verbose', 'Be verbose', false, false, 'v' );
    }
 
    public function execute() {
        global $IP;
 
        $component = $this->getOption( 'extension' ) ?? $this->getOption( 'skin' ) ?? '#core';
        $foreignResourcesDirs = ExtensionRegistry::getInstance()->getAttribute( 'ForeignResourcesDir' )
            + [ '#core' => "{$IP}/resources/lib" ];
        if ( !array_key_exists( $component, $foreignResourcesDirs ) ) {
            $this->fatalError( "Unknown component: $component\n" );
        }
        $foreignResourcesFile = "{$foreignResourcesDirs[$component]}/foreign-resources.yaml";
 
        $frm = new ForeignResourceManager(
            $foreignResourcesFile,
            dirname( $foreignResourcesFile ),
            $this->output( ... ),
            $this->error( ... ),
            function ( $text ) {
                if ( $this->hasOption( 'verbose' ) ) {
                    $this->output( $text );
                }
            }
        );
 
        $action = $this->getArg( 0 );
        $module = $this->getArg( 1, 'all' );
 
        try {
            return $frm->run( $action, $module );
        } catch ( Exception $e ) {
            $this->fatalError( "Error: {$e->getMessage()}" );
        }
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = ManageForeignResources::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd