homepagesettings.php

<?php
/*
* LimeSurvey
* Copyright (C) 2007-2011 The LimeSurvey Project Team / Carsten Schmitz
* All rights reserved.
* License: GNU/GPL License v2 or later, see LICENSE.php
* LimeSurvey is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*
* Home Page boxes can respect user permissions.
* To that goal, create user groups corresponding (like 'administrator', 'publisher', 'templateeditor') related to the permissions
* Inspired by ACL pattern, see : https://en.wikipedia.org/wiki/Access_control_list
*/

if (!defined('BASEPATH'))
    exit('No direct script access allowed');

class homepagesettings extends Survey_Common_Action
{
    public function __construct($controller, $id)
    {
        parent::__construct($controller, $id);
    }

    /**
     * Displays a particular model.
     * @param integer $id the ID of the model to be displayed
     */
    public function view($id)
    {
        if (!Permission::model()->hasGlobalPermission('settings', 'read') )
        {
            Yii::app()->session['flashmessage'] =gT('Access denied!');
            $this->getController()->redirect(App()->createUrl("/admin"));
        }
        $this->_renderWrappedTemplate('homepagesettings', 'read', array(
            'model'=>$this->loadModel($id),
        ));
    }

    /**
     * Creates a new model.
     * If creation is successful, the browser will be redirected to the 'view' page.
     */
    public function create()
    {
        if (! Permission::model()->hasGlobalPermission('settings', 'update') )
        {
            Yii::app()->session['flashmessage'] =gT('Access denied!');
            $this->getController()->redirect($this->createUrl("/admin/homepagesettings"));
        }

        $model=new Boxes;
        if(isset($_POST['Boxes']))
        {
            $model->attributes=$_POST['Boxes'];
            if($model->save())
            {
                Yii::app()->user->setFlash('success', gT('New box created'));
                if (isset($_POST['saveandclose']))
                {
                    $this->getController()->redirect(array('admin/homepagesettings'));
                }
                else
                {
                    $this->getController()->redirect(array('admin/homepagesettings/sa/update/id/'.$model->id));
                }
            }
            else
            {
                Yii::app()->user->setFlash('error', gT('Could not create new box'));
            }
        }

        $this->_renderWrappedTemplate('homepagesettings', 'create', array(
            'model'=>$model,
        ));

    }

    /**
     * Updates a particular model.
     * If update is successful, the browser will be redirected to the 'view' page.
     * @param integer $id the ID of the model to be updated
     */
    public function update($id)
    {
        if (! Permission::model()->hasGlobalPermission('settings', 'update') )
        {
            Yii::app()->session['flashmessage'] =gT('Access denied!');
            $this->getController()->redirect($this->createUrl("/admin/homepagesettings"));
        }

        $model=$this->loadModel($id);

        // Uncomment the following line if AJAX validation is needed
        // $this->performAjaxValidation($model);

        if(isset($_POST['Boxes']))
        {
            $model->attributes=$_POST['Boxes'];
            if($model->save())
            {
                Yii::app()->user->setFlash('success', gT('Box updated'));

                if (isset($_POST['saveandclose']))
                {
                    $this->getController()->redirect(array('admin/homepagesettings','id'=>$model->id));
                }
            }
            else
            {
                Yii::app()->user->setFlash('error', gT('Could not update box'));
            }
        }

        $this->_renderWrappedTemplate('homepagesettings', 'update', array(
            'model'=>$model,
        ));

    }

    /**
     * Deletes a particular model.
     * If deletion is successful, the browser will be redirected to the 'admin' page.
     * @param integer $id the ID of the model to be deleted
     */
    public function delete($id)
    {
        if (! Permission::model()->hasGlobalPermission('settings', 'update') )
        {
            Yii::app()->session['flashmessage'] =gT('Access denied!');
            $this->getController()->redirect($this->createUrl("/admin/homepagesettings"));
        }

        $this->loadModel($id)->delete();
        Yii::app()->user->setFlash('success', gT('Box deleted'));

        // if AJAX request (triggered by deletion via admin grid view), we should not redirect the browser
        if(!isset($_GET['ajax']))
        {
            $this->getController()->redirect(array('admin/homepagesettings'));
        }
    }

    /**
     * Lists all models.
     */
    public function index()
    {
        if (! Permission::model()->hasGlobalPermission('settings', 'read') )
        {
            Yii::app()->session['flashmessage'] =gT('Access denied!');
            $this->getController()->redirect(App()->createUrl("/admin"));
        }

        $dataProvider=new CActiveDataProvider('Boxes');
        $aData = array(
            'dataProvider'=>$dataProvider,
            'bShowLogo'=>(getGlobalSetting('show_logo')=="show"),
            'bShowLastSurveyAndQuestion'=>(getGlobalSetting('show_last_survey_and_question')=="show"),
            'iBoxesByRow'=>(int) getGlobalSetting('boxes_by_row'),
            'iBoxesOffset'=>(int) getGlobalSetting('boxes_offset'),
        );
        $this->_renderWrappedTemplate('homepagesettings', 'index', $aData);
    }

    /**
     * Manages all models.
     */
    public function admin()
    {
        $model=new Boxes('search');
        $model->unsetAttributes();  // clear any default values
        if(isset($_GET['Boxes']))
            $model->attributes=$_GET['Boxes'];

        $this->_renderWrappedTemplate('homepagesettings', 'admin', array(
            'model'=>$model,
        ));
    }

    /**
     * Returns the data model based on the primary key given in the GET variable.
     * If the data model is not found, an HTTP exception will be raised.
     * @param integer $id the ID of the model to be loaded
     * @return Boxes the loaded model
     * @throws CHttpException
     */
    public function loadModel($id)
    {
        $model=Boxes::model()->findByPk($id);
        if($model===null)
            throw new CHttpException(404,'The requested page does not exist.');
        return $model;
    }

    /**
     * Performs the AJAX toggle of show_logo setting
     */
    public function toggleShowLogoStatus()
    {
        if ( Permission::model()->hasGlobalPermission('settings', 'update') )
        {
            $bNewShowLogo = (getGlobalSetting('show_logo')=="show")?"hide":"show";
            setGlobalSetting('show_logo', $bNewShowLogo);
            echo $bNewShowLogo;
        }
    }

    /**
     * Performs the AJAX toggle of show_last_survey_and_question setting
     */
    public function toggleShowLastSurveyAndQuestion()
    {
        if ( Permission::model()->hasGlobalPermission('settings', 'update') )
        {
            $bNewShowLastSurveyAndQuestion = (getGlobalSetting('show_last_survey_and_question')=="show")?"hide":"show";
            setGlobalSetting('show_last_survey_and_question', $bNewShowLastSurveyAndQuestion);
            echo $bNewShowLastSurveyAndQuestion;
        }
    }

    /**
     * Performs the AJAX update of box setting
     */
    public function setBoxesSettings($boxesbyrow, $boxesoffset)
    {
        if ( Permission::model()->hasGlobalPermission('settings', 'update') )
        {
            setGlobalSetting('boxes_by_row', $boxesbyrow);
            setGlobalSetting('boxes_offset', $boxesoffset);
            return true;
        }
    }

    public function resetall()
    {
        if ( Permission::model()->hasGlobalPermission('settings', 'update') )
        {

            // We delete all the old boxes, and reinsert new ones
            Boxes::model()->deleteAll();

            // Then we recreate them
            $oDB = Yii::app()->db;
            $oDB->createCommand()->insert('{{boxes}}', array(
                'position' =>  '1',
                'url'      => 'admin/survey/sa/newsurvey' ,
                'title'    => 'Create survey' ,
                'ico'      => 'add' ,
                'desc'     => 'Create a new survey' ,
                'page'     => 'welcome',
                'usergroup' => '-2',
            ));

            $oDB->createCommand()->insert('{{boxes}}', array(
                'position' =>  '2',
                'url'      =>  'admin/survey/sa/listsurveys',
                'title'    =>  'List surveys',
                'ico'      =>  'list',
                'desc'     =>  'List available surveys',
                'page'     =>  'welcome',
                'usergroup' => '-1',
            ));

            $oDB->createCommand()->insert('{{boxes}}', array(
                'position' =>  '3',
                'url'      =>  'admin/globalsettings',
                'title'    =>  'Global settings',
                'ico'      =>  'global',
                'desc'     =>  'Edit global settings',
                'page'     =>  'welcome',
                'usergroup' => '-2',
            ));

            $oDB->createCommand()->insert('{{boxes}}', array(
                'position' =>  '4',
                'url'      =>  'admin/update',
                'title'    =>  'ComfortUpdate',
                'ico'      =>  'shield',
                'desc'     =>  'Stay safe and up to date',
                'page'     =>  'welcome',
                'usergroup' => '-2',
            ));

            $oDB->createCommand()->insert('{{boxes}}', array(
                'position' =>  '5',
                'url'      =>  'admin/labels/sa/view',
                'title'    =>  'Label sets',
                'ico'      =>  'labels',
                'desc'     =>  'Edit label sets',
                'page'     =>  'welcome',
                'usergroup' => '-2',
            ));

            $oDB->createCommand()->insert('{{boxes}}', array(
                'position' =>  '6',
                'url'      =>  'admin/templates/sa/view',
                'title'    =>  'Template editor',
                'ico'      =>  'templates',
                'desc'     =>  'Edit LimeSurvey templates',
                'page'     =>  'welcome',
                'usergroup' => '-2',
            ));
        }
        $this->getController()->redirect(array('admin/homepagesettings'));
    }

    /**
     * Performs the AJAX validation.
     * @param Boxes $model the model to be validated
     */
    protected function performAjaxValidation($model)
    {
        if(isset($_POST['ajax']) && $_POST['ajax']==='boxes-form')
        {
            echo CActiveForm::validate($model);
            Yii::app()->end();
        }
    }

    /**
    * Renders template(s) wrapped in header and footer
    *
    * @param string $sAction Current action, the folder to fetch views from
    * @param string|array $aViewUrls View url(s)
    * @param array $aData Data to be passed on. Optional.
    */
    protected function _renderWrappedTemplate($sAction = '', $aViewUrls = array(), $aData = array())
    {
        App()->getClientScript()->registerScriptFile( App()->getAssetManager()->publish( ADMIN_SCRIPT_PATH . 'homepagesettings.js' ));
        parent::_renderWrappedTemplate($sAction, $aViewUrls, $aData);
    }

}