hipo_job_regenerate_metadata.inc

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

class HIPO_Job_Regenerate_Metadata extends HIPO_Job
{


    function HIPO_Job_Regenerate_Metadata($code_name='')
    {
        $this->uses_trans = FALSE;
        $this->HIPO_Job($code_name);

    }//end constructor


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

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

        $o->closeField();

    }//end paintConfig()


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

    }//end getConfigVars()


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

    }//end getCodeName()


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

    }//end getHipoName()


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

    }//end getInitialStepData()


    function getThresholdPercentageRequired()
    {
        if (SQ_HIPO_REGENERATE_METADATA_THRESHOLD == 0) {
            return 0;
        }
        if (!isset($this->_running_vars['todo_assetids'])) {
            return 0;
        }
        return ((count($this->_running_vars['todo_assetids']) / SQ_HIPO_REGENERATE_METADATA_THRESHOLD) * 100);

    }//end getThresholdPercentageRequired()


    function freestyle()
    {
        while (!empty($this->_running_vars['todo_assetids'])) {
            if (!$this->processMetadata($this->_steps[0], get_class($this))) {
                return FALSE;
            }
        }
        return TRUE;

    }//end freestyle()


    function prepare()
    {
        // to start regenerating metadata, we need to have a schema that has been updated
        if (empty($this->_running_vars['schemaids'])) {
            trigger_localised_error('HIPO0003', E_USER_WARNING);
            return FALSE;
        }

        // If no context IDs are provided, it will do all of them
        if (empty($this->_running_vars['contextids']) === TRUE) {
            $this->_running_vars['contextids'] = array_keys($GLOBALS['SQ_SYSTEM']->getAllContexts());
        }

        // If a scalar is given instead of an array, assume a single context
        // and convert it into an array
        if (is_array($this->_running_vars['contextids']) === FALSE) {
            $this->_running_vars['contextids'] = Array($this->_running_vars['contextids']);
        }

        $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();

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

        foreach ($this->_running_vars['schemaids'] as $schemaid) {
            $this->_running_vars['todo_assetids'] = array_merge($this->_running_vars['todo_assetids'], $mm->getSchemaAssets($schemaid, TRUE));
        }

        // remove duplicates
        $this->_running_vars['todo_assetids'] = array_values(array_unique($this->_running_vars['todo_assetids']));

        // if nothing to do, bail out
        if (empty($this->_running_vars['todo_assetids'])) {
            return FALSE;
        }

        return parent::prepare();

    }//end prepare()


    function processMetadata(&$step_data, $prefix)
    {
        if (!isset($this->_running_vars['process_metadata'])) {
            $this->_running_vars['process_metadata'] = $this->_running_vars['todo_assetids'];
        }

        if (!empty($this->_running_vars['process_metadata'])) {
            $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();
            $assetid = array_shift($this->_running_vars['process_metadata']);
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);

            if (!is_null($asset)) {
                // try to acquire lock
                if (!$GLOBALS['SQ_SYSTEM']->am->acquireLock($asset->id, 'metadata')) {
                    $step_data['message'] = translate('hipo_skipping_asset', $assetid);
                    trigger_localised_error('HIPO0077', E_USER_WARNING, $asset->name, $assetid);
                }

                if (!$asset->writeAccess('metadata')) {
                    // we don't have write access to this asset for another
                    // reason (eg. status = Archived), skip the asset
                    $step_data['message'] = translate('hipo_skipping_asset', $assetid);
                    trigger_localised_error('HIPO0078', E_USER_WARNING, $asset->name, $assetid);
                } else {
                    foreach ($this->_running_vars['contextids'] as $contextid) {
                        if (!$mm->regenerateMetadata($asset->id, $contextid)) return FALSE;
                    }
                    $step_data['message'] = translate('hipo_generate_metadata', htmlentities($asset->name, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET));
                    $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);
                    unset($asset);
                }

                // release lock
                $GLOBALS['SQ_SYSTEM']->am->releaseLock($assetid, 'metadata');

            } else {
                $step_data['message'] = translate('hipo_skipping_asset', $assetid);
                $this->_addError(translate('hipo_cannot_regenerate_metadata', $assetid));
            }

            // add this assetid to the done array so we dont do it again
            $this->_running_vars['done_assetids'][] = $assetid;
        }//end if

        if (empty($this->_running_vars['process_metadata'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete']     = TRUE;
            unset($this->_running_vars['done_assetids']);
            $this->_running_vars['todo_assetids'] = Array();
        } else {
            $total = count($this->_running_vars['process_metadata']) + 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 processMetadata()


}//end class

?>