root/events/phpframework/zend_framework/trunk/app/Init.php @ 15805

<?php
/**
 * Init
 *
 * PHP version 5.2
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 *
 * @category Phwittr
 * @package Init
 * @version $id$
 * @copyright 2008 Heavens hell
 * @author Heavens hell <heavenshell.jp@gmail.com>
 * @license New BSD License
 */

/**
 * Initialize class for run applications
 *
 * @category Phwittr
 * @package Init
 * @version $id$
 * @copyright 2008 Heavens hell
 * @author Heavens hell <heavenshell@heavenshell.jp>
 * @license New BSD License
 */
final class Init
{
    /**
     * Values of configs.ini
     *
     * @var mixed
     * @access private
     */
    private $_configs;

    /**
     * View object
     *
     * @var Zend_View_Interface
     * @access private
     */
    private $_view = null;

    /**
     * Suffix of view file
     *
     * @var string
     * @access private
     */
    private $_viewSuffix = '';

    /**
     * Paramaters to controller
     *
     * @var array
     * @access private
     */
    private $_params = array();

    /**
     * Directory paths
     *
     * @var array
     * @access private
     */
    private $_dirs = array();

    /**
     * Module name
     *
     * @var array
     * @access private
     */
    private $_modules = array();

    /**
     * Routes which get from ini file
     *
     * @var Zend_Config
     * @access private
     */
    private $_routes = null;

    /**
     * Constructor
     *
     * @access public
     * @return void
     */
    public function __construct($appPath = null)
    {
        if (is_null($appPath) === true) {
            $appPath = dirname(__FILE__);
        }
        $appPath = rtrim($appPath, '/\\') . DIRECTORY_SEPARATOR;
        $this->_setParam('appPath', $appPath);

        require_once 'Zend/Loader.php';
        Zend_Loader::registerAutoload();
    }

    /**
     * Load settings
     *
     * @access public
     * @return Init
     */
    public function load()
    {
        $this->_loadCoreConfig()
            ->_loadTemplateEngine()
            ->_setViewRender()
            ->_loadLayoutSetting()
            ->_loadPaths()
            ->_loadDbAdapter();

        return $this;
    }

    /**
     * Load database adapter
     *
     * @access private
     * @return Init
     */
    private function _loadDbAdapter()
    {
        $file = $this->_getParam('appPath') . 'configs' . DIRECTORY_SEPARATOR . 'database.ini';
        $ini  = $this->_loadConfig($file, $this->_configs['global']['env_mode'], false);
        $db   = Zend_Db::factory($ini->database->adapter, $ini->database->params->toArray());
        $db->setFetchMode(Zend_Db::FETCH_ASSOC);
        Zend_Db_Table_Abstract::setDefaultAdapter($db);

        return $this;
    }

    /**
     * Load template engine
     *
     * @access private
     * @return Init
     * @throws Zend_Config_Exception
     */
    private function _loadTemplateEngine()
    {
        // Todo:Move to plugin
        $engine = $this->_configs['template']['engine'];
        if (!isset($engine)) {
            throw new Zend_Config_Exception('Template engine does not set.');
        }
        $rootDir     = $this->_getParam('rootDir');
        $viewIniFile = $this->_getParam('appPath') . 'configs' . DIRECTORY_SEPARATOR . 'view.ini';
        $config      = $this->_loadConfig($viewIniFile, $engine);

        $className   = 'Phwittr_View_Adapter_' . $engine;
        $reflection  = new ReflectionClass($className);
        $args        = array($config, $rootDir);
        $class       = $reflection->newInstanceArgs($args);
        $this->_view = $class->getView();

        // If helper path exist, set to params
        if (isset($this->_configs['template']['helper']['path'])
                && isset($this->_configs['template']['helper']['prefix'])) {

            $path   = $rootDir . $this->_configs['template']['helper']['path'];
            $prefix = $this->_configs['template']['helper']['prefix'];

            $this->_view->addHelperPath($path, $prefix);
        }

        return $this;
    }

    /**
     * Load layout setting
     *
     * @access private
     * @return Init
     */
    private function _loadLayoutSetting()
    {
        // Todo: Move to plugin
        $rootDir = $this->_getParam('rootDir');
        if (is_array($this->_configs['layout'])
                && $this->_configs['layout']['layoutPath']) {

            $layoutArray = $this->_configs['layout']['layoutPath'];
            $pathArray   = pathinfo($layoutArray);
            $layoutName  = $pathArray['filename'];
            $suffix      = $pathArray['extension'];
            $layoutPath  = $rootDir . $pathArray['dirname'];

            if (isset($this->_configs['layout']['contentKey'])) {
                $contentKey = $this->_configs['layout']['contentKey'];
            } else {
                $contentKey = 'content';
            }

            $options = array(
                'layout'     => $layoutName,
                'layoutPath' => $layoutPath,
                'contentKey' => $contentKey
            );

            $layout = new Zend_Layout($options, true);
        }
        return $this;
    }

    /**
     * Set view instance to ViewRenderer
     *
     * @access private
     * @return Init
     * @throws Zend_Exception
     */
    private function _setViewRender()
    {
        // Todo: Move to plugin
        if ($this->_view instanceof Zend_View) {
            return $this;
        }
        if ($this->_view == null) {
            throw new Zend_Exception('View object is null.');
        }

        // Set template file's suffix.
        $viewSuffix = 'php';
        if (isset($this->_configs['template']['suffix'])) {
            $viewSuffix = $this->_configs['template']['suffix'];
        }

        // Add to action helper.
        $this->_viewSuffix = $viewSuffix;

        $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();
        $viewRenderer->setView($this->_view)
                ->setViewSuffix($viewSuffix);
        Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);

        return $this;
    }

    /**
     * Get parameter
     *
     * @param mixed $key Parameter key
     * @access private
     * @return mixed parameter or null
     */
    private function _getParam($key = null)
    {
        if ($key === null) {
            return $this->_params;
        }
        if (!array_key_exists($key, $this->_params)) {
            return null;
        }
        return $this->_params[$key];
    }

    /**
     * Add or modify a parameter to use controller
     *
     * @param mixed $value Paramater key
     * @param mixed $key Paramater value
     * @access private
     * @return Init
     */
    private function _setParam($key, $value)
    {
        $this->_params[$key] = $value;
        return $this;
    }

    /**
     * Load config ini file
     *
     * @param mixed $file Path to ini file
     * @param mixed $option Section name
     * @param bool $toArray true:Return array
     * @access private
     * @return mixed Zend_Config_Ini object or Array
     * @throws Zend_Config_Exception
     */
    private function _loadConfig($file, $section = null, $toArray = true)
    {
        if (!file_exists($file)) {
            throw new Zend_Config_Exception('Could not load ini file.');
        }

        $config = new Zend_Config_Ini($file, $section);
        if ($toArray === true) {
            return $config->toArray();
        }
        return $config;
    }

    /**
     * Load core config ini file
     *
     * @access private
     * @return Init
     * @throws Zend_Config_Exception
     */
    private function _loadCoreConfig()
    {
        $appPath = $this->_getParam('appPath');
        $file = $appPath . 'configs' . DIRECTORY_SEPARATOR . 'core.ini';
        if (!file_exists($file)) {
            throw new Zend_Config_Exception('Could not load configs.ini.');
        }
        $this->_configs = $this->_loadConfig($file);

        $mode = 'production';
        if (isset($this->_configs['global']['env_mode'])) {
            $mode = $this->_configs['global']['env_mode'];
        }

        $rootDir = dirname(dirname(__FILE__));
        if (isset($this->_configs['global']['root_dir'])) {
            $rootDir = $this->_configs['global']['root_dir'];
        }
        $rootDir = rtrim($rootDir, '\//') . DIRECTORY_SEPARATOR;

        $moduleDir = $appPath . 'modules';
        if (isset($this->_configs['global']['modules_dir'])) {
            $moduleDir = $this->_configs['global']['modules_dir'];
        }
        $moduleDir = rtrim($moduleDir, '\//') . DIRECTORY_SEPARATOR;

        $cacheDir = $rootDir . 'var' . DIRECTORY_SEPARATOR . 'cache';
        if (isset($this->_configs['global']['cache_dir'])) {
            $cacheDir = $this->_configs['global']['cache_dir'];
        }
        $cacheDir = rtrim($cacheDir, '\//') . DIRECTORY_SEPARATOR;

        $logDir = $rootDir . 'var' . DIRECTORY_SEPARATOR . 'log';
        if (isset($this->_configs['global']['log_dir'])) {
            $logDir = $this->_configs['global']['log_dir'];
        }
        $logDir = rtrim($logDir, '/\\') . DIRECTORY_SEPARATOR;
        $this->_setParam('rootDir', $rootDir);
        $this->_setParam('cacheDir', $cacheDir);
        $this->_setParam('moduleDir', $moduleDir);
        $this->_setParam('logDir', $logDir);
        $this->_setParam('envMode', $mode);

        return $this;
    }

    /**
     * Load settings.ini
     *
     * @access private
     * @return Init
     * @throw Zend_Controller_Exception
     */
    private function _loadPaths()
    {
        $appPath = $this->_getParam('appPath');
        $file    = $appPath . 'configs' . DIRECTORY_SEPARATOR . 'setting.ini';
        if (!file_exists($file)) {
            throw new Zend_Controller_Exception('Could not load setting.ini');
        }

        // Get path setting from config file.
        $modelPaths   = array();
        $layoutPaths  = array();
        $servicePaths = array();
        $pathObj      = $this->_loadConfig($file, null, false);

        // Get routes settings for _initRoute().
        if (is_object($pathObj) && $pathObj->get('routes') !== null) {
            $this->_routes = $pathObj->get('routes');
        }

        $paths = $pathObj->toArray();

        if (is_array($paths)) {
            $rootDir   = $this->_getParam('rootDir');
            $moduleDir = $this->_getParam('moduleDir');

            // Set module name first.
            foreach ($paths as $key => $val) {
                $this->_modules = array_merge($this->_modules, array_keys($val));
            }

            // Get module name.
            $this->_modules = array_unique($this->_modules);
            foreach ($this->_modules as $key => $val) {
                if (isset($paths['layouts'][$val])) {
                    if (is_array($paths['layouts'][$val]['path'])) {
                        foreach ($paths['layouts'][$val]['path'] as $layoutKey => $layoutVal) {
                            $layoutPaths[$val][$layoutKey] = $rootDir . $layoutVal;
                        }
                    } else {
                        $layoutPaths[$val] = $rootDir . $paths['layouts'][$val]['path'];
                    }
                }

                if (isset($paths['models'][$val])) {
                    $modelPaths[$val] = $rootDir . $paths['models'][$val]['path'];
                }

                if (isset($paths['services'][$val])) {
                    $servicePaths[$val] = $rootDir . $paths['services'][$val]['path'];
                }
            }

            $this->_setParam('models', $modelPaths);
            $this->_setParam('layouts', $layoutPaths);
            $this->_setParam('services', $servicePaths);
        }

        return $this;
    }

    /**
     * Create plugin objects
     *
     * @access private
     * @return array Plugin object or null
     */
    private function _getPlugins()
    {
        if (!isset($this->_configs['plugin']['directory'])) {
            return null;
        }
        if (!isset($this->_configs['plugin']['classPrefix'])) {
            return null;
        }

        $path   = rtrim($this->_configs['plugin']['directory'], '/\\') . DIRECTORY_SEPARATOR;
        $path   = $this->_getParam('rootDir') . $path;
        $prefix = $this->_configs['plugin']['classPrefix'] . '_';

        // Create plugin instance from plugin directory.
        // Prefix of plugin class name is defined in config ini file.
        $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));
        $objArray = array();
        foreach ($iterator as $val) {
            if ($val->isFile()) {
                $pathArray = pathinfo($val->getPathname());
                if ($pathArray['extension'] !== 'php') {
                    continue;
                }

                // Create instance
                require_once $val->getPathname();
                if (basename($val->getPath()) === basename($path)) {
                    $className = $prefix . $pathArray['filename'];
               } else {
                    $className = $prefix . basename($val->getPath()) . '_' . $pathArray['filename'];
                }

                $classObj = new $className;
                if ($classObj instanceof Zend_Controller_Plugin_Abstract) {
                    $objArray[] = $classObj;
                }
            }
        }

        return $objArray;
    }

    /**
     * Initialize route settings
     *
     * @param mixed $route Zend_Controller_Router_Rewrite Router
     * @param mixed $defaultModule string Default module name
     * @access private
     * @return Zend_Controller_Router_Rewrite Router
     */
    private function _initRoute(Zend_Controller_Router_Rewrite $router, $defaultModule)
    {
        if (!$router instanceof Zend_Controller_Router_Rewrite) {
            throw new Zend_Exception('Invaild arguments.');
        }
        if ($defaultModule === '') {
            throw new Zend_Exception('Invaild arguments.');
        }

        // Default settings. 
        $router->removeDefaultRoutes();
        if (is_array($this->_modules)) {
            $moduleName = '';
            foreach ($this->_modules as $key => $val) {
                if ($val !== $defaultModule) {
                    $moduleName = $val . '/';
                }
                $route = new Zend_Controller_Router_Route(
                    $moduleName . ':controller/:action/*',
                    array(
                        'module'     => $val,
                        'controller' => 'index',
                        'action'     => 'index'
                    )
                );
                $router->addRoute($val, $route);
            }
        }

        // Additional settings which is defained in ini file.
        if ($this->_routes !== null) {
            $router->addConfig($this->_routes);
        }

        return $this;
    }

    /**
     * Run application
     *
     * @access public
     * @return void
     */
    public function run()
    {
        try {
            $front = Zend_Controller_Front::getInstance();
            $front->setParam('config', $this->_getParam());

//            // Register plugin
//            $plugins = $this->_getPlugins();
//            if (is_array($plugins)) {
//                foreach ($plugins as $key => $val) {
//                    $front->registerPlugin($val);
//                }
//            }
            $front->registerPlugin(new Phwittr_Controller_Plugin_Login());

            $defaultModule = 'default';
            if (isset($this->_configs['global']['default_module'])) {
                $defaultModule = $this->_configs['global']['default_module'];
            }

            // Register router
            $router = $front->getRouter();
            $this->_initRoute($router, $defaultModule);

            $front->setDefaultModule($defaultModule)
                ->addModuleDirectory($this->_getParam('moduleDir'))
                ->dispatch();

        } catch (Zend_Exception $e) {
        }
    }
}