hipo_job_clear_cache.inc

<?php
require_once SQ_SYSTEM_ROOT.'/core/hipo/hipo_job.inc';

class HIPO_Job_Clear_Cache extends HIPO_Job
{


    function HIPO_Job_Clear_Cache($code_name='')
    {
        $this->HIPO_Job($code_name);

    }//end constructor


    public static function paintConfig(&$o, $class, $write_access)
    {
        // clear cache threshhold HIPO config entry
        $o->openField(translate('clear_cache_threshold'));

        if ($write_access) {
            text_box($class.'[SQ_HIPO_CLEAR_CACHE_THRESHOLD]', SQ_HIPO_CLEAR_CACHE_THRESHOLD, 5);
            echo ' '.translate('assets');
        } else {
            echo SQ_HIPO_CLEAR_CACHE_THRESHOLD;
            echo ' '.translate('assets');
        }

        $o->closeField();

    }//end paintConfig()


    public static function getConfigVars()
    {
        return Array(
                'SQ_HIPO_CLEAR_CACHE_THRESHOLD' => Array('editable' => 1, 'default' => 100),
               );

    }//end getConfigVars()


    function getCodeName()
    {
        if (isset($this->_running_vars['linkid'])) {
            return parent::getCodeName().$this->_running_vars['linkid'];
        } else {
            if ($this->_running_vars['delete_all'] == 'yes') {
                // clear all system cache
                return parent::getCodeName().'delete_all';
            } else {
                return parent::getCodeName().$this->_running_vars['assetid'];
            }
        }

    }//end getCodeName()


    function getHipoName()
    {
        return translate('hipo_name_clear_cache');

    }//end getHipoName()


    function getInitialStepData()
    {
        return Array(
                Array(
                    'name'          => 'Clear Cache Table',
                    'function_call' => Array(
                                        'process_function'  => 'processClearCacheTable',
                                       ),
                    'running_mode'  => 'server',
                    'auto_step'     => TRUE,
                    'allow_cancel'  => TRUE,
                    'percent_done'  => 0,
                    'complete'      => FALSE,
                    'message'       => '',
                ),
                Array(
                    'name'          => translate('hipo_clearing_cache'),
                    'function_call' => Array(
                                        'process_function'  => 'processClearCacheFile',
                                       ),
                    'running_mode'  => 'server',
                    'auto_step'     => TRUE,
                    'allow_cancel'  => TRUE,
                    'percent_done'  => 0,
                    'complete'      => FALSE,
                    'message'       => '',
                ),
                Array(
                    'name'          => 'Repopulating Cache',
                    'function_call' => Array(
                                        'process_function'  => 'processRepopulate',
                                       ),
                    'running_mode'  => 'server',
                    'auto_step'     => TRUE,
                    'allow_cancel'  => TRUE,
                    'percent_done'  => 0,
                    'complete'      => FALSE,
                    'message'       => '',
                ),
               );

    }//end getInitialStepData()


    function getThresholdPercentageRequired()
    {
        if (SQ_HIPO_CLEAR_CACHE_THRESHOLD == 0) return 0;
        if (!isset($this->_running_vars['total'])) return 0;
        return (($this->_running_vars['total'] + 1) / SQ_HIPO_CLEAR_CACHE_THRESHOLD) * 100;

    }//end getThresholdPercentageRequired()


    function freestyle()
    {
        if ($this->_running_vars['delete_all'] == 'yes') {
            // run once to clear all cache
            $this->processClearCacheTable($this->_steps[0], get_class($this));
        } else {
            while (!empty($this->_running_vars['todo_assetids'])) {
                if (!$this->processClearCacheTable($this->_steps[0], get_class($this))) {
                    return FALSE;
                }
            }
        }

        // todo paths populated, so process them
        while (!empty($this->_running_vars['todo_filepaths'])) {
            if (!$this->processClearCacheFile($this->_steps[1], get_class($this))) {
                return FALSE;
            }
        }

        // repopulate
        while (!empty($this->_running_vars['todo_repopulate'])) {
            if (!$this->processRepopulate($this->_steps[2], get_class($this))) {
                return FALSE;
            }
        }

        return TRUE;

    }//end freestyle()


    function prepare()
    {
        if (empty($this->_running_vars['assetid']) && $this->_running_vars['delete_all'] == 'no') {
            trigger_localised_error('HIPO0033', E_USER_WARNING);
            return FALSE;
        }

        if (isset($this->_running_vars['delete_all']) && $this->_running_vars['delete_all'] == 'no') {

            $assetids = $this->_running_vars['assetid'];
            // Just in case some old code somewhere still passing the assetid as a string and not array.
            if (!is_array($assetids)) {
                $assetids = Array ($assetids);
            }
            if (empty($assetids)) {
                trigger_localised_error('HIPO0032', E_USER_WARNING, $this->_running_vars['assetid']);
                return FALSE;
            }//end if

            $child_assets = Array();
            $this->_running_vars['todo_assetids'] = Array();
            foreach ($assetids as $assetid) {
                switch ($this->_running_vars['level']) {
                    case 'single':
                        $this->_running_vars['todo_assetids'][] = $assetid;
                    break;
                    case 'dependants':
                        $child_assets += $GLOBALS['SQ_SYSTEM']->am->getDependantChildren($assetid, $this->_running_vars['type_codes']);
                        $this->_running_vars['todo_assetids'][] = $assetid;
                    break;
                    case 'children':
                        $child_assets += $GLOBALS['SQ_SYSTEM']->am->getChildren($assetid, $this->_running_vars['type_codes']);
                        $this->_running_vars['todo_assetids'][] = $assetid;
                    break;
                }//end switch

            }//end foreach

            if (!empty($child_assets)) {
                $child_assets   = array_keys($child_assets);
                $this->_running_vars['todo_assetids'] = array_merge($this->_running_vars['todo_assetids'], $child_assets);
            }//end if

            $this->_running_vars['delete_all'] = FALSE;
            $this->_running_vars['total'] = count($this->_running_vars['todo_assetids']);

        } else if (isset($this->_running_vars['delete_all']) && $this->_running_vars['delete_all'] == 'yes') {
            // empty todo_assetids, since we do clearAllCache in a single step
            $this->_running_vars['todo_assetids'] = Array();
            $this->_running_vars['delete_all'] = TRUE;
            $this->_running_vars['total'] = 1;
        }

        $this->_running_vars['done_assetids'] = Array();
        $this->_running_vars['todo_filepaths'] = Array();
        $this->_running_vars['done_filepaths'] = Array();

        // note that this option only presents in tool
        // and it does not work with 'delete_all' = yes
        $this->_running_vars['todo_repopulate'] = Array();
        $this->_running_vars['done_repopulate'] = Array();
        if (isset($this->_running_vars['repopulate']) && $this->_running_vars['repopulate']) {
            $this->_running_vars['todo_repopulate'] = $this->_running_vars['todo_assetids'];
        }

        return parent::prepare();

    }//end prepare()


    function processClearCacheTable(&$step_data, $prefix)
    {
        $cm = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('cache_manager');

        if ($this->_running_vars['delete_all'] === 'yes' || $this->_running_vars['delete_all'] === TRUE) {
            // get all unique filepaths, and clear all system cache
            $this->_running_vars['todo_filepaths'] = $cm->getAllFilePaths();
            $cm->clearAllCache();

        } else {
            // prepare all related filepaths, and clear cache for one asset
            $current_assetid = array_pop($this->_running_vars['todo_assetids']);
            $file_paths = $cm->getFilePaths(Array($current_assetid));
            $cm->clearCache(Array($current_assetid));
            $this->_running_vars['todo_filepaths'] = array_merge($this->_running_vars['todo_filepaths'], $file_paths);
            $this->_running_vars['done_assetids'][] = $current_assetid;
        }

        $GLOBALS['SQ_SYSTEM']->am->forgetAsset($cm);

        if (empty($this->_running_vars['todo_assetids'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete'] = TRUE;
        } else {
            $done = count($this->_running_vars['done_assetids']);
            $total = count($this->_running_vars['todo_assetids']) + $done;
            $step_data['percent_done'] = ($done / $total) * 100;
            $step_data['complete'] = FALSE;
        }
        return TRUE;

    }//end processClearCacheTable()


    function processClearCacheFile(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_filepaths'])) {
            $paths = array_splice($this->_running_vars['todo_filepaths'], 0, SQ_HIPO_CLEAR_CACHE_THRESHOLD);
            foreach ($paths as $path) {
                $path_name = SQ_CACHE_PATH.'/'.$path['path'];
                if (is_file($path_name)) {
                    if (!unlink($path_name)) {
                        $this->_addError('Failed to delete cache file, '.$path_name, TRUE);
                    }
                } else {
                    // missing cache file, probably corrupted.
                    // $this->_addError('The cache file can not be found : '.$path_name, TRUE);
                }
            }
            $this->_running_vars['done_filepaths'] = array_merge($this->_running_vars['done_filepaths'], $paths);
        }

        if (empty($this->_running_vars['todo_filepaths'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete'] = TRUE;
        } else {
            $done = count($this->_running_vars['done_filepaths']);
            $total = count($this->_running_vars['todo_filepaths']) + $done;
            $step_data['percent_done'] = ($done / $total) * 100;
            $step_data['complete'] = FALSE;
        }
        return TRUE;

    }//end processClearCacheFile()


    function processRepopulate(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_repopulate'])) {
            $current_assetid = array_pop($this->_running_vars['todo_repopulate']);
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($current_assetid);
            $urls_info = $asset->getURLs();
            $urls = Array();
            if (!empty($urls_info)) {
                foreach ($urls_info as $url_info) {
                    if ($url_info['http'] == '1') {
                        $urls[] = 'http://'.$url_info['url'];
                    }
                    if ($url_info['https'] == '1') {
                        $urls[] = 'https://'.$url_info['url'];
                    }
                }
            }

            // Re-generate the cache per URL
            $headers = Array(
                        'Cache-Control: public',
                        'Pragma: cache',
                       );
            foreach ($urls as $url) {
                fetch_url($url, array('RETURNTRANSFER' => 1), $headers, array(), FALSE);
            }

            $this->_running_vars['done_repopulate'][] = $current_assetid;
        }//end if

        if (empty($this->_running_vars['todo_repopulate'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete'] = TRUE;
        } else {
            $done = count($this->_running_vars['done_repopulate']);
            $total = count($this->_running_vars['todo_repopulate']) + $done;
            $step_data['percent_done'] = ($done / $total) * 100;
            $step_data['complete'] = FALSE;
        }
        return TRUE;

    }//end processRepopulate()


}//end class
?>