hipo_job_funnelback_rebuild_cache.inc

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

class HIPO_Job_Funnelback_Rebuild_Cache extends HIPO_Job
{


    function HIPO_Job_Rebuild_Cache($code_name='')
    {
        $this->uses_trans = FALSE;
        $this->HIPO_Job($code_name);
        $GLOBALS['SQ_SYSTEM']->lm->includePackageStrings('funnelback');
        $this->_hipo_vars['job_dir'] = SQ_PACKAGES_PATH.'/funnelback/hipo_jobs';

    }//end constructor


    public static function paintConfig(&$o, $class, $write_access)
    {
        $o->openField(translate('fnb_hipo_rebuild_cache'));

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

        $o->closeField();

    }//end paintConfig()


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

    }//end getConfigVars()


    function getThresholdPercentageRequired()
    {
        return 0;

    }//end getThresholdPercentageRequired()


    function getCodeName()
    {
        return parent::getCodeName().'-'.implode(',', $this->_running_vars['root_assetid']);

    }//end getCodeName()


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

    }//end getHipoName()


    function getInitialStepData()
    {
        return Array(
                Array(
                    'name'          => translate('fnb_hipo_rebuild_cache_step_name0'),
                    'function_call' => Array(
                                        'process_function'  => 'processFlushTable',
                                       ),
                    'running_mode'  => 'server',
                    'auto_step'     => TRUE,
                    'percent_done'  => 0,
                    'complete'      => FALSE,
                    'message'       => '',
                    'allow_cancel'  => TRUE,
                ),
                Array(
                    'name'          => translate('fnb_hipo_rebuild_cache_step_name1'),
                    'function_call' => Array(
                                        'process_function'  => 'processRebuild',
                                       ),
                    'running_mode'  => 'server',
                    'auto_step'     => TRUE,
                    'percent_done'  => 0,
                    'complete'      => FALSE,
                    'message'       => '',
                    'allow_cancel'  => TRUE,
                ),
               );

    }//end getInitialStepData()


    function freestyle()
    {
        // Put the HIPO in some context ;)
        if (array_get_index('contextid', $this->_running_vars)) {
            $this->_running_vars['contextid'] = $GLOBALS['SQ_SYSTEM']->getContextId();
        }

        // Empty the existing table
        $this->processFlushTable($this->_steps[0], get_class_lower($this));

        while (!empty($this->_running_vars['todo_assetids'])) {
            if (!$this->processRebuild($this->_steps[0], get_class_lower($this))) {
                return FALSE;
            }
        }

        return TRUE;

    }//end freestyle()


    function prepare()
    {
        // to start rebuilding the table, we need to have a root assetid - default to root folder if none is supplied
        if (is_null($this->_running_vars['root_assetid']) || empty($this->_running_vars['root_assetid'])) {
            $this->_running_vars['root_assetid'] = 1;   // the root folder
        }

        if (!is_array($this->_running_vars['root_assetid'])) {
            $this->_running_vars['root_assetid'] = Array($this->_running_vars['root_assetid']);
        }

        // If we have not been told which context to re-index, assume we're in
        // it already (but this is not recommended if not freestyling, since it
        // could be stuck somewhere where the context you want is not set)
        if (array_get_index('contextid', $this->_running_vars)) {
            $this->_running_vars['contextid'] = $GLOBALS['SQ_SYSTEM']->getContextId();
        }

        $this->_running_vars['todo_assetids'] = Array();
        $this->_running_vars['done_assetids'] = Array();
        foreach ($this->_running_vars['root_assetid'] as $assetid) {
            // so we have an assetid to start at, but make sure it is a valid assetid
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
            if (is_null($asset)) {
                trigger_localised_error('FNB0022', E_USER_WARNING, $assetid);
                return FALSE;
            }

            $child_assets = $GLOBALS['SQ_SYSTEM']->am->getChildren($asset->id);
            $child_assets[$asset->id][0]['type_code'] = $asset->type();
            $this->_running_vars['todo_assetids'] += $child_assets;
        }//end foreach

        return parent::prepare();

    }//end prepare()


    function processFlushTable(&$step_data, $prefix)
    {
        // If this hipo is running against the root folder, then flush the whole table, otherwise let update asset handle the deleting
        if (in_array('1', $this->_running_vars['root_assetid'])) {
            $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
            $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');
            MatrixDAL::executeSql('DELETE FROM sq_fnb_idx');
            $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        }//end if
        if ($step_data['percent_done'] == 0) {
            $step_data['percent_done'] = 50;
        } else {
            $step_data['percent_done'] = 100;
            $step_data['complete'] = TRUE;
        }
        return TRUE;

    }//end processFlushTable()


    function processRebuild(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_assetids'])) {
            $GLOBALS['SQ_SYSTEM']->changeContext(array_get_index($this->_running_vars, 'contextid', 0));

            $am =& $GLOBALS['SQ_SYSTEM']->am;
            $fm = $am->getSystemAsset('funnelback_manager');
            if (is_null($fm)) return FALSE;

            // get next asset to rebuild
            reset($this->_running_vars['todo_assetids']);
            $assetid = key($this->_running_vars['todo_assetids']);
            $asset_type = $this->_running_vars['todo_assetids'][$assetid][0]['type_code'];
            unset($this->_running_vars['todo_assetids'][$assetid]);
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid, $asset_type);

            if ($asset) {
                $step_data['message'] = translate('fnb_hipo_refreshing_asset', $asset->name);
                $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
                $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');
                $fm->updateAsset($asset, Array('update'));
                $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
                $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset, TRUE);
            }

            // add this assetid to the done array
            $this->_running_vars['done_assetids'][] = $assetid;

            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($fm, TRUE);
            $GLOBALS['SQ_SYSTEM']->restoreContext();
        }

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

        return TRUE;

    }//end processRebuild()


}//end class

?>