Subversion Repositories oidplus

Rev

Rev 1267 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. <?php
  2.  
  3. /*
  4.  * OIDplus 2.0
  5.  * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
  6.  *
  7.  * Licensed under the Apache License, Version 2.0 (the "License");
  8.  * you may not use this file except in compliance with the License.
  9.  * You may obtain a copy of the License at
  10.  *
  11.  *     http://www.apache.org/licenses/LICENSE-2.0
  12.  *
  13.  * Unless required by applicable law or agreed to in writing, software
  14.  * distributed under the License is distributed on an "AS IS" BASIS,
  15.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16.  * See the License for the specific language governing permissions and
  17.  * limitations under the License.
  18.  */
  19.  
  20. namespace ViaThinkSoft\OIDplus;
  21.  
  22. // phpcs:disable PSR1.Files.SideEffects
  23. \defined('INSIDE_OIDPLUS') or die;
  24. // phpcs:enable PSR1.Files.SideEffects
  25.  
  26. class OIDplusPageAdminColors extends OIDplusPagePluginAdmin
  27.         implements INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_1 /* oobeEntry, oobeRequested */
  28. {
  29.  
  30.         /**
  31.          * @param array $head_elems
  32.          * @return void
  33.          * @throws OIDplusException
  34.          */
  35.         public function htmlHeaderUpdate(array &$head_elems) {
  36.                 foreach ($head_elems as &$line) {
  37.                         if (strpos($line,'oidplus.min.css.php') !== false) {
  38.                                 $add_css_args = array();
  39.                                 $add_css_args[] = 'theme='.urlencode(OIDplus::config()->getValue('design','default'));
  40.                                 $add_css_args[] = 'invert='.urlencode(OIDplus::config()->getValue('color_invert',0));
  41.                                 $add_css_args[] = 'h_shift='.urlencode(number_format(OIDplus::config()->getValue('color_hue_shift',0)/360,5,'.',''));
  42.                                 $add_css_args[] = 's_shift='.urlencode(number_format(OIDplus::config()->getValue('color_sat_shift',0)/100,5,'.',''));
  43.                                 $add_css_args[] = 'v_shift='.urlencode(number_format(OIDplus::config()->getValue('color_val_shift',0)/100,5,'.',''));
  44.                                 if (count($add_css_args) > 0) {
  45.                                         $line = str_replace('oidplus.min.css.php?', 'oidplus.min.css.php&', $line);
  46.                                         $line = str_replace('oidplus.min.css.php', 'oidplus.min.css.php?'.htmlentities(implode('&',$add_css_args)), $line);
  47.                                 }
  48.                         }
  49.  
  50.                         if ((stripos($line,'<meta') !== false) && (stripos($line,'name="theme-color"') !== false)) {
  51.                                 if (preg_match('@content="(.+)"@ismU', $line, $m)) {
  52.                                         $theme_color = $m[1];
  53.                                         $hs = OIDplus::config()->getValue('color_hue_shift',0)/360;
  54.                                         $ss = OIDplus::config()->getValue('color_sat_shift',0)/100;
  55.                                         $vs = OIDplus::config()->getValue('color_val_shift',0)/100;
  56.                                         $theme_color = changeHueOfCSS($theme_color, $hs, $ss, $vs); // "changeHueOfCSS" can also change a single color value if it has the form #xxyyzz or #xyz
  57.                                         if (OIDplus::config()->getValue('color_invert',0)) {
  58.                                                 $theme_color = invertColorsOfCSS($theme_color);
  59.                                         }
  60.                                         $line = preg_replace('@content="(.+)"@ismU', 'content="'.$theme_color.'"', $line);
  61.  
  62.                                 }
  63.                         }
  64.                 }
  65.         }
  66.  
  67.         /**
  68.          * @param array $params
  69.          * @return array
  70.          * @throws OIDplusException
  71.          */
  72.         private function action_Update(array $params): array {
  73.                 if (!OIDplus::authUtils()->isAdminLoggedIn()) {
  74.                         throw new OIDplusHtmlException(_L('You need to <a %1>log in</a> as administrator.',OIDplus::gui()->link('oidplus:login$admin')), null, 401);
  75.                 }
  76.  
  77.                 _CheckParamExists($params, 'hue_shift');
  78.                 _CheckParamExists($params, 'sat_shift');
  79.                 _CheckParamExists($params, 'val_shift');
  80.                 _CheckParamExists($params, 'invcolors');
  81.                 _CheckParamExists($params, 'theme');
  82.  
  83.                 OIDplus::config()->setValue('color_hue_shift', $params['hue_shift']);
  84.                 OIDplus::config()->setValue('color_sat_shift', $params['sat_shift']);
  85.                 OIDplus::config()->setValue('color_val_shift', $params['val_shift']);
  86.                 OIDplus::config()->setValue('color_invert',    $params['invcolors']);
  87.                 OIDplus::config()->setValue('design',          $params['theme']);
  88.  
  89.                 OIDplus::logger()->log("V2:[OK/INFO]A", "Changed system color theme");
  90.  
  91.                 return array("status" => 0);
  92.         }
  93.  
  94.         /**
  95.          * @param string $actionID
  96.          * @param array $params
  97.          * @return array
  98.          * @throws OIDplusException
  99.          */
  100.         public function action(string $actionID, array $params): array {
  101.                 if ($actionID == 'color_update') {
  102.                         return $this->action_Update($params);
  103.                 } else {
  104.                         return parent::action($actionID, $params);
  105.                 }
  106.         }
  107.  
  108.         /**
  109.          * @param bool $html
  110.          * @return void
  111.          * @throws OIDplusException
  112.          */
  113.         public function init(bool $html=true) {
  114.                 OIDplus::config()->prepareConfigKey('color_hue_shift', 'HSV Hue shift of CSS colors (-360..360)', '0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  115.                         if (!is_numeric($value) || ($value < -360) || ($value > 360)) {
  116.                                 throw new OIDplusException(_L('Please enter a valid value.'));
  117.                         }
  118.                 });
  119.                 OIDplus::config()->prepareConfigKey('color_sat_shift', 'HSV Saturation shift of CSS colors (-100..100)', '0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  120.                         if (!is_numeric($value) || ($value < -100) || ($value > 100)) {
  121.                                 throw new OIDplusException(_L('Please enter a valid value.'));
  122.                         }
  123.                 });
  124.                 OIDplus::config()->prepareConfigKey('color_val_shift', 'HSV Value shift of CSS colors (-100..100)', '0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  125.                         if (!is_numeric($value) || ($value < -100) || ($value > 100)) {
  126.                                 throw new OIDplusException(_L('Please enter a valid value.'));
  127.                         }
  128.                 });
  129.                 OIDplus::config()->prepareConfigKey('color_invert', 'Invert colors? (0=no, 1=yes)', '0', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  130.                         if (!is_numeric($value) || ($value < 0) || ($value > 1)) {
  131.                                 throw new OIDplusException(_L('Please enter a valid value (0=no, 1=yes).'));
  132.                         }
  133.                 });
  134.                 OIDplus::config()->prepareConfigKey('design', 'Which design to use (must exist in plugins/[vendorname]/design/)?', 'default', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
  135.                         $good = true;
  136.                         if (strpos($value,'/') !== false) $good = false;
  137.                         if (strpos($value,'\\') !== false) $good = false;
  138.                         if (strpos($value,'..') !== false) $good = false;
  139.                         if (!$good) {
  140.                                 throw new OIDplusException(_L('Invalid design folder name. Do only enter a folder name, not an absolute or relative path'));
  141.                         }
  142.  
  143.                         if (!wildcard_is_dir(OIDplus::localpath().'plugins/'.'*'.'/design/'.$value)) {
  144.                                 throw new OIDplusException(_L('The design "%1" does not exist in plugin directory %2',$value,'plugins/[vendorname]/design/'));
  145.                         }
  146.                 });
  147.                 OIDplus::config()->prepareConfigKey('oobe_colors_done', '"Out Of Box Experience" wizard for OIDplusPageAdminColors done once?', '0', OIDplusConfig::PROTECTION_HIDDEN, function($value) {});
  148.         }
  149.  
  150.         /**
  151.          * @param string $id
  152.          * @param array $out
  153.          * @param bool $handled
  154.          * @return void
  155.          * @throws OIDplusException
  156.          */
  157.         public function gui(string $id, array &$out, bool &$handled) {
  158.                 if ($id === 'oidplus:colors') {
  159.                         $handled = true;
  160.                         $out['title'] = _L('Design');
  161.                         $out['icon']  = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png';
  162.  
  163.                         if (!OIDplus::authUtils()->isAdminLoggedIn()) {
  164.                                 throw new OIDplusHtmlException(_L('You need to <a %1>log in</a> as administrator.',OIDplus::gui()->link('oidplus:login$admin')), $out['title'], 401);
  165.                         }
  166.  
  167.                         $out['text']  = '<br><p>';
  168.                         $out['text'] .= '  <label for="theme">'._L('Design').':</label>';
  169.                         $out['text'] .= '  <select name="theme" id="theme">';
  170.                         foreach (OIDplus::getDesignPlugins() as $plugin) {
  171.                                 $plugin_id = $plugin->id();
  172.                                 $selected = $plugin_id == OIDplus::config()->getValue('design') ? ' selected="true"' : '';
  173.                                 $out['text'] .= '<option value="'.htmlentities($plugin_id).'"'.$selected.'>'.htmlentities($plugin->getManifest()->getName()).'</option>';
  174.                         }
  175.                         $out['text'] .= '  </select>';
  176.                         $out['text'] .= '</p>';
  177.  
  178.                         $out['text'] .= '<br><p>';
  179.                         $out['text'] .= '  <label for="amount">'._L('Hue shift').':</label>';
  180.                         $out['text'] .= '  <input type="text" id="hshift" readonly style="border:0; background:transparent; font-weight:bold;">';
  181.                         $out['text'] .= '</p>';
  182.                         $out['text'] .= '<div id="slider-hshift"></div>';
  183.  
  184.                         $out['text'] .= '<br><p>';
  185.                         $out['text'] .= '  <label for="amount">'._L('Saturation shift').':</label>';
  186.                         $out['text'] .= '  <input type="text" id="sshift" readonly style="border:0; background:transparent; font-weight:bold;">';
  187.                         $out['text'] .= '</p>';
  188.                         $out['text'] .= '<div id="slider-sshift"></div>';
  189.  
  190.                         $out['text'] .= '<br><p>';
  191.                         $out['text'] .= '  <label for="amount">'._L('Value shift').':</label>';
  192.                         $out['text'] .= '  <input type="text" id="vshift" readonly style="border:0; background:transparent; font-weight:bold;">';
  193.                         $out['text'] .= '</p>';
  194.                         $out['text'] .= '<div id="slider-vshift"></div>';
  195.  
  196.                         $out['text'] .= '<p><div><input type="checkbox" id="icolor"> <label for="icolor">'._L('Invert colors').'</label></div></p>';
  197.  
  198.                         $out['text'] .= '<script>';
  199.                         $out['text'] .= 'if (OIDplusPageAdminColors.hue_shift == null) OIDplusPageAdminColors.hue_shift = OIDplusPageAdminColors.hue_shift_saved = '.OIDplus::config()->getValue('color_hue_shift').";\n";
  200.                         $out['text'] .= 'if (OIDplusPageAdminColors.sat_shift == null) OIDplusPageAdminColors.sat_shift = OIDplusPageAdminColors.sat_shift_saved = '.OIDplus::config()->getValue('color_sat_shift').";\n";
  201.                         $out['text'] .= 'if (OIDplusPageAdminColors.val_shift == null) OIDplusPageAdminColors.val_shift = OIDplusPageAdminColors.val_shift_saved = '.OIDplus::config()->getValue('color_val_shift').";\n";
  202.                         $out['text'] .= 'if (OIDplusPageAdminColors.invcolors == null) OIDplusPageAdminColors.invcolors = OIDplusPageAdminColors.invcolors_saved = '.OIDplus::config()->getValue('color_invert').";\n";
  203.                         $out['text'] .= 'if (OIDplusPageAdminColors.activetheme == null) OIDplusPageAdminColors.activetheme_saved = '.js_escape(OIDplus::config()->getValue('design')).";\n";
  204.                         $out['text'] .= 'OIDplusPageAdminColors.setup_color_sliders();';
  205.                         $out['text'] .= '</script>';
  206.  
  207.                         $out['text'] .= '<br>';
  208.                         $out['text'] .= '<input type="button" onclick="OIDplusPageAdminColors.color_reset_sliders_cfg()" value="'._L('Reset to last saved config').'">'.str_repeat('&nbsp;',5);
  209.                         $out['text'] .= '<input type="button" onclick="OIDplusPageAdminColors.color_reset_sliders_factory()" value="'._L('Reset default setting').'">'.str_repeat('&nbsp;',5);
  210.                         $out['text'] .= '<input type="button" onclick="OIDplusPageAdminColors.test_color_theme()" value="'._L('Test').'">'.str_repeat('&nbsp;',5);
  211.                         $out['text'] .= '<input type="button" onclick="OIDplusPageAdminColors.crudActionColorUpdate()" value="'._L('Set permanently').'">';
  212.                 }
  213.         }
  214.  
  215.         /**
  216.          * @param array $json
  217.          * @param string|null $ra_email
  218.          * @param bool $nonjs
  219.          * @param string $req_goto
  220.          * @return bool
  221.          * @throws OIDplusException
  222.          */
  223.         public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {
  224.                 if (!OIDplus::authUtils()->isAdminLoggedIn()) return false;
  225.  
  226.                 if (file_exists(__DIR__.'/img/main_icon16.png')) {
  227.                         $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png';
  228.                 } else {
  229.                         $tree_icon = null; // default icon (folder)
  230.                 }
  231.  
  232.                 $json[] = array(
  233.                         'id' => 'oidplus:colors',
  234.                         'icon' => $tree_icon,
  235.                         'text' => _L('Design')
  236.                 );
  237.  
  238.                 return true;
  239.         }
  240.  
  241.         /**
  242.          * @param string $request
  243.          * @return array|false
  244.          */
  245.         public function tree_search(string $request) {
  246.                 return false;
  247.         }
  248.  
  249.         /**
  250.          * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_1
  251.          * @return bool
  252.          * @throws OIDplusException
  253.          */
  254.         public function oobeRequested(): bool {
  255.                 return OIDplus::config()->getValue('oobe_colors_done') == '0';
  256.         }
  257.  
  258.         /**
  259.          * Implements interface INTF_OID_1_3_6_1_4_1_37476_2_5_2_3_1
  260.          * @param int $step
  261.          * @param bool $do_edits
  262.          * @param bool $errors_happened
  263.          * @return void
  264.          * @throws OIDplusException
  265.          */
  266.         public function oobeEntry(int $step, bool $do_edits, bool &$errors_happened)/*: void*/ {
  267.                 echo '<h2>'._L('Step %1: Color Theme',$step).'</h2>';
  268.  
  269.                 echo '<input type="checkbox" name="color_invert" id="color_invert"';
  270.                 if (isset($_POST['sent'])) {
  271.                         if ($set_value = isset($_POST['color_invert'])) {
  272.                                 echo ' checked';
  273.                         }
  274.                 } else {
  275.                         if ($set_value = (OIDplus::config()->getValue('color_invert') == 1)) {
  276.                                 echo ' checked';
  277.                         }
  278.                 }
  279.                 echo '> <label for="color_invert">'._L('Dark Theme (inverted colors)').'</label><br>';
  280.  
  281.                 $htmlmsg = '';
  282.                 if ($do_edits) {
  283.                         try {
  284.                                 OIDplus::config()->setValue('color_invert', $set_value ? 1 : 0);
  285.                                 OIDplus::config()->setValue('oobe_colors_done', '1');
  286.                         } catch (\Exception $e) {
  287.                                 $htmlmsg = $e instanceof OIDplusException ? $e->getHtmlMessage() : htmlentities($e->getMessage());
  288.                                 $errors_happened = true;
  289.                         }
  290.                 }
  291.  
  292.                 echo ' <font color="red"><b>'.$htmlmsg.'</b></font>';
  293.         }
  294.  
  295. }
  296.