0byt3m1n1

Path: /data/applications/aps.bak/phprojekt/6.0.6-0/standard/htdocs/library/Phprojekt/Module/ [ Home ]
File: Module.php
<?php
/**
 * Module model class.
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 3 as published by the Free Software Foundation
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * @category   PHProjekt
 * @package    Phprojekt
 * @subpackage Module
 * @copyright  Copyright (c) 2010 Mayflower GmbH (http://www.mayflower.de)
 * @license    LGPL v3 (See LICENSE file)
 * @link       http://www.phprojekt.com
 * @since      File available since Release 6.0
 * @version    Release: 6.0.6
 * @author     Gustavo Solt <solt@mayflower.de>
 */

/**
 * Module model class.
 *
 * @category   PHProjekt
 * @package    Phprojekt
 * @subpackage Module
 * @copyright  Copyright (c) 2010 Mayflower GmbH (http://www.mayflower.de)
 * @license    LGPL v3 (See LICENSE file)
 * @link       http://www.phprojekt.com
 * @since      File available since Release 6.0
 * @version    Release: 6.0.6
 * @author     Gustavo Solt <solt@mayflower.de>
 */
class Phprojekt_Module_Module extends Phprojekt_ActiveRecord_Abstract implements Phprojekt_Model_Interface
{
    /**
     * The standard information manager with hardcoded field definitions.
     *
     * @var Phprojekt_ModelInformation_Interface
     */
    protected $_informationManager;

    /**
     * Validate object.
     *
     * @var Phprojekt_Model_Validate
     */
    protected $_validate = null;

    /**
     * Constructor.
     *
     * @param array $db Configuration for Zend_Db_Table.
     *
     * @return void
     */
    public function __construct($db = null)
    {
        if (null === $db) {
            $db = Phprojekt::getInstance()->getDb();
        }
        parent::__construct($db);

        $this->_validate           = Phprojekt_Loader::getLibraryClass('Phprojekt_Model_Validate');
        $this->_informationManager = Phprojekt_Loader::getLibraryClass('Phprojekt_Module_Information');
    }

    /**
     * Define the clone function for prevent the same point to same object.
     *
     * @return void
     */
    public function __clone()
    {
        parent::__clone();
        $this->_validate           = Phprojekt_Loader::getLibraryClass('Phprojekt_Model_Validate');
        $this->_informationManager = Phprojekt_Loader::getLibraryClass('Phprojekt_Module_Information');
    }

    /**
     * Get the information manager.
     *
     * @see Phprojekt_Model_Interface::getInformation()
     *
     * @return Phprojekt_ModelInformation_Interface An instance of Phprojekt_ModelInformation_Interface.
     */
    public function getInformation()
    {
        return $this->_informationManager;
    }

    /**
     * Help to save a model by setting the models properties.
     * Validation is based on the ModelInformation implementation.
     *
     * @param Phprojekt_Model_Interface $model  The model.
     * @param array                     $params The parameters used to feed the model.
     *
     * @throws Phprojekt_PublishedException On no valid parameters.
     *
     * @return boolean True for a sucessful save.
     */
    public function saveModule(array $params)
    {
        $this->name     = ucfirst($params['name']);
        $this->label    = $params['label'];
        $this->active   = (int) $params['active'];
        $this->saveType = (int) $params['saveType'];
        $this->version  = Phprojekt::getInstance()->getVersion();

        if ($this->recordValidate()) {
            $saveNewModule = false;
            if ($this->id == 0) {
                $saveNewModule = true;
            }
            $this->save();

            // Add the new module to the root project
            if ($saveNewModule) {
                $project = Phprojekt_Loader::getModel('Project', 'Project')->find(1);
                $project->addModule($this->id);

                // Save Module into the role 1 with 255 access
                $role  = Phprojekt_Loader::getLibraryClass('Phprojekt_Role_RoleModulePermissions');
                $role->addModuleToAdminRole($this->id);

                // Get the first and second fields
                $field  = Phprojekt_DatabaseManager::COLUMN_NAME;
                $db     = Phprojekt::getInstance()->getDb();
                $select = $db->select()
                             ->from('database_manager')
                             ->where(sprintf('table_name = %s AND status = 1 AND %s != %s', $db->quote($this->name),
                                $field, $db->quote('project_id')));
                $results     = $db->query($select)->fetchAll();
                $firstField  = (isset($results[0][$field])) ? $results[0][$field] : 'id';
                $secondField = (isset($results[1][$field])) ? $results[1][$field] : 'id';

                // Copy Templates files
                $this->_copyTemplates(array('Template'), $firstField, $secondField);

                // Change SQL file
                $this->_createSqlFile();
            }

            // Reset cache for modules
            $moduleNamespace = new Zend_Session_Namespace('Phprojekt_Module_Module-_getCachedIds');
            $moduleNamespace->unsetAll();

            // Reset cache for relations
            $aclNamespace = new Zend_Session_Namespace('Phprojekt_Acl');
            $aclNamespace->unsetAll();

            return $this->id;
        } else {
            $errors = $this->getError();
            $error  = array_pop($errors);
            throw new Phprojekt_PublishedException($error['field'] . ' ' . $error['message']);
        }
    }

    /**
     * Validate the current record.
     *
     * @return boolean True for valid.
     */
    public function recordValidate()
    {
        $data   = $this->_data;
        $fields = $this->_informationManager->getFieldDefinition(Phprojekt_ModelInformation_Default::ORDERING_FORM);

        if ($this->_data['id'] == 1 && $this->_data['saveType'] != 0) {
            $this->_validate->error->addError(array(
                'field'   => 'Module',
                'label'   => Phprojekt::getInstance()->translate('Module'),
                'message' => Phprojekt::getInstance()->translate('Project module must be a normal module')));
                return false;
        }

        return $this->_validate->recordValidate($this, $data, $fields);
    }

    /**
     * Prevent delete modules from the Frontend.
     * For delete modules use safeDelete.
     *
     * @return void
     */
    public function delete()
    {
        // Delete all the project-module relations
        $project = Phprojekt_Loader::getModel('Project', 'ProjectModulePermissions');
        $project->deleteModuleRelation($this->id);

        // Delete all the role-module relations
        $role = Phprojekt_Loader::getLibraryClass('Phprojekt_Role_RoleModulePermissions');
        $role->deleteModuleRelation($this->id);

        // Delete the items and tags
        $tag   = Phprojekt_Tags::getInstance();
        $model = Phprojekt_Loader::getModel($this->name, $this->name);
        if ($model instanceof Phprojekt_ActiveRecord_Abstract) {
            $results = $model->fetchAll();
            if (is_array($results)) {
                foreach ($results as $record) {
                    $tag->deleteTagsByItem($this->id, $record->id);
                    // @todo: Improve the delete routine for modules with a lot of entries.
                    $record->delete();
                }
            }
        }

        // Delete Files
        $this->_deleteFolder(PHPR_USER_CORE_PATH . $this->name);

        // Delete module entry
        parent::delete();
    }

    /**
     * Return the error data.
     *
     * @return array Array with errors.
     */
    public function getError()
    {
        return (array) $this->_validate->error->getError();
    }

    /**
     * Save rights.
     *
     * @return void
     */
    public function saveRights()
    {
    }

    /**
     * Create a folder if this not exists in the system.
     *
     * The folder is created with 0770 permissions and then change it to 0775.
     *
     * @param array $pathToFolder Array with all the folder names.
     *
     * @return void
     */
    private function _makeFolder($pathToFolder)
    {
        $folderPath = PHPR_USER_CORE_PATH . $this->name;
        if (!is_dir($folderPath)) {
            if (mkdir($folderPath, 0770)) {
                chmod($folderPath, 0775);
            } else {
                Phprojekt::getInstance()->getLog()->debug('Error on create folder ' . $path);
            }
        }

        foreach ($pathToFolder as $key => $path) {
            if ($key > 0) {
                $folderPath .= DIRECTORY_SEPARATOR . $path;
            }
        }

        if (!is_dir($folderPath)) {
            if (mkdir($folderPath, 0770)) {
                chmod($folderPath, 0775);
            } else {
                Phprojekt::getInstance()->getLog()->debug('Error on create folder ' . $folderPath);
            }
        }
    }

    /**
     * Read the Template folder and try to reproduce it into the aplication folder.
     *
     * All the strings ##TEMPLATE## are replaced by the name of the module.
     * All the strings ##FIRSTFIELD## are replaced by the first field found.
     * All the strings ##SECONDFIELD## are replaced by the second field found.
     *
     * @param array  $paths       Array with all the folder names.
     * @param string $firstField  Name of the first field for display.
     * @param string $secondField Name of the second field for display.
     *
     * @return void
     */
    private function _copyTemplates($paths, $firstField, $secondField)
    {
        $templatePath = PHPR_LIBRARY_PATH;
        foreach ($paths as $path) {
            $templatePath .= DIRECTORY_SEPARATOR . $path;
        }
        $files = scandir($templatePath);
        foreach ($files as $file) {
            if ($file != '.'  && $file != '..') {
                if (is_dir($templatePath . DIRECTORY_SEPARATOR . $file)) {
                    array_push($paths, $file);
                    $this->_makeFolder($paths);
                    $this->_copyTemplates($paths, $firstField, $secondField);
                    array_pop($paths);
                } else {
                    $templateContent = file_get_contents($templatePath . DIRECTORY_SEPARATOR . $file);
                    $templateContent = str_replace("##TEMPLATE##", $this->name, $templateContent);
                    $templateContent = str_replace("##FIRSTFIELD##", $firstField, $templateContent);
                    $templateContent = str_replace("##SECONDFIELD##", $secondField, $templateContent);

                    if ($file == 'Template.php') {
                        $file = $this->name . '.php';
                    }

                    $modulePath = PHPR_USER_CORE_PATH . $this->name;
                    foreach ($paths as $key => $path) {
                        if ($key > 0) {
                            $modulePath .= DIRECTORY_SEPARATOR . $path;
                        }
                    }
                    if ($newFile = fopen($modulePath . DIRECTORY_SEPARATOR . $file, 'w')) {
                        if (false === fwrite($newFile, $templateContent)) {
                            Phprojekt::getInstance()->getLog()->debug('Error on copy file ' .
                                $modulePath . DIRECTORY_SEPARATOR . $file);
                        }
                        fclose($newFile);
                    }
                }
            }
        }
    }

    /**
     * Create an Db.json file for the module.
     *
     * @return void
     */
    private function _createSqlFile()
    {
        $eol        = "\n";
        $modulePath = PHPR_USER_CORE_PATH . $this->name . DIRECTORY_SEPARATOR . 'Sql' . DIRECTORY_SEPARATOR . 'Db.json';

        $content = file_get_contents($modulePath);

        $content = str_replace("##VERSION##", $this->version, $content);
        $content = str_replace("##MODULETABLE##", strtolower($this->name), $content);
        $content = str_replace("##MODULENAME##", $this->name, $content);
        $content = str_replace("##MODULELABEL##", $this->label, $content);
        $content = str_replace("##MODULESAVETYPE##", $this->saveType, $content);

        $module = Phprojekt_Loader::getModel($this->name, $this->name);
        $fields = $module->getInformation()->getDataDefinition();

        $structure   = '';
        $initialData = '';
        $space1      = '                ';
        $space2      = '                    ';
        $count       = count($fields);
        $i           = 0;
        foreach ($fields as $field) {
            $i++;
            if (empty($field['formRegexp'])) {
                $field['formRegexp'] = 'NULL';
            }
            if (empty($field['formRange'])) {
                $field['formRange'] = 'NULL';
            }
            if (empty($field['defaultValue'])) {
                $field['defaultValue'] = 'NULL';
            }
            $initialData .= $space1 . '{' . $eol;
            $initialData .= $space2 . '"table_name":      "' . $field['tableName'] . '",' . $eol;
            $initialData .= $space2 . '"table_field":     "' . $field['tableField'] . '",' . $eol;
            $initialData .= $space2 . '"form_tab":        "' . $field['formTab'] . '",' . $eol;
            $initialData .= $space2 . '"form_label":      "' . $field['formLabel'] . '",' . $eol;
            $initialData .= $space2 . '"form_type":       "' . $field['formType'] . '",' . $eol;
            $initialData .= $space2 . '"form_position":   "' . $field['formPosition'] . '",' . $eol;
            $initialData .= $space2 . '"form_columns":    "' . $field['formColumns'] . '",' . $eol;
            $initialData .= $space2 . '"form_regexp":     "' . $field['formRegexp'] . '",' . $eol;
            $initialData .= $space2 . '"form_range":      "' . $field['formRange'] . '",' . $eol;
            $initialData .= $space2 . '"default_value":   "' . $field['defaultValue'] . '",' . $eol;
            $initialData .= $space2 . '"list_position":   "' . $field['listPosition'] . '",' . $eol;
            $initialData .= $space2 . '"list_align":      "' . $field['listAlign'] . '",' . $eol;
            $initialData .= $space2 . '"list_use_filter": "' . $field['listUseFilter'] . '",' . $eol;
            $initialData .= $space2 . '"alt_position":    "' . $field['altPosition'] . '",' . $eol;
            $initialData .= $space2 . '"status":          "' . $field['status'] . '",' . $eol;
            $initialData .= $space2 . '"is_integer":      "' . $field['isInteger'] . '",' . $eol;
            $initialData .= $space2 . '"is_required":     "' . $field['isRequired'] . '",' . $eol;
            $initialData .= $space2 . '"is_unique":       "' . $field['isUnique'] . '"' . $eol;
            $initialData .= $space1 . '}';

            $structure .= $space1 . '"' . $field['tableField'] . '":     {"type": "' . $field['tableType'] . '"';
            if ($field['tableLength'] > 0) {
                if (($field['tableType'] == 'int' && $field['tableLength'] != 11) ||
                    ($field['tableType'] == 'varchar' && $field['tableLength'] != 255)) {
                    $structure .= ', "length": "' . $field['tableLength'] .'"';
                }
            }
            $structure .= '}';

            if ($i != $count) {
                $initialData .= ',' . $eol . $eol;
                $structure   .= ',' . $eol;
            }
        }

        $content = str_replace("##STRUCTURE##", $structure, $content);
        $content = str_replace("##INITIALDATA##", $initialData, $content);

        if ($file = fopen($modulePath, 'w')) {
            if (false === fwrite($file, $content)) {
                Phprojekt::getInstance()->getLog()->debug('Error on write file ' . $modulePath);
            }
            fclose($file);
        }
    }

    /**
     * Delete a folder with subfolders and files.
     *
     * @param srting $path The full path of the folder.
     *
     * @return boolean True for a sucessful delete.
     */
    private function _deleteFolder($path)
    {
        if (is_dir($path) && !is_link($path)) {
            if ($directory = opendir($path)) {
                while (($file = readdir($directory)) !== false) {
                    if ($file == '.' || $file == '..') {
                        continue;
                    }
                    if (!$this->_deleteFolder($path . DIRECTORY_SEPARATOR . $file)) {
                        Phprojekt::getInstance()->getLog()->debug($path . DIRECTORY_SEPARATOR
                            . $file .' could not be deleted');
                    }
                }
                closedir($directory);
            }

            return rmdir($path);
        }

        return unlink($path);
    }
}