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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
|
<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use function __;
use function file_exists;
use function file_get_contents;
use function filemtime;
use function filesize;
use function in_array;
use function is_array;
use function is_dir;
use function is_readable;
use function json_decode;
use function sprintf;
use function trigger_error;
use function trim;
use function version_compare;
use const DIRECTORY_SEPARATOR;
use const E_USER_ERROR;
/**
* handles theme
*
* @todo add the possibility to make a theme depend on another theme
* and by default on original
* @todo make all components optional - get missing components from 'parent' theme
*/
class Theme
{
/** @var string theme version */
public $version = '0.0.0.0';
/** @var string theme name */
public $name = '';
/** @var string theme id */
public $id = '';
/** @var string theme path */
public $path = '';
/** @var string file system theme path */
private $fsPath = '';
/** @var string image path as an URL */
public $imgPath = '';
/** @var string image path on the file-system */
public $imgPathFs = '';
/** @var int last modification time for info file */
public $mtimeInfo = 0;
/**
* needed because sometimes, the mtime for different themes
* is identical
*
* @var int filesize for info file
*/
public $filesizeInfo = 0;
/**
* Loads theme information
*/
public function loadInfo(): bool
{
$infofile = $this->getFsPath() . 'theme.json';
if (! @file_exists($infofile)) {
return false;
}
if ($this->mtimeInfo === filemtime($infofile)) {
return true;
}
$content = @file_get_contents($infofile);
if ($content === false) {
return false;
}
$data = json_decode($content, true);
// Did we get expected data?
if (! is_array($data)) {
return false;
}
// Check that all required data are there
$members = [
'name',
'version',
'supports',
];
foreach ($members as $member) {
if (! isset($data[$member])) {
return false;
}
}
// Version check
if (! is_array($data['supports'])) {
return false;
}
if (! in_array(Version::SERIES, $data['supports'])) {
return false;
}
$this->mtimeInfo = filemtime($infofile);
$this->filesizeInfo = filesize($infofile);
$this->setVersion($data['version']);
$this->setName($data['name']);
return true;
}
public static function load(string $themeUrl, string $themeFsPath, string $themeName): ?self
{
$theme = new self();
$theme->setPath($themeUrl);
$theme->setFsPath($themeFsPath);
if (! $theme->loadInfo()) {
return null;
}
$theme->checkImgPath();
$theme->setId($themeName);
return $theme;
}
/**
* checks image path for existence - if not found use img from fallback theme
*/
public function checkImgPath(): bool
{
// try current theme first
if (is_dir($this->getFsPath() . 'img' . DIRECTORY_SEPARATOR)) {
$this->setImgPath($this->getPath() . '/img/');
$this->setImgPathFs($this->getFsPath() . 'img' . DIRECTORY_SEPARATOR);
return true;
}
// try fallback theme
$fallbackFsPathThemeDir = ThemeManager::getThemesFsDir() . ThemeManager::FALLBACK_THEME
. DIRECTORY_SEPARATOR . 'img' . DIRECTORY_SEPARATOR;
if (is_dir($fallbackFsPathThemeDir)) {
$fallbackUrl = ThemeManager::getThemesDir() . ThemeManager::FALLBACK_THEME
. '/img/';
$this->setImgPath($fallbackUrl);
$this->setImgPathFs($fallbackFsPathThemeDir);
return true;
}
// we failed
trigger_error(
sprintf(
__('No valid image path for theme %s found!'),
$this->getName()
),
E_USER_ERROR
);
return false;
}
/**
* returns path to theme
*
* @return string path to theme
*/
public function getPath()
{
return $this->path;
}
/**
* returns file system path to the theme
*
* @return string file system path to theme
*/
public function getFsPath(): string
{
return $this->fsPath;
}
/**
* set path to theme
*
* @param string $path path to theme
*/
public function setPath($path): void
{
$this->path = trim($path);
}
/**
* set file system path to the theme
*
* @param string $path path to theme
*/
public function setFsPath(string $path): void
{
$this->fsPath = trim($path);
}
/**
* sets version
*
* @param string $version version to set
*/
public function setVersion($version): void
{
$this->version = trim($version);
}
/**
* returns version
*
* @return string version
*/
public function getVersion()
{
return $this->version;
}
/**
* checks theme version against $version
* returns true if theme version is equal or higher to $version
*
* @param string $version version to compare to
*/
public function checkVersion($version): bool
{
return version_compare($this->getVersion(), $version, 'lt');
}
/**
* sets name
*
* @param string $name name to set
*/
public function setName($name): void
{
$this->name = trim($name);
}
/**
* returns name
*
* @return string name
*/
public function getName()
{
return $this->name;
}
/**
* sets id
*
* @param string $id new id
*/
public function setId($id): void
{
$this->id = trim($id);
}
/**
* returns id
*
* @return string id
*/
public function getId()
{
return $this->id;
}
/**
* Sets path to images for the theme
*
* @param string $path path to images for this theme as an URL path
*/
public function setImgPath($path): void
{
$this->imgPath = $path;
}
/**
* Sets path to images for the theme
*
* @param string $path file-system path to images for this theme
*/
public function setImgPathFs(string $path): void
{
$this->imgPathFs = $path;
}
/**
* Returns the path to image for the theme.
* If filename is given, it possibly fallbacks to fallback
* theme for it if image does not exist.
*
* @param string $file file name for image
* @param string $fallback fallback image
*
* @return string image path for this theme
*/
public function getImgPath($file = null, $fallback = null)
{
if ($file === null) {
return $this->imgPath;
}
if (is_readable($this->imgPathFs . $file)) {
return $this->imgPath . $file;
}
if ($fallback !== null) {
return $this->getImgPath($fallback);
}
return './themes/' . ThemeManager::FALLBACK_THEME . '/img/' . $file;
}
}
|