File libs/be_configure.php | BEdita API doc

  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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319

<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008-2015 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */
App::import('Model', 'ConnectionManager');

/**
 * BeConfigure class handle BEdita configuration 
 *
 */
class BeConfigure {
    
    /**
     * An array with all active relations
     *
     * @see self::mergeAllRelations()
     * @var array
     */
    private $relations = array();

    /**
     * initialize BEdita static configuration setting cache and
     * add plugged model and component path
     */
    public function initConfig() {
        $cachedConfig = Cache::read('beConfig');
        if ($cachedConfig  === false) {
            $cachedConfig = $this->cacheConfig();
        } else {
            $this->addModulesPaths($cachedConfig);
        }
        Configure::write($cachedConfig);
    }
    
    /**
     * cache object types array and module plugged configuration
     * 
     * @return array configuration cached 
     */
    public function cacheConfig() {
        $requiredTables = array("modules", "object_types");
        if (!$this->tableExists($requiredTables)) {
            return;
        }
        $conf = Configure::getInstance();
        $configurations = array();
                
        if (file_exists(BEDITA_ADDONS_PATH . DS . 'config' . DS . 'config.php')) {
            include BEDITA_ADDONS_PATH . DS . 'config' . DS . 'config.php';
        }

        $moduleModel = ClassRegistry::init('Module');
        $modules = $moduleModel->find('all', array(
                'conditions' => array('module_type' => array('plugin', 'addon'))
            )
        );
        if (!empty($modules)) {
            $pluginConfig = array();
            foreach ($modules as $m) {
                $modulePath = BEDITA_MODULES_PATH . DS . $m["Module"]["name"];
                if (is_dir($modulePath)) {
                    if (file_exists($modulePath . DS . "config" . DS . "config.php")) {
                        include $modulePath . DS . "config" . DS . "config.php";
                        if (!empty($config["objRelationType"])) {
                            $pluginConfig["objRelationType"] = (empty($pluginConfig["objRelationType"]))? $config["objRelationType"] : array_merge($pluginConfig["objRelationType"], $config["objRelationType"]);
                        }
                    }
                    $pluginConfig["modules"][$m["Module"]["name"]] = array(
                        "id" => $m["Module"]["id"],
                        "label" => $m["Module"]["label"],
                        "pluginPath" => $modulePath
                    );
                }
            }
        }
        
        $conf->plugged = array();
        if (!empty($pluginConfig)) {
            $conf->plugged = $pluginConfig;
        }
        $configurations["plugged"] = $conf->plugged;
        $this->addModulesPaths($configurations);
        
        $objectTypeModel = ClassRegistry::init("ObjectType");
        $ot = $objectTypeModel->find("all");
        if (!empty($ot)) {
            $configurations["objectTypes"] = array();
            foreach ($ot as $type) {
                $modelName = Inflector::camelize($type["ObjectType"]["name"]);
                $configurations["objectTypes"][$type["ObjectType"]["id"]] = $configurations["objectTypes"][$type["ObjectType"]["name"]] = array(
                    "id" => $type["ObjectType"]["id"],
                    "name" => $type["ObjectType"]["name"],
                    "module_name" => $type["ObjectType"]["module_name"],
                    "model" => $modelName
                );
                $objModel = ClassRegistry::init($modelName);
                if (!empty($objModel->objectTypesGroups)) {
                    foreach($objModel->objectTypesGroups as $group) {
                        $configurations["objectTypes"][$group]["id"][] = $type["ObjectType"]["id"];
                    }
                }
            }           
        }
        
        // read import / export filters
        $filters = array();
        $models = App::objects('model', null, false);
        foreach ($models as $modName) {
            $modClass = ClassRegistry::init($modName);
            if($modClass instanceof BeditaImportFilter) {
                $filters["import"][$modClass->name()] = $modName;
                foreach ($modClass->mimeTypes() as $v) {
                    $filters["mime"][$v]["import"] = $modName;
                }
            } else if($modClass instanceof BeditaExportFilter) {
                $filters["export"][$modClass->name()] = $modName;
                foreach ($modClass->mimeTypes() as $v) {
                    $filters["mime"][$v]["export"] = $modName;
                }
            }
        }
        if(empty($filters["import"])) {
            $filters["import"] = array();
        }
        if(empty($filters["export"])) {
            $filters["export"] = array();
        }
        $configurations["filters"] = $filters;
        
        Cache::write('beConfig', $configurations);

        // Flush loaded models and classes, so that classes are re-instantiated with configuration already available.
        // Get and restore the Session object in the registry to avoid issues on next session operations
        $sessionObject = ClassRegistry::getObject('Session');
        ClassRegistry::flush();
        if ($sessionObject) {
            ClassRegistry::addObject('Session', $sessionObject);
        }

        // set self::relations
        $this->mergeAllRelations(true);

        return $configurations;
    }

    /**
     * add models and components module plugin paths to BEdita core paths
     *
     * @param array $cachedConfig configuration cached
     */
    public function addModulesPaths(array $cachedConfig) {
        if (empty($cachedConfig["plugged"]["modules"])) {
            return;
        }

        $additionalPaths = array(
            'models' => array(),
            'behaviors' => array(),
            'components' => array(),
            'helpers' => array(),
        );
        foreach ($cachedConfig['plugged']['modules'] as $m) {
            $additionalPaths['models'][] = $m['pluginPath'] . DS . 'models' . DS;
            $additionalPaths['behaviors'][] = $m['pluginPath'] . DS . 'models' . DS . 'behaviors' . DS;
            $additionalPaths['components'][] = $m['pluginPath'] . DS . 'components' . DS;
            $additionalPaths['helpers'][] = $m['pluginPath'] . DS . 'helpers' . DS;
        }

        App::build($additionalPaths);
    }

    /**
     * write in configuration the external authorization types supported
     *
     * @return array of authorization type
     */
    public function setExtAuthTypes() {
        $beLib = BeLib::getInstance();
        $authTypes = array();
        $folder = new Folder();
        if ($folder->cd(BEDITA_ADDONS_PATH . DS . "components")) {
            $list = $folder->read(true, true);
            if (!empty($list[1])) {
                foreach ($list[1] as $componentFile) {
                    if (strstr($componentFile, "be_auth_")) {
                        $componentFile = basename($componentFile, ".php");
                        $componentClass = Inflector::camelize($componentFile);
                        if (App::import("Component", $componentClass)) {
                            $componentClass .= "Component";
                            $authComp = new $componentClass();
                            if (!$authComp->disabled) {
                                $authTypes[] = str_replace("be_auth_", "", $componentFile);
                            }
                        }
                    }
                }
            }
        }
        Configure::write("extAuthTypes", $authTypes);
        return $authTypes;
    }

    /**
     * check if table/s exist in certain database connection
     *
     * @param mixed $tableName, table name or array of table names
     * @param string $datasource, datasource to use
     * @return boolean
     */
    public function tableExists($tableName, $datasource="default") {
        $db = ConnectionManager::getDataSource($datasource);
        $tables = $db->listSources();
        if (!is_array($tableName)) {
            $tableName = array($tableName);
        }
        $intersect = array_intersect($tableName, $tables);
        return ($tableName === $intersect)? true : false;
    }
    
    /**
     * load local configuration of module plugged
     * file has to be named config_local.php and has to be in config folder of plugin
     * 
     * @param string $pluginName
     */
    public function loadPluginLocalConfig($pluginName, $configName = 'config_local') {
        $pluginPath = BEDITA_MODULES_PATH . DS . $pluginName;
        $configFile = $pluginPath . DS . 'config' . DS . $configName . '.php';
        if ( file_exists($configFile )){
            include $configFile;
            if (!empty($config)) {
                Configure::write($config);
            }
        }
    }


    /**
     * Returns array with all relations, merging defaultObjRelationType, objRelationType, plugged.objRelationType
     * Set also self::relations and use it when it's not empty and no forced reading is request
     *
     * @param boolean $forceReading true to force to read from config also if self::relations is populated
     * @return array
     */
    public function mergeAllRelations($forceReading = false) {
        if ($forceReading || empty($this->relations)) {
            $defaultObjRel = Configure::read("defaultObjRelationType");
            $cfgObjRel = Configure::read("objRelationType");
            $pluggedObjRel = Configure::read("plugged.objRelationType");
            if (!empty($cfgObjRel)) {
                foreach($cfgObjRel as $relation => $rules) {
                    if (isset($defaultObjRel[$relation])) {
                        $defaultObjRel[$relation]["left"] = array_merge($defaultObjRel[$relation]["left"], $rules["left"]);
                        $defaultObjRel[$relation]["right"] = array_merge($defaultObjRel[$relation]["right"], $rules["right"]);
                    } else {
                        $defaultObjRel[$relation] = $rules;
                    }
                }
            }
            if (!empty($pluggedObjRel)) {
                foreach($pluggedObjRel as $relation => $rules) {
                    if (isset($defaultObjRel[$relation])) {
                        $defaultObjRel[$relation]["left"] = array_merge($defaultObjRel[$relation]["left"], $rules["left"]);
                        $defaultObjRel[$relation]["right"] = array_merge($defaultObjRel[$relation]["right"], $rules["right"]);
                    } else {
                        $defaultObjRel[$relation] = $rules;
                    }
                }
            }
            $this->relations = $defaultObjRel;
        }

        return $this->relations;
    }

    /**
     * Tries to read ObjectType ID for given model from config, or from database as a fallback.
     *
     * @param string $modelName Model name.
     * @return int ObjectType ID, or `null` if none found.
     */
    public function getObjectTypeId($modelName) {
        $uModelName = Inflector::underscore($modelName);
        $otid = Configure::read("objectTypes.{$uModelName}.id");
        if (empty($otid)) {
            // Not found in config. Searching database..
            $res = ClassRegistry::init('ObjectType')->find('first', array(
                'conditions' => array('name' => $uModelName),
            ));
            if ($res) {
                $res = $res['ObjectType'];
                $otid = $res['id'];

                // Save for later use.
                $res['model'] = $modelName;
                Configure::write("objectTypes.{$uModelName}", $res);
                Configure::write("objectTypes.{$otid}", $res);
            }
        }
        return $otid ? $otid : null;  // Ensure `null` is returned in case no ID has been found.
    }
}

Classes

Interfaces

Exceptions