maintenance/manageForeignResources.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Maintenance
  20  */
  21
  22 require_once __DIR__ . '/Maintenance.php';
  23
  24 /**
  25  * Manage foreign resources registered with ResourceLoader.
  26  *
  27  * @ingroup Maintenance
  28  * @since 1.32
  29  */
  30 class ManageForeignResources extends Maintenance {
  31         public function __construct() {
  32                 parent::__construct();
  33                 $this->addDescription( <<<TEXT
  34 Manage foreign resources registered with ResourceLoader.
  35
  36 This helps developers with downloading, verifying, and updating local copies of upstream
  37 libraries registered as ResourceLoader modules. See resources/lib/foreign-resources.yaml.
  38
  39 Use the "update" action to download urls specified in foreign-resources.yaml, and unpack
  40 them to the resources directory. This will also verify them against the integrity hashes.
  41
  42 Use the "verify" action to verify the files currently in the resources directory match
  43 what "update" would replace them with. This is effectively a dry-run and will not change
  44 any module resources on disk.
  45
  46 Use the "make-sri" action to compute an integrity hash for upstreams that do not publish
  47 one themselves. Add or update the urls foreign-resources.yaml as needed, but omit (or
  48 leave empty) the "integrity" key. Then, run the "make-sri" action for the module and
  49 copy the integrity into the file. Then, you can use "verify" or "update" normally.
  50 TEXT
  51                 );
  52                 $this->addArg( 'action', 'One of "update", "verify" or "make-sri"', true );
  53                 $this->addArg( 'module', 'Name of a single module (Default: all)', false );
  54                 $this->addOption( 'verbose', 'Be verbose', false, false, 'v' );
  55         }
  56
  57         /**
  58          * @return bool
  59          * @throws Exception
  60          */
  61         public function execute() {
  62                 global $IP;
  63                 $frm = new ForeignResourceManager(
  64                          "{$IP}/resources/lib/foreign-resources.yaml",
  65                          "{$IP}/resources/lib",
  66                         function ( $text ) {
  67                                 $this->output( $text );
  68                         },
  69                         function ( $text ) {
  70                                 $this->error( $text );
  71                         },
  72                         function ( $text ) {
  73                                 if ( $this->hasOption( 'verbose' ) ) {
  74                                         $this->output( $text );
  75                                 }
  76                         }
  77                 );
  78
  79                 $action = $this->getArg( 0 );
  80                 $module = $this->getArg( 1, 'all' );
  81                 return $frm->run( $action, $module );
  82         }
  83 }
  84
  85 $maintClass = ManageForeignResources::class;
  86 require_once RUN_MAINTENANCE_IF_MAIN;