cron_job_future_status.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/system/cron/cron_job/cron_job.inc';

class Cron_Job_Future_Status extends Cron_Job
{


    function __construct($assetid=0)
    {
        parent::__construct($assetid);

    }//end constructor


    protected function _createAdditional(Array &$link)
    {
        if (!parent::_createAdditional($link)) return FALSE;

        if (!empty($this->_tmp['asset_in_link'])) {
            if (!$GLOBALS['SQ_SYSTEM']->am->acquireLock($this->id, 'links')) {
                trigger_localised_error('CRON0018', E_USER_WARNING);
                return FALSE;
            }

            $link = $this->_tmp['asset_in_link'];
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);
            if (is_null($asset) || !$this->setAssetToUpdate($asset)) {
                trigger_localised_error('CRON0017', E_USER_WARNING);
                return FALSE;
            }

            unset($this->_tmp['asset_in_link']);
            $GLOBALS['SQ_SYSTEM']->am->releaseLock($this->id, 'links');
        }
        return TRUE;

    }//end _createAdditional()


    protected function _getName($short_name=FALSE)
    {
        $asset = $this->getAssetToUpdate();
        if (is_null($asset)) {
            return translate('cron_job_asset_less_future_status');
        } else if ($short_name) {
            return translate('cron_fs_for', translate('asset_format', $asset->short_name, $asset->id));
        } else {
            return translate('cron_future_status_for', translate('asset_format', $asset->name, $asset->id));
        }

    }//end _getName()


    public function _getAllowedLinks()
    {
        $links = parent::_getAllowedLinks();

        // make sure that we can link to every asset
        if (empty($links[SQ_LINK_NOTICE]['asset'])) {
            $links[SQ_LINK_NOTICE]['asset'] = Array('card' => 1);
        }

        return $links;

    }//end _getAllowedLinks()


    public function canDelete()
    {
        if (parent::canDelete()) return TRUE;

        // read-only?
        if ($this->attr('read_only')) return FALSE;

        $asset = $this->getAssetToUpdate();
        if (!is_null($asset)) return $asset->adminAccess('');
        return FALSE;

    }//end canDelete()


    public function setAttrValue($name, $value)
    {
        switch ($name) {
            case 'status' :
                $value = (int) $value;
                if (!in_array($value, array_keys($this->_getAllStatii()))) {
                    trigger_localised_error('CRON0031', E_USER_NOTICE);
                    return FALSE;
                }
            break;

            case 'type' :
                trigger_localised_error('CRON0038', E_USER_NOTICE);
                return FALSE;
            break;
        }//end if

        return parent::setAttrValue($name, $value);

    }//end setAttrValue()


    protected static function _getAllStatii()
    {
        return Array(
                SQ_STATUS_ARCHIVED              => 'ARCHIVED',
                SQ_STATUS_UNDER_CONSTRUCTION    => 'UNDER_CONSTRUCTION',
                SQ_STATUS_LIVE                  => 'LIVE',
                SQ_STATUS_EDITING               => 'EDITING',
                SQ_STATUS_LIVE_APPROVAL         => 'LIVE_APPROVAL',
               );

    }//end _getAllStatii()


    public static function _getAllStatiiDescs()
    {
        static $descs = Array();

        if (empty($descs)) {
            $descs['']  = '[Select Status]';
            $statii = self::_getAllStatii();
            foreach ($statii as $value => $code) {
                $code = strtolower($code);
                $status_code = 'asset_status_'.$code;
                require_once SQ_INCLUDE_PATH.'/asset_status/'.$status_code.'.inc';
                eval('$descs[$value] = '.$status_code.'::getDescription();');
            }
        }

        return $descs;

    }//end _getAllStatiiDescs()


    public function statusName()
    {
        if (!$this->attr('status')) return '[ No Status Set ]';
        $statii = self::_getAllStatii();
        $code = strtolower($statii[$this->attr('status')]);
        $status_code = 'asset_status_'.$code;
        require_once SQ_INCLUDE_PATH.'/asset_status/'.$status_code.'.inc';
        eval('$desc = '.$status_code.'::getDescription();');
        return $desc;

    }//end statusName()


    public function setAssetToUpdate(Asset $asset)
    {
        if ($this->id) {
            $existing_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($this->id, SQ_LINK_NOTICE, '', TRUE, 'major', $value='updating');
            $link_exists = FALSE;
            foreach ($existing_links as $old_link) {
                if ($old_link['minorid'] == $asset->id) {
                    $link_exists = TRUE;
                } else {
                    $GLOBALS['SQ_SYSTEM']->am->deleteAssetLink($old_link['linkid']);
                }
            }
            if ($link_exists) {
                return TRUE;
            } else {
                return (bool)  $this->createLink($asset, SQ_LINK_NOTICE, 'updating');
            }
        } else {
            if (!isset($this->_tmp['asset_in_link'])) {
                $this->_tmp['asset_in_link'] = Array();
            }
            $this->_tmp['asset_in_link'] = Array('minorid' => $asset->id, 'minor_type_code' => $asset->type());
            return TRUE;
        }

    }//end setAssetToUpdate()


    public function getAssetToUpdate()
    {
        // because we need to return by ref
        $null = NULL;

        if ($this->id) {
            $link = $GLOBALS['SQ_SYSTEM']->am->getLink($this->id, SQ_LINK_NOTICE, 'asset', FALSE, 'updating');
        } else {
            $link = (isset($this->_tmp['asset_in_link'])) ? $this->_tmp['asset_in_link'] : Array();
        }
        if (empty($link)) return $null;

        return $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);

    }//end getAssetToUpdate()


    protected function _exec(&$msg)
    {
        $asset = $this->getAssetToUpdate();
        if (!is_null($asset)) {

            $old_status = $asset->status;

            // process the status change
            $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();
            $vars = Array('assetid' => $asset->id, 'new_status' => $this->attr('status'), 'dependants_only' => $this->attr('dependants_only'));

            $status_errors = $hh->freestyleHipo('hipo_job_edit_status', $vars);
            if (empty($status_errors)) {
                // all OK, and we can be removed because we have done our one off task
                $msg = translate('cron_altered_asset_status', translate('asset_format', $asset->name, $asset->id), get_status_description($old_status), $this->statusName());
                return SQ_CRON_JOB_COMPLETED | SQ_CRON_JOB_REMOVE;
            } else {
                // process failed
                trigger_localised_error('CRON0003', E_USER_WARNING, $asset->name, $asset->id);
                // we have errors so dump them out too
                foreach ($status_errors as $error) {
                    $line = '';
                    if (is_string($error)) {
                        $line = $error;
                    } else if (is_array($error)) {
                        if (isset($error['time'])) $line .= 'Time : '.$error['time'].'. ';
                        if (isset($error['message'])) $line .= 'Message : '.$error['message'].'.';
                    }
                    if ($line !== '') trigger_error($line, E_USER_WARNING);
                }
            }

        } else {
            // asset not found
            trigger_localised_error('CRON0020', E_USER_WARNING);
        }

        // we can be removed because the error is beyound our control
        return SQ_CRON_JOB_ERROR | SQ_CRON_JOB_REMOVE;

    }//end _exec()


    public static function &getActiveJobs(Asset $asset)
    {
        $links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_NOTICE, strtolower(__CLASS__), TRUE, 'minor', 'updating');
        $assetids = Array();
        $cm = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('cron_manager');
        foreach ($links as $link) {
            $cm_links = $GLOBALS['SQ_SYSTEM']->am->getLinkByAsset($cm->id, $link['majorid']);
            if (!empty($cm_links)) {
                // This asset is still linked to the cron manager, so its still active.
                $assetids[] = $link['majorid'];
            }
        }
        $dates = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('when', 'cron_job_future_status', $assetids);
        asort($dates, SORT_STRING);
        $res = Array();
        foreach ($dates as $assetid => $date) {
            $res[] = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid, strtolower(__CLASS__));
        }
        return $res;

    }//end getActiveJobs()


}//end class

?>