388 lines
7.9 KiB
PHP
388 lines
7.9 KiB
PHP
<?php
|
|
/* vim: set expandtab sw=4 ts=4 sts=4: */
|
|
/**
|
|
* hold Theme class
|
|
*
|
|
* @package PhpMyAdmin
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin;
|
|
|
|
use PhpMyAdmin\Template;
|
|
use PhpMyAdmin\ThemeManager;
|
|
use PhpMyAdmin\Url;
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @package PhpMyAdmin
|
|
*/
|
|
class Theme
|
|
{
|
|
/**
|
|
* @var string theme version
|
|
* @access protected
|
|
*/
|
|
public $version = '0.0.0.0';
|
|
|
|
/**
|
|
* @var string theme name
|
|
* @access protected
|
|
*/
|
|
public $name = '';
|
|
|
|
/**
|
|
* @var string theme id
|
|
* @access protected
|
|
*/
|
|
public $id = '';
|
|
|
|
/**
|
|
* @var string theme path
|
|
* @access protected
|
|
*/
|
|
public $path = '';
|
|
|
|
/**
|
|
* @var string image path
|
|
* @access protected
|
|
*/
|
|
public $img_path = '';
|
|
|
|
/**
|
|
* @var integer last modification time for info file
|
|
* @access protected
|
|
*/
|
|
public $mtime_info = 0;
|
|
|
|
/**
|
|
* needed because sometimes, the mtime for different themes
|
|
* is identical
|
|
* @var integer filesize for info file
|
|
* @access protected
|
|
*/
|
|
public $filesize_info = 0;
|
|
|
|
/**
|
|
* @var array List of css files to load
|
|
* @access private
|
|
*/
|
|
public $_cssFiles = [
|
|
'common',
|
|
'enum_editor',
|
|
'gis',
|
|
'navigation',
|
|
'designer',
|
|
'rte',
|
|
'codemirror',
|
|
'jqplot',
|
|
'resizable-menu',
|
|
'icons',
|
|
];
|
|
|
|
/**
|
|
* @var Template
|
|
*/
|
|
public $template;
|
|
|
|
/**
|
|
* Theme constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->template = new Template();
|
|
}
|
|
|
|
/**
|
|
* Loads theme information
|
|
*
|
|
* @return boolean whether loading them info was successful or not
|
|
* @access public
|
|
*/
|
|
public function loadInfo()
|
|
{
|
|
$infofile = $this->getPath() . '/theme.json';
|
|
if (! @file_exists($infofile)) {
|
|
return false;
|
|
}
|
|
|
|
if ($this->mtime_info === 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(PMA_MAJOR_VERSION, $data['supports'])) {
|
|
return false;
|
|
}
|
|
|
|
$this->mtime_info = filemtime($infofile);
|
|
$this->filesize_info = filesize($infofile);
|
|
|
|
$this->setVersion($data['version']);
|
|
$this->setName($data['name']);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* returns theme object loaded from given folder
|
|
* or false if theme is invalid
|
|
*
|
|
* @param string $folder path to theme
|
|
*
|
|
* @return Theme|false
|
|
* @static
|
|
* @access public
|
|
*/
|
|
public static function load($folder)
|
|
{
|
|
$theme = new Theme();
|
|
|
|
$theme->setPath($folder);
|
|
|
|
if (! $theme->loadInfo()) {
|
|
return false;
|
|
}
|
|
|
|
$theme->checkImgPath();
|
|
|
|
return $theme;
|
|
}
|
|
|
|
/**
|
|
* checks image path for existence - if not found use img from fallback theme
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
public function checkImgPath()
|
|
{
|
|
// try current theme first
|
|
if (is_dir($this->getPath() . '/img/')) {
|
|
$this->setImgPath($this->getPath() . '/img/');
|
|
return true;
|
|
}
|
|
|
|
// try fallback theme
|
|
$fallback = './themes/' . ThemeManager::FALLBACK_THEME . '/img/';
|
|
if (is_dir($fallback)) {
|
|
$this->setImgPath($fallback);
|
|
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
|
|
*
|
|
* @access public
|
|
* @return string path to theme
|
|
*/
|
|
public function getPath()
|
|
{
|
|
return $this->path;
|
|
}
|
|
|
|
/**
|
|
* set path to theme
|
|
*
|
|
* @param string $path path to theme
|
|
*
|
|
* @return void
|
|
* @access public
|
|
*/
|
|
public function setPath($path)
|
|
{
|
|
$this->path = trim($path);
|
|
}
|
|
|
|
/**
|
|
* sets version
|
|
*
|
|
* @param string $version version to set
|
|
*
|
|
* @return void
|
|
* @access public
|
|
*/
|
|
public function setVersion($version)
|
|
{
|
|
$this->version = trim($version);
|
|
}
|
|
|
|
/**
|
|
* returns version
|
|
*
|
|
* @return string version
|
|
* @access public
|
|
*/
|
|
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
|
|
*
|
|
* @return boolean true if theme version is equal or higher to $version
|
|
* @access public
|
|
*/
|
|
public function checkVersion($version)
|
|
{
|
|
return version_compare($this->getVersion(), $version, 'lt');
|
|
}
|
|
|
|
/**
|
|
* sets name
|
|
*
|
|
* @param string $name name to set
|
|
*
|
|
* @return void
|
|
* @access public
|
|
*/
|
|
public function setName($name)
|
|
{
|
|
$this->name = trim($name);
|
|
}
|
|
|
|
/**
|
|
* returns name
|
|
*
|
|
* @access public
|
|
* @return string name
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* sets id
|
|
*
|
|
* @param string $id new id
|
|
*
|
|
* @return void
|
|
* @access public
|
|
*/
|
|
public function setId($id)
|
|
{
|
|
$this->id = trim($id);
|
|
}
|
|
|
|
/**
|
|
* returns id
|
|
*
|
|
* @return string id
|
|
* @access public
|
|
*/
|
|
public function getId()
|
|
{
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Sets path to images for the theme
|
|
*
|
|
* @param string $path path to images for this theme
|
|
*
|
|
* @return void
|
|
* @access public
|
|
*/
|
|
public function setImgPath($path)
|
|
{
|
|
$this->img_path = $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
|
|
*
|
|
* @access public
|
|
* @return string image path for this theme
|
|
*/
|
|
public function getImgPath($file = null, $fallback = null)
|
|
{
|
|
if (is_null($file)) {
|
|
return $this->img_path;
|
|
}
|
|
|
|
if (is_readable($this->img_path . $file)) {
|
|
return $this->img_path . $file;
|
|
}
|
|
|
|
if (! is_null($fallback)) {
|
|
return $this->getImgPath($fallback);
|
|
}
|
|
|
|
return './themes/' . ThemeManager::FALLBACK_THEME . '/img/' . $file;
|
|
}
|
|
|
|
/**
|
|
* Renders the preview for this theme
|
|
*
|
|
* @return string
|
|
* @access public
|
|
*/
|
|
public function getPrintPreview()
|
|
{
|
|
$url_params = ['set_theme' => $this->getId()];
|
|
$screen = null;
|
|
$path = $this->getPath() . '/screen.png';
|
|
if (@file_exists($path)) {
|
|
$screen = $path;
|
|
}
|
|
|
|
return $this->template->render('theme_preview', [
|
|
'url_params' => $url_params,
|
|
'name' => $this->getName(),
|
|
'version' => $this->getVersion(),
|
|
'id' => $this->getId(),
|
|
'screen' => $screen,
|
|
]);
|
|
}
|
|
}
|
