CRM/Admin/Page/CKEditorConfig.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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_FILENAME = '[civicrm.files]/persist/crm-ckeditor-config.js';
  44
  45   /**
  46    * Default settings if config file has not been initialized
  47    *
  48    * @var array
  49    */
  50   public $defaultSettings = array(
  51     'skin' => 'moono',
  52     'extraPlugins' => '',
  53   );
  54
  55   /**
  56    * Run page.
  57    *
  58    * @return string
  59    */
  60   public function run() {
  61     // If the form was submitted, take appropriate action.
  62     if (!empty($_POST['revert'])) {
  63       self::deleteConfigFile();
  64     }
  65     elseif (!empty($_POST['config'])) {
  66       $this->save($_POST);
  67     }
  68
  69     CRM_Core_Resources::singleton()
  70       ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/fulltoolbareditor.js', 1)
  71       ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/abstracttoolbarmodifier.js', 2)
  72       ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/toolbarmodifier.js', 3)
  73       ->addScriptFile('civicrm', 'js/wysiwyg/admin.ckeditor-configurator.js', 10)
  74       ->addStyleFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/css/fontello.css')
  75       ->addStyleFile('civicrm', 'bower_components/ckeditor/samples/css/samples.css')
  76       ->addVars('ckConfig', array(
  77         'plugins' => array_values($this->getCKPlugins()),
  78       ));
  79
  80     $this->assign('skins', $this->getCKSkins());
  81     $this->assign('skin', $this->getConfigSetting('skin'));
  82     $this->assign('extraPlugins', $this->getConfigSetting('extraPlugins'));
  83     $this->assign('configUrl', self::getConfigUrl());
  84     $this->assign('revertConfirm', htmlspecialchars(ts('Are you sure you want to revert all changes?', array('escape' => 'js'))));
  85
  86     CRM_Utils_System::appendBreadCrumb(array(array(
  87       'url' => CRM_Utils_System::url('civicrm/admin/setting/preferences/display', 'reset=1'),
  88       'title' => ts('Display Preferences'),
  89     )));
  90
  91     return parent::run();
  92   }
  93
  94   /**
  95    * Generate the config js file based on posted data.
  96    *
  97    * @param array $params
  98    */
  99   public function save($params) {
 100     $config = "/**\n"
 101       . " * CKEditor config file auto-generated by CiviCRM.\n"
 102       . " *\n"
 103       . " * Note: This file will be overwritten if settings are modified at:\n"
 104       . " * @link " . CRM_Utils_System::url(CRM_Utils_System::currentPath(), NULL, TRUE, NULL, FALSE) . "\n"
 105       . " */\n\n"
 106       // Standardize line-endings
 107       . preg_replace('~\R~u', "\n", $params['config']);
 108
 109     // Use defaultSettings as a whitelist so we don't just insert any old junk into the file
 110     foreach ($this->defaultSettings as $key => $default) {
 111       if (isset($params[$key]) && strlen($params[$key])) {
 112         $pos = strrpos($config, '};');
 113         $setting = "\n\tconfig.$key = '{$params[$key]}';\n";
 114         $config = substr_replace($config, $setting, $pos, 0);
 115       }
 116     }
 117     self::saveConfigFile($config);
 118     if (!empty($params['save'])) {
 119       CRM_Core_Session::setStatus(ts("You may need to clear your browser's cache to see the changes in CiviCRM."), ts('CKEditor Saved'), 'success');
 120     }
 121   }
 122
 123   /**
 124    * Get available CKEditor plugin list.
 125    *
 126    * @return array
 127    */
 128   private function getCKPlugins() {
 129     $plugins = array();
 130     $pluginDir = Civi::paths()->getPath('[civicrm.root]/bower_components/ckeditor/plugins');
 131
 132     foreach (glob($pluginDir . '/*', GLOB_ONLYDIR) as $dir) {
 133       $dir = rtrim(str_replace('\\', '/', $dir), '/');
 134       $name = substr($dir, strrpos($dir, '/') + 1);
 135       $dir = CRM_Utils_file::addTrailingSlash($dir, '/');
 136       if (is_file($dir . 'plugin.js')) {
 137         $plugins[$name] = array(
 138           'id' => $name,
 139           'text' => ucfirst($name),
 140           'icon' => NULL,
 141         );
 142         if (is_dir($dir . "icons")) {
 143           if (is_file($dir . "icons/$name.png")) {
 144             $plugins[$name]['icon'] = "bower_components/ckeditor/plugins/$name/icons/$name.png";
 145           }
 146           elseif (glob($dir . "icons/*.png")) {
 147             $icon = CRM_Utils_Array::first(glob($dir . "icons/*.png"));
 148             $icon = rtrim(str_replace('\\', '/', $icon), '/');
 149             $plugins[$name]['icon'] = "bower_components/ckeditor/plugins/$name/icons/" . substr($icon, strrpos($icon, '/') + 1);
 150           }
 151         }
 152       }
 153     }
 154
 155     return $plugins;
 156   }
 157
 158   /**
 159    * Get available CKEditor skins.
 160    *
 161    * @return array
 162    */
 163   private function getCKSkins() {
 164     $skins = array();
 165     $skinDir = Civi::paths()->getPath('[civicrm.root]/bower_components/ckeditor/skins');
 166     foreach (glob($skinDir . '/*', GLOB_ONLYDIR) as $dir) {
 167       $dir = rtrim(str_replace('\\', '/', $dir), '/');
 168       $skins[] = substr($dir, strrpos($dir, '/') + 1);
 169     }
 170     return $skins;
 171   }
 172
 173   /**
 174    * @param $setting
 175    * @return string
 176    */
 177   private function getConfigSetting($setting) {
 178     $value = CRM_Utils_Array::value($setting, $this->defaultSettings, '');
 179     $file = self::getConfigFile();
 180     if ($file) {
 181       $contents = file_get_contents($file);
 182       $matches = array();
 183       preg_match("/\sconfig\.$setting\s?=\s?'([^']*)'/", $contents, $matches);
 184       if ($matches) {
 185         $value = $matches[1];
 186       }
 187     }
 188     return $value;
 189   }
 190
 191   /**
 192    * @return null|string
 193    */
 194   public static function getConfigUrl() {
 195     if (self::getConfigFile()) {
 196       return Civi::paths()->getUrl(self::CONFIG_FILENAME);
 197     }
 198     return NULL;
 199   }
 200
 201   /**
 202    * @param bool $checkIfFileExists
 203    *   If false, this fn will return fileName even if it doesn't exist
 204    *
 205    * @return null|string
 206    */
 207   public static function getConfigFile($checkIfFileExists = TRUE) {
 208     $fileName = Civi::paths()->getPath(self::CONFIG_FILENAME);
 209     return !$checkIfFileExists || is_file($fileName) ? $fileName : NULL;
 210   }
 211
 212   /**
 213    * @param string $contents
 214    */
 215   public static function saveConfigFile($contents) {
 216     $file = self::getConfigFile(FALSE);
 217     file_put_contents($file, $contents);
 218   }
 219
 220   /**
 221    * Delete config file.
 222    */
 223   public static function deleteConfigFile() {
 224     $file = self::getConfigFile();
 225     if ($file) {
 226       unlink($file);
 227     }
 228   }
 229
 230 }