Changeset 2813

Timestamp:

11/14/08 17:52:39 (8 weeks ago)

Author:

freakerz

Message:

FormUIze Installer, allow schemas to hook it and add their db-specific fields. InstallSchema extends Pluggable so actions/filters/etc are registered in schemas... many more changes

Location:

branches/081018-handlers/htdocs/system

Files:

• classes/adminhandler.php (modified) (1 diff)
• classes/ajaxadminhandler.php (modified) (1 diff)
• classes/formui.php (modified) (19 diffs)
• classes/installhandler.php (modified) (10 diffs)
• classes/installschema.php (added)
• classes/rewriterules.php (modified) (1 diff)
• classes/site.php (modified) (2 diffs)
• classes/templateengine.php (modified) (1 diff)
• classes/theme.php (modified) (1 diff)
• schema/sqlite/install.php (added)
• themes/admin/theme.php (modified) (2 diffs)
• themes/installer/db_setup.php (modified) (2 diffs)
• themes/installer/formcontrols (added)
• themes/installer/formcontrols/formcontrol_checkbox.php (added)
• themes/installer/formcontrols/formcontrol_checkboxes.php (added)
• themes/installer/formcontrols/formcontrol_fieldset.php (added)
• themes/installer/formcontrols/formcontrol_form.php (added)
• themes/installer/formcontrols/formcontrol_password.php (added)
• themes/installer/formcontrols/formcontrol_radio.php (added)
• themes/installer/formcontrols/formcontrol_select.php (added)
• themes/installer/formcontrols/formcontrol_silos.php (added)
• themes/installer/formcontrols/formcontrol_submit.php (added)
• themes/installer/formcontrols/formcontrol_tabs.php (added)
• themes/installer/formcontrols/formcontrol_text.php (added)
• themes/installer/formcontrols/formcontrol_textarea.php (added)
• themes/installer/formcontrols/formcontrol_textmulti.php (added)
• themes/installer/formcontrols/formcontrol_wrapper.php (added)
• themes/installer/formcontrols/installer_advancedoptions.php (added)
• themes/installer/formcontrols/installer_checkboxes.php (added)
• themes/installer/formcontrols/installer_installstep.php (added)
• themes/installer/formcontrols/installer_installstep_nohelp.php (added)
• themes/installer/formcontrols/installer_nextstep.php (added)
• themes/installer/formcontrols/installer_options.php (added)
• themes/installer/formcontrols/installer_password.php (added)
• themes/installer/formcontrols/installer_password_wrapper.php (added)
• themes/installer/formcontrols/installer_submit.php (added)
• themes/installer/script.js (modified) (2 diffs)
• themes/installer/theme.php (added)

branches/081018-handlers/htdocs/system/classes/adminhandler.php

@@ -1757 +1757 @@
     }
 
-    /**
-     * Function used to set theme variables to the add module dashboard widget
-     * TODO make this form use an AJAX call instead of reloading the page
-     */
-    public function filter_dash_module_add_item( $module, $id, $theme )
-    {
-        $modules = Modules::get_all();
-        if ( $modules ) {
-            $modules = array_combine( array_values( $modules ), array_values( $modules ) );
-        }
-
-        $form = new FormUI( 'dash_additem' );
-        $form->append( 'select', 'module', 'null:unused' );
-        $form->module->options = $modules;
-        $form->append( 'submit', 'submit', _t('+') );
-        //$form->on_success( array( $this, 'dash_additem' ) );
-        $form->properties['onsubmit'] = "dashboard.add(); return false;";
-        $theme->additem_form = $form->get();
-
-        $module['content'] = $theme->fetch( 'dash_additem' );
-        return $module;
-    }
-
-    /**
-     * Adds a module to the user's dashboard
-     * @param object form FormUI object
-     */
-    public function dash_additem( $form )
-    {
-        $new_module = $form->module->value;
-        Modules::add( $new_module );
-
-        // return false to redisplay the form
-        return false;
-    }
 }
 

branches/081018-handlers/htdocs/system/classes/ajaxadminhandler.php

@@ -507 +507 @@
         echo json_encode( $output );
     }
+    
+    /**
+     * Function used to set theme variables to the add module dashboard widget
+     */
+    public function ajax_dash_module_add_item( $module, $id, $theme )
+    {
+        $modules = Modules::get_all();
+        if ( $modules ) {
+            $modules = array_combine( array_values( $modules ), array_values( $modules ) );
+        }
+
+        $form = new FormUI( 'dash_additem' );
+        $form->append( 'select', 'module', 'null:unused' );
+        $form->module->options = $modules;
+        $form->append( 'submit', 'submit', _t('+') );
+        //$form->on_success( array( $this, 'dash_additem' ) );
+        $form->properties['onsubmit'] = "dashboard.add(); return false;";
+        $theme->additem_form = $form->get();
+
+        $module['content'] = $theme->fetch( 'dash_additem' );
+        return $module;
+    }
 }
 ?>

branches/081018-handlers/htdocs/system/classes/formui.php

@@ -22 +22 @@
     protected $checksum;
     public $template = 'formcontainer';
-    public $properties = array();
+    protected $properties = array();
 
     /**
@@ -158 +158 @@
             $contents.= $control->get($forvalidation);
         }
-        $theme->contents = $contents;
-        // Do not move before $contents
-        // Else, these variables will contain the last control's values
-        $theme->class = $this->class;
-        $theme->id = $this->name;
-        $theme->caption = $this->caption;
-
-        return $theme->fetch( $this->template );
+        
+        foreach($this->properties as $prop => $value) {
+            $theme->assign($prop, $value);
+        }
+        
+        $theme->assign('contents', $contents);
+        $theme->assign('class', $this->class);
+        $theme->assign('id', $this->name);
+        $theme->assign('caption', $this->caption);
+        
+        return $theme->fetch( $this->template, true );
     }
 
@@ -181 +184 @@
             $this->theme_obj = Themes::create( 'admin', 'RawPHPEngine', $theme_dir );
         }
-        if($control instanceof FormControl) {
-            // PHP doesn't allow __get() to return pointers, and passing this array to foreach directly generates an error.
-            $properties = $control->properties;
-            foreach($properties as $name => $value) {
-                $this->theme_obj->$name = $value;
-            }
-            $this->theme_obj->field = $control->field;
-            $this->theme_obj->value = $control->value;
-            $this->theme_obj->caption = $control->caption;
-            $this->theme_obj->id = (string) $control->id;
+        if($control instanceof FormControl) {   
+            $this->theme_obj->start_buffer();
+            
+            foreach($control->properties as $name => $value) {
+                $this->theme_obj->assign($name, $value);
+            }
+            
+            $this->theme_obj->assign('field', $control->field);
+            $this->theme_obj->assign('value', $control->value);
+            $this->theme_obj->assign('caption', $control->caption);
+            $this->theme_obj->assign('id', (string) $control->id);
+            
             $class = $control->class;
-
             $message = '';
             if($forvalidation) {
@@ -201 +205 @@
                 }
             }
-            $this->theme_obj->class = implode( ' ', (array) $class );
-            $this->theme_obj->message = $message;
+            
+            $this->theme_obj->assign('class', implode( ' ', (array) $class ));
+            $this->theme_obj->assign('message', $message);
         }
         return $this->theme_obj;
@@ -313 +318 @@
                 }
             }
+        }
+    }
+    
+    /**
+     * Magic property setter for FormContainer and its descendants
+     *
+     * @param string $name The name of the property
+     * @param mixed $value The value to set the property to
+     */
+    public function __set($name, $value)
+    {
+        switch($name) {
+            case 'contents':
+            case 'class':
+            case 'id':
+            case 'caption':
+            case 'template':
+            case 'controls':
+            case 'checksum':
+            case 'container':
+            case 'theme_obj':
+                $this->$name = $value;
+                break;
+            default:
+                $this->properties[$name] = $value;
+                break;
         }
     }
@@ -405 +436 @@
     public function salted_name()
     {
-        return md5(Options::get('secret') . 'added salt, for taste' . $this->checksum());
+        //return md5(Options::get('secret') . 'added salt, for taste' . $this->checksum());
+        return md5('added salt, for taste' . $this->checksum());
     }
 
@@ -419 +451 @@
 
         $theme = $this->get_theme($forvalidation, $this);
-        $theme->start_buffer();
-        $theme->success = false;
+        
+        $theme->assign('success', false);
 
         // Should we be validating?
@@ -432 +464 @@
                     }
                 }
-                $theme->success = true;
-                $theme->message = $this->options['success_message'];
+                $theme->assign('success', true);
+                $theme->assign('message', $this->options['success_message']);
             }
             else {
@@ -440 +472 @@
         }
 
-        $out = '';
-
-        $theme->controls = $this->output_controls($forvalidation);
-
+        $theme->assign('controls', $this->output_controls($forvalidation));
+        $theme->assign('id', Utils::slugify($this->name));
+        $theme->assign('class', implode( " ", (array) $this->class ));
+        $theme->assign('action', $this->options['form_action']);
+        $theme->assign('onsubmit', ($this->properties['onsubmit'] == '') ? '' : "onsubmit=\"{$this->properties['onsubmit']}\"");
+        $theme->assign('salted_name', $this->salted_name());
+        $theme->assign('pre_out', $this->pre_out_controls());
+        
         foreach($this->properties as $prop => $value) {
-            $theme->$prop = $value;
-        }
-
-        $theme->id = Utils::slugify($this->name);
-        $theme->class = implode( " ", (array) $this->class );
-        $theme->action = $this->options['form_action'];
-        $theme->onsubmit = ($this->properties['onsubmit'] == '') ? '' : "onsubmit=\"{$this->properties['onsubmit']}\"";
-        $theme->salted_name = $this->salted_name();
-        $theme->pre_out = $this->pre_out_controls();
-
-        $out = $theme->fetch($this->options['template']);
-        $theme->end_buffer();
-
-        return $out;
+            $theme->assign($prop, $value);
+        }
+        
+        return $theme->fetch($this->options['template'], true);
     }
 
@@ -480 +506 @@
     {
         $out = '';
-        $this->get_theme( $forvalidation )->start_buffer();
         foreach($this->controls as $control) {
             $out.= $control->get( $forvalidation );
         }
-        $this->get_theme( $forvalidation )->end_buffer();
         return $out;
     }
@@ -829 +853 @@
     {
         $theme = $this->get_theme($forvalidation);
-        $theme->start_buffer();
-
-        foreach($this->properties as $prop => $value) {
-            $theme->$prop = $value;
-        }
-
-        $theme->caption = $this->caption;
-        $theme->id = $this->name;
-        $theme->value = $this->value;
-
-        return $theme->fetch( $this->get_template(), true );
+
+        foreach($this->properties as $prop => $value) {         
+            $theme->assign($prop, $value);
+        }
+        
+        $theme->assign('caption', $this->caption);
+        $theme->assign('id', $this->name);
+        $theme->assign('value', $this->value);
+                    
+        return $theme->fetch( $this->get_template() );
     }
 
@@ -1008 +1031 @@
     protected function get_theme($forvalidation)
     {
-        $theme = $this->container->get_theme($forvalidation, $this);
-        foreach($this->properties as $name => $value) {
-            $theme->name = $value;
-        }
-        return $theme;
+        return $this->container->get_theme($forvalidation, $this);
     }
 
@@ -1154 +1173 @@
 class FormControlTag extends FormContainer
 {
+    public $tag;
+    
     /**
      * Override the FormControl constructor to support more parameters
@@ -1184 +1205 @@
         $tag = $this->tag;
         
-        $theme->class = 'tag_'.$tag->slug;
-        $theme->id = $tag->id;
-        $theme->weight = $max > 0 ? round(($tag->count * 10)/$max) : 0;
-        $theme->caption = $tag->tag;
-        $theme->count = $tag->count;
-                
-        return $theme->fetch( 'tabcontrol_tag' );
+        $theme->assign('class', 'tag_'.$tag->slug);
+        $theme->assign('id', $tag->id);
+        $theme->assign('weight', $max > 0 ? round(($tag->count * 10)/$max) : 0);
+        $theme->assign('caption', $tag->tag);
+        $theme->assign('count', $tag->count);
+        
+        return $theme->fetch( 'tabcontrol_tag', true );
     }
 
@@ -1210 +1231 @@
     {
         $theme = $this->get_theme($forvalidation);
-        $theme->outvalue = $this->value == '' ? '' : substr(md5($this->value), 0, 8);
-
-        return $theme->fetch( $this->get_template() );
+
+        $theme->assign('id', $this->name);
+        $theme->assign('outvalue', $this->value == '' ? '' : substr(md5($this->value), 0, 8));
+        
+        return $theme->fetch( $this->get_template(), true );
     }
 
@@ -1324 +1347 @@
     {
         $theme = $this->get_theme($forvalidation);
-        $theme->options = $this->options;
-        $theme->multiple = $this->multiple;
-        $theme->size = $this->size;
-        $theme->id = $this->name;
-
-        return $theme->fetch( $this->get_template() );
+
+        $theme->assign('options', $this->options);
+        $theme->assign('multiple', $this->multiple);
+        $theme->assign('size', $this->size);
+        $theme->assign('id', $this->name);
+    
+        return $theme->fetch( $this->get_template(), true );
     }
 }
@@ -1347 +1371 @@
     {
         $theme = $this->get_theme($forvalidation);
-        $theme->options = $this->options;
-        $theme->id = $this->name;
-
-        return $theme->fetch( $this->get_template() );
+        
+        $theme->assign('options', $this->options);
+        $theme->assign('id', $this->name);
+
+        return $theme->fetch( $this->get_template(), true );
     }
     
@@ -1502 +1527 @@
     function get( $forvalidation = true )
     {
-        $out = '<div' . (($this->class) ? ' class="' . implode( " ", (array) $this->class ) . '"' : '') . (($this->id) ? ' id="' . $this->id . '"' : '') .'><label for="' . $this->name . '">' . $this->caption . '</label></div>';
-        return $out;
+        return '<div' . (($this->class) ? ' class="' . implode( " ", (array) $this->class ) . '"' : '') . (($this->id) ? ' id="' . $this->id . '"' : '') .'><label for="' . $this->name . '">' . $this->caption . '</label></div>';
     }
 
@@ -1567 +1591 @@
             }
         }
-        $theme->controls = $controls;
-        // Do not move before $contents
-        // Else, these variables will contain the last control's values
-        $theme->class = $this->class;
-        $theme->id = $this->name;
-        $theme->caption = $this->caption;
-
-        return $theme->fetch( $this->template );
+        $theme->assign('controls', $controls);
+
+        $theme->assign('class', $this->class);
+        $theme->assign('id', $this->name);
+        $theme->assign('caption', $this->caption);
+        
+        return $theme->fetch( $this->template, true );
     }
 

branches/081018-handlers/htdocs/system/classes/installhandler.php

@@ -6 +6 @@
  */
 class InstallHandler extends ActionHandler {
+    
+    // Cached theme object for handling templates and presentation
+    private $theme = NULL;
+    // Cached schema object for db-specific install steps
+    private $schemas = array();
 
     /**
@@ -18 +23 @@
 
         // Create a new theme to handle the display of the installer
-        $this->theme = Themes::create('installer', 'RawPHPEngine', HABARI_PATH . '/system/installer/');
+        $this->theme = Themes::create('installer', 'RawPHPEngine', HABARI_PATH . '/system/themes/installer/');
         
         /**
@@ -43 +48 @@
         }
 
-        // Dispatch AJAX requests.
-        if ( isset( $_POST['ajax_action'] ) ) {
-            switch ( $_POST['ajax_action'] ) {
-                case 'check_mysql_credentials':
-                    self::ajax_check_mysql_credentials();
-                    exit;
-                    break;
-                case 'check_pgsql_credentials':
-                    self::ajax_check_pgsql_credentials();
-                    exit;
-                    break;
-                case 'check_sqlite_credentials':
-                    self::ajax_check_sqlite_credentials();
-                    exit;
-                    break;
-            }
-        }
         // set the default values now, which will be overriden as we go
         $this->form_defaults();
@@ -66 +54 @@
             $this->display('requirements');
         }
-
-        /*
-         * Add the AJAX hooks
-         */
-        Plugins::register( array('InstallHandler', 'ajax_check_mysql_credentials'), 'ajax_', 'check_mysql_credentials' );
-        Plugins::register( array('InstallHandler', 'ajax_check_pgsql_credentials'), 'ajax_', 'check_pgsql_credentials' );
 
         /*
@@ -86 +68 @@
             if ( isset( $db_connection ) ) {
                 list( $this->handler_vars['db_type'], $remainder )= explode( ':', $db_connection['connection_string'] );
-                switch( $this->handler_vars['db_type'] ) {
-                case 'sqlite':
-                    // SQLite uses less info.
-                    // we stick the path in db_host
-                    $this->handler_vars['db_file']= $remainder;
-                    break;
-                case 'mysql':
-                    list($host,$name)= explode(';', $remainder);
-                    list($discard, $this->handler_vars['db_host'])= explode('=', $host);
-                    list($discard, $this->handler_vars['db_schema'])= explode('=', $name);
-                    break;
-                case 'pgsql':
-                    list($host,$name)= explode(' ', $remainder);
-                    list($discard, $this->handler_vars['db_host'])= explode('=', $host);
-                    list($discard, $this->handler_vars['db_schema'])= explode('=', $name);
-                    break;
-                }
+                Plugins::act( 'install_existing_config', $this, $remainder );
                 $this->handler_vars['db_user']= $db_connection['username'];
                 $this->handler_vars['db_pass']= $db_connection['password'];
@@ -131 +97 @@
         }
 
+        // This will use formUI
         $db_type = $this->handler_vars['db_type'];
         if ( $db_type == 'mysql' || $db_type == 'pgsql' ) {
@@ -165 +132 @@
         }
 
-        
-
         // Installation complete. Secure sqlite if it was chosen as the database type to use
-        if ( $db_type == 'sqlite' ) {
-            if ( !$this->secure_sqlite() ) {
-                $this->handler_vars['sqlite_contents'] = implode( "\n", $this->sqlite_contents() );
-                $this->display( 'sqlite' );
-            }
-        }
+        Plugins::act('install_complete', $this);
 
         EventLog::log(_t('Habari successfully installed.'), 'info', 'default', 'habari');
@@ -322 +282 @@
             );
         }
-
+        
+        // Load available schemas' install script
+        foreach ($pdo_drivers as $pdo_driver) {
+            $file_path = HABARI_PATH . '/system/schema/' . $pdo_driver . '/install.php';
+            if (file_exists($file_path)) {
+                include_once($file_path);
+            }
+            $classname = $pdo_driver.'Install';
+            if (class_exists($pdo_driver.'Install')) {
+                $this->schemas[$pdo_driver] = new $classname();
+                // Register plugin hooks
+                $this->schemas[$pdo_driver]->load();
+            }
+        }
+                        
         $pdo_drivers_ok = count( $pdo_drivers );
         $this->theme->assign( 'pdo_drivers_ok', $pdo_drivers_ok );
@@ -903 +877 @@
         }
 
-        return true;
-    }
-
-    /**
-     * returns an array of Files declarations used by Habari
-     */
-    public function sqlite_contents()
-    {
-        $db_file = basename( $this->handler_vars['db_file'] );
-        $contents = array(
-            '### HABARI SQLITE START',
-            '<Files "' . $db_file . '">',
-            'Order deny,allow',
-            'deny from all',
-            '</Files>',
-            '### HABARI SQLITE END'
-        );
-
-        return $contents;
-    }
-
-    /**
-     * attempts to write the Files clause to the .htaccess file 
-     * if the clause for this sqlite doesn't exist.
-     * @return bool success or failure
-    **/
-    public function secure_sqlite()
-    {
-        if ( FALSE === strpos( $_SERVER['SERVER_SOFTWARE'], 'Apache' ) ) {
-            // .htaccess is only needed on Apache
-            return false;
-        }
-        if ( !file_exists( HABARI_PATH . '/.htaccess') ) {
-            // no .htaccess to write to
-            return false;
-        }
-        if ( !is_writable( HABARI_PATH . DIRECTORY_SEPARATOR . '.htaccess' ) ) {
-            // we can't update the file
-            return false;
-        }
-
-        // Get the files clause
-        $sqlite_contents = $this->sqlite_contents();
-        $files_contents = "\n" . implode( "\n", $sqlite_contents ) . "\n";
-
-        // See if it already exists
-        $current_files_contents = file_get_contents( HABARI_PATH . DIRECTORY_SEPARATOR . '.htaccess');
-        if ( FALSE === strpos( $current_files_contents, $files_contents ) ) {
-            // If not, append the files clause to the .htaccess file
-            if ( $fh = fopen( HABARI_PATH . DIRECTORY_SEPARATOR . '.htaccess', 'a' ) ) {
-                if ( FALSE === fwrite( $fh, $files_contents ) ) {
-                    // Can't write to the file
-          &nbs