1: <?php
  2: /**
  3:  * This file contains the abstract WYSIWYG editor class.
  4:  *
  5:  * @package Core
  6:  * @subpackage Backend
  7:  * @author Timo Hummel
  8:  * @copyright four for business AG <www.4fb.de>
  9:  * @license http://www.contenido.org/license/LIZENZ.txt
 10:  * @link http://www.4fb.de
 11:  * @link http://www.contenido.org
 12:  */
 13: 
 14: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 15: 
 16: /**
 17:  * Base class for all WYSIWYG editors
 18:  *
 19:  * @package Core
 20:  * @subpackage Backend
 21:  */
 22: abstract class cWYSIWYGEditor {
 23:     /**
 24:      * Access key under which the wysiwyg editor settings will be stored
 25:      * @var string
 26:      */
 27:     protected static $_configPrefix = '[\'wysiwyg\']';
 28: 
 29:     /**
 30:      *
 31:      * @var string
 32:      */
 33:     protected $_sPath;
 34: 
 35:     /**
 36:      *
 37:      * @var string
 38:      */
 39:     protected $_sEditor;
 40: 
 41:     /**
 42:      *
 43:      * @var string
 44:      */
 45:     protected $_sEditorName;
 46: 
 47:     /**
 48:      *
 49:      * @var string
 50:      */
 51:     protected $_sEditorContent;
 52: 
 53:     /**
 54:      *
 55:      * @var array
 56:      */
 57:     protected $_aSettings;
 58: 
 59:     /**
 60:      * Constructor to create an instance of this class.
 61:      *
 62:      * @param string $editorName
 63:      * @param string $editorContent
 64:      */
 65:     public function __construct($editorName, $editorContent) {
 66:         $cfg = cRegistry::getConfig();
 67: 
 68:         $this->_sPath = $cfg['path']['all_wysiwyg_html'];
 69:         $this->_setEditorName($editorName);
 70:         $this->_setEditorContent($editorContent);
 71:     }
 72: 
 73:     /**
 74:      *
 75:      * @param string $sEditorContent
 76:      */
 77:     protected function _setEditorContent($sEditorContent) {
 78:         $this->_sEditorContent = $sEditorContent;
 79:     }
 80: 
 81:     /**
 82:      *
 83:      * @param string $sEditor
 84:      */
 85:     protected function _setEditor($sEditor) {
 86:         global $cfg;
 87: 
 88:         if (is_dir($cfg['path']['all_wysiwyg'] . $sEditor)) {
 89:             if (cString::getPartOfString($sEditor, cString::getStringLength($sEditor) - 1, 1) != "/") {
 90:                 $sEditor = $sEditor . "/";
 91:             }
 92: 
 93:             $this->_sEditor = $sEditor;
 94:         }
 95:     }
 96: 
 97:     /**
 98:      * Sets given setting if setting was not yet defined.
 99:      * Overwriting defined setting can be achieved with $forceSetting = true.
100:      *
101:      * @param string $key
102:      *         of setting to set
103:      * @param string $value
104:      *         of setting to set
105:      * @param bool $forceSetting [optional]
106:      *         to overwrite defined setting
107:      * @param bool $type Normally unused (counterpart of cTinyMCE4Editor::setSetting)
108:      */
109:     public function setSetting($type = null, $key, $value, $forceSetting = false) {
110:         if ($forceSetting || !array_key_exists($key, $this->_aSettings)) {
111:             $this->_aSettings[$key] = $value;
112:         }
113:     }
114: 
115:     /**
116:      *
117:      * @param string $key
118:      */
119:     protected function _unsetSetting($key) {
120:         unset($this->_aSettings[$key]);
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 === cString::getStringLength($curWysiwygEditor)
171:         || false === cFileHandler::exists(cRegistry::getConfigValue('path', 'all_wysiwyg') . $curWysiwygEditor)
172:         || false !== cString::findFirstPos($curWysiwygEditor, '.')
173:         || false !== cString::findFirstPos($curWysiwygEditor, '/')
174:         || false !== cString::findFirstPos($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:      *
186:      * @param array $config
187:      *         Array with configuration values for the current WYSIWYG editor to save
188:      *
189:      * @return array
190:      *         Array with values that were not accepted
191:      *
192:      * @throws cInvalidArgumentException
193:      */
194:     public static function saveConfig($config) {
195: 
196:         // specify filename scheme
197:         // for tinymce 4 this will be config.wysiwyg_tinymce4.php
198:         $configFile = 'config.wysiwyg_' . static::getCurrentWysiwygEditorName() . '.php';
199: 
200:         // get path to current config folder
201:         $configPath = cRegistry::getConfigValue('path', 'contenido_config');
202: 
203:         // write content to file as array in $cfg['tinymce4']
204:         $filePrefix = '<?php ' . PHP_EOL;
205:         $filePrefix .= "defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');\n";
206:         $filePrefix .= 'global $cfg;' . PHP_EOL . PHP_EOL;
207: 
208:         $content = $filePrefix . '$cfg' . static::$_configPrefix . ' = ' . var_export($config, true) . ';' . PHP_EOL;
209: 
210:         // first try to write then check what went wrong in case of error
211:         if (true !== cFileHandler::write($configPath . $configFile, $content)) {
212:             $erroneousSettings = array();
213: 
214:             // just pass back that the file could not be written
215:             $erroneusSettings['saving'] = array('config_file' => 'wysiwyg config file could not be written');
216:             // write more detailed information with sensitive information such as full path into error log
217:             error_log('Error writing ' . $configPath . $configFile);
218:             return $erroneusSettings;
219:         }
220: 
221:         // apply changes to current config
222:         global $cfg;
223:         $cfg['wysiwyg'][static::getCurrentWysiwygEditorName()] = $config;
224: 
225:         return array();
226:     }
227: }
228: