snap2/objects/SnapMetadata.php5

<?php

class SnapMetadata extends SnapObject {
    private static $ATTRIBUTES = array(
        'Directory' => array(
            'directoryId', 'mdKey', 'mdValue'),
        'Resource' => array(
            'resourceId', 'mdKey', 'mdValue'));

    const MD_INSERT = 0;
    const MD_UPDATE = 1;
    const MD_DELETE = 2;

    public function __construct($file) {
        parent::__construct('Metadata', array('id' => true, 'file' => true, 'md' => true, 'changes' => true), array());

        $this->set('file', $file);
        $this->set('id', $file->getType() . $file->getId());
        $this->populate();
    }

    protected function populate() {
        if(!$this->checkValid()) return false;

        $file = $this->get('file');
        $ftype = $file->getType();

        $alist = implode(',', self::$ATTRIBUTES[$ftype]);

        $query = 'SELECT ' . $alist . ' FROM ' . $ftype . 'Metadata WHERE ' . strtolower($ftype) . 'Id = '
            . $file->getId();
        $result = SnapDBI::query($query, true);
        if($result === false) {
            $this->setError('Failed to populate from DB');
            $this->setValid(false);
            return false;
        }

        $md = array();
        foreach($result as $r)
            $md[$r['mdKey']] = $r['mdValue'];
        $this->set('md', $md);
        $this->set('changes', array());

        SnapCache::updateById($this->getType(), $this->getId());
        $this->setValid(true);

        return true;
    }

    public function put($key, $value) {
        if(!$this->checkValid()) return false;

        if(!is_string($key) && !ctype_digit((string) $key)) {
            $this->setError('You can only use string and numeric keys');
            return false;
        }

        if(!is_string($value) && !ctype_digit((string) $value)) {
            $this->setError('You can only store strings and numbers as metadata values');
            return false;
        }

        $changes = $this->get('changes');
        $md = $this->get('md');
        $changes[$key] = (isset($md[$key]) ? self::MD_UPDATE : self::MD_INSERT);
        $md[$key] = $value;
        $this->set('changes', $changes);
        $this->set('md', $md);

        return true;
    }

    public function retrieve($key) {
        if(!$this->checkValid()) return false;

        $md = $this->get('md');
        if(!isset($md[$key]))
            return null;
        else
            return $md[$key];
    }

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

        return array_keys($this->get('md'));
    }

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

        return $this->get('md');
    }

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

        $md = $this->get('md');
        $changes = array();
        foreach($md as $k => $v)
            $changes[$k] = self::MD_DELETE;
        $this->set('md', array());
        $this->set('changes', $changes);

        return true;
    }

    public function remove($key) {
        if(!$this->checkValid()) return false;

        $md = $this->get('md');
        if(!isset($md[$key]))
            return true;
        $changes = $this->get('changes');
        unset($md[$key]);
        $changes[$key] = self::MD_DELETE;
        $this->set('md', $md);
        $this->set('changes', $changes);

        return true;
    }

    public function putMany($data) {
        if(!$this->checkValid()) return false;

        if(!is_array($data)) {
            $this->setError('New metadata must be in form of a single-level associative array');
            return false;
        }

        $changes = $this->get('changes');
        $md = $this->get('md');
        foreach($data as $k => $v) {
            if(!is_string($v) && !ctype_digit((string) $v)) {
                $this->setError('You can only store strings and numbers as metadata values');
                return false;
            }

            $changes[$k] = (isset($md[$k]) ? self::MD_UPDATE : self::MD_INSERT);
            $md[$k] = $v;
        }
        $this->set('changes', $changes);
        $this->set('md', $md);

        return true;
    }

    public function setAll($data) {
        if(!$this->checkValid()) return false;

        if(!is_array($data)) {
            $this->setError('New metadata must be in form of a single-level associative array');
            return false;
        }

        $changes = $this->get('changes');
        $md = $this->get('md');
        foreach($md as $k => $v)
            $changes[$k] = self::MD_DELETE;
        foreach($data as $k => $v) {
            if(!is_string($v) && !ctype_digit((string) $v)) {
                $this->setError('You can only store strings and numbers as metadata values');
                return false;
            }
            if(isset($md[$k]))
                $changes[$k] = self::MD_UPDATE;
            else
                $changes[$k] = self::MD_INSERT;
        }
        $this->set('md', $data);
        $this->set('changes', $changes);

        return true;
    }

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

        $file = $this->get('file');

        $perm = $file->getPermission();
        if(!$file->canChangeMetadata()) {
            $this->setError('You do not have permission to change metadata on this file');
            return false;
        }

        if(!SnapDBI::startTransaction()) {
            $this->setError('Failed to start transaction');
            return false;
        }

        $md = $this->get('md');
        $changes = $this->get('changes');

        $queryInsert = '';

        foreach($changes as $c => $how) {
            switch($how) {
                case self::MD_INSERT:
                    $queryInsert .= '(' . $file->getId() . ', \'' . mysql_escape_string($c) . '\', \''
                                            . mysql_escape_string($md[$c]) . '\'),';
                    break;
                case self::MD_UPDATE:
                    $queryUpdate = 'UPDATE ' . $file->getType() . 'Metadata SET mdValue = \'' . mysql_escape_string($md[$c])
                        . '\' WHERE ' . strtolower($file->getType()) . 'Id = ' .  $file->getId() . ' AND mdKey = \''
                        . mysql_escape_string($c) . '\'';
                    if(!SnapDBI::query($queryUpdate)) {
                        SnapDBI::cancelTransaction();
                        $this->setError('Failed to perform update for (' . $file->getId() . ', ' . $c . ')');
                        return false;
                    }
                    break;
                case self::MD_DELETE:
                    $queryDelete = 'DELETE FROM ' . $file->getType() . 'Metadata WHERE '
                        . strtolower($file->getType()) . 'Id = ' .  $file->getId() . ' AND mdKey = \''
                        . mysql_escape_string($c) . '\'';
                    if(!SnapDBI::query($queryDelete)) {
                        SnapDBI::cancelTransaction();
                        $this->setError('Failed to perform delete for (' . $file->getId() . ', ' . $c . ')');
                        return false;
                    }
                    break;
            }
        }

        if($queryInsert != '') {
            $queryInsert = 'INSERT INTO ' . $file->getType() . 'Metadata ('
                    . strtolower($file->getType()) . 'Id, mdKey, mdValue) VALUES ' . rtrim($queryInsert, ',');
            if(!SnapDBI::query($queryInsert)) {
                SnapDBI::cancelTransaction();
                $this->setError('Failed to perform insert for (' . $file->getId() . ', ' . $c . ')');
                return false;
            }
        }

        SnapDBI::commitTransaction();

        SnapCache::updateById($this->getType(), $this->getId());
        $this->set('changes', array());

        return true;
    }

    public static function findKeys($domain = '//', $constraints = array(), $limit = array(), $order = array()) {
        $domainObj = self::convertReference($domain, 'File');
        if(!$domainObj) {
            self::setStaticError('Invalid Snap2 reference');
            return false;
        }
        $domain = (is_string($domain) ? $domain : $domainObj->getCanonicalPath());

        $appendStr = '';
        if($domain != '//')
            $domainFix = " path LIKE BINARY '$domain%' ";
        else
            $domainFix = '';
        $attrs = array('mdKey', 'mdValue', 'fileId', 'fileType');
        if($constraints != '' || $domainFix != '') {
            $cstr = SnapDBI::criteriaToString($constraints, $attrs);
            if($cstr === false)
                return false;
            if($cstr != '' || $domainFix != '')
                $appendStr .= " WHERE $domainFix" . ($cstr!=''?" AND $cstr ":'');
        }
        if($limit != '') {
            $lstr = SnapDBI::limitToString($limit);
            if($lstr === false)
                return false;
            $appendStr .= $lstr;
        }
        if($order != '') {
            $ostr = SnapDBI::orderToString($order, $attrs);
            if($ostr === false)
                return false;
            $appendStr .= $ostr;
        }

        if($domain == '//') {
            // we can do a simpler search without using PathCache
            $query = 'SELECT mdKey, mdValue, directoryId AS fileId, \'Directory\' AS fileType FROM DirectoryMetadata '
                    . $appendStr
                    . ' UNION SELECT mdKey, mdValue, resourceId AS fileId, \'Resource\' AS fileType FROM ResourceMetadata '
                    . $appendStr;
        }
        else {
            $query = 'SELECT mdKey, mdValue, PathCache.directoryId AS fileId, \'Directory\' AS fileType FROM PathCache '
                    . 'RIGHT JOIN DirectoryMetadata ON PathCache.directoryId = DirectoryMetadata.directoryId ' . $appendStr
                    . ' UNION SELECT mdKey, mdValue, PathCache.resourceId AS fileId, \'Resource\' AS fileType FROM PathCache '
                    . 'RIGHT JOIN ResourceMetadata ON PathCache.resourceId = ResourceMetadata.resourceId ' . $appendStr;
        }

        if(($result = SnapDBI::query($query, true)) === false) {
            self::setStaticError('Failed to execute query: ' . $query);
            return false;
        }

        return $result;
    }
}

?>

---