a_co_db_table_base.class.php

Go to the documentation of this file.

<?php
/***************************************************************************************************************************/
defined( 'LGV_ADBTB_CATCHER' ) or die ( 'Cannot Execute Directly' );    // Makes sure that this file is in the correct context.
        
if ( !defined('LGV_DBF_CATCHER') ) {
    define('LGV_DBF_CATCHER', 1);
}
 
require_once(CO_Config::db_classes_class_dir().'/co_security_login.class.php');
 
/***************************************************************************************************************************/
abstract class A_CO_DB_Table_Base {
    protected   $_db_object;    
    protected   $_id;           
    protected   $_batch_mode;   
    
    var $class_description;     
    var $instance_description;  
    
    var $last_access;           
    var $name;                  
    var $read_security_id;      
    var $write_security_id;     
    var $context;               
    var $error;                 
 
    /***********************************************************************************************************************/
    /***********************/
    protected function _default_setup() {
        return Array(   'id'                    => 0,
                        'last_access'           => 86400,   // Default is first UNIX day.
                        'object_name'           => '',
                        'read_security_id'      => 0,
                        'write_security_id'     => 0,
                        'access_class_context'  => NULL
                        );
    }
    
    /***********************/
    protected function _build_parameter_array() {
        $ret = Array();
        
        if ($this instanceof CO_Security_ID) {
            $this->write_security_id = -1;          // These always have a -1
            $this->read_security_id = $this->id();  // These always have their own ID set as the read ID
        }
            
        $ret['id'] = $this->id();
        $ret['access_class'] = strval(get_class($this));
        $ret['last_access'] = strval(date('Y-m-d H:i:s'));
        $ret['read_security_id'] = intval($this->read_security_id);
        $ret['write_security_id'] = intval($this->write_security_id);
        $name = trim(strval($this->name));
        $ret['object_name'] = $name ? $name : NULL;
        $ret['access_class_context'] = $this->context ? $this->_badger_serialize($this->context) : NULL;   // If we have a context, then we serialize it for the DB.
        
        return $ret;
    }
    
    /***********************/
    protected function _badger_serialize(   $in_data    
                                        ) {
        return serialize($in_data);
    }
    
    /***********************/
    protected function _badger_unserialize( $in_data    
                                        ) {
        return unserialize($in_data);
    }
    
    /***********************/
    protected function _write_to_db() {
        $ret = false;
        
        if (isset($this->_db_object)) {
            $params = $this->_build_parameter_array();
            
            if (isset($params) && is_array($params) && count($params)) {
                $ret = $this->_db_object->write_record($params);
                $this->error = $this->get_access_object()->error;
                if ((1 < intval($ret)) && !$this->error) {
                    $this->_id = intval($ret);
                    if ($this instanceof CO_Security_ID) {
                        $this->read_security_id = $this->id();  // These always have their own ID set as the read ID
                        $this->write_security_id = -1;          // These always have a -1
                    }
                }
            }
        }
        
        return $ret;
    }
    
    /***********************/
    protected function _seppuku() {
        $ret = false;
        
        if ($this->id() && isset($this->_db_object)) {
            $ret = $this->_db_object->delete_record($this->id());
            if ($ret) {
                $this->_id = 0; // Make sure we have no more ID. If anyone wants to re-use this instance, it needs to become a new record.
            }
        }
        
        return $ret;
    }
    
    /***********************************************************************************************************************/
    /***********************/
    public function __construct(    $in_db_object = NULL,   
                                    $in_db_result = NULL    
                                ) {
        $this->class_description = '';
        $this->_id = NULL;
        $this->last_access = time();
        $this->read_security_id = 0;
        $this->write_security_id = 0;
        $this->name = NULL;
        $this->context = NULL;
        $this->instance_description = NULL;
        $this->_db_object = $in_db_object;
        $this->error = NULL;
        
        if ($in_db_object) {
            if (!$in_db_result) {
                $in_db_result = $this->_default_setup();
            }
        
            $this->load_from_db($in_db_result);
        }
    }
    
    /***********************/
    public function set_batch_mode() {
        $this->_batch_mode = true;
    }
    
    /***********************/
    public function clear_batch_mode() {
        $ret = false;
        
        $call_update = $this->_batch_mode;
        $this->_batch_mode = false;
        if ($call_update) {
            $ret = $this->update_db();
            if (method_exists($this, '_scrub')) {
                $this->_scrub();
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function load_from_db(   $in_db_result   
                                ) {
        $ret = false;
        $this->last_access = max(86400, time());    // Just in case of badly-set clocks in the server.
        
        if (isset($this->_db_object) && isset($in_db_result) && isset($in_db_result['id']) && intval($in_db_result['id'])) {
            $ret = true;
            $this->_id = intval($in_db_result['id']);
            
            if (isset($in_db_result['last_access'])) {
                $date_from_db = date_create_from_format('Y-m-d H:i:s', $in_db_result['last_access']);
                $timestamp = date_timestamp_get($date_from_db);
                $this->last_access = max(86400, $timestamp);
            }
        
            if (isset($in_db_result['read_security_id']) && intval($in_db_result['read_security_id'])) {
                $this->read_security_id = intval($in_db_result['read_security_id']);
            }
            
            if ($this instanceof CO_Security_ID) {
                $this->write_security_id = -1;          // These always have a -1
                if ($this->id()) {
                    $this->read_security_id = $this->id();   // These always have their own ID set as the read ID
                }
            } else {
                if (isset($in_db_result['write_security_id'])) {
                    $this->write_security_id = intval($in_db_result['write_security_id']);
                } else {
                    $this->write_security_id = $this->read_security_id ? -1 : intval($this->write_security_id);  // Writing is completely blocked if we have read security, but no write security specified.
                }
            }
            
            if (isset($in_db_result['object_name'])) {
                $this->name = strval($in_db_result['object_name']);
            }
            
            if (isset($in_db_result['access_class_context'])) {
                $serialized_context = trim(strval($in_db_result['access_class_context']));
                if (isset($serialized_context) && $serialized_context) {
                    $serialized_context = stripslashes($serialized_context);
                    $temp_context = $this->_badger_unserialize($serialized_context);
    
                    if ($temp_context) {
                        $this->context = $temp_context;
                    }
                }
            }
        }
        
        $this->class_description = 'Abstract Base Class for Records -Should never be instantiated.';
 
        return $ret;
    }
    
    /***********************/
    public function id() {
        return $this->_id;
    }
    
    /***********************/
    public function lock() {
        return $this->_db_object->lock_record($this->id());
    }
    
    /***********************/
    public function locked() {
        return $this->read_security_id == -2;
    }
    
    /***********************/
    public function danger_will_robinson_danger_clear_id() {
        $this->_id = 0;
    }
    
    /***********************/
    public function user_can_read() {
        $ret = false;
        
        $ids = $this->get_access_object()->get_security_ids();
        
        $my_read_item = intval($this->read_security_id);
        $my_write_item = intval($this->write_security_id);
        
        if ((0 == $my_read_item) || $this->get_access_object()->god_mode()) {
            $ret = true;
        } else {
            if (isset($ids) && is_array($ids) && count($ids)) {
                $ret = in_array($my_read_item, $ids) || in_array($my_write_item, $ids);
            }
        }
        
        if (!$ret && $this->get_access_object()->get_login_id()) {
            $ret = (1 == $my_read_item);  // Logged-in users can read 1s.
        }
        
        return $ret;
    }
    
    /***********************/
    public function user_can_write() {
        $ret = false;
        
        $ids = $this->get_access_object()->get_security_ids();
        
        $my_write_item = intval($this->write_security_id);
        // We can never edit unless we are logged in.
        if (((isset($ids) && is_array($ids) && count($ids)) && (0 == $my_write_item)) || $this->get_access_object()->god_mode()) {
            $ret = true;
        } else {
            if (isset($ids) && is_array($ids) && count($ids)) {
                $ret = in_array($my_write_item, $ids);
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_read_security_id($in_new_id 
                                        ) {
        $ret = false;
        if ($this->user_can_write() && isset($in_new_id)) {
            $this->read_security_id = intval($in_new_id);
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_write_security_id($in_new_id    
                                        ) {
        $ret = false;
        if ($this->user_can_write() && isset($in_new_id)) {
            $this->write_security_id = intval($in_new_id);
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_name($in_new_value  
                            ) {
        $ret = false;
        
        if (isset($in_new_value)) {
            $this->name = strval($in_new_value);
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
    public function delete_from_db() {
        if ($this->user_can_write()) {
            return $this->_seppuku();
        } else {
            return false;
        }
    }
    
    /***********************/
    public function update_db() {
        if (!$this->id() || $this->user_can_write()) {
            if (!$this->_batch_mode) {
                return $this->_write_to_db();
            } else {
                return true;
            }
        } else {
            return false;
        }
    }
    
    /***********************/
    public function reload_from_db() {
        $ret = false;
        $db_result = $this->_db_object->get_single_raw_row_by_id($this->id());
        $this->error = $this->get_access_object()->error;
        if (!isset($this->error) || !$this->error) {
            $ret = $this->load_from_db($db_result);
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_access_object() {
        $db_object = $this->_db_object;
        
        if (isset($db_object)) {
            return $db_object->access_object;
        }
        
        return NULL;
    }
    
    /***********************/
    public function get_lang() {
        $ret = CO_Config::$lang;
        
        // We replace the default only if we have a valid lang value.
        if (isset($this->context['lang']) && trim($this->context['lang'])) {
            $ret = strtolower(trim($this->context['lang']));    // Should be unneccessary, but belt and suspenders...
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_lang(   $in_lang_id = NULL  
                            ) {
        $ret = false;
        
        if ($this->user_can_write()) {
            $this->context['lang'] = strtolower(trim(strval($in_lang_id)));
            $ret = $this->update_db();
        }
        
        return $ret;
    }
};