cron_job_squid_cache_purge.inc

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

class Cron_Job_Squid_Cache_Purge extends Cron_Job
{


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

    }//end constructor


    protected function _getName($short_name=FALSE)
    {
        // the ownerid must be set at the creation of this cron job
        return translate('squid_cron_name', $this->attr('ownerid'));

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

        // if we have admin access to the asset owning this job
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->attr('ownerid'));
        if (!is_null($asset)) return $asset->adminAccess('');
        return FALSE;

    }//end canDelete()


    protected function _exec(&$msg)
    {
        // based on the options in the tool interface and settings in the global prefs
        $assetid = $this->attr('ownerid');
        $vars = Array(
                    'assetid'       => $assetid,
                    'cascade'       => $this->attr('cascade'),
                    'repopulate'    => $this->attr('repopulate'),
                );

        $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();
        $status_errors = $hh->freestyleHipo('hipo_job_tool_clear_squid_cache', $vars, SQ_PACKAGES_PATH.'/squid/hipo_jobs');

        if (empty($status_errors)) {
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
            $msg = translate('squid_cron_done_msg', $asset->name, $assetid);
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);

            if ($this->attr('type') == 'one_off') {
                // all OK, and we can be removed because we have done our one off task
                return SQ_CRON_JOB_COMPLETED | SQ_CRON_JOB_REMOVE;
            } else if ($this->attr('type') == 'repeating') {
                // repeating time interval job, do not remove
                return SQ_CRON_JOB_COMPLETED;
            }
        } else {
            // process failed
            trigger_localised_error('SQUID0002', 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()
    {
        $cm = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('cron_manager');
        return $cm->getJobs('cron_job_squid_cache_purge');

    }//end getActiveJobs()


}//end class

?>