CRM/Admin/Page/CKEditorConfig.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2016
  32  */
  33
  34 /**
  35  * Page for configuring CKEditor options.
  36  *
  37  * Note that while this is implemented as a CRM_Core_Page, it is actually a form.
  38  * Because the form needs to be submitted and refreshed via javascript, it seemed like
  39  * Quickform and CRM_Core_Form/Controller might get in the way.
  40  */
  41 class CRM_Admin_Page_CKEditorConfig extends CRM_Core_Page {
  42
  43   const CONFIG_FILEPATH = '[civicrm.files]/persist/crm-ckeditor-';
  44
  45   /**
  46    * Settings that cannot be configured in "advanced options"
  47    *
  48    * @var array
  49    */
  50   public $blackList = array(
  51     'on',
  52     'skin',
  53     'extraPlugins',
  54     'toolbarGroups',
  55     'removeButtons',
  56     'filebrowserBrowseUrl',
  57     'filebrowserImageBrowseUrl',
  58     'filebrowserFlashBrowseUrl',
  59     'filebrowserUploadUrl',
  60     'filebrowserImageUploadUrl',
  61     'filebrowserFlashUploadUrl',
  62   );
  63
  64   public $preset;
  65
  66   /**
  67    * Run page.
  68    *
  69    * @return string
  70    */
  71   public function run() {
  72     $this->preset = CRM_Utils_Array::value('preset', $_REQUEST, 'default');
  73
  74     // If the form was submitted, take appropriate action.
  75     if (!empty($_POST['revert'])) {
  76       self::deleteConfigFile($this->preset);
  77     }
  78     elseif (!empty($_POST['config'])) {
  79       $this->save($_POST);
  80     }
  81
  82     $settings = $this->getConfigSettings();
  83
  84     CRM_Core_Resources::singleton()
  85       ->addScriptFile('civicrm', 'bower_components/ckeditor/ckeditor.js', 0, 'page-header')
  86       ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/fulltoolbareditor.js', 1)
  87       ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/abstracttoolbarmodifier.js', 2)
  88       ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/toolbarmodifier.js', 3)
  89       ->addScriptFile('civicrm', 'js/wysiwyg/admin.ckeditor-configurator.js', 10)
  90       ->addStyleFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/css/fontello.css')
  91       ->addStyleFile('civicrm', 'bower_components/ckeditor/samples/css/samples.css')
  92       ->addVars('ckConfig', array(
  93         'plugins' => array_values($this->getCKPlugins()),
  94         'blacklist' => $this->blackList,
  95         'settings' => $settings,
  96       ));
  97
  98     $configUrl = self::getConfigUrl($this->preset);
  99     if (!$configUrl) {
 100       $configUrl = self::getConfigUrl('default');
 101     }
 102
 103     $this->assign('preset', $this->preset);
 104     $this->assign('presets', CRM_Core_OptionGroup::values('wysiwyg_presets', FALSE, FALSE, FALSE, NULL, 'label', TRUE, FALSE, 'name'));
 105     $this->assign('skins', $this->getCKSkins());
 106     $this->assign('skin', CRM_Utils_Array::value('skin', $settings));
 107     $this->assign('extraPlugins', CRM_Utils_Array::value('extraPlugins', $settings));
 108     $this->assign('configUrl', $configUrl);
 109     $this->assign('revertConfirm', htmlspecialchars(ts('Are you sure you want to revert all changes?', array('escape' => 'js'))));
 110
 111     CRM_Utils_System::appendBreadCrumb(array(array(
 112       'url' => CRM_Utils_System::url('civicrm/admin/setting/preferences/display', 'reset=1'),
 113       'title' => ts('Display Preferences'),
 114     )));
 115
 116     return parent::run();
 117   }
 118
 119   /**
 120    * Generate the config js file based on posted data.
 121    *
 122    * @param array $params
 123    */
 124   public function save($params) {
 125     $config = "/**\n"
 126       . " * CKEditor config file auto-generated by CiviCRM.\n"
 127       . " *\n"
 128       . " * Note: This file will be overwritten if settings are modified at:\n"
 129       . " * @link " . CRM_Utils_System::url(CRM_Utils_System::currentPath(), NULL, TRUE, NULL, FALSE) . "\n"
 130       . " */\n\n"
 131       // Standardize line-endings
 132       . preg_replace('~\R~u', "\n", $params['config']);
 133
 134     // Use all params starting with config_
 135     foreach ($params as $key => $val) {
 136       $val = trim($val);
 137       if (strpos($key, 'config_') === 0 && strlen($val)) {
 138         if ($val != 'true' && $val != 'false' && $val != 'null' && $val[0] != '{' && $val[0] != '[' && !is_numeric($val)) {
 139           $val = json_encode($val);
 140         }
 141         $pos = strrpos($config, '};');
 142         $key = preg_replace('/^config_/', 'config.', $key);
 143         $setting = "\n\t{$key} = {$val};\n";
 144         $config = substr_replace($config, $setting, $pos, 0);
 145       }
 146     }
 147     self::saveConfigFile($this->preset, $config);
 148     if (!empty($params['save'])) {
 149       CRM_Core_Session::setStatus(ts("You may need to clear your browser's cache to see the changes in CiviCRM."), ts('CKEditor Saved'), 'success');
 150     }
 151   }
 152
 153   /**
 154    * Get available CKEditor plugin list.
 155    *
 156    * @return array
 157    */
 158   private function getCKPlugins() {
 159     $plugins = array();
 160     $pluginDir = Civi::paths()->getPath('[civicrm.root]/bower_components/ckeditor/plugins');
 161
 162     foreach (glob($pluginDir . '/*', GLOB_ONLYDIR) as $dir) {
 163       $dir = rtrim(str_replace('\\', '/', $dir), '/');
 164       $name = substr($dir, strrpos($dir, '/') + 1);
 165       $dir = CRM_Utils_file::addTrailingSlash($dir, '/');
 166       if (is_file($dir . 'plugin.js')) {
 167         $plugins[$name] = array(
 168           'id' => $name,
 169           'text' => ucfirst($name),
 170           'icon' => NULL,
 171         );
 172         if (is_dir($dir . "icons")) {
 173           if (is_file($dir . "icons/$name.png")) {
 174             $plugins[$name]['icon'] = "bower_components/ckeditor/plugins/$name/icons/$name.png";
 175           }
 176           elseif (glob($dir . "icons/*.png")) {
 177             $icon = CRM_Utils_Array::first(glob($dir . "icons/*.png"));
 178             $icon = rtrim(str_replace('\\', '/', $icon), '/');
 179             $plugins[$name]['icon'] = "bower_components/ckeditor/plugins/$name/icons/" . substr($icon, strrpos($icon, '/') + 1);
 180           }
 181         }
 182       }
 183     }
 184
 185     return $plugins;
 186   }
 187
 188   /**
 189    * Get available CKEditor skins.
 190    *
 191    * @return array
 192    */
 193   private function getCKSkins() {
 194     $skins = array();
 195     $skinDir = Civi::paths()->getPath('[civicrm.root]/bower_components/ckeditor/skins');
 196     foreach (glob($skinDir . '/*', GLOB_ONLYDIR) as $dir) {
 197       $dir = rtrim(str_replace('\\', '/', $dir), '/');
 198       $skins[] = substr($dir, strrpos($dir, '/') + 1);
 199     }
 200     return $skins;
 201   }
 202
 203   /**
 204    * @return array
 205    */
 206   private function getConfigSettings() {
 207     $matches = $result = array();
 208     $file = self::getConfigFile($this->preset);
 209     if (!$file) {
 210       $file = self::getConfigFile('default');
 211     }
 212     $result['skin'] = 'moono';
 213     if ($file) {
 214       $contents = file_get_contents($file);
 215       preg_match_all("/\sconfig\.(\w+)\s?=\s?([^;]*);/", $contents, $matches);
 216       foreach ($matches[1] as $i => $match) {
 217         $result[$match] = trim($matches[2][$i], ' "\'');
 218       }
 219     }
 220     return $result;
 221   }
 222
 223   /**
 224    * @param string $preset
 225    *   Omit to get an array of all presets
 226    * @return array|null|string
 227    */
 228   public static function getConfigUrl($preset = NULL) {
 229     $items = array();
 230     $presets = CRM_Core_OptionGroup::values('wysiwyg_presets', FALSE, FALSE, FALSE, NULL, 'name');
 231     foreach ($presets as $key => $name) {
 232       if (self::getConfigFile($name)) {
 233         $items[$name] = Civi::paths()->getUrl(self::CONFIG_FILEPATH . $name . '.js', 'absolute');
 234       }
 235     }
 236     return $preset ? CRM_Utils_Array::value($preset, $items) : $items;
 237   }
 238
 239   /**
 240    * @param string $preset
 241    *
 242    * @return null|string
 243    */
 244   public static function getConfigFile($preset = 'default') {
 245     $fileName = Civi::paths()->getPath(self::CONFIG_FILEPATH . $preset . '.js');
 246     return is_file($fileName) ? $fileName : NULL;
 247   }
 248
 249   /**
 250    * @param string $contents
 251    */
 252   public static function saveConfigFile($preset, $contents) {
 253     $file = Civi::paths()->getPath(self::CONFIG_FILEPATH . $preset . '.js');
 254     file_put_contents($file, $contents);
 255   }
 256
 257   /**
 258    * Delete config file.
 259    */
 260   public static function deleteConfigFile($preset) {
 261     $file = self::getConfigFile($preset);
 262     if ($file) {
 263       unlink($file);
 264     }
 265   }
 266
 267 }