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
|
<?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 LogicException;
/**
* Loads the module definition from JSON files in the format that OOUI uses, converting it to the
* format we use. (Previously known as secret special sauce.)
*
* @since 1.26
*/
class OOUIImageModule extends ImageModule {
use OOUIModule;
protected function loadFromDefinition() {
if ( $this->definition === null ) {
// Do nothing if definition was already processed
return;
}
$themes = self::getSkinThemeMap();
// For backwards-compatibility, allow missing 'themeImages'
$module = $this->definition['themeImages'] ?? '';
$definition = [];
foreach ( $themes as $skin => $theme ) {
$data = $this->loadOOUIDefinition( $theme, $module );
if ( !$data ) {
// If there's no file for this module of this theme, that's okay, it will just use the defaults
continue;
}
// Convert into a definition compatible with the parent vanilla ImageModule
foreach ( $data as $key => $value ) {
switch ( $key ) {
// Images and color variants are defined per-theme, here converted to per-skin
case 'images':
case 'variants':
$definition[$key][$skin] = $value;
break;
// Other options must be identical for each theme (or only defined in the default one)
default:
if ( !isset( $definition[$key] ) ) {
$definition[$key] = $value;
} elseif ( $definition[$key] !== $value ) {
throw new LogicException(
"Mismatched OOUI theme images definition: " .
"key '$key' of theme '$theme' for module '$module' " .
"does not match other themes"
);
}
break;
}
}
}
// Extra selectors to allow using the same icons for old-style MediaWiki UI code
if ( str_starts_with( $module, 'icons' ) ) {
$definition['selectorWithoutVariant'] = '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before';
$definition['selectorWithVariant'] = '.oo-ui-image-{variant}.oo-ui-icon-{name}, ' .
'.mw-ui-icon-{name}-{variant}:before';
}
// Fields from module definition silently override keys from JSON files
$this->definition += $definition;
parent::loadFromDefinition();
}
/**
* Load the module definition from the JSON file(s) for the given theme and module.
*
* @since 1.34
* @param string $theme
* @param string $module
* @return array|false
* @suppress PhanTypeArraySuspiciousNullable
*/
protected function loadOOUIDefinition( $theme, $module ) {
// Find the path to the JSON file which contains the actual image definitions for this theme
if ( $module ) {
$dataPath = $this->getThemeImagesPath( $theme, $module );
} else {
// Backwards-compatibility for things that probably shouldn't have used this class...
$dataPath =
$this->definition['rootPath'] . '/' .
strtolower( $theme ) . '/' .
$this->definition['name'] . '.json';
}
return $this->readJSONFile( $dataPath );
}
/**
* Read JSON from a file, and transform all paths in it to be relative to the module's base path.
*
* @since 1.34
* @param string $dataPath Path relative to the module's base bath
* @return array|false
*/
protected function readJSONFile( $dataPath ) {
$localDataPath = $this->getLocalPath( $dataPath );
if ( !file_exists( $localDataPath ) ) {
return false;
}
$data = json_decode( file_get_contents( $localDataPath ), true );
// Expand the paths to images (since they are relative to the JSON file that defines them, not
// our base directory)
$fixPath = static function ( &$path ) use ( $dataPath ) {
if ( $dataPath instanceof FilePath ) {
$path = new FilePath(
dirname( $dataPath->getPath() ) . '/' . $path,
$dataPath->getLocalBasePath(),
$dataPath->getRemoteBasePath()
);
} else {
$path = dirname( $dataPath ) . '/' . $path;
}
};
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable
array_walk( $data['images'], static function ( &$value ) use ( $fixPath ) {
if ( is_string( $value['file'] ) ) {
$fixPath( $value['file'] );
} elseif ( is_array( $value['file'] ) ) {
array_walk_recursive( $value['file'], $fixPath );
}
} );
return $data;
}
}
|
