config.inc

<?php
class Config extends MySource_Object
{


    public $config_vars = Array();

    public $config_file = '';

    public $name = '';


    function __construct()
    {
        parent::__construct();
        $this->name = ucwords(str_replace('_', ' ', get_class($this)));

    }//end constructor


    public function save($vars, $backup_existing=FALSE, $send_message=TRUE)
    {
        if (!$this->writeAccess()) {
            trigger_localised_error('SYS0026', E_USER_WARNING, $this->name);
            return FALSE;
        }

        // attempt to load the config file to make sure we get any current settings
        if (file_exists($this->config_file)) {
            require_once $this->config_file;
        }

        $changed_vars = Array();
        ob_start();
        foreach ($this->config_vars as $var_name => $data) {

            $current_value = (defined($var_name)) ? constant($var_name) : $data['default'];
            if ($data['editable'] && isset($vars[$var_name]) && $current_value !== $vars[$var_name]) {

                // OK to make sure that everything is fine, we are going to force the issue of setting the type
                // of the vars to that of the default
                $default_type = gettype($data['default']);

                $value = $vars[$var_name];

                $changed_vars[$var_name] = Array('old' => $current_value, 'new' => $value);

            } else {
                $value = $current_value;
            }

            if (!$this->_paintConfigVar($var_name, $value)) {
                ob_end_clean();
                return FALSE;
            }

        }//end foreach

        $str = '<'."?php\n".ob_get_contents().'?'.">\n";

        ob_end_clean();

        if ($backup_existing && file_exists($this->config_file)) {

            $i = 0;
            do {
                $i++;
                $old_version = $this->config_file.'.'.$i;
            } while (file_exists($old_version));

            if (!copy($this->config_file, $old_version)) {
                return FALSE;
            }

        }// endif

        if (SQ_PHP_CLI) {
            echo "----------------------------------\n".($str)."----------------------------------\n";
        }
        require_once SQ_FUDGE_PATH.'/general/file_system.inc';
        // make sure the directory exists
        if (!create_directory(dirname($this->config_file))) {
            return FALSE;
        }

        // and save the file
        if (!string_to_file($str, $this->config_file)) {
            return FALSE;
        }

        // Check if a message should be sent.
        if ($changed_vars && $send_message) {
            $ms = $GLOBALS['SQ_SYSTEM']->getMessagingService();
            $ms->openQueue();
            foreach ($changed_vars as $var_name => $values) {
                $message_body = $var_name.' changed from '.var_export($values['old'], true).' to '.var_export($values['new'], true)."\n";
                $config_name = ucwords(str_replace('_', ' ', get_class($this)));
                $msg_reps = Array(
                                'setting'   => $var_name,
                                'old_value' => var_export($values['old'], true),
                                'new_value' => var_export($values['new'], true),
                            );
                $message = $ms->newMessage(Array(), 'config.'.get_class_lower($this), $msg_reps);
                $ms->enqueueMessage($message);
            }
            $ms->closeQueue();

        }// end if

        return TRUE;

    }//end save()


    protected function _paintConfigVar($var_name, $value, $var_export=TRUE)
    {
        echo "define('", $var_name, "', ";
        if ($var_export) {
            var_export($value);
        } else {
            echo $value;
        }

        echo ");\n";

        return TRUE;

    }//end _paintConfigVar()


    public function acquireLock()
    {
        if (!$this->canAcquireLock()) {
            return 'You are not allowed to acquire the lock on '.$this->name;
        }
        return $GLOBALS['SQ_SYSTEM']->acquireLock(get_class_lower($this));

    }//end acquireLock()


    public function canAcquireLock()
    {
        return TRUE;

    }//end canAcquireLock()


    public function releaseLock()
    {
        return $GLOBALS['SQ_SYSTEM']->releaseLock(get_class_lower($this));

    }//end releaseLock()


    public function updateLock()
    {
        return $GLOBALS['SQ_SYSTEM']->updateLock(get_class_lower($this));

    }//end updateLock()


    public function getLockInfo()
    {
        return $GLOBALS['SQ_SYSTEM']->getLockInfo(get_class_lower($this));

    }//end getLockInfo()


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

        $lock_info = $this->getLockInfo();
        if (!empty($lock_info) && $lock_info['userid'] == $GLOBALS['SQ_SYSTEM']->currentUserId()) {
            return TRUE;
        }
        return FALSE;

    }//end writeAccess()


    public function paintBackend(&$o)
    {
        if (is_null($this->config_file) === FALSE) {
            require_once $this->config_file;
        }

        $map_array = Array (
                        'system_config'                 => 'system_configuration',
                        'squiz_server_config'           => 'squiz_server_configuration',
                        'apache_config'                 => 'apache_configuration',
                        'hipo_config'                   => 'hipo_configuration',
                        'external_tools_config'         => 'external_tools_configuration',
                        'password_rules_config'         => 'password_rules_configuration',
                        'messaging_service_config'      => 'messaging_service_configuration',
                        'proxy_authentication_config'   => 'proxy_configuration',
                        'context_config'                => 'context_configuration',
                     );

        if ($o->_persistant_get_vars['config_screen'] = $map_array[$o->_persistant_get_vars['config_screen']]) {
            $config_screen = $o->_persistant_get_vars['config_screen'];
        }

        $lock = $this->getLockInfo();
        $have_lock = (!empty($lock) && $GLOBALS['SQ_SYSTEM']->currentUserId() == $lock['userid']);

        if (!empty($lock) || $this->canAcquireLock()) {

            $o->openSection(translate('locking_/_editing'));
            $o->openRaw();
            ?>
            <table border="0" cellspacing="3" cellpadding="1">
                <tr>
                    <td>
                        <?php sq_print_icon(sq_web_path('lib').'/web/images/icons/'.((empty($lock)) ? 'un' : '').'locked.png', 16, 16); ?>
                    </td>
                    <td>
                        <p class="sq-lock-message">
                        <?php
                        if (!empty($lock)) {
                            // this asset is currently locked
                            // so display message to the user
                            $user = $GLOBALS['SQ_SYSTEM']->am->getAsset($lock['userid']);

                            $now = time();

                            require_once SQ_FUDGE_PATH.'/general/datetime.inc';
                            $expires_in = easy_time_total(($lock['expires'] - $now), TRUE);
                            if (!$expires_in) $expires_in = '1 second';
                            $expires_in = translate('due_to_expire', $expires_in);
                            if ($have_lock) {
                                echo translate('release_lock', translate('release_lock_button'), translate($config_screen));
                                echo '<br />';
                            }
                            echo $expires_in;

                        } else {
                            echo translate('acquire_lock', translate('acquire_lock_button'), translate($config_screen));
                        }
                        echo '</p>';
                        if (!empty($lock)) {
                            if ($have_lock) {
                                submit_button('sq_lock_release_manual', translate('release_lock_button'), 'set_hidden_field("process_form", "0");', 'accesskey="r"');
                            }
                        } else {
                            submit_button('sq_lock_acquire', translate('acquire_lock_button'), 'set_hidden_field("process_form", "0");', 'accesskey="a"');
                        }
                        ?>
                    </td>
                </tr>
            </table>
            <?php
            $o->closeRaw();
            $o->closeSection();

        }//end if (!empty($lock) || $this->canAcquireLock())

    }//end paintBackend()


    public function processBackend(&$o)
    {
        $saved = FALSE;
        if (!empty($_POST['process_form'])) {

            if (!empty($_POST[get_class_lower($this)])) {
                $saved = $this->save($_POST[get_class_lower($this)]);
            }
        }

        if (!empty($_POST['sq_lock_release']) || !empty($_POST['sq_lock_release_manual'])) {
            $this->releaseLock();
        }

        // if there is no lock currently and we want it
        if (!empty($_POST['sq_lock_acquire'])) {
            $this->acquireLock();
        }

        // if the save was successful, we need to redirect because the constants
        // that are already defined cannot be redefined in this script execution
        if ($saved) $o->setRedirect($o->getCurrentLocation());

        return $saved;

    }//end processBackend()


}//end class

?>