hipo_config.inc

<?php
require_once SQ_LIB_PATH.'/config/config.inc';

class HIPO_Config extends Config
{
    var $config_vars = Array(
                        'SQ_HIPO_USE_SERVER'                    => Array('editable' => 1, 'default' => FALSE),
                        'SQ_HIPO_SERVER_STATUS_CHECK_THRESHOLD' => Array('editable' => 1, 'default' => 30),
                        'SQ_HIPO_TOTAL_THRESHOLD'               => Array('editable' => 1, 'default' => 80),
                       );


    function __construct()
    {
        parent::__construct();
        $this->config_file = SQ_DATA_PATH.'/private/conf/hipo.inc';
        $this->_loadJobConfigVars();

    }//end constructor


    function _loadJobConfigVars()
    {
        // if our config file doesn't exist then we can't load the job's because they require it
        if (!file_exists($this->config_file)) return;
        
        // ask each of the jobs for their config vars
        $packages = $GLOBALS['SQ_SYSTEM']->getInstalledPackages();
        
        foreach($packages as $package) {
            if ($package['code_name'] == '__core__') {
                $hipo_job_path = SQ_SYSTEM_ROOT.'/core/hipo/jobs';
            } else {
                $hipo_job_path = SQ_SYSTEM_ROOT.'/packages/'.strtolower($package['code_name']).'/hipo_jobs';
            }

            if (is_dir($hipo_job_path)) {
                require_once SQ_FUDGE_PATH.'/general/file_system.inc';
                $d = dir($hipo_job_path);
                while (FALSE !== ($file = $d->read())) {
                    if ($file == '.' || $file == '..') {
                        continue;
                        }
                    // skip hidden files
                    if (strpos($file, '.') == 0) continue;

                    if (!is_dir($hipo_job_path.'/'.$file)) {
                        if (get_file_type($file) != 'inc') continue;
                        require_once $hipo_job_path.'/'.$file;
                        $type_code = substr($file, 0, strpos($file, '.'));

                        if ($type_code) {
                            $vars = call_user_func(Array($type_code, 'getConfigVars'));
                            $this->config_vars = array_merge($this->config_vars, $vars);
                        }
                    }
                }//end while

                $d->close();

            }//end if

        }//end foreach

    }//end _loadJobConfigVars()


    function save($vars, $backup_existing=FALSE)
    {
        // if the config file exists, just do a normal save
        if (file_exists($this->config_file)) {
            return parent::save($vars, $backup_existing);

        // else this is the first time that we have saved a config, things need to be done a little differently
        } else {

            // first we save as normal, but we won't have the jobs config vars in there
            // (no need to backup either because the file doesn't exist)
            if (!parent::save($vars, FALSE)) return FALSE;
            // then we load all jobs configs (which can happen now that there is a
            // config file that they can require) and save again to put them in the file
            $this->_loadJobConfigVars();
            return parent::save($vars, FALSE);

        }//end if

    }//end save()


    function canAcquireLock()
    {
        // need to be root
        return $GLOBALS['SQ_SYSTEM']->userRoot();

    }//end canAcquireLock()


    function writeAccess()
    {
        if (!parent::writeAccess()) return FALSE;
        if (!$GLOBALS['SQ_SYSTEM']->runLevelEnables(SQ_SECURITY_PERMISSIONS)) {
            return TRUE;
        }

        // need to be root
        return $GLOBALS['SQ_SYSTEM']->userRoot();

    }//end writeAccess()


    function paintBackend(&$o)
    {
        parent::paintBackend($o);

        $write_access = $this->writeAccess();
        $class = get_class_lower($this);

        $o->openSection(translate('hipo_server_configuration'));

            // writing out standard fields, which are not specific to any single job
            $o->openField(translate('run_on_squiz_server'));
            if ($write_access) {
                combo_box($class.'[SQ_HIPO_USE_SERVER]', Array('1' => translate('yes'), '0' => translate('no')), FALSE, SQ_HIPO_USE_SERVER);
            } else {
                echo (SQ_HIPO_USE_SERVER) ? translate('yes') : translate('no');
            }
            $o->closeField();

            // server check threshold config entry
            $o->openField(translate('hipo_status_check_threshold'));
            if ($write_access) {
                text_box($class.'[SQ_HIPO_SERVER_STATUS_CHECK_THRESHOLD]', SQ_HIPO_SERVER_STATUS_CHECK_THRESHOLD, 5);
                echo '&nbsp;';
            } else {
                echo SQ_HIPO_SERVER_STATUS_CHECK_THRESHOLD;
            }
            echo translate('hipo_status_check_threshold_note');
            $o->closeField();

            // total threshold HIPO config entry
            $o->openField(translate('hipo_freestyle_threashold'));
            if ($write_access) {
                text_box($class.'[SQ_HIPO_TOTAL_THRESHOLD]', SQ_HIPO_TOTAL_THRESHOLD, 5);
                echo '&nbsp;';
            } else {
                echo SQ_HIPO_TOTAL_THRESHOLD;
            }
            echo translate('hipo_threshold_note');
            $o->closeField();

            // looping through job class files and painting their backends
            $this->paintJobsBackends($o, $class);

        $o->closeSection();

        if ($write_access) $o->commitButton('', TRUE);

    }//end paintBackend()


    function paintJobsBackends(&$o, $class)
    {
        $packages = $GLOBALS['SQ_SYSTEM']->getInstalledPackages();

        foreach($packages as $package) {
            if ($package['code_name'] == '__core__') {
                $hipo_job_path = SQ_SYSTEM_ROOT.'/core/hipo/jobs';
            } else {
                $hipo_job_path = SQ_SYSTEM_ROOT.'/packages/'.$package['code_name'].'/hipo_jobs';
                //include locale strings for hipo jobs because they are not assets and the strings are in package locale strings
                $GLOBALS['SQ_SYSTEM']->lm->includePackageStrings($package['code_name']);
            }

            if (is_dir($hipo_job_path)) {
                $d = dir($hipo_job_path);

                while (FALSE !== ($file = $d->read())) {
                    if ($file == '.' || $file == '..') {
                        continue;
                    }
                    // skip hidden files
                    if (strpos($file, '.') == 0) continue;

                    if (!is_dir($hipo_job_path.'/'.$file)) {
                        if (get_file_type($file) != 'inc') continue;
                        require_once $hipo_job_path.'/'.$file;
                        $type_code = substr($file, 0, strpos($file, '.'));

                        $write_access = $this->writeAccess();
                        if ($type_code) {
                            eval($type_code.'::paintConfig($o, $class, $write_access);');
                        }
                    }
                }//end while

                $d->close();

            }//end if

        }//end foreach

    }//end paintJobsBackends()


}//end class

?>