1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
<?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
*/
namespace MediaWiki\ResourceLoader;
use InvalidArgumentException;
use MediaWiki\Registration\ExtensionRegistry;
/**
* Convenience methods for dealing with OOUI themes and their relations to MW skins.
*
* @ingroup ResourceLoader
* @internal
*/
trait OOUIModule {
/** @var string[] */
protected static $knownScriptsModules = [ 'core' ];
/** @var string[] */
protected static $knownStylesModules = [ 'core', 'widgets', 'toolbars', 'windows' ];
/** @var string[] */
protected static $knownImagesModules = [
'indicators',
// Extra icons
'icons-accessibility',
'icons-alerts',
'icons-content',
'icons-editing-advanced',
'icons-editing-citation',
'icons-editing-functions',
'icons-editing-core',
'icons-editing-list',
'icons-editing-styling',
'icons-interactions',
'icons-layout',
'icons-location',
'icons-media',
'icons-moderation',
'icons-movement',
'icons-user',
'icons-wikimedia',
];
/** @var string[] Note that keys must be lowercase, values TitleCase. */
protected static $builtinSkinThemeMap = [
'default' => 'WikimediaUI',
];
/** @var string[][] Note that keys must be TitleCase. */
protected static $builtinThemePaths = [
'WikimediaUI' => [
'scripts' => 'resources/lib/ooui/oojs-ui-wikimediaui.js',
'styles' => 'resources/lib/ooui/oojs-ui-{module}-wikimediaui.css',
'images' => 'resources/lib/ooui/themes/wikimediaui/{module}.json',
],
'Apex' => [
'scripts' => 'resources/lib/ooui/oojs-ui-apex.js',
'styles' => 'resources/lib/ooui/oojs-ui-{module}-apex.css',
'images' => 'resources/lib/ooui/themes/apex/{module}.json',
],
];
/**
* Return a map of skin names (in lowercase) to OOUI theme names, defining which theme a given
* skin should use.
*
* @return array
*/
public static function getSkinThemeMap() {
$themeMap = self::$builtinSkinThemeMap;
$themeMap += ExtensionRegistry::getInstance()->getAttribute( 'SkinOOUIThemes' );
return $themeMap;
}
/**
* Return a map of theme names to lists of paths from which a given theme should be loaded.
*
* Keys are theme names, values are associative arrays. Keys of the inner array are 'scripts',
* 'styles', or 'images', and values are paths. Paths may be strings or FilePaths.
*
* Additionally, the string '{module}' in paths represents the name of the module to load.
*
* @return array
*/
protected static function getThemePaths() {
$themePaths = self::$builtinThemePaths;
$themePaths += ExtensionRegistry::getInstance()->getAttribute( 'OOUIThemePaths' );
[ $defaultLocalBasePath, $defaultRemoteBasePath ] =
FileModule::extractBasePaths();
// Allow custom themes' paths to be relative to the skin/extension that defines them,
// like with ResourceModuleSkinStyles
foreach ( $themePaths as &$paths ) {
[ $localBasePath, $remoteBasePath ] =
FileModule::extractBasePaths( $paths );
if ( $localBasePath !== $defaultLocalBasePath || $remoteBasePath !== $defaultRemoteBasePath ) {
foreach ( $paths as &$path ) {
$path = new FilePath( $path, $localBasePath, $remoteBasePath );
}
}
}
return $themePaths;
}
/**
* Return a path to load given module of given theme from.
*
* The file at this path may not exist. This should be handled by the caller (throwing an error or
* falling back to default theme).
*
* @param string $theme OOUI theme name, for example 'WikimediaUI' or 'Apex'
* @param string $kind Kind of the module: 'scripts', 'styles', or 'images'
* @param string $module Module name, for valid values see $knownScriptsModules,
* $knownStylesModules, $knownImagesModules
* @return string|FilePath
*/
protected function getThemePath( $theme, $kind, $module ) {
$paths = self::getThemePaths();
$path = $paths[$theme][$kind];
if ( $path instanceof FilePath ) {
$path = new FilePath(
str_replace( '{module}', $module, $path->getPath() ),
$path->getLocalBasePath(),
$path->getRemoteBasePath()
);
} else {
$path = str_replace( '{module}', $module, $path );
}
return $path;
}
/**
* @param string $theme See getThemePath()
* @param string $module See getThemePath()
* @return string|FilePath
*/
protected function getThemeScriptsPath( $theme, $module ) {
if ( !in_array( $module, self::$knownScriptsModules ) ) {
throw new InvalidArgumentException( "Invalid OOUI scripts module '$module'" );
}
return $this->getThemePath( $theme, 'scripts', $module );
}
/**
* @param string $theme See getThemePath()
* @param string $module See getThemePath()
* @return string|FilePath
*/
protected function getThemeStylesPath( $theme, $module ) {
if ( !in_array( $module, self::$knownStylesModules ) ) {
throw new InvalidArgumentException( "Invalid OOUI styles module '$module'" );
}
return $this->getThemePath( $theme, 'styles', $module );
}
/**
* @param string $theme See getThemePath()
* @param string $module See getThemePath()
* @return string|FilePath
*/
protected function getThemeImagesPath( $theme, $module ) {
if ( !in_array( $module, self::$knownImagesModules ) ) {
throw new InvalidArgumentException( "Invalid OOUI images module '$module'" );
}
return $this->getThemePath( $theme, 'images', $module );
}
}
|
