3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 * Page for configuring CKEditor options.
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.
41 class CRM_Admin_Page_CKEditorConfig
extends CRM_Core_Page
{
43 const CONFIG_FILENAME
= '[civicrm.files]/persist/crm-ckeditor-config.js';
46 * Default settings if config file has not been initialized
50 public $defaultSettings = array(
60 public function run() {
61 // If the form was submitted, take appropriate action.
62 if (!empty($_POST['revert'])) {
63 self
::deleteConfigFile();
65 elseif (!empty($_POST['config'])) {
69 CRM_Core_Resources
::singleton()
70 ->addScriptFile('civicrm', 'bower_components/ckeditor/ckeditor.js', 0, 'html-header')
71 ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/fulltoolbareditor.js', 1)
72 ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/abstracttoolbarmodifier.js', 2)
73 ->addScriptFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/js/toolbarmodifier.js', 3)
74 ->addScriptFile('civicrm', 'js/wysiwyg/admin.ckeditor-configurator.js', 10)
75 ->addStyleFile('civicrm', 'bower_components/ckeditor/samples/toolbarconfigurator/css/fontello.css')
76 ->addStyleFile('civicrm', 'bower_components/ckeditor/samples/css/samples.css')
77 ->addVars('ckConfig', array(
78 'plugins' => array_values($this->getCKPlugins()),
81 $this->assign('skins', $this->getCKSkins());
82 $this->assign('skin', $this->getConfigSetting('skin'));
83 $this->assign('extraPlugins', $this->getConfigSetting('extraPlugins'));
84 $this->assign('configUrl', self
::getConfigUrl());
85 $this->assign('revertConfirm', htmlspecialchars(ts('Are you sure you want to revert all changes?', array('escape' => 'js'))));
87 CRM_Utils_System
::appendBreadCrumb(array(array(
88 'url' => CRM_Utils_System
::url('civicrm/admin/setting/preferences/display', 'reset=1'),
89 'title' => ts('Display Preferences'),
96 * Generate the config js file based on posted data.
98 * @param array $params
100 public function save($params) {
102 . " * CKEditor config file auto-generated by CiviCRM.\n"
104 . " * Note: This file will be overwritten if settings are modified at:\n"
105 . " * @link " . CRM_Utils_System
::url(CRM_Utils_System
::currentPath(), NULL, TRUE, NULL, FALSE) . "\n"
107 // Standardize line-endings
108 . preg_replace('~\R~u', "\n", $params['config']);
110 // Use defaultSettings as a whitelist so we don't just insert any old junk into the file
111 foreach ($this->defaultSettings
as $key => $default) {
112 if (isset($params[$key]) && strlen($params[$key])) {
113 $pos = strrpos($config, '};');
114 $setting = "\n\tconfig.$key = '{$params[$key]}';\n";
115 $config = substr_replace($config, $setting, $pos, 0);
118 self
::saveConfigFile($config);
119 if (!empty($params['save'])) {
120 CRM_Core_Session
::setStatus(ts("You may need to clear your browser's cache to see the changes in CiviCRM."), ts('CKEditor Saved'), 'success');
125 * Get available CKEditor plugin list.
129 private function getCKPlugins() {
131 $pluginDir = Civi
::paths()->getPath('[civicrm.root]/bower_components/ckeditor/plugins');
133 foreach (glob($pluginDir . '/*', GLOB_ONLYDIR
) as $dir) {
134 $dir = rtrim(str_replace('\\', '/', $dir), '/');
135 $name = substr($dir, strrpos($dir, '/') +
1);
136 $dir = CRM_Utils_file
::addTrailingSlash($dir, '/');
137 if (is_file($dir . 'plugin.js')) {
138 $plugins[$name] = array(
140 'text' => ucfirst($name),
143 if (is_dir($dir . "icons")) {
144 if (is_file($dir . "icons/$name.png")) {
145 $plugins[$name]['icon'] = "bower_components/ckeditor/plugins/$name/icons/$name.png";
147 elseif (glob($dir . "icons/*.png")) {
148 $icon = CRM_Utils_Array
::first(glob($dir . "icons/*.png"));
149 $icon = rtrim(str_replace('\\', '/', $icon), '/');
150 $plugins[$name]['icon'] = "bower_components/ckeditor/plugins/$name/icons/" . substr($icon, strrpos($icon, '/') +
1);
160 * Get available CKEditor skins.
164 private function getCKSkins() {
166 $skinDir = Civi
::paths()->getPath('[civicrm.root]/bower_components/ckeditor/skins');
167 foreach (glob($skinDir . '/*', GLOB_ONLYDIR
) as $dir) {
168 $dir = rtrim(str_replace('\\', '/', $dir), '/');
169 $skins[] = substr($dir, strrpos($dir, '/') +
1);
178 private function getConfigSetting($setting) {
179 $value = CRM_Utils_Array
::value($setting, $this->defaultSettings
, '');
180 $file = self
::getConfigFile();
182 $contents = file_get_contents($file);
184 preg_match("/\sconfig\.$setting\s?=\s?'([^']*)'/", $contents, $matches);
186 $value = $matches[1];
193 * @return null|string
195 public static function getConfigUrl() {
196 if (self
::getConfigFile()) {
197 return Civi
::paths()->getUrl(self
::CONFIG_FILENAME
, 'absolute');
203 * @param bool $checkIfFileExists
204 * If false, this fn will return fileName even if it doesn't exist
206 * @return null|string
208 public static function getConfigFile($checkIfFileExists = TRUE) {
209 $fileName = Civi
::paths()->getPath(self
::CONFIG_FILENAME
);
210 return !$checkIfFileExists ||
is_file($fileName) ?
$fileName : NULL;
214 * @param string $contents
216 public static function saveConfigFile($contents) {
217 $file = self
::getConfigFile(FALSE);
218 file_put_contents($file, $contents);
222 * Delete config file.
224 public static function deleteConfigFile() {
225 $file = self
::getConfigFile();