opensourcemirror
/
dokuwiki
mirror of https://github.com/splitbrain/dokuwiki.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Use config cascade for style.ini files 

This simplifies style loading and allows the plugins like farmer to
extend the the loading of style files. Also adds some first unit tests.

Originally discussed in FS#2703 and #134

Squashed commit of the following:

commit 5ed550f6ba61a1d475b7572cbff18f0d790c78c2
Merge: 0cefed65e cab1833b0
Author: Andreas Gohr <gohr@cosmocode.de>
Date:   Thu Feb 28 13:38:46 2019 +0100

    Merge branch 'styleConfCascade' of https://github.com/annda/dokuwiki into annda-styleConfCascade

    * 'styleConfCascade' of https://github.com/annda/dokuwiki:
      Clean up StyleUtils
      Update StyleUtils test
      Fix array to boolean conversion
      Use better placeholder string in config cascade
      Calls to StyleUtils use the new constructor
      Add test for StyleUtils
      Refactor StyleUtils
      WIP add temporary test comparing two implementations of StyleUtils
      WIP add new style config cascade side by side with the old one

commit cab1833b09
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 17:54:27 2019 +0100

    Clean up StyleUtils

commit 766e3907cf
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 17:51:15 2019 +0100

    Update StyleUtils test

commit f5c08787dd
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 12:51:53 2019 +0100

    Fix array to boolean conversion

commit c967169899
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 12:38:55 2019 +0100

    Use better placeholder string in config cascade

commit 4845eff54d
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 12:24:16 2019 +0100

    Calls to StyleUtils use the new constructor

commit 7a6337a8f8
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 12:22:44 2019 +0100

    Add test for StyleUtils

commit 5ae9e8f69e
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Thu Feb 21 12:16:57 2019 +0100

    Refactor StyleUtils

commit a2adcc9f37
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Sat Feb 16 23:58:04 2019 +0100

    WIP add temporary test comparing two implementations of StyleUtils

commit 845c40c4fa
Author: Anna Dabrowska <dabrowska@cosmocode.de>
Date:   Sat Feb 16 23:59:41 2019 +0100

    WIP add new style config cascade side by side with the old one
This commit is contained in:
Anna Dabrowska 2019-02-28 13:45:19 +01:00 committed by Andreas Gohr
parent 0cefed65e6
commit 4593dbd285
10 changed files with 196 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_test/conf/tpl/dokuwiki/css/_tests.less Normal file
View File

@ -0,0 +1 @@
/* dummy file */

7
_test/conf/tpl/dokuwiki/style.ini Normal file
View File

@ -0,0 +1,7 @@
[stylesheets]
css/_tests.less = screen
[replacements]
__background__ = "#f2ecec"
__custom_variable__ = "#5e4040"
__custom_variable_two__ = "url(test/foo.png)"

38
_test/tests/inc/styleutils_cssstyleini.test.php Normal file
View File

@ -0,0 +1,38 @@
<?php
class styleutils_cssstyleini_test extends DokuWikiTest {
function test_mergedstyleini() {
$util = new \dokuwiki\StyleUtils('dokuwiki', false, true);
$expected = array (
'stylesheets' =>
array (
'screen' =>
array (
DOKU_CONF . 'tpl/dokuwiki/css/_tests.less' => '/./',
DOKU_INC . 'lib/tpl/dokuwiki/css/content.less' => '/./lib/tpl/dokuwiki/',
),
),
'replacements' =>
array (
'__text__' => '#333',
'__background__' => '#f2ecec',
'__custom_variable__' => '#5e4040',
'__custom_variable_two__' => 'url(' . DOKU_BASE . 'test/foo.png)',
),
);
$actual = $util->cssStyleini();
// check that all stylesheet levels are present
$this->assertArrayHasKey('all', $actual['stylesheets']);
$this->assertArrayHasKey('print', $actual['stylesheets']);
// check an original stylesheet and an additional one
$this->assertArraySubset($expected['stylesheets']['screen'], $actual['stylesheets']['screen']);
// merged config has an original value (text), an overridden value (background) and a new custom replacement (custom_variable)
$this->assertArraySubset($expected['replacements'], $actual['replacements']);
}
}

2
inc/Manifest.php
View File

@ -29,7 +29,7 @@ class Manifest
}
$styleUtil = new \dokuwiki\StyleUtils();
$styleIni = $styleUtil->cssStyleini($conf['template']);
$styleIni = $styleUtil->cssStyleini();
$replacements = $styleIni['replacements'];
if (empty($manifest['background_color'])) {

212
inc/StyleUtils.php
View File

@ -4,6 +4,43 @@ namespace dokuwiki;
class StyleUtils
{
/** @var string current template */
protected $tpl;
/** @var bool reinitialize styles config */
protected $reinit;
/** @var bool $preview preview mode */
protected $preview;
/** @var array default replacements to be merged with custom style configs */
protected $defaultReplacements = array(
'__text__' => "#000",
'__background__' => "#fff",
'__text_alt__' => "#999",
'__background_alt__' => "#eee",
'__text_neu__' => "#666",
'__background_neu__' => "#ddd",
'__border__' => "#ccc",
'__highlight__' => "#ff9",
'__link__' => "#00f",
);
/**
* StyleUtils constructor.
* @param string $tpl template name: if not passed as argument, the default value from $conf will be used
* @param bool $preview
* @param bool $reinit whether static style conf should be reinitialized
*/
public function __construct($tpl = '', $preview = false, $reinit = false)
{
if (!$tpl) {
global $conf;
$tpl = $conf['conf'];
}
$this->tpl = $tpl;
$this->reinit = $reinit;
$this->preview = $preview;
}
/**
* Load style ini contents
*
@ -11,94 +48,118 @@ class StyleUtils
* the stylesheet modes
*
* @author Andreas Gohr <andi@splitbrain.org>
* @author Anna Dabrowska <info@cosmocode.de>
*
* @param string $tpl the used template
* @param bool $preview load preview replacements
* @return array with keys 'stylesheets' and 'replacements'
*/
public function cssStyleini($tpl, $preview=false) {
global $conf;
$stylesheets = array(); // mode, file => base
// guaranteed placeholder => value
$replacements = array(
'__text__' => "#000",
'__background__' => "#fff",
'__text_alt__' => "#999",
'__background_alt__' => "#eee",
'__text_neu__' => "#666",
'__background_neu__' => "#ddd",
'__border__' => "#ccc",
'__highlight__' => "#ff9",
'__link__' => "#00f",
);
// load template's style.ini
$incbase = tpl_incdir($tpl);
$webbase = tpl_basedir($tpl);
$ini = $incbase.'style.ini';
if(file_exists($ini)){
$data = parse_ini_file($ini, true);
// stylesheets
if(is_array($data['stylesheets'])) foreach($data['stylesheets'] as $file => $mode){
if (!file_exists($incbase . $file)) {
list($extension, $basename) = array_map('strrev', explode('.', strrev($file), 2));
$newExtension = $extension === 'css' ? 'less' : 'css';
if (file_exists($incbase . $basename . '.' . $newExtension)) {
$stylesheets[$mode][$incbase . $basename . '.' . $newExtension] = $webbase;
if ($conf['allowdebug']) {
msg("Stylesheet $file not found, using $basename.$newExtension instead. Please contact developer of \"{$conf['template']}\" template.", 2);
}
continue;
}
}
$stylesheets[$mode][$incbase . $file] = $webbase;
}
// replacements
if(is_array($data['replacements'])){
$replacements = array_merge($replacements, $this->cssFixreplacementurls($data['replacements'],$webbase));
}
public function cssStyleini()
{
static $combined = [];
if (!empty($combined) && !$this->reinit) {
return $combined;
}
// load configs's style.ini
$webbase = DOKU_BASE;
$ini = DOKU_CONF."tpl/$tpl/style.ini";
$incbase = dirname($ini).'/';
if(file_exists($ini)){
$data = parse_ini_file($ini, true);
global $conf;
global $config_cascade;
$stylesheets = array(); // mode, file => base
// stylesheets
if(isset($data['stylesheets']) && is_array($data['stylesheets'])) foreach($data['stylesheets'] as $file => $mode){
$stylesheets[$mode][$incbase.$file] = $webbase;
}
// guaranteed placeholder => value
$replacements = $this->defaultReplacements;
// replacements
if(isset($data['replacements']) && is_array($data['replacements'])){
$replacements = array_merge($replacements, $this->cssFixreplacementurls($data['replacements'],$webbase));
}
// merge all styles from config cascade
if (!is_array($config_cascade['styleini'])) {
trigger_error('Missing config cascade for styleini', E_USER_WARNING);
}
// allow replacement overwrites in preview mode
if($preview) {
$webbase = DOKU_BASE;
$ini = $conf['cachedir'].'/preview.ini';
if(file_exists($ini)) {
$data = parse_ini_file($ini, true);
// replacements
if(is_array($data['replacements'])) {
$replacements = array_merge($replacements, $this->cssFixreplacementurls($data['replacements'], $webbase));
if ($this->preview) {
$config_cascade['styleini']['local'][] = $conf['cachedir'] . '/preview.ini';
}
$combined['stylesheets'] = [];
$combined['replacements'] = [];
foreach (array('default', 'local', 'protected') as $config_group) {
if (empty($config_cascade['styleini'][$config_group])) continue;
// set proper server dirs
$webbase = $this->getWebbase($config_group);
foreach ($config_cascade['styleini'][$config_group] as $inifile) {
// replace the placeholder with the name of the current template
$inifile = str_replace('%TEMPLATE%', $this->tpl, $inifile);
$incbase = dirname($inifile) . '/';
if (file_exists($inifile)) {
$config = parse_ini_file($inifile, true);
if (is_array($config['stylesheets'])) {
foreach ($config['stylesheets'] as $inifile => $mode) {
// validate and include style files
$stylesheets = array_merge($stylesheets, $this->getValidatedStyles($stylesheets, $inifile, $mode, $incbase, $webbase));
$combined['stylesheets'] = array_merge($combined['stylesheets'], $stylesheets);
}
}
if (is_array($config['replacements'])) {
$replacements = array_replace($replacements, $this->cssFixreplacementurls($config['replacements'], $webbase));
$combined['replacements'] = array_merge($combined['replacements'], $replacements);
}
}
}
}
return array(
'stylesheets' => $stylesheets,
'replacements' => $replacements
);
return $combined;
}
/**
* Checks if configured style files exist and, if necessary, adjusts file extensions in config
*
* @param array $stylesheets
* @param string $file
* @param string $mode
* @param string $incbase
* @param string $webbase
* @return mixed
*/
protected function getValidatedStyles($stylesheets, $file, $mode, $incbase, $webbase)
{
global $conf;
if (!file_exists($incbase . $file)) {
list($extension, $basename) = array_map('strrev', explode('.', strrev($file), 2));
$newExtension = $extension === 'css' ? 'less' : 'css';
if (file_exists($incbase . $basename . '.' . $newExtension)) {
$stylesheets[$mode][$incbase . $basename . '.' . $newExtension] = $webbase;
if ($conf['allowdebug']) {
msg("Stylesheet $file not found, using $basename.$newExtension instead. Please contact developer of \"$this->tpl\" template.", 2);
}
} elseif ($conf['allowdebug']) {
msg("Stylesheet $file not found, please contact the developer of \"$this->tpl\" template.", 2);
}
}
$stylesheets[$mode][fullpath($incbase . $file)] = $webbase;
return $stylesheets;
}
/**
* Returns the web base path for the given level/group in config cascade.
* Style resources are relative to the template directory for the main (default) styles
* but relative to DOKU_BASE for everything else"
*
* @param string $config_group
* @return string
*/
protected function getWebbase($config_group)
{
if ($config_group === 'default') {
return tpl_basedir($this->tpl);
} else {
return DOKU_BASE;
}
}
/**
* Amend paths used in replacement relative urls, refer FS#2879
@ -109,9 +170,10 @@ class StyleUtils
* @param string $location
* @return array
*/
protected function cssFixreplacementurls($replacements, $location) {
foreach($replacements as $key => $value) {
$replacements[$key] = preg_replace('#(url\([ \'"]*)(?!/|data:|http://|https://| |\'|")#','\\1'.$location,$value);
protected function cssFixreplacementurls($replacements, $location)
{
foreach ($replacements as $key => $value) {
$replacements[$key] = preg_replace('#(url\([ \'"]*)(?!/|data:|http://|https://| |\'|")#', '\\1' . $location, $value);
}
return $replacements;
}

4
inc/config_cascade.php
View File

@ -61,6 +61,10 @@ $config_cascade = array_merge(
'userscript' => array(
'default' => array(DOKU_CONF . 'userscript.js')
),
'styleini' => array(
'default' => array(DOKU_INC . 'lib/tpl/%TEMPLATE%/' . 'style.ini'),
'local' => array(DOKU_CONF . 'tpl/%TEMPLATE%/' . 'style.ini')
),
'acl' => array(
'default' => DOKU_CONF . 'acl.auth.php',
),

2
inc/template.php
View File

@ -247,7 +247,7 @@ function tpl_metaheaders($alt = true) {
}
$styleUtil = new \dokuwiki\StyleUtils();
$styleIni = $styleUtil->cssStyleini($conf['template']);
$styleIni = $styleUtil->cssStyleini();
$replacements = $styleIni['replacements'];
if (!empty($replacements['__theme_color__'])) {
$head['meta'][] = array('name' => 'theme-color', 'content' => $replacements['__theme_color__']);

4
lib/exe/css.php
View File

@ -45,8 +45,8 @@ function css_out(){
if(!$tpl) $tpl = $conf['template'];
// load style.ini
$styleUtil = new \dokuwiki\StyleUtils();
$styleini = $styleUtil->cssStyleini($tpl, $INPUT->bool('preview'));
$styleUtil = new \dokuwiki\StyleUtils($tpl, $INPUT->bool('preview'));
$styleini = $styleUtil->cssStyleini();
// cache influencers
$tplinc = tpl_incdir($tpl);

4
lib/plugins/styling/admin.php
View File

@ -58,8 +58,8 @@ class admin_plugin_styling extends DokuWiki_Admin_Plugin {
global $conf;
global $ID;
$styleUtil = new \dokuwiki\StyleUtils();
$styleini = $styleUtil->cssStyleini($conf['template'], true);
$styleUtil = new \dokuwiki\StyleUtils($conf['template'], true);
$styleini = $styleUtil->cssStyleini();
$replacements = $styleini['replacements'];
if($this->ispopup) {

6
lib/tpl/index.php
View File

@ -46,10 +46,10 @@ require_once(DOKU_INC.'inc/init.php');
// get merged style.ini
define('SIMPLE_TEST', true); // hack to prevent css output and headers
require_once(DOKU_INC.'lib/exe/css.php');
$styleUtils = new \dokuwiki\StyleUtils();
$ini = $styleUtils->cssStyleini($conf['template']);
$styleUtils = new \dokuwiki\StyleUtils($conf['template']);
$ini = $styleUtils->cssStyleini();
if ($ini) {
if (!empty($ini)) {
echo '<table>';
echo "<caption>".hsc($conf['template'])."'s style.ini</caption>";
foreach($ini['replacements'] as $key => $val){