Changeset 500

Timestamp:

06/28/08 01:39:45 (6 months ago)

Author:

padams

Message:

adding update framework and refactored entity manager and db abstraction layer.
moved perform action into api from caller.
added schema update to make tables transactional under mysql

Location:

trunk

Files:

• conf/messages.php (modified) (2 diffs)
• modules/base/classes/entityManager.php (modified) (7 diffs)
• modules/base/module.php (modified) (1 diff)
• modules/base/updates/002.php (added)
• modules/base/updates/_002.php (deleted)
• modules/base/updates/_003.php (deleted)
• modules/base/updatesApply.php (modified) (2 diffs)
• modules/hello/module.php (modified) (1 diff)
• owa_caller.php (modified) (6 diffs)
• owa_coreAPI.php (modified) (2 diffs)
• owa_entity.php (modified) (1 diff)
• owa_lib.php (modified) (3 diffs)
• owa_module.php (modified) (2 diffs)
• owa_observer.php (modified) (4 diffs)
• owa_requestContainer.php (modified) (4 diffs)
• plugins/db/owa_db_mysql.php (modified) (2 diffs)

trunk/conf/messages.php

@@ -46 +46 @@
 2503 => array("Options reset to Default Values.",0),
 
+
 //User managment
 3000 => array("Success. User Added.", 0),
@@ -74 +75 @@
 3305 => array("Success. Base Database Schema Installed.",0),
 3306 => array("Error. User id already exists for some reason.",0),
+3307 => array("Updates failed. Check the log file for more details and try again.",0),
 
 // Graph related

trunk/modules/base/classes/entityManager.php

@@ -96 +96 @@
         function create() {     
                 
-                $all_cols = $this->entity->getColumns();
-                
-                $cols = array();
-                
-                // Control loop
-                foreach ($all_cols as $k => $v){
-                
-                        // drop column is it is marked as auto-incement as DB will take car of that.
-                        if ($this->entity->$v->auto_increment == true):
-                                break;
-                        else:
-                                $cols[$v] = $this->entity->$v->value;
-                        endif;
-                                
-                }
-        
-                // Persist object
-                $status = $this->db->save($cols, get_class($this->entity));
-                
-                // Add to Cache
-                
-                if ($status == true):
-                        if ($this->config['cache_objects'] == true):
-                                $this->cache->set(get_class($this->entity), 'id'.$this->entity->id->value, $this->entity);
-                        endif;
-                endif;
-                
-                return $status;
+                return $this->entity->create();
                 
         }
@@ -130 +103 @@
          * Create Table
          *
-         * Handled by DB abstraction layer because the SQ associated with this is way too DB specific
+         * Handled by DB abstraction layer because the SQL associated with this is way too DB specific
          */
         function createTable() {
@@ -235 +208 @@
         function update($where = '') {  
                 
-                if(empty($where)):
-                        $constraint = array('id' => $this->entity->id->value);
-                else:
-                        $constraint = array($where => $this->entity->$where->value);
-                endif;
-                
-                
-                // Persist object
-                $status = $this->db->update($this->_getProperties(), $constraint, get_class($this->entity));
-                
-                // Add to Cache
-                if ($status == true):
-                        if ($this->config['cache_objects'] == true):
-                                $this->cache->replace(get_class($this->entity), 'id'.$this->entity->id->value, $this->entity);
-                        endif;
-                endif;
-                
-                return $status;
+                $this->entity->update($where);
                 
         }
@@ -265 +221 @@
         function partialUpdate($named_properties, $where) {
                 
-                $properties = array();
-                
-                foreach ($named_properties as $n) {
-                        
-                        $properties[$n] = $this->entity->$n->value;
-                        
-                }
-                
-                                
-                // Persist object
-                $status = $this->db->update($properties, $where, get_class($this->entity));
-                
-                // Add to Cache
-                if ($status == true):
-                        if ($this->config['cache_objects'] == true):
-                                $this->cache->set(get_class($this->entity), 'id'.$this->entity->id->value, $this->entity);
-                        endif;
-                endif;
-                
-                return $status;
+                return $this->entity->partialUpdate($named_properties, $where);
                 
         }
@@ -295 +232 @@
         function delete($id, $col = '') {       
                                 
-                if (empty($col)):
-                        $col = 'id';
-                endif;
-                
-                // Persist object
-                $status = $this->db->delete($id, $col, get_class($this->entity));
-        
-                // Add to Cache
-                if ($status == true):
-                        if ($this->config['cache_objects'] == true):
-                                $this->cache->remove(get_class($this->entity), 'id'.$this->entity->id->value);
-                        endif;
-                endif;
-                
-                return $status;
-                
+                return $this->entity->delete($id, $col);        
         }
         
         function getByPk($col, $value) {
                 
-                return $this->getByColumn($col, $value);
+                return $this->entity->getByColumn($col, $value);
                 
         }
@@ -321 +243 @@
         function getByColumn($col, $value) {
                 
-                $cache_obj = '';
-                
-                if ($this->config['cache_objects'] == true):
-                        $cache_obj = $this->cache->get(get_class($this->entity), $col.$value);
-                endif;
-                        
-                if (!empty($cache_obj)):
-                
-                        $this->entity = $cache_obj;
-                                        
-                else:
-                
-                        $constraint = array($col => $value);
-                                
-                        $properties = $this->db->select($this->_getProperties(), $constraint, get_class($this->entity));
-                        
-                        if (!empty($properties)):
-                                        
-                                $this->setProperties($properties);
-                                
-                                if ($this->config['cache_objects'] == true):
-                                        $this->cache->set(get_class($this->entity), 'id'.$this->entity->id->value, $this->entity);      
-                                endif;          
-                        endif;
-                endif;
-                
-                return; 
+                return $this->entity->getByColumn($col, $value);
+                
         }
         
@@ -402 +299 @@
         }
         
-        
+        /**
+         * Sets Values/Properties
+         * @depricated use setProperties()
+         */
         function setValues($values) {
                 
-                $properties = array_keys(get_object_vars($this->entity));
-                
-                foreach ($properties as $k => $v) {
-                                
-                                $this->entity->$v->value = $values[$v];
-                
-                        }
-                
-                return;
+                return $this->setProperties($values);
                 
         }

trunk/modules/base/module.php

@@ -43 +43 @@
                 $this->description = 'Base functionality for OWA.';
                 $this->config_required = false;
-                $this->required_schema_version = 1;
+                $this->required_schema_version = 3;
                 
                 
                 $this->owa_module();
-                $this->c->set('base', 'schema_version', '1');
+                //$this->c->set('base', 'schema_version', '1');
                 return;
         }

trunk/modules/base/updatesApply.php

@@ -51 +51 @@
                 
                 $modules = $api->getModulesNeedingUpdates();
+                //print_r($modules);
+                //return;
                 
                 // foreach do update in order
+                
+                $error = false;
                 
                 foreach ($modules as $k => $v) {
@@ -59 +63 @@
                         
                         if ($ret != true):
+                                $error = true;
                                 break;
                         endif;
                 
                 }
+                
+                if ($error == true):
+                        $data['error_msg'] = 'something went wrong here with the updates.';
+                        $data['view'] = 'base.error';
+                        $data['view_method'] = 'delegate';                      
+                else:
                         
-                // add data to container
-                $this->data['status_code'] = '';
-                $this->data['do'] = 'base.optionsGeneral';
-                $this->data['view_method'] = 'delegate';
+                        // add data to container
+                        $data['status_code'] = 3307;
+                        $data['do'] = 'base.optionsGeneral';
+                        $data['view_method'] = 'redirect';
+                 
+                endif;          
                 
-                return $this->data;
+                return $data;
+        
         
         }

trunk/modules/hello/module.php

@@ -43 +43 @@
                 $this->description = 'Hello world sample module.';
                 $this->config_required = false;
-                $this->required_schema_version = 2;
+                $this->required_schema_version = 1;
                 
                 $this->owa_module();
+                //$this->c->set('hello', 'schema_version', '1');
                 
                 return;

trunk/owa_caller.php

@@ -287 +287 @@
         function logEvent($event_type, $caller_params = '') {
                 
-                $this->e->debug(print_r($this->e->backtrace(), true));
+                if ($this->c->get('base', 'error_log_level') > 9):
+                        $this->e->debug(print_r($this->e->backtrace(), true));
+                endif;
+                
                 //change config value to incomming site_id
                 if(!empty($caller_params['site_id'])):
@@ -403 +406 @@
          *
          * @param array $caller_data
+         * @depricated
          * @return string
          */
@@ -426 +430 @@
         /**
          * Displays a View without user authentication. Takes array of data as input
-         *
+         * @depricated
          * @param array $data
          */
@@ -437 +441 @@
         }
         
-        /**
-         * Invokes controller to perform controller
-         *
-         * @param $action string
-         * 
-         */
-        function performAction($action) {
-                
-                // Load 
-                $controller = $this->api->moduleFactory($action, 'Controller', $this->params);
-                
-                //perfrom authentication
-                //$auth = &owa_auth::get_instance();
-                
-                //$data = $auth->authenticateUser($controller->priviledge_level);
-                
-                // if auth was success then procead to do action specified in the intended controller.
-                //if ($data['auth_status'] == true):
-                        $data = $controller->doAction();
-                //endif;
-                
-                // Display view if controller calls for one.
-                if (!empty($data['view']) || !empty($data['action'])):
-                
-                        // 
-                        if ($data['view_method'] == 'delegate'):
-                                return $this->api->displayView($data);
-                        
-                        // Redirect to a view   
-                        elseif ($data['view_method'] == 'redirect'):
-                                owa_lib::redirectToView($data);
-                                return;
-                                
-                        // return an image . Will output headers and binary data.
-                        elseif ($data['view_method'] == 'image'):
-                                return $this->api->displayImage($data);
-                        
-                        else:
-                                return $this->api->displayView($data);
-                                
-                        endif;
-                
-                elseif(!empty($data['do'])):
-                
-                        if ($data['view_method'] == 'redirect'):
-                                owa_lib::redirectToView($data);
-                                return;
-                        endif;
-                endif;
-                
-                return;
-                
-        }
-
         
         /**
@@ -502 +452 @@
                 
                 // Override request parsms with those passed by caller
-                // TODO: make this an array merge
                 if (!empty($caller_params)):
-                
-                        foreach ($caller_params as $n => $v) {
-                                $this->params[$n] = $v;
-                        }
-                
+                        $this->params = array_merge($this->params, $caller_params);
                 endif;
                 
@@ -516 +461 @@
                                 
                 if (!empty($this->params['action'])):
-                        $result =  $this->performAction($this->params['action']);
+                        $result = owa_coreAPI::performAction($this->params['action'], $this->params);
                         unset($this->params['action']);
                         
                 elseif (!empty($this->params['do'])):
-                        $result =  $this->performAction($this->params['do']);   
+                        $result = owa_coreAPI::performAction($this->params['do'], $this->params);       
                         //unset($this->params['action']);
                         
                 elseif ($this->params['view']):
                         // its a view request so the only data is in whats in the params
-                        $result = $this->renderView($this->params);
+                        $result = owa_coreAPI::displayView($this->params);
                         unset($this->params['view']);
                         

trunk/owa_coreAPI.php

@@ -374 +374 @@
         }
         
-        function updateFactory($module, $class) {
+        function updateFactory($module, $filename) {
         
                 require_once(OWA_BASE_CLASS_DIR.'update.php');
                 
-                $obj = owa_coreAPI::moduleGenericFactory($module, 'updates', $class, '_update');
+                //$obj = owa_coreAPI::moduleGenericFactory($module, 'updates', $filename, '_update');
+                $class = 'owa_'.$module.'_'.$filename.'_update';
+        
+                // Require class file if class does not already exist
+                if(!class_exists($class)):      
+                        owa_coreAPI::moduleRequireOnce($module, 'updates', $filename);
+                endif;
+                        
+                $obj = owa_lib::factory(OWA_DIR.'modules'.DIRECTORY_SEPARATOR.$module.DIRECTORY_SEPARATOR.'updates', '', $class, $params);
+
                 $obj->module_name = $module;
                 return $obj;
@@ -648 +657 @@
         }
         
+        /**
+         * Invokes controller to perform controller
+         *
+         * @param $action string
+         * 
+         */
+        function performAction($action, $params = array()) {
+                
+                // Load 
+                $controller = owa_coreAPI::moduleFactory($action, 'Controller', $params);
+                
+                $data = $controller->doAction();
+                                
+                // Display view if controller calls for one.
+                if (!empty($data['view']) || !empty($data['action'])):
+                
+                        // 
+                        if ($data['view_method'] == 'delegate'):
+                                return owa_coreAPI::displayView($data);
+                        
+                        // Redirect to a view   
+                        elseif ($data['view_method'] == 'redirect'):
+                                owa_lib::redirectToView($data);
+                                return;
+                                
+                        // return an image . Will output headers and binary data.
+                        elseif ($data['view_method'] == 'image'):
+                                return owa_coreAPI::displayImage($data);
+                        
+                        else:
+                                return owa_coreAPI::displayView($data);
+                                
+                        endif;
+                
+                elseif(!empty($data['do'])):
+                        //print_r($data);
+                        owa_lib::redirectToView($data);
+                        return;
+                        
+                endif;
+                
+                
+                
+        }
+        
+        /**
+         * Logs an event to the event queue
+         * 
+         * This function sets the action to be perfromed, santizes, 
+         * and adds all of PHP's $_SERVER vars to the $caller_params.
+         * $_REQUEST vars are already added to $this->params in the constructor.
+         *
+         * @param array $caller_params
+         * @param string $event_type
+         * @return boolean
+         */
+        function logEvent($event_type, $caller_params = '') {
+                
+                $c = owa_coreAPI::configSingleton();
+                $e = owa_coreAPI::errorSingleton();
+                $request_params = owa_coreAPI::requestContainer();
+                
+                if ($c->get('base', 'error_log_level') > 9):
+                        $e->debug(print_r($e->backtrace(), true));
+                endif;
+                
+                // do not log if the do not log param is set by caller.
+                if ($request_params['do_not_log'] == true):
+                        $e->debug("ABORTING LOG ACTION: do not log flag appears to be set");
+                        return false;
+                endif;
+                
+                //change config value to incomming site_id
+                if(!empty($caller_params['site_id'])):
+                        $c->set('base', 'site_id', $caller_params['site_id']);
+                else:
+                        $caller_params['site_id'] = $c->get('base', 'site_id');
+                endif;
+                
+                // do not log if the request is from a reserved IP
+                // ips = $this->c->get('base', 'log_not_log_ips');
+                //      ...
+                
+                $params = array();
+                // Add PHP's $_SERVER scope variables to event properties
+                $params['server'] = $_SERVER;
+                
+                // Apply caller's params to event properties
+                if (!empty($caller_params)):
+                        $params['caller'] = $caller_params;
+                endif;
+                
+                // set controller to invoke
+                $params['action'] = $event_type;
+                
+                // Filter input
+                $params = owa_lib::inputFilter($params);
+                
+                //Load browscap
+                $bcap = owa_coreAPI::supportClassFactory('base', 'browscap', $params['server']['HTTP_USER_AGENT']);
+                
+                // Abort if the request is from a robot
+                if ($c->get('base', 'log_robots') != true):
+                        if ($bcap->robotCheck() == true):
+                                $e->debug("ABORTING LOG ACTION: request appears to be from a robot");
+                                return;
+                        endif;
+                endif;
+                
+                // Fetch browser capabilities and and apply to event params
+                $params['browscap'] = get_object_vars($bcap->browser);
+        
+                return owa_coreAPI::handleRequest($params);
+                
+        }
+        
 }
 

trunk/owa_entity.php

@@ -127 +127 @@
         
         }
+        
+        /**
+         * Persist new object
+         *
+         */ 
+        function create() {     
+                
+                $db = owa_coreAPI::dbSingleton();
+                $config = owa_coreAPI::configSingleton();
+                $cache = owa_coreAPI::cacheSingleton();
+                
+                $all_cols = $this->getColumns();
+                
+                $cols = array();
+                
+                // Control loop
+                foreach ($all_cols as $k => $v){
+                
+                        // drop column is it is marked as auto-incement as DB will take care of that.
+                        if ($this->$v->auto_increment == true):
+                                ;
+                        else:
+                                $cols