archwiki/maintenance/manageForeignResources.php

91 lines
2.9 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
require_once __DIR__ . '/Maintenance.php';
/**
* Manage foreign resources registered with ResourceLoader.
*
* @ingroup Maintenance
* @since 1.32
*/
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 resources/lib/foreign-resources.yaml.
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.
TEXT
);
$this->addArg( 'action', 'One of "update", "verify" or "make-sri"', true );
$this->addArg( 'module', 'Name of a single module (Default: all)', false );
$this->addOption( 'verbose', 'Be verbose', false, false, 'v' );
}
/**
* @return bool
*/
public function execute() {
global $IP;
$frm = new ForeignResourceManager(
"{$IP}/resources/lib/foreign-resources.yaml",
"{$IP}/resources/lib",
function ( $text ) {
$this->output( $text );
},
function ( $text ) {
$this->error( $text );
},
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()}" );
}
}
}
$maintClass = ManageForeignResources::class;
require_once RUN_MAINTENANCE_IF_MAIN;