<?php
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2018 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 */

if (!defined('sugarEntry') || !sugarEntry) {
    die('Not A Valid Entry Point');
}
  /**
  * ViewFactory
  *
  * View factory class. This file is used by the controller along with a view paramter to build the
  * requested view.
  */
require_once('include/MVC/View/SugarView.php');

/**
 * Sugar view factory
 * @api
 */
class ViewFactory
{

    /**
     * Load the correct view
     *
     * @param string $type
     * @param null $module
     * @param null $bean
     * @param array $view_object_map
     * @param string $target_module
     * @return a|null
     */
    public static function loadView(
        $type = 'default',
        $module = '',
        $bean = null,
        $view_object_map = array(),
        $target_module = ''
    ) {
        $type = strtolower($type);

        //first let's check if the module handles this view

        $view = null;

        //Check to see if we should load a custom parent view instance
        loadParentView($type);

        if (!empty($target_module)) {
            if (file_exists('custom/modules/'.$target_module.'/views/view.'.$type.'.php')) {
                $view = ViewFactory::_buildFromFile('custom/modules/'.$target_module.'/views/view.'.$type.'.php', $bean, $view_object_map, $type, $target_module);
            } elseif (file_exists('modules/'.$target_module.'/views/view.'.$type.'.php')) {
                $view = ViewFactory::_buildFromFile('modules/'.$target_module.'/views/view.'.$type.'.php', $bean, $view_object_map, $type, $target_module);
            }
        }

        if (!isset($view)) {
            if (file_exists('custom/modules/'.$module.'/views/view.'.$type.'.php')) {
                $view = ViewFactory::_buildFromFile('custom/modules/'.$module.'/views/view.'.$type.'.php', $bean, $view_object_map, $type, $module);
            } elseif (file_exists('modules/'.$module.'/views/view.'.$type.'.php')) {
                $view = ViewFactory::_buildFromFile('modules/'.$module.'/views/view.'.$type.'.php', $bean, $view_object_map, $type, $module);
            } elseif (file_exists('custom/include/MVC/View/views/view.'.$type.'.php')) {
                $view = ViewFactory::_buildFromFile('custom/include/MVC/View/views/view.'.$type.'.php', $bean, $view_object_map, $type, $module);
            } else {
                //if the module does not handle this view, then check if Sugar handles it OOTB
                $file = 'include/MVC/View/views/view.'.$type.'.php';
                if (file_exists($file)) {
                    //it appears Sugar does have the proper logic for this file.
                    $view = ViewFactory::_buildFromFile($file, $bean, $view_object_map, $type, $module);
                }
            }
        }
        // Default to SugarView if still nothing found/built
        if (!isset($view)) {
            $view = new SugarView();
        }
        ViewFactory::_loadConfig($view, $type);
        return $view;
    }

    /**
     * Load the view_<view>_config.php file which holds options used by the view.
     */
    public static function _loadConfig(&$view, $type)
    {
        $view_config_custom = array();
        $view_config_module = array();
        $view_config_root_cstm = array();
        $view_config_root = array();
        $view_config_app = array();
        $config_file_name = 'view.'.$type.'.config.php';
        $view_config = sugar_cache_retrieve("VIEW_CONFIG_FILE_".$view->module."_TYPE_".$type);
        if (!$view_config) {
            if (file_exists('custom/modules/'.$view->module.'/views/'.$config_file_name)) {
                require_once('custom/modules/'.$view->module.'/views/'.$config_file_name);
                $view_config_custom = $view_config;
            }
            if (file_exists('modules/'.$view->module.'/views/'.$config_file_name)) {
                require_once('modules/'.$view->module.'/views/'.$config_file_name);
                $view_config_module = $view_config;
            }
            if (file_exists('custom/include/MVC/View/views/'.$config_file_name)) {
                require_once('custom/include/MVC/View/views/'.$config_file_name);
                $view_config_root_cstm = $view_config;
            }
            if (file_exists('include/MVC/View/views/'.$config_file_name)) {
                require_once('include/MVC/View/views/'.$config_file_name);
                $view_config_root = $view_config;
            }
            if (file_exists('include/MVC/View/views/view.config.php')) {
                require_once('include/MVC/View/views/view.config.php');
                $view_config_app = $view_config;
            }
            $view_config = array('actions' => array(), 'req_params' => array(),);

            //actions
            if (!empty($view_config_app) && !empty($view_config_app['actions'])) {
                $view_config['actions'] = array_merge($view_config['actions'], $view_config_app['actions']);
            }
            if (!empty($view_config_root) && !empty($view_config_root['actions'])) {
                $view_config['actions'] = array_merge($view_config['actions'], $view_config_root['actions']);
            }
            if (!empty($view_config_root_cstm) && !empty($view_config_root_cstm['actions'])) {
                $view_config['actions'] = array_merge($view_config['actions'], $view_config_root_cstm['actions']);
            }
            if (!empty($view_config_module) && !empty($view_config_module['actions'])) {
                $view_config['actions'] = array_merge($view_config['actions'], $view_config_module['actions']);
            }
            if (!empty($view_config_custom) && !empty($view_config_custom['actions'])) {
                $view_config['actions'] = array_merge($view_config['actions'], $view_config_custom['actions']);
            }

            //req_params
            if (!empty($view_config_app) && !empty($view_config_app['req_params'])) {
                $view_config['req_params'] = array_merge($view_config['req_params'], $view_config_app['req_params']);
            }
            if (!empty($view_config_root) && !empty($view_config_root['req_params'])) {
                $view_config['req_params'] = array_merge($view_config['req_params'], $view_config_root['req_params']);
            }
            if (!empty($view_config_root_cstm) && !empty($view_config_root_cstm['req_params'])) {
                $view_config['req_params'] = array_merge($view_config['req_params'], $view_config_root_cstm['req_params']);
            }
            if (!empty($view_config_module) && !empty($view_config_module['req_params'])) {
                $view_config['req_params'] = array_merge($view_config['req_params'], $view_config_module['req_params']);
            }
            if (!empty($view_config_custom) && !empty($view_config_custom['req_params'])) {
                $view_config['req_params'] = array_merge($view_config['req_params'], $view_config_custom['req_params']);
            }

            sugar_cache_put("VIEW_CONFIG_FILE_".$view->module."_TYPE_".$type, $view_config);
        }
        $action = strtolower($view->action);
        $config = null;
        if (!empty($view_config['req_params'])) {
            //try the params first
            foreach ($view_config['req_params'] as $key => $value) {
                if (!empty($_REQUEST[$key]) && $_REQUEST[$key] == "false") {
                    $_REQUEST[$key] = false;
                }
                if (!empty($_REQUEST[$key])) {
                    if (!is_array($value['param_value'])) {
                        if ($value['param_value'] ==  $_REQUEST[$key]) {
                            $config = $value['config'];
                            break;
                        }
                    } else {
                        foreach ($value['param_value'] as $v) {
                            if ($v ==  $_REQUEST[$key]) {
                                $config = $value['config'];
                                break;
                            }
                        }
                    }
                }
            }
        }
        if ($config == null && !empty($view_config['actions']) && !empty($view_config['actions'][$action])) {
            $config = $view_config['actions'][$action];
        }
        if ($config != null) {
            $view->options = $config;
        }
    }

    /**
     * This is a private function which just helps the getView function generate the
     * proper view object
     *
     * @return a valid SugarView
     */
    public static function _buildFromFile($file, &$bean, $view_object_map, $type, $module)
    {
        require_once($file);
        //try ModuleViewType first then try ViewType if that fails then use SugarView
        $class = ucfirst($module).'View'.ucfirst($type);
        $customClass = 'Custom' . $class;

        if (class_exists($customClass)) {
            return ViewFactory::_buildClass($customClass, $bean, $view_object_map);
        }
        if (class_exists($class)) {
            return ViewFactory::_buildClass($class, $bean, $view_object_map);
        }
        //Now try the next set of possibilites if it was none of the above
        $class = 'View'.ucfirst($type);
        $customClass = 'Custom' . $class;
        if (class_exists($customClass)) {
            return ViewFactory::_buildClass($customClass, $bean, $view_object_map);
        }
        if (class_exists($class)) {
            return ViewFactory::_buildClass($class, $bean, $view_object_map);
        }
        //Now check if there is a custom SugarView for generic handling
        if (file_exists('custom/include/MVC/View/SugarView.php')) {
            require_once('custom/include/MVC/View/SugarView.php');
            if (class_exists('CustomSugarView')) {
                return new CustomSugarView($bean, $view_object_map);
            }
        }
        //if all else fails return SugarView
        return new SugarView($bean, $view_object_map);
    }

    /**
     * instantiate the correct view and call init to pass on any obejcts we need to
     * from the controller.
     *
     * @param string class - the name of the class to instantiate
     * @param object bean = the bean to pass to the view
     * @param array view_object_map - the array which holds obejcts to pass between the
     *                                controller and the view.
     *
     * @return SugarView
     */
    public static function _buildClass($class, $bean, $view_object_map)
    {
        $view = new $class();
        $view->init($bean, $view_object_map);
        if ($view instanceof SugarView) {
            return $view;
        }
        return new SugarView($bean, $view_object_map);
    }
}
