Merge pull request #1317 from ArthurHoaro/feature/default-colors

Plugin to override default template colors

5 files changed, 141 insertions, 0 deletions

diff --git a/plugins/default_colors/default_colors.css.template b/plugins/default_colors/default_colors.css.template
new file mode 100644
index 00000000..87e22a08
--- /dev/null
+++ b/plugins/default_colors/default_colors.css.template
@@ -0,0 +1,3 @@
+:root {
+%s
+}
diff --git a/plugins/default_colors/default_colors.meta b/plugins/default_colors/default_colors.meta
new file mode 100644
index 00000000..108962c6
--- /dev/null
+++ b/plugins/default_colors/default_colors.meta
@@ -0,0 +1,5 @@
+description="Override default theme colors. Use any CSS valid color."
+parameters="DEFAULT_COLORS_MAIN;DEFAULT_COLORS_BACKGROUND;DEFAULT_COLORS_DARK_MAIN"
+parameter.DEFAULT_COLORS_MAIN="Main color (navbar green)"
+parameter.DEFAULT_COLORS_BACKGROUND="Background color (light grey)"
+parameter.DEFAULT_COLORS_DARK_MAIN="Dark main color (e.g. visited links)"
diff --git a/plugins/default_colors/default_colors.php b/plugins/default_colors/default_colors.php
new file mode 100644
index 00000000..1928cc9f
--- /dev/null
+++ b/plugins/default_colors/default_colors.php
@@ -0,0 +1,111 @@
+<?php
+
+/**
+ * Plugin default_colors.
+ *
+ * Allow users to easily overrides colors of the default theme.
+ */
+
+use Shaarli\Config\ConfigManager;
+use Shaarli\Plugin\PluginManager;
+
+const DEFAULT_COLORS_PLACEHOLDERS = [
+    'DEFAULT_COLORS_MAIN',
+    'DEFAULT_COLORS_BACKGROUND',
+    'DEFAULT_COLORS_DARK_MAIN',
+];
+
+/**
+ * Display an error if the plugin is active a no color is configured.
+ *
+ * @param $conf ConfigManager instance
+ *
+ * @return array|null The errors array or null of there is none.
+ */
+function default_colors_init($conf)
+{
+    $params = '';
+    foreach (DEFAULT_COLORS_PLACEHOLDERS as $placeholder) {
+        $params .= trim($conf->get('plugins.'. $placeholder, ''));
+    }
+
+    if (empty($params)) {
+        $error = t('Default colors plugin error: '.
+            'This plugin is active and no custom color is configured.');
+        return array($error);
+    }
+}
+
+/**
+ * When plugin parameters are saved, we regenerate the custom CSS file with provided settings.
+ *
+ * @param array $data $_POST array
+ *
+ * @return array Updated $_POST array
+ */
+function hook_default_colors_save_plugin_parameters($data)
+{
+    $file = PluginManager::$PLUGINS_PATH . '/default_colors/default_colors.css';
+    $template = file_get_contents(PluginManager::$PLUGINS_PATH . '/default_colors/default_colors.css.template');
+    $content = '';
+    foreach (DEFAULT_COLORS_PLACEHOLDERS as $rule) {
+        $content .= ! empty($data[$rule])
+            ? default_colors_format_css_rule($data, $rule) .';'. PHP_EOL
+            : '';
+    }
+
+    if (! empty($content)) {
+        file_put_contents($file, sprintf($template, $content));
+    }
+
+    return $data;
+}
+
+/**
+ * When linklist is displayed, include default_colors CSS file.
+ *
+ * @param array $data - header data.
+ *
+ * @return mixed - header data with default_colors CSS file added.
+ */
+function hook_default_colors_render_includes($data)
+{
+    $file = PluginManager::$PLUGINS_PATH . '/default_colors/default_colors.css';
+    if (file_exists($file )) {
+        $data['css_files'][] = $file ;
+    }
+
+    return $data;
+}
+
+/**
+ * Create a valid CSS rule from parameters settings and plugin parameter.
+ *
+ * @param array  $data      $_POST array
+ * @param string $parameter Plugin parameter name
+ *
+ * @return string CSS rules for the provided parameter and its matching value.
+ */
+function default_colors_format_css_rule($data, $parameter)
+{
+    if (empty($data[$parameter])) {
+        return '';
+    }
+
+    $key = str_replace('DEFAULT_COLORS_', '', $parameter);
+    $key = str_replace('_', '-', strtolower($key)) .'-color';
+    return '  --'. $key .': '. $data[$parameter];
+}
+
+
+/**
+ * This function is never called, but contains translation calls for GNU gettext extraction.
+ */
+function default_colors_translation()
+{
+    // meta
+    t('Override default theme colors. Use any CSS valid color.');
+    t('Main color (navbar green)');
+    t('Background color (light grey)');
+    t('Dark main color (e.g. visited links)');
+}
diff --git a/plugins/demo_plugin/demo_plugin.meta b/plugins/demo_plugin/demo_plugin.meta
index b063ecb7..cd616441 100644
--- a/plugins/demo_plugin/demo_plugin.meta
+++ b/plugins/demo_plugin/demo_plugin.meta
@@ -1 +1,4 @@
 description="A demo plugin covering all use cases for template designers and plugin developers."
+parameters="DEMO_PLUGIN_PARAMETER;DEMO_PLUGIN_OTHER_PARAMETER"
+parameter.DEMO_PLUGIN_PARAMETER="This is a parameter dedicated to the demo plugin. It'll be suffixed."
+parameter.DEMO_PLUGIN_OTHER_PARAMETER="Other demo parameter"
diff --git a/plugins/demo_plugin/demo_plugin.php b/plugins/demo_plugin/demo_plugin.php
index 95ea7fe2..71ba7495 100644
--- a/plugins/demo_plugin/demo_plugin.php
+++ b/plugins/demo_plugin/demo_plugin.php
@@ -457,10 +457,29 @@ function hook_demo_plugin_render_feed($data)
 }
 
 /**
+ * When plugin parameters are saved.
+ *
+ * @param array $data $_POST array
+ *
+ * @return array Updated $_POST array
+ */
+function hook_demo_plugin_save_plugin_parameters($data)
+{
+    // Here we edit the provided value, but we can use this to generate config files, etc.
+    if (! empty($data['DEMO_PLUGIN_PARAMETER']) && ! endsWith($data['DEMO_PLUGIN_PARAMETER'], '_SUFFIX')) {
+        $data['DEMO_PLUGIN_PARAMETER'] .= '_SUFFIX';
+    }
+
+    return $data;
+}
+
+/**
  * This function is never called, but contains translation calls for GNU gettext extraction.
  */
 function demo_dummy_translation()
 {
     // meta
     t('A demo plugin covering all use cases for template designers and plugin developers.');
+    t('This is a parameter dedicated to the demo plugin. It\'ll be suffixed.');
+    t('Other demo parameter');
 }