Source for file user_settings.inc.php

<?php
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SVN Web Control
Copyright ©2006 by sTEFANs
Created on 02.03.2006
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
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 General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
 
/**
 * This file contains a class that encapsulates and stores / restores
 * user settings of SWC.
 * 
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @copyright Copyright ©2006 by sTEFANs
 * @license http://opensource.org/licenses/lgpl-license.php GNU General Public License
 * @version v1.1.0
 * @since v1.0.0
 */
 
/** Common utility functions */
require_once('inc/utils.inc.php');
/** Common definitions */
require_once('inc/var.inc.php');
 
/** A singleton containing settings made by the user via GUI.
 * The instance of the class can be
 * retrieved via <b>GetInstance</b>.
 * 
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @since v1.0.0
 */
class SwcUserSettings {
    
    /**
     * The single instance.
     * @since v1.0.0
     */
    private static $instance = NULL;
    
    /**
     * Settings array.
     * @since v1.0.0
     */
    private $settings = NULL;
    
    /** 
     * Returns the single instance of this class.
     * @return SwcUserSettings Single instance of this class.
     * 
     * @since v1.0.0
     */
    public static function GetInstance(){
        if (self::$instance == NULL){
            self::$instance = new SwcUserSettings();
        }
        return self::$instance;
    }
    
    /** 
     * Determines whether the top control bar should be minimized.
     * @return boolean True if the control bar schould be minimized.
     * 
     * @since v1.0.0
     */ 
    public function IsMinimizeControlBar(){
        return ($this->configs[OPT_MINIMIZE_CTRL_BAR] == 1 ? true : false);
    }
    
    /** 
     * Sets whether the top control bar should be minimized.
     * @param boolean $minimize True if the control bar schould be minimized.
     * 
     * @since v1.0.0
     */
    public function SetMinimizeControlBar($minimize){
        $this->configs[OPT_MINIMIZE_CTRL_BAR] = ($minimize ? 1 : 0);
    }
    
    /** 
     * Determines whether the project page should always be shown,
     * regardles of the current action.
     * @return boolean True if the project page should always be shown.
     * 
     * @since v1.0.0
     */ 
    public function IsPinProjectPage(){
        return ($this->configs[OPT_PIN_PROJECT_PAGE] != 0 ? true : false);
    }
    
    /** 
     * Sets whether the project page should always be shown.
     * @param boolean $pin True if project page should always be shown.
     * 
     * @since v1.0.0
     */
    public function SetPinProjectPage($pin){
        $this->configs[OPT_PIN_PROJECT_PAGE] = ($pin ? 1 : 0);
    }
    
    /** 
     * Determines whether the webspace should automatically
     * be updated if it is outdated.
     * @return boolean True if the webspace should
     *  automatically be updated.
     * 
     * @since v1.0.0
     */ 
    public function IsAutoUpdate(){
        return ($this->configs[OPT_WEBSPACE_AUTO_UPDATE] != 0 ? true : false);
    }
    
    /** 
     * Sets whether the webspace should automatically
     * be updated if it is outdated.
     * @param boolean $enable True if the webspace should
     *  automatically be updated.
     * 
     * @since v1.0.0
     */
    public function SetAutoUpdate($enable){
        $this->configs[OPT_WEBSPACE_AUTO_UPDATE] = ($enable ? 1 : 0);
    }
    
    /** 
     * Determines whether command execution result
     * should be opened within a separate browser window.
     * @return boolean True if command execution result
     *  should be opened within a separate browser window.
     * 
     * @since v1.0.0
     */ 
    public function SetSeparateResultWindow($enable){
        $this->configs[OPT_SEPARATE_RESULT_WINDOW] = ($enable ? 1 : 0);
    }
    
    /** 
     * Determines whether command execution result
     * should be opened within a separate browser window.
     * @return boolean True if command execution result
     *  should be opened within a separate browser window.
     * 
     * @since v1.0.0
     */ 
    public function IsSeparateResultWindow(){
        return ($this->configs[OPT_SEPARATE_RESULT_WINDOW] != 0 ? true : false);
    }
    
    /** 
     * Provides the width in pixel for the project frame.
     * @return int Frame width in pixel.
     * 
     * @since v1.0.0
     */ 
    public function GetProjectFrameWidth(){
        return $this->configs[OPT_FRAME_WIDTH];
    }
    
    /** 
     * Sets the width in pixel for the project frame.
     * @param int $width Frame width in pixel.
     * 
     * @since v1.0.0
     */
    public function SetProjectFrameWidth($width){
        $this->configs[OPT_FRAME_WIDTH] = $width;
    }
    
    /** 
     * Provides the height in pixel for the project frame.
     * @return int Frame height in pixel.
     * 
     * @since v1.0.0
     */ 
    public function GetProjectFrameHeight(){
        return $this->configs[OPT_FRAME_HEIGHT];
    }
    
    /** 
     * Sets the height in pixel for the project frame.
     * @param int $width Frame height in pixel.
     * 
     * @since v1.0.0
     */
    public function SetProjectFrameHeight($height){
        $this->configs[OPT_FRAME_HEIGHT] = $height;
    }
    
    /** 
     * Sets SVN command bar to visible or invisible.
     * @param boolean $enable True if SVN command bar should
     *  be visible.
     * 
     * @since v1.0.0
     */
    function SetSvnCommandBarVisible($visible){
        $this->configs[OPT_SHOW_SVN_CMD_BAR] = ($visible ? 1 : 0);
    }
    
    /** 
     * Determines whether SVN command bar is visible.
     * @return boolean True if SVN command bar is visible.
     * 
     * @since v1.0.0
     */     
    function IsSvnCommandBarVisible(){
        return ($this->configs[OPT_SHOW_SVN_CMD_BAR] != 0 ? true : false);
    }
    
    /** 
     * Sets SVN switch bar to visible or invisible.
     * @param boolean $enable True if SVN switch bar should
     *  be visible.
     * 
     * @since v1.0.0
     */
    function SetSvnSwitchBarVisible($visible){
        $this->configs[OPT_SHOW_SVN_SWITCH_BAR] = ($visible ? 1 : 0);
    }
    
    /** 
     * Determines whether SVN switch bar is visible.
     * @return boolean True if SVN switch bar is visible.
     * 
     * @since v1.0.0
     */
    function IsSvnSwitchBarVisible(){
        return ($this->configs[OPT_SHOW_SVN_SWITCH_BAR] != 0 ? true : false);
    }
    
    /** 
     * Processes the user settings. This basically
     * means, that the function scans <b>$_GET</b>
     * and <b>$_POST</b> (preferred) for changes
     * in the settings, stores the changes and
     * restores the user settings.<br/>
     * <b>Important:</b>
     * Because user settings are stored via cookies,
     * it is important that this function is invoked
     * before any HTML or whitespace is printed!
     * @return boolean True if a user setting
     *  has been changed within <b>$_POST</b> or
     *  <b>$_GET</b>, false otherwise.
     * 
     * @since v1.0.0
     */
    public function ProcessSettings(){
        $this->RestoreSettings();
        $this->ScanArrayForSettings($_GET);
        $this->ScanArrayForSettings($_POST);
        $this->StoreSettings();
    }
    
    /** 
     * Scans the given array for user settings.
     * @param array $array Array to scan.
     * @return boolean True if changed settings are found.
     * 
     * @since v1.0.0
     */
    private function ScanArrayForSettings(&$array){
        $idx = 0;
        $idxs = $this->GetIndexArray();
        while ($idx < count($idxs)){
            if (isset($array[$idxs[$idx]])){
                $this->configs[$idxs[$idx]] = $array[$idxs[$idx]];
            }
            $idx++;
        }
    }
    
    /** 
     * Stores the user settings within a cookie.
     * 
     * @since v1.0.0
     */
    private function StoreSettings(){
        $vals = '';
        $idxs = $this->GetIndexArray();
        $idx = 0;
        while ($idx < count($idxs)-1){
            $vals .= $this->configs[$idxs[$idx]].';';
            $idx++;
        }
        $vals .= $this->configs[$idxs[count($idxs)-1]];
        // expires after 120 days
        $expire = time()+60*60*24*120;
        setcookie(IDX_USER_SETTINGS, $vals, $expire);
        // store them in the session as well in case user does not accept cookies.
        $_SESSION[IDX_USER_SETTINGS] = $vals;
    }
    
    /** 
     * Restores the user settings from the cookie.
     * 
     * @since v1.0.0
     */
    private function RestoreSettings(){
        $data = NULL;
        if (isset($_COOKIE[IDX_USER_SETTINGS])){
            $data = $_COOKIE[IDX_USER_SETTINGS];
        } else if (isset($_SESSION[IDX_USER_SETTINGS])){
            $data = $_SESSION[IDX_USER_SETTINGS];
        }
        if ($data != NULL){
            $vals = explode(';', $data);
            $idxs = $this->GetIndexArray();
            if ($vals[0] == 'v01'){
                $idx = 0;
                while ($idx < count($idxs)){
                    $this->configs[$idxs[$idx]] = $vals[$idx];
                    $idx++;
                }
            }
        }
    }
    
    /** 
     * Returns an array that provides mapping of index. The key
     * of this array is numeric and the value is the index
     * for the internal array.
     * @return array Key map.
     * 
     * @since v1.0.0
     */
    private function &GetIndexArray(){
        $map = array(
            IDX_SETTINGS_VERSION,
            OPT_MINIMIZE_CTRL_BAR,
            OPT_PIN_PROJECT_PAGE,
            OPT_WEBSPACE_AUTO_UPDATE,
            OPT_SEPARATE_RESULT_WINDOW,
            OPT_FRAME_WIDTH,
            OPT_FRAME_HEIGHT,
            OPT_SHOW_SVN_CMD_BAR,
            OPT_SHOW_SVN_SWITCH_BAR
            );
        return $map;
    }
    
    /** 
     * Singleton c'tor. Initializes user settings with default values.
     * 
     * @since v1.0.0
     */
    private function __construct(){
        $idxs = $this->GetIndexArray();
        $this->settings = array();
        $this->configs[$idxs[0]] = 'v01';
        $this->configs[$idxs[1]] = 0;
        $this->configs[$idxs[2]] = 0;
        $this->configs[$idxs[3]] = 0;
        $this->configs[$idxs[4]] = 0;
        $this->configs[$idxs[5]] = 1024;
        $this->configs[$idxs[6]] = 768;
        $this->configs[$idxs[7]] = 1;
        $this->configs[$idxs[8]] = 1;
    }
    
    /** 
     * Does nothing else as prevent from beeing cloned.
     * 
     * @since v1.0.0
     */
    public function __clone(){
  }
}
?>