Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7425679
manageForeignResources.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
manageForeignResources.php
View Options
<?php
/**
* @license GPL-2.0-or-later
* @file
*/
use
MediaWiki\Maintenance\Maintenance
;
use
MediaWiki\Registration\ExtensionRegistry
;
use
MediaWiki\ResourceLoader\ForeignResourceManager
;
// @codeCoverageIgnoreStart
require_once
__DIR__
.
'/Maintenance.php'
;
// @codeCoverageIgnoreEnd
/**
* Manage foreign resources registered with ResourceLoader.
*
* This uses the MediaWiki\ResourceLoader\ForeignResourceManager class internally.
* See also ForeignResourceStructureTest, which runs the "verify" action in CI.
*
* @ingroup Maintenance
* @ingroup ResourceLoader
* @since 1.32
* @see https://www.mediawiki.org/wiki/Manual:ManageForeignResources.php
*/
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'
);
}
/**
* @return bool
*/
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
),
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()}"
);
}
}
}
// @codeCoverageIgnoreStart
$maintClass
=
ManageForeignResources
::
class
;
require_once
RUN_MAINTENANCE_IF_MAIN
;
// @codeCoverageIgnoreEnd
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 08:02 (1 h, 57 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
4e/36/a4bf2c3d7910aad929baf09ce95e
Default Alt Text
manageForeignResources.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment