hipo_job_tool_import_bmail_user.inc

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

class HIPO_Job_Tool_Import_Bmail_User extends HIPO_Job
{


    function __construct($code_name='')
    {
        $this->uses_trans = FALSE;
        parent::__construct($code_name);
        $GLOBALS['SQ_SYSTEM']->lm->includePackageStrings('bulkmail');

    }//end constructor

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

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

        $o->closeField();

    }//end paintConfig()


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

    }//end getConfigVars()

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

    }//end getThresholdPercentageRequired()
    

    function getCodeName()
    {
        return parent::getCodeName().'-'.$this->_running_vars['file_info']['name'];

    }//end getCodeName()


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

    }//end getHipoName()


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

    }//end getInitialStepData()


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

    }//end freestyle()


    function prepare()
    {
        // import the csv file
        require_once SQ_FUDGE_PATH.'/csv/csv.inc';
        $csv = new CSV($this->_running_vars['file_info']['tmp_name']);

        $csv_start = 1;
        if (isset($this->_running_vars['csv_header']) && $this->_running_vars['csv_header'] == TRUE) {
            $csv_start = 2;
        }
        $csv->import($csv_start);

        // add users into the 'todo' array
        $i = 0;
        foreach ($csv->values as $line_value) {
            $this->_running_vars['todo_asset_users'][$i]['name'] = trim($line_value[0]);
            $this->_running_vars['todo_asset_users'][$i]['email'] = trim($line_value[1]);
            $i++;
        }
        $this->_running_vars['done_asset_users'] = Array();
        return parent::prepare();

    }//end prepare()


    function processImport(&$step_data, $prefix)
    {
        if (!empty($this->_running_vars['todo_asset_users'])) {

            // import one bmail user
            $GLOBALS['SQ_SYSTEM']->am->includeAsset('bulkmail_user');
            $array_keys = array_keys($this->_running_vars['todo_asset_users']);
            $index = array_shift($array_keys);
            $create_in = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->_running_vars['create_in_assetid']);
            $name = $this->_running_vars['todo_asset_users'][$index]['name'];
            $email = $this->_running_vars['todo_asset_users'][$index]['email'];

            $user = new Bulkmail_User();
            $user->setAttrValue('name', $name);

            // turn off error reporting if we are linking user with same address
            if ($this->_running_vars['new_link']) {
                $old_reporting = error_reporting(0);
            }
            $status = $user->setAttrValue('email', $email);
            if ($this->_running_vars['new_link']) {
                error_reporting($old_reporting);
                if (!$status) {
                    // find the existing bmail user, and link here
                    $user = $this->_getExistingBmailUser($email);
                    if ($name != $user->name) {
                        trigger_error("(Bulkmail User #$user->id) \"$name\" does not match existing name \"$user->name\"");
                        $step_data['message'] = "Skipping \"$user->name\" (#$user->id)";
                    } else {
                        $create_in->createLink($user, SQ_LINK_TYPE_1);
                        $step_data['message'] = "Linking \"$user->name\" (#$user->id)";
                    }
                }
            }

            // create new user as usual
            if ($status) {
                $link = Array(
                            'asset'     => $create_in,
                            'link_type' => SQ_LINK_TYPE_1,
                        );
                $status = $user->create($link);
            }
            $step_data['message'] = translate('bm_importing_bmail_user', $email);

            // add this user to the done array
            $this->_running_vars['done_asset_users'][] = $email;

            // clean up
            unset($this->_running_vars['todo_asset_users'][$index]);
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($user);
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($create_in);

        }//end if not empty todo

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

        return TRUE;

    }//end processImport()


    function &_getExistingBmailUser($email)
    {
        try {
            $bind_vars['email'] = $email;
            $assetid = MatrixDAL::executeOne('bulkmail_package', 'getExistingBmailUser', $bind_vars);
        } catch (Exception $e) {
            throw new Exception('Unable to get existing bulkmail user due to database error: '.$e->getMessage());
        }

        $user = NULL;
        if (!is_null($assetid)) {
            $user = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
        }

        return $user;

    }//end _getExistingBmailUser()


}//end class


?>