hipo_job_regenerate_design.inc

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

class HIPO_Job_Regenerate_Design extends HIPO_Job
{


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

    }//end constructor


    public static function paintConfig(&$o, $class, $write_access)
    {
        // design regeneration threshhold HIPO config entry
        $o->openField('Hipo Job Regenerate Design');

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

        $o->closeField();

    }//end paintConfig()


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

    }//end getConfigVars()


    function getCodeName()
    {
        $code_name = parent::getCodeName();
        return $code_name.'-'.md5($this->_running_vars['assetid']);

    }//end getCodeName()


    function getHipoName()
    {
        return 'Hipo Job Regenerate Design';

    }//end getHipoName()


    function getInitialStepData()
    {
        return Array(
                Array(
                    'name'      => 'Hipo Job Regenerate Design',
                    'function_call' => Array(
                                'process_function'  => 'processCustomisation',
                            ),
                    'running_mode'  => 'web',
                    'auto_step'     => true,
                    'allow_cancel'  => true,
                    'percent_done'  => 0,
                    'complete'      => false,
                    'message'       => '',
                ),
               );

    }//end getInitialStepData()


    


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

    }//end freestyle()


    function prepare()
    {
        $parentid = isset($this->_running_vars['parentid']) ? $this->_running_vars['parentid'] : NULL;
        $assetid = isset($this->_running_vars['assetid']) ? $this->_running_vars['assetid'] : NULL;
    
        if (empty($assetid)) {
            trigger_error('Unable to run HIPO job; this job requires a design asset ID', E_USER_WARNING);
            return FALSE;
        }
        $this->_running_vars['todo_assetids'] = Array();
        $this->_running_vars['total_count'] = 0;
        $all_customisations = Array();
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
        $type = $asset->type();

        // first of first, generate parse file for itself
        if ($type === 'design_customisation' || $type === 'design_css_customisation') {
            if(empty ($parentid)) {
            trigger_error('To regenerate a design customisation, parentid is required', E_USER_WARNING);
            return FALSE;
            }
            $parent = $GLOBALS['SQ_SYSTEM']->am->getAsset($parentid);
            $asset->updateFromParent($parent, FALSE);
        }
        else {
            $asset->generateDesignFile(FALSE);
        }
        

         // get all children customisation to do
        $all_customisations = $this->_getCustomisations($assetid);
        $this->_running_vars['total_count'] += count($all_customisations);
        $this->_running_vars['todo_assetids'] = array_merge($this->_running_vars['todo_assetids'], $all_customisations);
        $this->_running_vars['done_assetids'] = Array();

        return parent::prepare();

    }//end prepare()


    function processCustomisation(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_assetids'])) {
            $current_customisation = array_shift($this->_running_vars['todo_assetids']);

            $customisation = $GLOBALS['SQ_SYSTEM']->am->getAsset($current_customisation['child']);
            $design = $GLOBALS['SQ_SYSTEM']->am->getAsset($current_customisation['parent']);
            if ($acquired = $GLOBALS['SQ_SYSTEM']->am->acquireLock($customisation->id, 'all')) {

                // update individual customisation, but don't pass on
                $customisation->updateFromParent($design, FALSE);

                $this->_running_vars['done_assetids'][] =  $current_customisation;
                if ($acquired != 2) {
                    $GLOBALS['SQ_SYSTEM']->am->releaseLock($customisation->id, 'all');
                }
            }
            
            
        }

        if (empty($this->_running_vars['todo_assetids'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete']     = true;
        } else {
            $step_data['percent_done'] = (count($this->_running_vars['done_assetids']) / $this->_running_vars['total_count']) * 100;
            $step_data['complete']     = false;
        }

        return true;

    }//end processCustomisation()


    private function _getCustomisations ($designid) {
        $customisation_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($designid, SQ_LINK_TYPE_2, 'design_customisation', TRUE, 'major', 'customisation');
        $customisation_links = array_merge($customisation_links, $GLOBALS['SQ_SYSTEM']->am->getLinks($designid, SQ_LINK_TYPE_2, 'design_css_customisation', TRUE, 'major', 'customisation'));
        if (empty($customisation_links)) return Array();
        
        $children_customisations = Array();
        foreach ($customisation_links as $link) {
        $children_customisations[] = Array('parent' => $designid, 'child' => $link['minorid']);
        $children_customisations = array_merge($children_customisations, $this->_getCustomisations($link['minorid']));
        }
        return $children_customisations;
    }
}//end class

?>