hipo_job_edit_roles.inc

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

class HIPO_Job_Edit_Roles extends HIPO_Job
{


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

    }//end constructor

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

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

        $o->closeField();

    }//end paintConfig()


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

    }//end getConfigVars()


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

    }//end getCodeName()


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

    }//end getHipoName()


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

    }//end getInitialStepData()


    function getThresholdPercentageRequired()
    {
        if (SQ_HIPO_EDIT_ROLE_THRESHOLD == 0) return 0;
        if (!isset($this->_running_vars['todo_assetids']) || !isset($this->_running_vars['role_changes'])) {
            return 0;
        }
        
        //total userids in 'add' and 'delete' role changes - include duplicated userids because we are counting the number of calls to setRole and deleteRole methods
        $total_userids = 0;
        foreach ($this->_running_vars['role_changes'] as $action_data) {
            foreach ($action_data as $userids) {
                $total_userids += count($userids);
            }
        }
        
        //we have to multiply with the number of users because we want to run runQueuedJobs() instead of freestyle() in hipo job
        //when we want to set role for 1 asset but 1000 users. It will take time in this case
        return ((count($this->_running_vars['todo_assetids']) * $total_userids / SQ_HIPO_EDIT_ROLE_THRESHOLD) * 100);

    }//end getThresholdPercentageRequired()


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

    }//end freestyle()


    function prepare()
    {
        if (empty($this->_running_vars['assets'])) {
            trigger_localised_error('HIPO0075', E_USER_WARNING);
            return '';
        }

        if (empty($this->_running_vars['role_changes'])) {
            $this->_running_vars['role_changes'] = Array();
        }

        $assets = $this->_running_vars['assets'];
        $child_assets = Array();
        for (reset($assets); NULL !== ($assetid = key($assets)); next($assets)) {
            $asset_info = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo(Array($assetid));
            if (empty($asset_info)) {
                trigger_localised_error('HIPO0013', E_USER_WARNING, $assetid);
                return '';
            }

            if (array_get_index($this->_running_vars, 'dependants_only')) {
                $child_assets += $GLOBALS['SQ_SYSTEM']->am->getDependantChildren($assetid);
            } else {
                $child_assets += $GLOBALS['SQ_SYSTEM']->am->getChildren($assetid);
            }

            $child_assets[$assetid] = Array (
                                        0   => Array (
                                                'type_code' => $asset_info[$assetid]['type_code'],
                                               ),
                                      );
        }

        $child_assets = array_reverse($child_assets,TRUE);
        $this->_running_vars['todo_assetids'] = $child_assets;
        $this->_running_vars['done_assetids'] = Array();
        return parent::prepare();

    }//end prepare()


    function processRoles(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_assetids'])) {
            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 (!is_null($asset)) {
                // check we can acquire lock and change roles, otherwise silently pass by
                if ($GLOBALS['SQ_SYSTEM']->am->acquireLock($assetid, 'roles')) {
                    if ($asset->adminAccess('roles')) {
                        foreach ($this->_running_vars['role_changes'] as $action => $action_data) {
                            foreach ($action_data as $roleid => $userids) {
                                foreach ($userids as $userid) {
                                    switch ($action) {
                                        case 'add':
                                            $GLOBALS['SQ_SYSTEM']->am->setRole($asset->id, $roleid, $userid);
                                        break;
                                        case 'delete':
                                            $GLOBALS['SQ_SYSTEM']->am->deleteRole($asset->id, $roleid, $userid);
                                        break;
                                    }
                                }
                            }
                        }
                        $step_data['message'] = translate('hipo_edit_role', htmlentities($asset->name, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET));
                        $GLOBALS['SQ_SYSTEM']->am->releaseLock($assetid, 'roles');
                        $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);
                        unset($asset);
                    } else {
                        // we do not have admin access
                        trigger_localised_error('SYS0313', E_USER_WARNING, $asset->name);
                    }
                } else {
                    // we do not acquire lock
                    trigger_localised_error('SYS0100', E_USER_WARNING, $asset->name);
                }
            } else {
                $step_data['message'] = translate('hipo_skipping_asset', $assetid);
                $this->_addError(translate('hipo_skipping_role', $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['todo_assetids'])) {
            $step_data['percent_done'] = 100;
            $step_data['complete']     = TRUE;
            unset($this->_running_vars['done_assetids']);
        } 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 processRoles()


    function getLockAssetDetails(&$job_type, &$running_vars, &$options)
    {
        $job_type = 'hipo_job_acquire_locks';
        $options['auto_complete'] = TRUE;

        $running_vars = Array(
                            'assetids'          => array_keys($this->_running_vars['assets']),
                            'lock_type'         => Array('roles'),
                            'forceably_acquire' => FALSE,
                            'dependants_only'   => isset($this->_running_vars['dependants_only']),
                        );

    }//end getLockAssetDetails()


    function releaseLocks(&$step_data, $prefix)
    {
        if (!isset($this->_running_vars['re_lock_assets'])) {
            $this->_running_vars['re_lock_assets'] = $this->_running_vars['assets'];
        }

        $assetid = key($this->_running_vars['re_lock_assets']);
        unset($this->_running_vars['re_lock_assets'][$assetid]);

        $children = $GLOBALS['SQ_SYSTEM']->am->getDependantChildren($assetid);

        foreach ($children as $dep_child_id => $dep_child_data) {
            $GLOBALS['SQ_SYSTEM']->am->releaseLock($dep_child_id, 'roles');
        }

        $asset_info = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo(Array($assetid));

        $step_data['message'] = translate('hipo_release_locks', $asset_info[$assetid]['name']).translate('hipo_release_locks_dependents');

        $GLOBALS['SQ_SYSTEM']->am->releaseLock($assetid, 'all');

        $this->_running_vars['done_assetids'][] = $assetid;

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

        return TRUE;

    }//end releaseLocks()


}//end class

?>