1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: <?php
// ------------------------------------------------------------------------ //
// XOOPS - PHP Content Management System //
// Copyright (c) 2000 XOOPS.org //
// <http://www.xoops.org/> //
// ------------------------------------------------------------------------ //
// This program is free software; you can redistribute it and/or modify //
// it under the terms of the GNU General Public License as published by //
// the Free Software Foundation; either version 2 of the License, or //
// (at your option) any later version. //
// //
// You may not change or alter any portion of this comment or credits //
// of supporting developers from this source code or any supporting //
// source code which is considered copyrighted (c) material of the //
// original comment or credit authors. //
// //
// This program is distributed in the hope that it will be useful, //
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
// GNU General Public License for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with this program; if not, write to the Free Software //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA //
// ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu) //
// URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project //
// ------------------------------------------------------------------------- //
/**
* Editor framework
*
* @license http://www.fsf.org/copyleft/gpl.html GNU public license
* @copyright
* @category ICMS
* @package Plugins
* @subpackage Editor
* @version SVN: $Id: EditorHandler.php 12313 2013-09-15 21:14:35Z skenow $
*/
/**
* Handler for editors
*
* @author Taiwen Jiang (phppp or D.J.) <php_pp@hotmail.com>
* @copyright Copyright (c) 2000 XOOPS.org
* @category ICMS
* @package Plugins
* @subpackage Editor
*/
class icms_plugins_EditorHandler {
private $root_path = "";
public $nohtml = FALSE;
public $allowed_editors = array();
private $_type = "";
/**
* Constructor
*
* @param string type
*/
public function __construct($type = '') {
$this->root_path = self::_getRootPath($type);
$this->_type = $type;
}
/**
* Access the only instance of this class
*
* @param string type
* @return object
* @static
* @staticvar object
*/
static public function &getInstance($type = '') {
static $instances = array();
if (!isset($instances[$type])) {
$instances[$type] = new self($type);
}
return $instances[$type];
}
/**
* @param string $name Editor name which is actually the folder name
* @param array $options editor options: $key => $val
* @param string $OnFailure a pre-validated editor that will be used if the required editor is failed to create
* @param bool $noHtml dohtml disabled
*/
public function &get($name = "", $options = NULL, $noHtml = FALSE, $OnFailure = "") {
if ($editor = $this->_loadEditor($name, $options)) {
return $editor;
}
$list = array_keys($this->getList($noHtml));
if (empty($OnFailure) || !in_array($OnFailure, $list)) {
$OnFailure = $list[0];
}
$editor = $this->_loadEditor($OnFailure, $options);
return $editor;
}
/**
* Gets list of available editors
*
* @param bool $noHtml is this an editor with no html options?
* @return array $_list list of available editors that are allowed (through admin config)
*/
public function &getList($noHtml = FALSE) {
static $list = null;
$cache_file = ICMS_CACHE_PATH . '/' . $this->_type . 'editor_list.php';
if ($list === null && file_exists($cache_file)) {
$list = include($cache_file);
} else {
$list = array();
$order = array();
$_list = icms_core_Filesystem::getDirList($this->root_path . '/');
foreach ($_list as $item) {
if (@include $this->root_path . '/' . $item . '/editor_registry.php') {
if (empty($config['order'])) continue;
$order[] = $config['order'];
$list[$item] = array("title" => $config["title"], "nohtml" => @$config["nohtml"]);
}
}
array_multisort($order, $list);
$contents = "<?php\n return " . var_export($list, TRUE) . "\n?>";
icms_core_Filesystem::writeFile($contents, $this->_type . 'editor_list', 'php', ICMS_CACHE_PATH);
}
$editors = array_keys($list);
if (!empty($this->allowed_editors)) {
$editors = array_intersect($editors, $this->allowed_editors);
}
$_list = array();
foreach ($editors as $name) {
if (!empty($noHtml) && empty($list[$name]['nohtml'])) continue;
$_list[$name] = $list[$name]['title'];
}
return $_list;
}
/**
* Render the editor
* @param string &$editor Reference to the editor object
* @return string The rendered Editor string
*/
public function render(&$editor) {
return $editor->render();
}
/**
* Sets the config of the editor
*
* @param string &$editor Reference to the editor object
* @param string $options Options in the configuration to set
*/
public function setConfig(&$editor, $options) {
if (method_exists($editor, 'setConfig')) {
$editor->setConfig($options);
} else {
foreach ($options as $key => $val) {
$editor->$key = $val;
}
}
}
/**
* Loads the editor
*
* @param string $name Name of the editor to load
* @param string $options Options in the editor to load (configuration)
* @return object The loaded Editor object
*
*/
public function &_loadEditor($name, $options = NULL) {
$editor = NULL;
if (empty($name)) {
return $editor;
}
$editor_path = $this->root_path . "/" . $name;
if (!include $editor_path . "/editor_registry.php") {
return $editor;
}
if (empty($config['order'])) {
return NULL;
}
require_once $config['file'];
$editor = new $config['class']($options);
return $editor;
}
/**
* Determines the root path of the editor type
* @param string $type
* @return string
*/
private function _getRootPath($type = '') {
if ($type == '') {
return ICMS_EDITOR_PATH;
} else {
return ICMS_PLUGINS_PATH . '/' . strtolower($type) . 'editors/';
}
}
/**
* Retrieve a list of the available editors, by type
* @param string $type
* @return array Available editors
*/
static public function getListByType($type = '') {
$editor = self::getInstance($type);
return $editor->getList();
}
}