tsd/TSDObject.php5

<?php

abstract class TSDObject extends SObject {
    protected $table;
    protected $attributes;
    protected $access;
    protected $unique;
    protected $DBI;

    protected $inDB;

    public function __construct($table, $attrs, $unique, $id) {
        parent::__construct();

        $this->table = $table;
        $this->attributes = array();
        foreach($attrs as $a => $prot) {
            $this->setAttr($a, null);
            $this->access[$a] = $prot;
        }
        $this->unique = $unique;
        $this->DBI = TSD::getDBI();

        if($id != '') {
            $this->setAttr($unique, $id);
            $this->populate();
        }
    }

    protected function checkInit($errmsg) {
        if(!TSD::checkInit()) {
            $this->setError($errmsg . ' (because TSD cannot be initialized)');
            return false;
        }
        else
            return true;
    }

    protected function populate() {
        if(!$this->checkInit('Cannot populate')) return false;

        $query = 'SELECT ' . implode(',', array_keys($this->attributes)) . ' FROM ' . $this->table . ' WHERE '
                . $this->unique . ' = \'' . mysql_escape_string($this->attributes[$this->unique]) . '\'';
        $result = $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->setError('Failed to populate ' . $this->table . ' on \'' . $this->unique . '\': '
                                . implode('; ', $this->DBI->getError()));
            return false;
        }

        if(count($result) == 0) {
            return true;
        }

        if(count($result) > 1)
            $this->setWarning('Multiple results for key \'' . $this->attributes[$this->unique] . '\'; using first result');

        foreach($result[0] as $a => $v)
            $this->setAttr($a, $v);

        $this->inDB = true;

        return true;
    }

    public function commit() {
        if(!$this->checkInit('Cannot commit')) return false;
        if(!$this->isValid()) {
            $this->setError('Cannot commit invalid object');
            return false;
        }
        if(!TSD::can('edit')) {
            $this->setError('Permission denied');
            return false;
        }

        if($this->inDB) {
            $query = 'UPDATE ' . $this->table . ' SET ';
            foreach($this->attributes as $a => $v) {
                $v = mysql_escape_string($v);
                $query .= " $a = '$v',";
            }
            $query = rtrim($query, ',');
            $query .= ' WHERE ' . $this->unique . ' = \'' . mysql_escape_string($this->attributes[$this->unique]) . '\'';
        }
        else {
            $query = 'INSERT INTO ' . $this->table . ' SET ';
            foreach($this->attributes as $a => $v) {
                if($a == $this->unique && $v == '')
                    continue;
                $v = mysql_escape_string($v);
                $query .= " $a = '$v',";
            }
            $query = rtrim($query, ',');
        }

        $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->setError('Failed to commit because of database error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }

        if($this->attributes[$this->unique] == '') {
            $this->setAttr($this->unique, $this->DBI->mysql_insert_id());
        }

        $this->inDB = true;

        return true;
    }

    public function delete() {
        if(!$this->checkInit('Cannot delete')) return false;
        if(!$this->isValid()) {
            $this->setError('Cannot delete invalid object!');
            return false;
        }
        if(!TSD::can('approve')) {
            $this->setError('Permission denied');
            return false;
        }

        $query = 'DELETE FROM ' . $this->table . ' WHERE ' . $this->unique . ' = \''
                    . mysql_escape_string($this->attributes[$this->unique]) . '\'';
        $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->setError('Failed to delete because of database error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }

        $this->attributes = array();

        return true;
    }

    public function getAttributes() {
        return array_keys($this->attributes);
    }

    public function getValues() {
        return array_merge($this->attributes);
    }

    public function getUnique() {
        return $this->unique;
    }

    public function getTable() {
        return $this->table;
    }

    public function isInDB() {
        return $this->inDB;
    }

    public function get($name) {
        if(array_key_exists($name, $this->attributes))
            return $this->attributes[$name];
        $this->setError("No such attribute '$name' in $this->table");
        return null;
    }

    public function set($name, $value) {
        if(array_key_exists($name, $this->attributes)) {
            if($this->access[$name] === false || (is_string($this->access[$name]) && !TSD::can($this->access[$name]))) {
                $this->setError("You do not have permission to change attribute '$name'");
                return false;
            }
            $this->setAttr($name, $value);
            return true;
        }
        $this->setError("No such attribute '$name' in $this->table");
        return false;
    }

    public function __get($name) {
        return $this->get($name);
    }

    public function __set($name, $value) {
        return $this->set($name, $value);
    }

    public function __call($func, $args) {
        if(preg_match('/^get([a-zA-Z0-9_]*)$/i', $func, $matches)) {
            $name = $matches[1];
            if(array_key_exists($name, $this->attributes))
                return $this->attributes[$name];
            else {
                $nameLower = strtolower($name);
                foreach($this->attributes as $a => $dummy) {
                    if(strtolower($a) == $nameLower)
                        return $this->attributes[$a];
                }
            }
            $this->setError("No such attribute '$name' in $this->table");
            return false;
        }
        else if(preg_match('/^set([a-zA-Z0-9_]*)$/i', $func, $matches)) {
            if(count($args) != 1) {
                $this->setError('Calls to setXxx() require an argument!');
                return false;
            }
            $name = $matches[1];
            if(array_key_exists($name, $this->attributes)) {
                if($this->access[$name] === false || (is_string($this->access[$name]) && !TSD::can($this->access[$name]))) {
                    $this->setError("You do not have permission to change attribute '$name'");
                    return false;
                }
                $this->setAttr($name, $args[0]);
                return true;
            }
            else {
                $nameLower = strtolower($name);
                foreach($this->attributes as $a => $dummy) {
                    if(strtolower($a) == $nameLower) {
                        if($this->access[$name] === false ||
                            (is_string($this->access[$name]) && !TSD::can($this->access[$name])))
                        {
                            $this->setError("You do not have permission to change attribute '$a'");
                            return false;
                        }
                        $this->setAttr($a, $args[0]);
                        return true;
                    }
                }
            }
            $this->setError("No such attribute '$name' in $this->table");
            return false;
        }
        else {
            $this->setError("No such method '$func'");
            return false;
        }
    }

    protected function setAttr($field, $value) {
        $this->attributes[$field] = $value;
    }

    protected function getAttr($field, $value) {
        return $this->attribute[$field];
    }

    protected static function getListImpl($class, $table, $attrs, $constraints, $addlConstraints, $limit, $order, $cnt, $ljoin = '') {
        $DBI = TSD::getDBI();
        if(!$DBI) {
            self::setStaticError('Cannot connect to TSD!');
            return null;
        }

        $constraints = array_merge($constraints, $addlConstraints);
        $constraintC = self::criteriaToString($constraints, $attrs);
        if($constraintC === false)
            return null;
        $limitC = self::limitToString($limit);
        if($limitC === false)
            return null;
        $orderC = self::orderToString($order, $attrs);
        if($orderC === false)
            return null;

        if($cnt)
            $query = 'SELECT COUNT(*) FROM ' . $table;
        else
            $query = 'SELECT ' . implode(',', $attrs) . ' FROM ' . $table;
        if($ljoin != '')
            $query .= " $ljoin ";
        if($constraintC != '')
            $query .= ' WHERE ' . $constraintC;
        $query .= ' ' . $limitC . ' ' . $orderC;

        $result = $DBI->query($query);
        if(count($DBI->getError()) > 0) {
            self::setStaticError('Error doing query: ' . implode('; ', $DBI->getError()));
            return null;
        }

        if($cnt)
            return $result[0]['COUNT(*)'];

        $ret = array();
        foreach($result as $r) {
            $obj = new $class();
            foreach($r as $a => $v)
                $obj->setAttr($a, $v);
            $obj->inDB = true;
            $ret[] = $obj;
        }

        return $ret;
    }

    public function toXML() {
        $xml = '<' . get_class($this) . '>';
        foreach($this->attributes as $a => $v)
            $xml .= '<' . $a . '>' . htmlspecialchars($v) . '</' . $a . '>';
        $xml .= '<identifier>' . htmlspecialchars($this->getIdentifier()) . '</identifier>';
        $xml .= '</' . get_class($this) . '>';
        return $xml;
    }

    public function isLoaded() {
        return $this->inDB;
    }

    protected function addAttribute($name, $access = true) {
        $this->setAttr($name, '');
        $this->access[$name] = $access;
    }

    public abstract function isValid();
    public abstract function getParent();
    public abstract function getIdentifier();
    public abstract function listChildren($constraints = array(), $limit = array(), $order = array(), $cnt = false);
    public abstract function listValidChildren($constraints = array(), $limit = array(), $order = array(), $cnt = false);

    protected static function criteriaToString($arr, $attributes) {
        if(is_string($arr))
            return $arr;
        else if(!is_array($arr)) {
            self::setStaticError('Criteria must be string or array!');
            return false;
        }
        else if(count($arr) == 0)
            return '';

        $collect = "";
        $op = "=";
        $conj = "AND";
        foreach($arr as $k => $v) {
            // if it's numeric, it means it's a non-associative entry (hopefully)
            if(ctype_digit((string) $k)) {
                // if it's a string, then we have an operator or a conjunction
                if(is_string($v)) {
                    switch(strtoupper($v)) {
                        case 'AND':
                        case 'OR':
                            $conj = $v;
                            break;
                        case '=':
                        case '>=':
                        case '<=':
                        case '<':
                        case '>':
                        case '<>':
                        case 'LIKE':
                        case 'LIKE BINARY':
                        case 'IS':
                        case 'IS NOT':
                        case 'IS NULL':
                        case 'IS NOT NULL':
                            $op = $v;
                            break;
                        default:
                            self::setStaticError("Invalid operator or conjunction in criteria: $v");
                            return false;
                    }
                }
                // if it's an array, then we have a sub-expression, which can be recursively evaluated
                else if(is_array($v)) {
                    $res = self::criteriaToString($v, $attributes);
                    if($res === false)
                        return false;
                    if($collect != "")
                        // only add conjunction if we already have something in our string so far
                        $collect .= " $conj " . $res;
                    else
                        $collect .= $res;
                }
                // it's something else, which is not allowed
                else {
                    self::setStaticError("Invalid operator or conjunction in criteria: $v");
                    return false;
                }
            }
            // it's a string, so it's an attribute
            else if(is_string($k)) {
                // check to see if it's a valid attribute
                if($attributes && !in_array($k, $attributes)) {
                    self::setStaticError("Invalid field '$k' in criteria");
                    return false;
                }
                // if we have 'attr' => array('a', 'b'), that means that we want to compare 'attr' to
                //   both 'a' and 'b'
                if(is_array($v)) {
                    foreach($v as $value) {
                        // SPECIAL CASE: IS NULL and IS NOT NULL are unary operators, so we ignored 'value'
                        //   it should be noted that it would be stupid to do 'attr' => array('a', 'b') with the operator
                        //   being IS NULL or IS NOT NULL; perhaps we should print a warning?
                        if($op == 'IS NULL' || $op == 'IS NOT NULL') {
                            if($collect != "")
                                $collect .= " $conj $k $op";
                            else
                                $collect = "$k $op";
                        }
                        else {
                            // some other operator; check type of value we're comparing to and then construct string
                            $value = mysql_escape_string($value);
                            if($collect != "")
                                $collect .= " $conj $k $op '$value'";
                            else
                                $collect = "$k $op '$value'";
                        }
                    }
                }
                else {
                    // no array, but we do the same thing as in the array case, except for a single value
                    if($op == 'IS NULL' || $op == 'IS NOT NULL') {
                        if($collect != "")
                            $collect .= " $conj $k $op";
                        else
                            $collect = "$k $op";
                    }
                    else {
                        $v = mysql_escape_string($v);
                        if($collect != "")
                            $collect .= " $conj $k $op '$v'";
                        else
                            $collect = "$k $op '$v'";
                    }
                }
            }
        }

        // this could be a subexpression, so surround in parentheses
        if($collect != "")
            $collect = "($collect)";

        return $collect;
    }

    protected static function limitToString($limit) {
        if($limit == "" || count($limit) == 0)
            return '';

        if(is_array($limit)) {
            if(count($limit) == 2) {
                if(!ctype_digit((string) $limit[0]) || $limit[0] < 0 || !ctype_digit((string) $limit[1]) || $limit[1] < 0) {
                    self::setStaticError('Invalid limit values');
                    return false;
                }
                return " LIMIT $limit[0], $limit[1]";
            }
            else if(count($limit) == 1) {
                if(!ctype_digit((string) $limit[0]) || $limit[0] < 0) {
                    self::setStaticError('Invalid limit values');
                    return false;
                }
                return " LIMIT $limit[0]";
            }
        }
        else if(ctype_digit((string) $limit)) {
            if($limit < 0) {
                self::setStaticError('Invalid limit values');
                return false;
            }
            return " LIMIT $limit";
        }

        self::setStaticError('Invalid limit array!');
        return false;
    }

    protected static function orderToString($order, $attributes = null) {
        if($order == "" || count($order) == 0)
            return '';

        if(is_array($order)) {
            $orderStr = ' ORDER BY ';
            foreach($order as $key => $value) {
                if(ctype_digit((string) $key)) {
                    if($attributes != null && !in_array($value, $attributes)) {
                        self::setStaticError('Invalid attribute \'' . $value . '\'');
                        return false;
                    }
                    $orderStr .= $value . ', ';
                }
                else {
                    if($attributes != null && !in_array($key, $attributes)) {
                        self::setStaticError('Invalid attribute \'' . $key . '\'');
                        return false;
                    }
                    $value = strtoupper($value);
                    if($value != 'ASC' && $value != 'DESC') {
                        self::setStaticError('Ordering must be ASC or DESC');
                        return false;
                    }
                    $orderStr .= $key . ' ' . $value . ', ';
                }
            }
            return rtrim($orderStr, ', ');
        }
        else if(is_string($order)) { // && in_array($order, $attributes)) {
            return " ORDER BY $order";
        }
        else {
            self::setStaticError('Invalid order by array');
            return false;
        }
    }

    protected static function getCWISID($urlOrId) {
        if(ctype_digit((string) $urlOrId))
            $id = $urlOrId;
        else {
            $id = SDRService::getCserdIdForURL($urlOrId);
            if(!$id)
                return false;
        }
        return $id;
    }
}

?>

---