snap2/objects/SnapResource.php5

<?php

final class SnapResource extends SnapFile {
    const TYPE_STDXML = 0;
    const TYPE_HTML = 1;
    const TYPE_MEDIA_IMAGE = 2;
    const TYPE_MEDIA_NETLOGO = 4;
    const TYPE_MEDIA_AGENTSHEETS = 5;
    const TYPE_MEDIA_INTERACTIVATE = 6;
    const TYPE_MEDIA_DOCUMENT = 7;
    const TYPE_LESSONPLAN = 8;
    const TYPE_MEDIA_FILE = 9;
    const TYPE_CSS = 10;
    const TYPE_JAVASCRIPT = 11;
    const TYPE_INTERACTIVATE_LESSON = 20;
    const TYPE_INTERACTIVATE_INSTRUCTOR = 21;

    public static $ATTRIBUTES = array('id', 'name', 'description', 'created', 'modified',
            'canonParentId', 'refCount', 'oldParentId', 'contentType', 'approvalDate', 'validDate',
            'nextOrdinal', 'liveVersionId', 'devVersionId');

    private static $DELETED_VERSIONS = array();

    public function __construct($id = "") {
        parent::__construct('Resource', array_merge(array_flip(self::$ATTRIBUTES),
                                                    array('maxOrdinal' => array($this, 'loadMaxOrdinal'),
                                                        'devVersion' => array($this, 'loadDevVersion'),
                                                        'liveVersion' => array($this, 'loadLiveVersion'),
                                                        'activeVersion' => array($this, 'loadActiveVersion'))),
                            self::$ATTRIBUTES, $id);
        $this->setSave('devVersion', false);
        $this->setSave('liveVersion', false);
        $this->setSave('activeVersion', false);
    }

    /*
     *
     */
    public function toCacheDump() {
        $name = $this->get('name');
        $cparent = $this->get('canonParentId');
        $devId = $this->get('devVersionId');
        $liveId = $this->get('liveVersionId');
        return "Name: $name; Canon. Parent: $cparent; Dev: $devId; Live: $liveId";
    }

    /*
     * Dynamic Loaders
     */

    protected function loadMaxOrdinal() {
        $id = $this->get('id');
        $query = "SELECT MAX(ordinal) FROM Version WHERE resourceId = $id";
        if(!($result = SnapDBI::query($query, true))) {
            $this->setError('Could not load maximum ordinal for this resource');
            return false;
        }
        if($result[0]['MAX(ordinal)'] == '')
            $this->set('maxOrdinal', 0);
        else
            $this->set('maxOrdinal', $result[0]['MAX(ordinal)']);
        SnapCache::updateById($this->getType(), $this->getId());
        return true;
    }

    protected function loadDevVersion() {
        $devId = $this->get('devVersionId');
        if(ctype_digit((string) $devId) && $devId > 0)
            $dev = SnapVersion::retrieve($devId);
        else
            $dev = null;

        $this->set('devVersion', $dev);
        SnapCache::updateById($this->getType(), $this->getId());
        return true;
    }

    protected function loadLiveVersion() {
        $liveId = $this->get('liveVersionId');
        if(ctype_digit((string) $liveId) && $liveId > 0)
            $live = SnapVersion::retrieve($liveId);
        else
            $live = null;
        $this->set('liveVersion', $live);
        SnapCache::updateById($this->getType(), $this->getId());
        return true;
    }

    protected function loadActiveVersion() {
        $server = SConfig::getDefault('common.serverClass');

        $v = null;
        if($server == 'dev') {
            $v = $this->get('devVersion');
            if(!$v)
                $v = $this->get('liveVersion');
        }

        if($server == 'prod') {
            $v = $this->get('liveVersion');
//          if(!$v)
//              $v = $this->get('devVersion');
        }

        $this->set('activeVersion', $v);
        SnapCache::updateById($this->getType(), $this->getId());
        return true;
    }

    /*
     * Destruction-related functions
     */

    protected function doDestroy() {
        $versions = $this->listVersions();
        foreach($versions as $v) {
            // this loads the content module while we still can
            $v->getContentModule();
            self::$DELETED_VERSIONS[] = $v;
        }
        return true;
    }

    public static function _destroyCMs() {
        foreach(self::$DELETED_VERSIONS as $v) {
            $v->systemDestroy();
        }
        self::$DELETED_VERSIONS = array();
    }

    /*
     * Cancels queue of versions to delete
     */
    public static function _cancelDestroy() {
        self::$DELETED_VERSIONS = array();
    }

    /*
     * Capability methods
     */

    protected function _canCreateVersion($oldVersion = null) {
        if($oldVersion != null) {
            $oldVersionObj = $this->convertReference($oldVersion, 'Version');
            if(!$oldVersionObj)
                return false;
        }

        if(!$this->getPermission()->mayCreateVersion()) {
            $this->setReason('Permission denied');
            return false;
        }

        return $oldVersion == null ? true : $oldVersionObj;
    }

    protected function _canSetValidDate($timestamp) {
        $ts = strtotime($timestamp);
        if($ts === false || $ts == -1) {
            $this->setReason('Invalid timestamp given');
            return false;
        }

        if(!$this->getPermission()->mayChangeMetadata()) {
            $this->setReason('Permission denied');
            return false;
        }

        $ts = date("Y-m-d 00:00:00", $ts);

        return $ts;
    }

    /*
     * Static Factory Methods
     */

    public static function retrieve($id) {
        if(!Snap2::checkInit()) return null;
        if(!ctype_digit((string) $id) || $id <= 0) {
            self::setStaticError('ID must be numeric');
            return null;
        }

        $res = SnapCache::getById('Resource', $id);
        if($res != null)
            return $res;
        else {
            $res = new SnapResource($id);
            if(!($res->getId() > 0))
                return null;
        }

        SnapCache::putById('Resource', $id, $res);

        return $res;
    }

    public static function lookup($path) {
        if(!Snap2::checkInit()) return null;
        if(!preg_match('/^\s*((\/[a-zA-Z0-9\$\-_.]*)+)\s*$/', $path, $matches)) {
            self::setStaticError('Invalid path: \'' . $path . '\'');
            return null;
        }

        $path = $matches[1];

        $dir = SnapCache::getByPath('Resource', $path);
        if($dir != null)
            return $dir;

        $pathParts = explode('/', $path);

        $query = 'SELECT ' . implode(',', self::$ATTRIBUTES) . ' FROM Resource';
        $where = ' WHERE ';
        for($i = 1, $j = count($pathParts) - 1; $i < count($pathParts); $i++, $j--) {
            if($i == 1) $link1 = 'ResourceLink';
            else $link1 = 'DirectoryLink';
            if($i == 2) $link2 = 'ResourceLink';
            else $link2 = 'DirectoryLink';
            if($j == 1) $link3 = 'ResourceLink';
            else $link3 = 'DirectoryLink';
            $query .= ' LEFT JOIN ' . $link1 . ' AS ' . $link1 . $i . ' ON ' . $link1 . $i
                . '.childId = ' . ($i == 1 ? 'Resource.id' : ($link2 . ($i - 1) . '.parentId'));
            $where .= ' ' . $link3 . $j . '.shortName = BINARY \'' . $pathParts[$i] . '\' AND ';
        }
        $query .= rtrim($where, ' AND ');

        $result = SnapDBI::query($query, true);
        if($result === false)
            return null;

        if(count($result) == 0)
            return null;
        else if(count($result) != 1)
            self::setStaticWarning('Multiple results for path \'' . $path
                                    . '\'!  Run Snap consistency check please.');

        $res = SnapCache::getById('Resource', $result[0]['id']);
        if($res != null) {
            SnapCache::putByPath('Resource', $path, $res);
            return $res;
        }

        $res = new SnapResource();
        foreach(self::$ATTRIBUTES as $a)
            $res->set($a, $result[0][$a]);

        SnapCache::putByPath('Resource', $path, $res);

        return $res;
    }

    /*
     * Public API methods
     */

    public function createVersion($oldVersion = null) {
        if(!$this->checkValid()) return false;

        if(!SnapDBI::startTransaction())
            return null;

        if(!($oldVersionObj = $this->_canCreateVersion($oldVersion))) {
            $this->setError('Failed to create version: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return null;
        }

        if($oldVersion != null) {
            $cm = $oldVersion->getContentModule();
            $newCM = $cm->copy();
            if(!$newCM || !$newCM instanceof SnapContent) {
                $this->setError('Failed to make copy: <ul><li>' . implode('</li><li>', $cm->getError()) . '</li></ul>');
                SnapDBI::cancelTransaction();
                return null;
            }
            $content = $newCM->getRaw();
        }
        else
            $content = SnapContent::getInitialValue($this->get('contentType'));

        $ordinal = $this->get('nextOrdinal');
        $this->set('nextOrdinal', $ordinal + 1);
        $query = 'UPDATE Resource SET nextOrdinal = ' . ($ordinal + 1) . ' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            if($oldVersion != '')
                $newCM->delete();
            SnapDBI::cancelTransaction();
            return null;
        }

        $content = mysql_escape_string($content);
        $query = 'INSERT INTO Version (created, author, status, ordinal, content, resourceId, prevVersionId)'
            . ' VALUES (CURRENT_TIMESTAMP,' . Snap2::getCurrentUser() . ',' . SnapVersion::STATUS_PRIVATE
            . ',' . $ordinal . ',\'' . $content . '\',' . $this->getId() . ','
            . (!is_object($oldVersion) ? 'NULL' : $oldVersionObj->getId()) . ')';

        if(!SnapDBI::query($query)) {
            if($oldVersion != null)
                $newCM->delete();
            SnapDBI::cancelTransaction();
            return null;
        }
        $id = SnapDBI::getInsertId();

        $paths = $this->getAllPaths();
        $query = 'INSERT INTO PathCache (path, versionId, type) VALUES ';
        foreach($paths as $i => $p)
            $query .= "('$p@$ordinal', $id, 'VERS'),";
        $query = substr($query, 0, -1);
        if(!SnapDBI::query($query)) {
            if($oldVersion != '')
                $newCM->delete();
            SnapDBI::cancelTransaction();
            return null;
        }

        $v = new SnapVersion();
        $v->set('id', $id);

        if(SnapDBI::commitTransaction() === false) {
            if($oldVersion != null)
                $newCM->delete();
            return null;
        }

        $this->set('maxOrdinal', $ordinal);

        SnapCache::putById('Version', $id, $v);

        return $v;
    }

    public function setValidDate($validDate) {
        if(!$this->checkValid()) return false;

        $ts = $this->_canSetValidDate($validDate);
        if($ts === false) {
            $this->setError('Invalid timestamp given!');
            return false;
        }

        if(!SnapDBI::startTransaction())
            return false;

        $query = 'UPDATE Resource SET validDate = \'' . $ts. '\' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            SnapDBI::cancelTransaction();
            $this->setError('Database error');
            return false;
        }

        SnapDBI::commitTransaction();

        $this->set('validDate', $validDate);
        SnapCache::updateById('Resource', $this->getId());

        return true;
    }

    /*
     * Listing/query methods
     */

    public function listVersions($constraint = array(), $limit = array(), $order = array()) {
        if(!$this->checkValid()) return false;

        $query = "SELECT " . implode(',', SnapVersion::$ATTRIBUTES) . " FROM Version WHERE resourceId = "
            . $this->getId();

        $where = SnapDBI::criteriaToString($constraint, SnapVersion::$ATTRIBUTES);
        if($where === false) return null;
        else if($where != '') $query .= ' AND ' . $where;

        $order = SnapDBI::orderToString($order, SnapVersion::$ATTRIBUTES);
        if($order === false) return null;
        else if($order != '') $query .= ' ' . $order;

        $limit = SnapDBI::limitToString($limit);
        if($limit === false) return null;
        else if($limit != '') $query .= ' ' . $limit;

        if(!SnapDBI::query($query)) {
            $this->setError('Invalid query');
            return null;
        }

        $ret = array();
        while($row = SnapDBI::getRow()) {
            $obj = SnapCache::getById('Version', $row['id']);
            if($obj == null) {
                $obj = new SnapVersion();
                foreach(SnapVersion::$ATTRIBUTES as $a)
                    $obj->set($a, $row[$a]);
                SnapCache::putById('Version', $row['id'], $obj);
            }
            $ret[] = $obj;
        }
        SnapDBI::freeResult();

        return $ret;
    }

    public function countVersions($constraint = array(), $limit = array(), $order = array()) {
        if(!$this->checkValid()) return false;

        $query = "SELECT status, COUNT(*) FROM Version WHERE resourceId = "
            . $this->getId() . ' GROUP BY status';

        $where = SnapDBI::criteriaToString($constraint, SnapVersion::$ATTRIBUTES);
        if($where === false) return null;
        else if($where != '') $query .= ' AND ' . $where;

        $order = SnapDBI::orderToString($order, SnapVersion::$ATTRIBUTES);
        if($order === false) return null;
        else if($order != '') $query .= ' ' . $order;

        $limit = SnapDBI::limitToString($limit);
        if($limit === false) return null;
        else if($limit != '') $query .= ' ' . $limit;

        if(!SnapDBI::query($query)) {
            $this->setError('Invalid query');
            return null;
        }

        $ret = array();
        $sum = 0;
        while($row = SnapDBI::getRow()) {
            $sum += $row['COUNT(*)'];
            $ret[$row['status']] = $row['COUNT(*)'];
        }
        if(!isset($ret[SnapVersion::STATUS_PRIVATE])) $ret[SnapVersion::STATUS_PRIVATE] = 0;
        if(!isset($ret[SnapVersion::STATUS_PENDING])) $ret[SnapVersion::STATUS_PENDING] = 0;
        if(!isset($ret[SnapVersion::STATUS_DEV])) $ret[SnapVersion::STATUS_DEV] = 0;
        if(!isset($ret[SnapVersion::STATUS_LIVE])) $ret[SnapVersion::STATUS_LIVE] = 0;
        if(!isset($ret[SnapVersion::STATUS_DEFUNCT])) $ret[SnapVersion::STATUS_DEFUNCT] = 0;
        $ret['total'] = $sum;
        SnapDBI::freeResult();

        return $ret;
    }

    public function listRelevantVersions($constraint = array(), $limit = array(), $order = array()) {
        if(!$this->checkValid()) return null;

        $query = 'SELECT ' . implode(',', SnapVersion::$ATTRIBUTES) . ' FROM Version WHERE '
            . '(status != ' . SnapVersion::STATUS_DEFUNCT . ' OR id = ANY(SELECT prevVersionId '
            . 'FROM Version WHERE status != 4)) AND resourceId = ' . $this->getId();

        $constraint = SnapDBI::criteriaToString($constraint, SnapVersion::$ATTRIBUTES);
        if($constraint === false) return null;
        else if($constraint != '') $query .= ' AND ' . $constraint;

        $order = SnapDBI::orderToString($order, SnapVersion::$ATTRIBUTES);
        if($order === false) return null;
        else if($order != '') $query .= ' ' . $order;

        $limit = SnapDBI::limitToString($limit);
        if($limit === false) return null;
        else if($limit != '') $query .= ' ' . $limit;

        if(!SnapDBI::query($query)) {
            $this->setError('Invalid query');
            return null;
        }

        $ret = array();
        while($row = SnapDBI::getRow()) {
            $obj = SnapCache::getById('Version', $row['id']);
            if($obj == null) {
                $obj = new SnapVersion();
                foreach(SnapVersion::$ATTRIBUTES as $a)
                    $obj->set($a, $row[$a]);
                SnapCache::putById('Version', $row['id'], $obj);
            }
            $ret[] = $obj;
        }
        SnapDBI::freeResult();

        return $ret;
    }

    public function countRelevantVersions($constraint = array(), $limit = array(), $order = array()) {
        if(!$this->checkValid()) return null;

        $query = 'SELECT COUNT(*) FROM Version WHERE '
            . '(status != ' . SnapVersion::STATUS_DEFUNCT . ' OR id = ANY(SELECT prevVersionId '
            . 'FROM Version WHERE status != 4)) AND resourceId = ' . $this->getId();

        $constraint = SnapDBI::criteriaToString($constraint, SnapVersion::$ATTRIBUTES);
        if($constraint === false) return null;
        else if($constraint != '') $query .= ' AND ' . $constraint;

        $order = SnapDBI::orderToString($order, SnapVersion::$ATTRIBUTES);
        if($order === false) return null;
        else if($order != '') $query .= ' ' . $order;

        $limit = SnapDBI::limitToString($limit);
        if($limit === false) return null;
        else if($limit != '') $query .= ' ' . $limit;

        if(!SnapDBI::query($query)) {
            $this->setError('Invalid query');
            return null;
        }

        $ret = SnapDBI::firstRow();
        SnapDBI::freeResult();
        return $ret['COUNT(*)'];
    }

    public function listActions($constraint = array(), $limit = array(), $order = array()) {
        if(!$this->checkValid()) return null;

        $query = 'SELECT uid,action,actionTime,Version.' . implode(',', SnapVersion::$ATTRIBUTES)
            . ' FROM ActionLog LEFT JOIN Version ON ActionLog.versionId = Version.id '
            . 'WHERE Version.resourceId = ' . $this->getId();

        $attrs = array_merge(array('uid', 'action', 'actionTime'), SnapVersion::$ATTRIBUTES);

        $constraint = SnapDBI::criteriaToString($constraint, $attrs);
        if($constraint === false) return null;
        else if($constraint != '') $query .= ' AND ' . $constraint;

        $order = SnapDBI::orderToString($order, $attrs);
        if($order === false) return null;
        else if($order != '') $query .= ' ' . $order;

        $limit = SnapDBI::limitToString($limit);
        if($limit === false) return null;
        else if($limit != '') $query .= ' ' . $limit;

        if(($result = SnapDBI::query($query, true)) === false) {
            $this->setError('Error during query');
            return null;
        }

        return $result;
    }
}

?>

---