snap2/objects/SnapVersion.php5

<?php

class SnapVersion extends SnapObject {
    const STATUS_PRIVATE = 0;
    const STATUS_PENDING = 1;
    const STATUS_DEV = 2;
    const STATUS_LIVE = 3;
    const STATUS_DEFUNCT = 4;

    public static $STAT_NAMES = array(
        self::STATUS_PRIVATE => 'In Progress',
        self::STATUS_PENDING => 'Pending',
        self::STATUS_DEV => 'Dev',
        self::STATUS_LIVE => 'Live',
        self::STATUS_DEFUNCT => 'Defunct'
    );

    public static $STAT_VALUES = array(
        'In Progress' => self::STATUS_PRIVATE,
        'Pending' => self::STATUS_PENDING,
        'Dev' => self::STATUS_DEV,
        'Live' => self::STATUS_LIVE,
        'Defunct' => self::STATUS_DEFUNCT
    );

    public static $ATTRIBUTES = array(
        'id', 'created', 'modified', 'author', 'status', 'ordinal', 'content', 'resourceId', 'prevVersionId'
    );

    public function __construct($id = '') {
        $fields = array_merge(array_flip(self::$ATTRIBUTES), array('resource' => array($this, 'loadResource'),
                                'contentModule' => array($this, 'loadContentModule'),
                                'prevVersion' => array($this, 'loadPrevVersion')));
        parent::__construct('Version', $fields, self::$ATTRIBUTES);
        $this->setSave('contentModule', false);
        $this->setSave('prevVersion', false);
        $this->setSave('resource', false);
        if($id != '') {
            $this->set('id', $id);
            $this->populate();
        }
    }

    public function toCacheDump() {
        $resourceId = $this->get('resourceId');
        $status = $this->get('status');
        return "Resource: $resourceId; status: " . self::$STAT_NAMES[$status];
    }

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

        $query = 'SELECT ' . implode(',', self::$ATTRIBUTES)  . ' FROM Version '
            . 'WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Could not populate due to database error');
            return false;
        }

        if(SnapDBI::getNumRows() == 0) {
            SnapDBI::freeResult();
            $this->setValid(false);
            return false;
        }

        if(SnapDBI::getNumRows() > 1)
            $this->setWarning('Multiple version objects with the same ID!');

        $result = SnapDBI::firstRow();
        foreach(self::$ATTRIBUTES as $a)
            $this->set($a, $result[$a]);

        SnapDBI::freeResult();

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

        return true;
    }

    protected function loadResource() {
        $res = SnapResource::retrieve($this->get('resourceId'));
        $this->set('resource', $res);
        SnapCache::updateById($this->getType(), $this->getId());
        return true;
    }

    protected function loadContentModule() {
        $cm = SnapContent::getContentModule($this);
        $this->set('contentModule', $cm);
        SnapCache::updateById($this->getType(), $this->getId());
        return true;
    }

    protected function loadPrevVersion() {
        $prevId = $this->get('prevVersionId');
        if($prevId > 0) {
            $v = SnapVersion::retrieve($prevId);
            $this->set('prevVersion', $v);
            SnapCache::updateById($this->getType(), $this->getId());
        }
        return true;
    }

    public function systemDestroy() {
        $cm = $this->get('contentModule');
        $cm->delete();
        $this->set('contentModule', null);
        $this->setValid(false);
        return true;
    }

    protected function logAction($action) {
        if(!SnapDBI::startTransaction())
            return false;

        $query = 'INSERT INTO ActionLog (uid, action, versionId) VALUES '
            . '(\'' . Snap2::getCurrentUser() . '\',\'' . $action . '\',\'' . $this->getId()
            . '\')';
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        return true;
    }

    public function __call($name, $args) {
        if(substr($name, 0, 3) == 'can') {
            if(!method_exists($this, '_' . $name)) {
                $this->setError('Invalid dynamic function call: \'' . $name . '\'');
                return false;
            }
            if(!$this->checkValid()) return false;
            return call_user_func_array(array($this, '_' . $name), $args) ? true : false;
        }
        else
            return parent::__call($name, $args);
    }

    /*
     * 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;
        }

        $v = SnapCache::getById('Version', $id);
        if($v != null)
            return $v;
        else {
            $v = new SnapVersion($id);
            $v->populate();
            if(!($v->getId() > 0))
                return null;
        }

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

        return $v;
    }

    public static function lookup($path) {
        if(!Snap2::checkInit()) return null;

        if(!preg_match('/^\s*((\/[a-zA-Z0-9\$\-_.]*)+\@([0-9]+|dev|live|active|latest|pending|private|defunct))\s*$/',
            $path, $matches))
        {
            self::setStaticError('Invalid path: \'' . $path . '\'');
            return null;
        }

        $path = $matches[1];

        $v = SnapCache::getByPath('Version', $path);
        if($v != null)
            return $v;

        $vParts = explode('@', $path);
        $pathParts = explode('/', $vParts[0]);
        $ordinal = $vParts[1];

        $attributes = '';
        foreach(self::$ATTRIBUTES as $a)
            $attributes .= 'Version.'. $a . ',';
        $attributes = rtrim($attributes, ',');

        $query = 'SELECT ' . $attributes . ' FROM Version LEFT JOIN Resource '
            . 'ON Version.resourceId = Resource.id ';
        if(ctype_digit((string) $ordinal))
            $where = ' WHERE Version.ordinal = ' . $ordinal;
        else if($ordinal == 'dev')
            $where = ' WHERE Version.status = ' . self::STATUS_DEV;
        else if($ordinal == 'live')
            $where = ' WHERE Version.status = ' . self::STATUS_LIVE;
        else if($ordinal == 'private') {
            $where = ' WHERE Version.status = ' . self::STATUS_PRIVATE;
            $ignoreMulti = true;
        }
        else if($ordinal == 'pending') {
            $where = ' WHERE Version.status = ' . self::STATUS_PENDING;
            $ignoreMulti = true;
        }
        else if($ordinal == 'defunct') {
            $where = ' WHERE Version.status = ' . self::STATUS_DEFUNCT;
            $ignoreMulti = true;
        }
        else if($ordinal == 'latest') {
            $where = ' WHERE Version.ordinal = (SELECT MAX(ordinal) FROM Version WHERE resourceId = Resource.id)';
            $ignoreMulti = true;
        }
        else if($ordinal == 'active' && SConfig::getOption('common.SERVER_TYPE') == 'dev')
            $where = ' WHERE (Version.status = ' . self::STATUS_DEV . ' OR Version.status = ' . self::STATUS_LIVE . ')';
        else if($ordinal == 'active' && SConfig::getOption('common.SERVER_TYPE') == 'prod')
            $where = ' WHERE Version.status = ' . self::STATUS_LIVE;
        $where .= ' AND ';
        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 ') . ' ORDER BY status';

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

        if(count($result) == 0)
            return null;
        else if(count($result) == 2 && $ordinal == 'active') {
            if($result[0]['status'] == $result[1]['status'])
                self::setStaticWarning('Multiple active results for path \'' . $path
                                        . '\'!  Run snap consistency check please.');
            else {
                if($result[1]['status'] == SnapVersion::STATUS_DEV)
                    $result[0] = $result[1];
                unset($result[1]);
            }
        }
        else if(count($result) != 1) {
            if(isset($ignoreMulti)) {
                $newResult = array($result[count($result)-1]);
                $result = $newResult;
            }
            else {
                self::setStaticWarning('Multiple results for path \'' . $path
                                    . '\'!  Run Snap consistency check please.');
            }
        }

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

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

        SnapCache::putByPath('Version', $path, $v);

        return $v;
    }

    /*
     * Capability Checks
     */

    protected function _canSteal() {
        if($this->get('status') != self::STATUS_PRIVATE) {
            $this->setReason('Cannot steal version that is not In Progress');
            return false;
        }

        if($this->get('author') == Snap2::getCurrentUser()) {
            $this->setReason('Cannot steal version that is already your own');
            return false;
        }

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

        return true;
    }

    protected function _canUpdate($newCM = null) {
        if($this->get('status') != self::STATUS_PRIVATE) {
            $this->setReason('Cannot update version that is not In Progress');
            return false;
        }

        $cl = SnapContent::getContentModuleClass($this);
        if($newCM) {
            if(!is_object($newCM) || !$newCM instanceof $cl) {
                $this->setReason('Invalid content module passed to update():'.
                                " It's possible there are two or more modules with the same shortName.");
                return false;
            }

            if(!$newCM->isValid()) {
                $this->setReason('Invalid content');
                return false;
            }
        }

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

        return true;
    }

    protected function _canSubmit() {
        if($this->get('status') != self::STATUS_PRIVATE) {
            $this->setReason('Cannot submit version that is not In Progress');
            return false;
        }

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

        return true;
    }

    protected function _canApproveForDev() {
        if($this->get('status') != self::STATUS_PENDING) {
            $this->setReason('Cannot submit version that is not Pending');
            return false;
        }

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

        return true;
    }

    protected function _canApproveForLive() {
        if($this->get('status') != self::STATUS_PENDING
            && $this->get('status') != self::STATUS_DEV) {
            $this->setReason('Cannot submit version that is not Pending or Dev');
            return false;
        }

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

        return true;
    }

    protected function _canDefunct() {
        if($this->get('status') == self::STATUS_DEFUNCT) {
            $this->setReason('Version is already defunct');
            return false;
        }

        if(!$this->get('resource')->getPermission()->mayDefunct($this->get('status'))) {
            $this->setReason('Permission denied');
            return false;
        }

        return true;
    }

    protected function _canDestroy() {
        if($this->get('status') != self::STATUS_DEFUNCT) {
            $this->setReason('Cannot destroy version that is not Defunct');
            return false;
        }

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

        return true;
    }

    protected function _canDeny() {
        if($this->get('status') != self::STATUS_PENDING) {
            $this->setReason('Cannot deny version that is not Pending');
            return false;
        }

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

        return true;
    }

    /*
     * Public Interface Methods
     */

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

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

        if($newCM == null) {
            $this->setError('No content module passed to update!');
            SnapDBI::cancelTransaction();
            return false;
        }

        if(!$this->_canUpdate($newCM)) {
            $this->setError('Failed to update: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        $oldCM = $this->getContentModule();

        $content = mysql_escape_string($newCM->getRaw());
        $query = 'UPDATE Version SET content = \'' . $content . '\' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }
        SnapDBI::commitTransaction();

        $oldCM->delete();

        $this->set('contentModule', $newCM);
        $this->set('content', $newCM->getRaw());

        $this->logAction('Edit');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

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

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

        if(!$this->_canSubmit()) {
            $this->setError('Failed to submit: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        $query = 'UPDATE Version SET status = ' . self::STATUS_PENDING . ' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        $this->set('status', self::STATUS_PENDING);

        $this->logAction('Submit');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

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

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

        if(!$this->_canApproveForDev()) {
            $this->setError('Failed to approve for dev: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        $res = $this->get('resource');

        // 1) Set old dev version to defunct
        if($res->get('devVersionId') > 0) {
            $query = 'UPDATE Version SET status = ' . self::STATUS_DEFUNCT . ' WHERE id = ' . $res->get('devVersionId');
            if(!SnapDBI::query($query)) {
                $this->setError('Error updating old dev version');
                SnapDBI::cancelTransaction();
                return false;
            }
        }

        // 2) Set this version to dev
        $query = 'UPDATE Version SET status = ' . self::STATUS_DEV . ' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        // 3) Set resource's devVersionId to this
        $query = 'UPDATE Resource SET devVersionId = ' . $this->getId() . ' WHERE id = ' . $this->get('resourceId');
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        $this->set('status', self::STATUS_DEV);

        $oldDev = SnapCache::getById('Version', $res->get('devVersionId'));
        if($oldDev) {
            $oldDev->set('status', self::STATUS_DEFUNCT);
            SnapCache::updateById($oldDev->getType(), $oldDev->getId());
        }

        $res->set('devVersionId', $this->getId());
        if($res->isLoaded('devVersion')) {
            $res->set('devVersion', $this);
            SnapCache::updateById($res->getType(), $res->getId());
        }

        $this->logAction('ApproveForDev');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

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

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

        if(!$this->_canApproveForLive()) {
            $this->setError('Failed to approve for live: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        /*
        Things to do:
        1) Set old live version to defunct (if there was an old live version)
        2) Set this version to live
        3) Set resource's devVersionId to null (if this was the dev version)
        4) Set resource's liveVersionId to this
        5) Update cache for old live version (if old live version)
        6) Update cache for resource
        */

        $res = $this->get('resource');

        // 1) Set old live version to defunct
        if($res->get('liveVersionId') > 0) {
            $query = 'UPDATE Version SET status = ' . self::STATUS_DEFUNCT . ' WHERE id = ' . $res->get('liveVersionId');
            if(!SnapDBI::query($query)) {
                $this->setError('Error updating old live version');
                SnapDBI::cancelTransaction();
                return false;
            }
        }

        // 2) Set this version to live
        $query = 'UPDATE Version SET status = ' . self::STATUS_LIVE . ' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        // 3) Set resource's devVersionId to null
        if(($oldStatus = $this->get('status')) == self::STATUS_DEV) {
            $query = 'UPDATE Resource SET devVersionId = NULL WHERE id = ' . $this->get('resourceId');
            if(!SnapDBI::query($query)) {
                $this->setError('Error updating resource');
                SnapDBI::cancelTransaction();
                return false;
            }
        }

        // 4) Set resource's liveVersionId to this
        $query = 'UPDATE Resource SET liveVersionId = ' . $this->getId() . ' WHERE id = ' . $this->get('resourceId');
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        $query = 'UPDATE Resource SET approvalDate = CURRENT_TIMESTAMP WHERE id = ' . $this->get('resourceId');
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        $this->set('status', self::STATUS_LIVE);

        $oldLive = SnapCache::getById('Version', $res->get('liveVersionId'));
        if($oldLive) {
            $oldLive->set('status', self::STATUS_DEFUNCT);
            SnapCache::updateById($oldLive->getType(), $oldLive->getId());
        }

        $res->set('liveVersionId', $this->getId());
        if($res->isLoaded('liveVersion'))
            $res->set('liveVersion', $this);

        if($oldStatus == self::STATUS_DEV) {
            $res->set('devVersionId', '');
            if($res->isLoaded('devVersion'))
                $res->set('devVersion', null);
        }
        SnapCache::updateById($res->getType(), $res->getId());

        $this->logAction('ApproveForLive');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

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

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

        if(!$this->_canDefunct()) {
            $this->setError('Failed to defunct: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        if($this->get('status') == self::STATUS_DEV) {
            $query = 'UPDATE Resource SET devVersionId = NULL WHERE id = ' . $this->get('resourceId');
            if(!SnapDBI::query($query)) {
                $this->setError('Error updating parent resource');
                SnapDBI::cancelTransaction();
                return false;
            }
        }
        else if($this->get('status') == self::STATUS_LIVE) {
            $query = 'UPDATE Resource SET liveVersionId = NULL WHERE id = ' . $this->get('resourceId');
            if(!SnapDBI::query($query)) {
                $this->setError('Error updating parent resource');
                SnapDBI::cancelTransaction();
                return false;
            }
        }

        $query = 'UPDATE Version SET status = ' . self::STATUS_DEFUNCT . ' WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error updating version');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        $oldStatus = $this->get('status');
        $this->set('status', self::STATUS_DEFUNCT);
        if($res = SnapCache::getById('Resource', $this->get('resourceId'))) {
            if($oldStatus == self::STATUS_DEV) {
                $res->set('devVersionId', '');
                if($res->isLoaded('devVersion'))
                    $res->set('devVersion', null);
            }
            else if($oldStatus == self::STATUS_LIVE) {
                $res->set('liveVersionId', '');
                if($res->isLoaded('liveVersion'))
                    $res->set('liveVersion', null);
            }
            SnapCache::updateById($res->getType(), $res->getId());
        }

        $this->logAction('ApproveForLive');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

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

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

        if(!$this->_canDestroy()) {
            $this->setError('Failed to destroy: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        $query = 'DELETE FROM Version WHERE id = ' . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        $cm = $this->getContentModule();
        $cm->delete();

        SnapDBI::commitTransaction();

        $res = SnapResource::retrieve($this->get('resourceId'));
        $res->unsetField('maxOrdinal');

        SnapCache::deleteById('Version', $this->getId());

        SnapDBI::query('DELETE FROM PathCache WHERE versionId = ' . $this->getId());

        $this->setValid(false);

        return true;
    }

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

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

        if(!$this->_canDeny()) {
            $this->setError('Failed to deny: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        $query = "UPDATE Version SET status = '" . self::STATUS_PRIVATE . "' WHERE id = "
            . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        $this->set('status', self::STATUS_PRIVATE);

        $this->logAction('Deny');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

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

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

        if(!$this->_canSteal()) {
            $this->setError('Failed to steal: ' . $this->getReason());
            SnapDBI::cancelTransaction();
            return false;
        }

        $query = 'UPDATE Version SET author = \'' . Snap2::getCurrentUser() . '\' WHERE id = '
            . $this->getId();
        if(!SnapDBI::query($query)) {
            $this->setError('Error during query');
            SnapDBI::cancelTransaction();
            return false;
        }

        SnapDBI::commitTransaction();

        $this->set('author', Snap2::getCurrentUser());

        $this->logAction('Steal');
        SnapCache::updateById($this->getType(), $this->getId());

        return true;
    }

    /*
     * Query/list functions
     */

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

        $query = 'SELECT uid,action,actionTime FROM ActionLog WHERE versionId = ' . $this->getId();

        $attrs = array('uid', 'action', 'actionTime');

        $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;
    }

    public function getCanonicalPath() {
        $res = $this->get('resource');
        return $res->getCanonicalPath() . '@' . $this->get('ordinal');
    }

    public function getAllPaths() {
        $paths = $this->get('resource')->getAllPaths();
        $finalPaths = array();
        foreach($paths as $path) {
            $finalPaths[] = $path . '@' . $this->get('ordinal');
        }
        return $finalPaths;
    }
}

?>

---