1: <?php
  2: /**
  3:  * This file contains the abstract WYSIWYG editor class.
  4:  *
  5:  * @package Core
  6:  * @subpackage Backend
  7:  * @version SVN Revision $Rev:$
  8:  *
  9:  * @author Timo Hummel
 10:  * @copyright four for business AG <www.4fb.de>
 11:  * @license http://www.contenido.org/license/LIZENZ.txt
 12:  * @link http://www.4fb.de
 13:  * @link http://www.contenido.org
 14:  */
 15: 
 16: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 17: 
 18: /**
 19:  * Base class for all WYSIWYG editors
 20:  *
 21:  * @package Core
 22:  * @subpackage Backend
 23:  */
 24: abstract class cWYSIWYGEditor {
 25:     /**
 26:      * Access key under which the wysiwyg editor settings will be stored
 27:      * @var string
 28:      */
 29:     protected static $_sConfigPrefix = '[\'wysiwyg\']';
 30: 
 31:     /**
 32:      *
 33:      * @var string
 34:      */
 35:     protected $_sPath;
 36: 
 37:     /**
 38:      *
 39:      * @var string
 40:      */
 41:     protected $_sEditor;
 42: 
 43:     /**
 44:      *
 45:      * @var string
 46:      */
 47:     protected $_sEditorName;
 48: 
 49:     /**
 50:      *
 51:      * @var string
 52:      */
 53:     protected $_sEditorContent;
 54: 
 55:     /**
 56:      *
 57:      * @var array
 58:      */
 59:     protected $_aSettings;
 60: 
 61:     /**
 62:      *
 63:      * @param string $sEditorName
 64:      * @param string $sEditorContent
 65:      */
 66:     public function __construct($sEditorName, $sEditorContent) {
 67:         $cfg = cRegistry::getConfig();
 68: 
 69:         $this->_sPath = $cfg['path']['all_wysiwyg_html'];
 70:         $this->_setEditorName($sEditorName);
 71:         $this->_setEditorContent($sEditorContent);
 72:     }
 73: 
 74:     /**
 75:      *
 76:      * @param string $sContent
 77:      */
 78:     protected function _setEditorContent($sEditorContent) {
 79:         $this->_sEditorContent = $sEditorContent;
 80:     }
 81: 
 82:     /**
 83:      *
 84:      * @param string $sEditor
 85:      */
 86:     protected function _setEditor($sEditor) {
 87:         global $cfg;
 88: 
 89:         if (is_dir($cfg['path']['all_wysiwyg'] . $sEditor)) {
 90:             if (substr($sEditor, strlen($sEditor) - 1, 1) != "/") {
 91:                 $sEditor = $sEditor . "/";
 92:             }
 93: 
 94:             $this->_sEditor = $sEditor;
 95:         }
 96:     }
 97: 
 98:     /**
 99:      * Sets given setting if setting was not yet defined.
100:      * Overwriting defined setting can be achieved with $bForceSetting = true.
101:      *
102:      * @param string $sKey
103:      *         of setting to set
104:      * @param string $sValue
105:      *         of setting to set
106:      * @param bool $bForceSetting [optional]
107:      *         to overwrite defined setting
108:      */
109:     protected function _setSetting($sKey, $sValue, $bForceSetting = false) {
110:         if ($bForceSetting || !array_key_exists($sKey, $this->_aSettings)) {
111:             $this->_aSettings[$sKey] = $sValue;
112:         }
113:     }
114: 
115:     /**
116:      *
117:      * @param string $sKey
118:      */
119:     protected function _unsetSetting($sKey) {
120:         unset($this->_aSettings[$sKey]);
121:     }
122: 
123:     /**
124:      *
125:      * @return string
126:      */
127:     protected function _getEditorPath() {
128:         return $this->_sPath . $this->_sEditor;
129:     }
130: 
131:     /**
132:      *
133:      * @param string $sEditorName
134:      */
135:     protected function _setEditorName($sEditorName) {
136:         $this->_sEditorName = $sEditorName;
137:     }
138: 
139:     /**
140:      *
141:      * @throws cBadMethodCallException if this method is not overridden in the
142:      *         subclass
143:      */
144:     protected function _getScripts() {
145:         throw new cBadMethodCallException('You need to override the method _getScripts');
146:     }
147: 
148:     /**
149:      *
150:      * @throws cBadMethodCallException if this method is not overridden in the
151:      *         subclass
152:      */
153:     protected function _getEditor() {
154:         throw new cBadMethodCallException('You need to override the method _getEditor');
155:     }
156: 
157:     /**
158:      * Find out which WYSIWYG editor is currently chosen
159:      * @return string
160:      *         The name of current WYSIWYG editor
161:      */
162:     public static function getCurrentWysiwygEditorName() {
163:         // define fallback WYSIWYG editor
164:         define('DEFAULT_WYSIWYG_EDITOR', cRegistry::getConfigValue('wysiwyg', 'editor', 'tinymce3'));
165: 
166:         $curWysiwygEditor = getEffectiveSetting('wysiwyg', 'editor', constant('DEFAULT_WYSIWYG_EDITOR'));
167: 
168:         // no paths are allowed in WYSIWYG editor
169:         // fall back to defaults if editor folder does not exist
170:         if (0 === strlen($curWysiwygEditor)
171:         || false === cFileHandler::exists(cRegistry::getConfigValue('path', 'all_wysiwyg') . $curWysiwygEditor)
172:         || false !== strpos($curWysiwygEditor, '.')
173:         || false !== strpos($curWysiwygEditor, '/')
174:         || false !== strpos($curWysiwygEditor, '\\')) {
175:             $curWysiwygEditor = constant('DEFAULT_WYSIWYG_EDITOR');
176:         }
177: 
178:         return $curWysiwygEditor;
179:     }
180: 
181:     /**
182:      * Saves configuration of WYSIWYG editor into a file
183:      * This function does not validate input! This has to be done by classes that extend cWYSIWYGEditor
184:      * because this class does not know what each WYSIWYG editor expects.
185:      * @param array $config
186:      *         Array with configuration values for the current WYSIWYG editor to save
187:      * @return array
188:      *         Array with values that were not accepted
189:      */
190:     public static function saveConfig($config) {
191: 
192:         // specify filename scheme
193:         // for tinymce 4 this will be config.wysiwyg_tinymce4.php
194:         $configFile = 'config.wysiwyg_' . static::getCurrentWysiwygEditorName() . '.php';
195: 
196:         // get path to current config folder
197:         $configPath = cRegistry::getConfigValue('path', 'contenido_config');
198: 
199:         // write content to file as array in $cfg['tinymce4']
200:         $filePrefix = '<?php ' . PHP_EOL;
201:         $filePrefix .= "defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');\n";
202:         $filePrefix .= 'global $cfg;' . PHP_EOL . PHP_EOL;
203: 
204:         $content = $filePrefix . '$cfg' . static::$_sConfigPrefix . ' = ' . var_export($config, true) . ';' . PHP_EOL;
205: 
206:         // first try to write then check what went wrong in case of error
207:         if (true !== cFileHandler::write($configPath . $configFile, $content)) {
208:             $erroneousSettings = array();
209: 
210:             // just pass back that the file could not be written
211:             $erroneusSettings['saving'] = array('config_file' => 'wysiwyg config file could not be written');
212:             // write more detailed information with sensitive information such as full path into error log
213:             error_log('Error writing ' . $configPath . $configFile);
214:             return $erroneusSettings;
215:         }
216: 
217:         // apply changes to current config
218:         global $cfg;
219:         $cfg['wysiwyg'][static::getCurrentWysiwygEditorName()] = $config;
220: 
221:         return array();
222:     }
223: }
224: