SWAT/session/SUserConfig.php5

<?php

class SUserConfig extends SObject {
    private $types = array();
    private $default = array();
    private $user = array();
    private $session = array();

    private $userId = null;
    private $project = null;

    private $userToSave = array();

    private $_result;

    private static $DBI = null;

    public function __construct($project = '*', $userId = null) {
        parent::__construct();

        if(self::$DBI) {
            self::$DBI = new DBI2('userconfig', SConfig::getDefault('snap2.prod.dbhost'),
                                                SConfig::getDefault('snap2.prod.dbname'),
                                                SConfig::getDefault('snap2.prod.admin.dbuser'),
                                                SConfig::getDefault('snap2.prod.admin.dbpass'));
        }

        if($userId === null) {
            // TODO: checks to make sure this is valid
            $guser = $GLOBALS['SWAT']->getGlobalUser();
            $ldap = $guser->getAuthModule('ldap');
            $userId = $ldap->getUID();
        }

        $this->project = $project;
        $this->userId = $userId;

        $this->loadDefaults();
        $this->loadUser();
        $this->loadSession();

        register_shutdown_function(array($this, 'saveSession'));
    }

    public function loadDefaults() {
        if(isset($GLOBALS['USER_CONFIG_DEFAULTS'])) {
            foreach($GLOBALS['USER_CONFIG_DEFAULTS'] as $entry) {
                $this->setDefault($entry[0], $entry[1], $entry[2], $entry[3]);
            }
        }
    }

    public function loadUser() {
        $query = 'SELECT opt, page, value FROM UserConfig WHERE uid = ' . $this->userId
                . ' AND project = \'' . mysql_escape_string($this->project) . '\'';
        $result = self::$DBI->query($query);
        foreach($result as $r) {
            $this->setUser($r['opt'], $r['page'], $r['value']);
        }
    }

    public function loadSession() {
        $key = 'SWATUC:' . $this->project . ':' . $this->userId;
        if(isset($_SESSION[$key]))
            $this->session = json_decode($_SESSION[$key], true);
    }

    public function saveUser() {
        if(count($this->userToSave) == 0) {
            return true;}

        $remove = array();
        $removeNum = 0;
        $add = array();

        foreach($this->userToSave as $constraints => $keep) {
            $tmp = explode("\000", $constraints);
            $opt = $tmp[0];
            $page = $tmp[1];
            if($keep)
                $add[] = '(\'' . mysql_escape_string($this->project) . '\', ' . $this->userId . ', \''
                            . mysql_escape_string($opt) . '\', \'' . mysql_escape_string($page) . '\', \''
                            . mysql_escape_string($this->user[$opt][$page]) . '\')';
            else
                $remove[] = '(opt="' . mysql_escape_string($opt) . '"'
                        . ' AND page="' . mysql_escape_string($page) . '"'
                        . ' AND project="' . mysql_escape_string($this->project) . '"'
                        . ' AND uid=' . $this->userId . ')';
            $removeNum++;
        }

        self::$DBI->startTransaction();

        if(!empty($add)) {
            $addQuery = 'REPLACE INTO UserConfig (project, uid, opt, page, value) VALUES ' . implode(',', $add);
            if(self::$DBI->query($addQuery) === null) {
                self::$DBI->cancelTransaction();
                return false;
            }
        }

        if(!empty($remove)) {
            $delQuery = 'DELETE FROM UserConfig WHERE ' . implode(' OR ', $remove) . ' LIMIT ' . $removeNum;
            $delRes = self::$DBI->query($delQuery) !== null;
            if(self::$DBI->query($addQuery) === null) {
                self::$DBI->cancelTransaction();
                return false;
            }
        }

        if(!self::$DBI->commitTransaction())
            return false;

        $this->userToSave = array();

        return true;
    }

    public function sessionToUser() {
        foreach($this->session as $option => $pages) {
            foreach($pages as $page => $value) {
                if($value !== null) {
                    $this->setUser($option, $page, $value);
                }
            }
        }
    }

    public function unsetConfig($domain, $option, $page) {
        $delete = array();
        if($domain !== null) {
            if($domain == 'user') {
                $delete['user'] = $this->user;
            } elseif($domain == 'session') {
                $delete['session'] = $this->session;
            }
        }

        if(empty($delete)) {
            $delete['user'] = $this->user;
            $delete['session'] = $this->session;
        }
        if($option !== null) {
            foreach($delete as $currentDomain => $currentOptions) {
                foreach($currentOptions as $currentOption => $currentPages) {
                    if($currentOption != $option) {
                        unset($delete[$currentDomain][$currentOption]);
                    }
                }
            }
        }
        if($page !== null) {
            foreach($delete as $currentDomain => $currentOptions) {
                foreach($currentOptions as $currentOption => $currentPages) {
                    foreach($currentPages as $currentPage => $value) {
                        if($currentPage != $page) {
                            unset($delete[$currentDomain][$currentOption][$currentPage]);
                        }
                    }
                }
            }
        }
        foreach($delete as $currentDomain => $currentOptions) {
            foreach($currentOptions as $currentOption => $currentPages) {
                foreach($currentPages as $currentPage => $value) {
                    unset($this->{$currentDomain}[$currentOption][$currentPage]);
                    if($currentDomain == 'user')
                        $this->userToSave["$currentOption\000$currentPage"] = false;
                }
                if(empty($currentPages))
                    unset($delete[$currentDomain][$currentOption]);
            }
            if(empty($currentOptions))
                    unset($delete[$currentDomain]);
        }
        return $delete;
    }

    public function saveSession() {
        $key = 'SWATUC:' . $this->project . ':' . $this->userId;
        $_SESSION[$key] = json_encode($this->session);
    }

    public function setDefault($opt, $page, $val, $type = 'string') {
        if($val === null)
            unset($this->default[$opt][$page]);
        else {
            $this->default[$opt][$page] = $val;
            $this->types[$opt] = $type;
        }
    }

    private function setInternal(&$array, $opt, $page, $val) {
        if(!isset($this->types[$opt])) {
            $this->setError('Invalid preference: ' . $opt);
            return false;
        }
        if($val === null)
            unset($array[$opt][$page]);
        else {
            switch($this->types[$opt]) {
                case 'integer':
                    if(!ctype_digit($val)) {
                        $this->setError("$opt requires an integer");
                        return false;
                    }
                    break;
                case 'boolean':
                    if($val !== true && $val !== false && $val != '0' && $val != '1'
                        && $val != 'true' && $val != 'false' && $val != '')
                    {
                        $this->setError("$opt requires a boolean");
                        return false;
                    }
                    if($val == '1' || $val == 'true' || $val === true)
                        $val = true;
                    else
                        $val = false;
                    break;
            }
            $array[$opt][$page] = $val;
            return true;
        }
    }

    public function setUser($opt, $page, $val) {
        if($this->setInternal($this->user, $opt, $page, $val)) {
            $this->userToSave["$opt\000$page"] = true;
        }else
            return false;
        return true;
    }

    public function setSession($opt, $page, $val) {
        $result = $this->setInternal($this->session, $opt, $page, $val);
        return $result;
    }

    public function getOption($opt, $page = '*') {
        if($this->getOptionFrom($this->session, $opt, $page)) {
            return $this->_result;
        }
        if($this->getOptionFrom($this->user, $opt, $page)) {
            return $this->_result;
        }
        if($this->getOptionFrom($this->default, $opt, $page)) {
            return $this->_result;
        }
        return null;
    }

    public function getDefault($opt, $page = '*') {
        if($this->getOptionFrom($this->default, $opt, $page))
            return $this->_result;
        else {
            foreach($this->default[$opt] as $pg => $val) {
                if($page == '*' || preg_match("!^$pg$!", $page))
                    return $val;
            }
            return null;
        }
    }

    public function getUser($opt, $page = '*') {
        if($this->getOptionFrom($this->user, $opt, $page))
            return $this->_result;
        else
            return null;
    }

    public function getSession($opt, $page = '*') {
        if($this->getOptionFrom($this->session, $opt, $page))
            return $this->_result;
        else
            return null;
    }

    public function getOptionType($opt) {
        if(isset($this->types[$opt]))
            return $this->types[$opt];
        else
            return null;
    }

    public function getOptions() {
        $res = array();
        foreach($this->default as $opt => $info)
            foreach($info as $page => $val)
                $res[$opt][$page] = $val;
        foreach($this->user as $opt => $info)
            foreach($info as $page => $val)
                $res[$opt][$page] = $val;
        foreach($this->session as $opt => $info)
            foreach($info as $page => $val)
                $res[$opt][$page] = $val;
        return $res;
    }

    private function getOptionFrom($array, $opt, $page) {
        if(!isset($array[$opt]))
            return false;

        if(isset($array[$opt][$page])) {
            $this->_result = $array[$opt][$page];
            return true;
        }
        if(isset($array[$opt]['*'])) {
            $this->_result = $array[$opt]['*'];
            return true;
        }
        foreach($array[$opt] as $pg => $val) {
            if(preg_match("!^$pg$!", $page)) {
                $this->_result = $val;
                return true;
            }
        }
        return false;
    }

    public static function regexEscape($str) {
        $chars = array('\\','^',')','$','.','[',']','|','(',')','?','*','+','{','}');
        $escape = array('\\\\','\\^','\\)','\\$','\\.','\\[','\\]','\\|','\\(','\\)','\\?','\\*','\\+','\\{','\\}');
        return str_replace($chars, $escape, $str);
    }

    public static function regexUnescape($str) {
        $chars = array('\\\\','\\^','\\)','\\$','\\.','\\[','\\]','\\|','\\(','\\)','\\?','\\*','\\+','\\{','\\}');
        $escape = array('\\','^',')','$','.','[',']','|','(',')','?','*','+','{','}');
        return str_replace($chars, $escape, $str);
    }

    public static function stripPrefix($str, $prefix = false) {
        if($prefix === false) {
            global $PATH;
            $prefix = $PATH['home'];
        }
        $len = strlen($prefix);
        if(substr($str, 0, $len) == $prefix) {
            $str = substr($str, $len);
        }
        return $str;
    }
}

?>

---