Code refactoring (add autoloader and change files organization)

1 files changed, 238 insertions, 0 deletions

diff --git a/app/Controller/Base.php b/app/Controller/Base.php
new file mode 100644
index 00000000..bb9add4f
--- /dev/null
+++ b/app/Controller/Base.php
@@ -0,0 +1,238 @@
+<?php
+
+namespace Controller;
+
+use Core\Registry;
+use Core\Translator;
+use Model\LastLogin;
+
+/**
+ * Base controller
+ *
+ * @package  controller
+ * @author   Frederic Guillot
+ */
+abstract class Base
+{
+    /**
+     * Request instance
+     *
+     * @accesss public
+     * @var \Core\Request
+     */
+    public $request;
+
+    /**
+     * Response instance
+     *
+     * @accesss public
+     * @var \Core\Response
+     */
+    public $response;
+
+    /**
+     * Template instance
+     *
+     * @accesss public
+     * @var \Core\Template
+     */
+    public $template;
+
+    /**
+     * Session instance
+     *
+     * @accesss public
+     * @var \Core\Session
+     */
+    public $session;
+
+    /**
+     * Registry instance
+     *
+     * @access private
+     * @var Core\Registry
+     */
+    private $registry;
+
+    /**
+     * Constructor
+     *
+     * @access public
+     * @param  \Core\Registry  $registry   Registry instance
+     */
+    public function __construct(Registry $registry)
+    {
+        $this->registry = $registry;
+    }
+
+    /**
+     * Load automatically models
+     *
+     * @access public
+     * @param  string   $name   Model name
+     */
+    public function __get($name)
+    {
+        $class = '\Model\\'.ucfirst($name);
+        $this->registry->$name = new $class($this->registry->shared('db'), $this->registry->shared('event'));
+        return $this->registry->shared($name);
+    }
+
+    /**
+     * Method executed before each action
+     *
+     * @access public
+     */
+    public function beforeAction($controller, $action)
+    {
+        // Start the session
+        $this->session->open(BASE_URL_DIRECTORY, SESSION_SAVE_PATH);
+
+        // HTTP secure headers
+        $this->response->csp();
+        $this->response->nosniff();
+        $this->response->xss();
+        $this->response->hsts();
+        $this->response->xframe();
+
+        // Load translations
+        $language = $this->config->get('language', 'en_US');
+        if ($language !== 'en_US') Translator::load($language);
+
+        // Set timezone
+        date_default_timezone_set($this->config->get('timezone', 'UTC'));
+
+        // Authentication
+        if (! $this->acl->isLogged() && ! $this->acl->isPublicAction($controller, $action)) {
+
+            // Try the remember me authentication first
+            if (! $this->rememberMe->authenticate()) {
+
+                // Redirect to the login form if not authenticated
+                $this->response->redirect('?controller=user&action=login');
+            }
+            else {
+
+                $this->lastLogin->create(
+                    LastLogin::AUTH_REMEMBER_ME,
+                    $this->acl->getUserId(),
+                    $this->user->getIpAddress(),
+                    $this->user->getUserAgent()
+                );
+            }
+        }
+        else if ($this->rememberMe->hasCookie()) {
+            $this->rememberMe->refresh();
+        }
+
+        // Check if the user is allowed to see this page
+        if (! $this->acl->isPageAccessAllowed($controller, $action)) {
+            $this->response->redirect('?controller=user&action=forbidden');
+        }
+
+        // Attach events
+        $this->action->attachEvents();
+        $this->project->attachEvents();
+    }
+
+    /**
+     * Application not found page (404 error)
+     *
+     * @access public
+     */
+    public function notfound()
+    {
+        $this->response->html($this->template->layout('app_notfound', array('title' => t('Page not found'))));
+    }
+
+    /**
+     * Check if the current user have access to the given project
+     *
+     * @access protected
+     * @param  integer   $project_id  Project id
+     */
+    protected function checkProjectPermissions($project_id)
+    {
+        if ($this->acl->isRegularUser()) {
+
+            if ($project_id > 0 && ! $this->project->isUserAllowed($project_id, $this->acl->getUserId())) {
+                $this->response->redirect('?controller=project&action=forbidden');
+            }
+        }
+    }
+
+    /**
+     * Redirection when there is no project in the database
+     *
+     * @access protected
+     */
+    protected function redirectNoProject()
+    {
+        $this->session->flash(t('There is no active project, the first step is to create a new project.'));
+        $this->response->redirect('?controller=project&action=create');
+    }
+
+    /**
+     * Display the template show task (common between different actions)
+     *
+     * @access protected
+     * @param  array  $task               Task data
+     * @param  array  $comment_form       Comment form data
+     * @param  array  $description_form   Description form data
+     * @param  array  $comment_edit_form  Comment edit form data
+     */
+    protected function showTask(array $task, array $comment_form = array(), array $description_form = array(), array $comment_edit_form = array())
+    {
+        if (empty($comment_form)) {
+            $comment_form = array(
+                'values' => array('task_id' => $task['id'], 'user_id' => $this->acl->getUserId()),
+                'errors' => array()
+            );
+        }
+
+        if (empty($description_form)) {
+            $description_form = array(
+                'values' => array('id' => $task['id']),
+                'errors' => array()
+            );
+        }
+
+        if (empty($comment_edit_form)) {
+            $comment_edit_form = array(
+                'values' => array('id' => 0),
+                'errors' => array()
+            );
+        }
+        else {
+            $hide_comment_form = true;
+        }
+
+        $this->response->html($this->taskLayout('task_show', array(
+            'hide_comment_form' => isset($hide_comment_form),
+            'comment_edit_form' => $comment_edit_form,
+            'comment_form' => $comment_form,
+            'description_form' => $description_form,
+            'comments' => $this->comment->getAll($task['id']),
+            'task' => $task,
+            'columns_list' => $this->board->getColumnsList($task['project_id']),
+            'colors_list' => $this->task->getColors(),
+            'menu' => 'tasks',
+            'title' => $task['title'],
+        )));
+    }
+
+    /**
+     * Common layout for task views
+     *
+     * @access protected
+     * @param  string   $template   Template name
+     * @param  array    $params     Template parameters
+     */
+    protected function taskLayout($template, array $params)
+    {
+        $content = $this->template->load($template, $params);
+        $params['task_content_for_layout'] = $content;
+
+        return $this->template->layout('task_layout', $params);
+    }
+}