tsd/TSDLeaf.php5

<?php

abstract class TSDLeaf extends TSDObject {
    protected $realID = '';
    protected $alignTable = '';

    public function __construct($table, $attrs, $idname, $id, $alignTable, $realIdname) {
        parent::__construct($table, $attrs, $idname, $id);
        $this->realID = $realIdname;
        $this->alignTable = $alignTable;
    }

    public function listAlignments($what = TSD::MODE_APPROVED, $cnt = false) {
        $id = $this->get($this->getUnique());
        
        $state = 'live';
        // Choose default state according to the current server
        if (SConfig::getDefault('common.server') == 'newdev') {
            $state = 'dev';
        } else if (SConfig::getDefault('common.server') == 'www') {
            $state = 'live';
        }
        
        if($cnt)
            $query = "SELECT COUNT(*) FROM $this->alignTable WHERE $this->realID = '" . mysql_escape_string($id) . "'";
        else
            $query = "SELECT $this->alignTable.resourceId, $this->alignTable.version, $this->alignTable.status, "
                . "$this->alignTable.reason FROM " . $this->alignTable
                . " LEFT JOIN SDRResourceCache ON SDRResourceCache.cserdId = $this->alignTable.resourceId"
                . " WHERE $this->realID = '" . mysql_escape_string($id) . "'";

        switch($what) {
            case TSD::MODE_LIVE:
                $query .= ' AND version = \'LIVE\'';
                break;
            case TSD::MODE_DEV:
                $query .= ' AND version = \'DEV\'';
                break;
            case TSD::MODE_DEV_ACTIVE:
                $query .= ' AND version = \'DEV\' AND status <> \'DELETED\'';
                break;
            case TSD::MODE_DEV_UNAPPROVED:
                $query .= ' AND version = \'DEV\' AND status <> \'APPROVED\'';
                break;
            case TSD::MODE_NEW:
                $query .= ' AND version = \'DEV\' AND status = \'NEW\'';
                break;
            case TSD::MODE_CHANGED:
                $query .= ' AND version = \'DEV\' AND status = \'CHANGED\'';
                break;
            case TSD::MODE_DELETED:
                $query .= ' AND version = \'DEV\' AND status = \'DELETED\'';
                break;
            case TSD::MODE_APPROVED:
                $query .= ' AND version = \'DEV\' AND status = \'APPROVED\'';
                break;
            case TSD::MODE_ALL:
                $query .= '';
                break;
        }
        $query .= ' AND SDRResourceCache.' . $state .'VersionId IS NOT NULL' .
                  ' ORDER BY version ASC, status ASC, resourceId ASC';
        $result = $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            return null;
        }

        $out = array();
        foreach($result as $r) {
            $record = array(
                'id' => $r['resourceId'],
                'reason' => $r['reason'],
                'version' => $r['version'],
                'status' => $r['status']
            );

            $out[] = $record;
        }

        return $out;
    }

    public function align($urlOrId, $reason = '') {
        if(!TSD::can('align')) {
            $this->setError('Permission denied');
            return false;
        }
        if(($id = self::getCWISID($urlOrId)) === false) {
            $this->setError('No such URL or ID: ' . $urlOrId);
            return false;
        }
        $idname = $this->realID;
        $oid = $this->get($this->getUnique());

        // get old DEV alignment if there is one
        $query = "SELECT COUNT(*) FROM $this->alignTable WHERE $idname = '" . mysql_escape_string($oid)
            . "' AND version = 'DEV' AND resourceId = $id";
        $results = $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }

        if($results[0]['COUNT(*)'] > 0) {
            // already have a DEV version of some sort, so mark it as CHANGED, unless it is already marked as NEW
            //   we don't want to mark NEW versions as CHANGED because CHANGED only means that it has been modified
            //   relative to the LIVE version; well, there is no live version with new versions, so no need to change marking
            $query = "UPDATE $this->alignTable SET reason = '" . mysql_escape_string($reason) . "', status = 'CHANGED' WHERE"
                . " $idname = '" . mysql_escape_string($oid) . "' AND resourceId = $id AND version = 'DEV' AND status <> 'NEW'";
            $description = 'Updating pending alignment';
        }
        else {
            // need to create a DEV version and initialize it correctly
            $query = "INSERT INTO $this->alignTable ($idname, resourceId, reason, version, status) VALUES ('"
                . mysql_escape_string($oid) . '\', ' . $id . ', \'' . mysql_escape_string($reason) . '\', \'DEV\', \'NEW\')';
            $description = 'Creating pending alignment';
        }

        $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            TSD::log("FAILED: $description", $query);
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }
        TSD::log($description, $query);
        return true;
    }

    public function unalign($urlOrId) {
        if(!TSD::can('align')) {
            $this->setError('Permission denied');
            return false;
        }
        if(($id = self::getCWISID($urlOrId)) === false)
            return false;
        $idname = $this->realID;
        $oid = $this->get($this->getUnique());

        // mark as DELETED any dev versions that aren't marked as NEW; for versions marked as NEW, we use the
        //   second query (below) to simply delete them
        $query = "UPDATE $this->alignTable SET status = 'DELETED' WHERE $idname = '" . mysql_escape_string($oid)
            . "' AND resourceId = $id AND version = 'DEV' AND status <> 'NEW'";
        $desc = 'unalign(): marking dev versions as deleted';
        $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            TSD::log("FAILED: $desc", $query);
            return false;
        }
        TSD::log($desc, $query);

        // simply delete versions marked as NEW, since they don't need to be approved to be deleted, they just go away as if
        //   they were never aligned in the first place
        $query = "DELETE FROM $this->alignTable WHERE $idname = '" . mysql_escape_string($oid) . "' AND resourceId = $id "
            . " AND version = 'DEV' AND status = 'NEW'";
        $this->DBI->query($query);
        $desc = 'unalign(): deleting dev versions';
        if(count($this->DBI->getError()) > 0) {
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            TSD::log("FAILED: $desc", $query);
            return false;
        }
        TSD::log($desc, $query);

        return true;
    }

    public function approveAlignments($urlOrId = null) {
        if(!TSD::can('approve')) {
            $this->setError('Permission denied');
            return false;
        }
        if($urlOrId !== null) {
            if(($id = self::getCWISID($urlOrId)) === false)
                return false;
        }
        else
            $id = null;

        $queryList = array();

        $idname = $this->realID;
        $oid = $this->get($this->getUnique());

        $this->DBI->query('START TRANSACTION');

        $query = "SELECT resourceId, reason, status FROM $this->alignTable WHERE $idname = '" . mysql_escape_string($oid)
            . "' AND version = 'DEV' AND status <> 'APPROVED'";
        if($id !== null)
            $query .= ' AND resourceId = ' . $id;
        $result = $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->DBI->query('ROLLBACK');
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }

        foreach($result as $r) {
            switch($r['status']) {
                case TSD::STATUS_DELETED:
                    // delete both dev and live versions
                    $query = "DELETE FROM $this->alignTable WHERE $idname = '"
                        . mysql_escape_string($oid) . "' AND resourceId = $r[resourceId]";
                    break;
                case TSD::STATUS_CHANGED:
                    // update live version to match dev version
                    $query = "UPDATE $this->alignTable SET reason = '" . mysql_escape_string($r['reason'])
                        . "', status = 'APPROVED' WHERE $idname = '" . mysql_escape_string($oid)
                        . "' AND resourceId = $r[resourceId]";
                    break;
                case TSD::STATUS_NEW:
                    // create live version
                    $query = "INSERT INTO $this->alignTable ($idname, resourceId, reason, version, status) VALUES "
                        . "('" . mysql_escape_string($oid) ."', $r[resourceId], '" . mysql_escape_string($r['reason'])
                        . "', 'LIVE', 'APPROVED')";
                    break;
            }
            $this->DBI->query($query);
            $queryList[] = $query;
            if(count($this->DBI->getError()) > 0) {
                $this->DBI->query('ROLLBACK');
                TSD::log('FAILED: approveAlignments()', implode("\n", $queryList));
                $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
                return false;
            }
            TSD::log('approveAlignments(): copying to live', $query);
            if($r['status'] != TSD::STATUS_DELETED) {
                // mark the dev version as being approved, unless it's been deleted
                $query = "UPDATE $this->alignTable SET status = 'APPROVED' WHERE $idname = '$oid' AND "
                    . " resourceId = $r[resourceId] AND version = 'DEV'";
                $queryList[] = $query;
                $this->DBI->query($query);
                if(count($this->DBI->getError()) > 0) {
                    $this->DBI->query('ROLLBACK');
                    TSD::log('FAILED: approveAlignments()', implode("\n", $queryList));
                    $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
                    return false;
                }
                TSD::log('approveAlignments(): updating dev version', $query);
            }
        }

        $this->DBI->query('COMMIT');

        return true;
    }

    public function cancelAlignments($urlOrId = null) {
        if(!TSD::can('approve')) {
            $this->setError('Permission denied');
            return false;
        }
        if($urlOrId !== null) {
            if(($id = self::getCWISID($urlOrId)) === false)
                return false;
        }
        else
            $id = null;

        $idname = $this->realID;
        $oid = $this->get($this->getUnique());

        $queryList = array();

        $this->DBI->query('START TRANSACTION');

        /*
         * If status is NEW: simply delete DEV version (first query); second query is a no-op
         * If status is DELETED: copy from LIVE version to DEV version (second query); first query removes DELETED dev version
         * If status is CHANGED: copy from LIVE version to DEV version (Second query); first query removes CHANGED dev version
         */

        // delete old dev versions
        $query = "DELETE FROM $this->alignTable WHERE $idname = '" . mysql_escape_string($oid) . "' AND version = 'DEV'";
        if($id !== null)
            $query .= ' AND resourceId = ' . $id;
        $desc = 'cancelAlignments(): delete old dev versions';
        $queryList[] = $query;
        $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->DBI->query('ROLLBACK');
            TSD::log("FAILED: $desc", implode("\n", $queryList));
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }
        TSD::log($desc, $query);

        // copy live versions back to dev versions
        $query = "REPLACE INTO $this->alignTable ($idname, resourceId, reason, version, status) SELECT $idname, resourceId, "
            . "reason, 'DEV' AS version, 'APPROVED' AS status FROM $this->alignTable WHERE $idname = '"
            . mysql_escape_string($oid) . "'";
        if($id !== null)
            $query .= ' AND resourceId = ' . $id;
        $desc = 'cancelAlignments(): copying live to dev versions';
        $queryList[] = $query;
        $this->DBI->query($query);
        if(count($this->DBI->getError()) > 0) {
            $this->DBI->query('ROLLBACK');
            TSD::log("FAILED: $desc", implode("\n", $queryList));
            $this->setError('DB error(s): ' . implode('; ', $this->DBI->getError()));
            return false;
        }
        TSD::log($desc, $query);

        $this->DBI->query('COMMIT');
        return true;
    }
}

?>

---