co_access.class.php

Go to the documentation of this file.

<?php
/***************************************************************************************************************************/
defined( 'LGV_ACCESS_CATCHER' ) or die ( 'Cannot Execute Directly' );   // Makes sure that this file is in the correct context.
 
define('__BADGER_VERSION__', '1.1.2.3000');
 
if ( !defined('LGV_MD_CATCHER') ) {
    define('LGV_MD_CATCHER', 1);
}
 
require_once(CO_Config::db_class_dir().'/co_main_data_db.class.php');
 
if ( !defined('LGV_SD_CATCHER') ) {
    define('LGV_SD_CATCHER', 1);
}
 
require_once(CO_Config::db_class_dir().'/co_security_db.class.php');
 
if ( !defined('LGV_LANG_CATCHER') ) {
    define('LGV_LANG_CATCHER', 1);
}
 
require_once(CO_Config::badger_lang_class_dir().'/common.inc.php');
 
/***************************************************************************************************************************/
class CO_Access {    
    protected $_data_db_object;     
    protected $_security_db_object; 
    protected $_login_id;           
 
    public $valid;                  
    public $error;                  
    public $class_description;      
    
    public $version;                
    
    /***********************************************************************************************************************/
    /***********************/
    public function __construct(    $in_login_id = NULL,        
                                    $in_hashed_password = NULL, 
                                    $in_raw_password = NULL,    
                                    $in_api_key = NULL          
                                ) {
        $this->class_description = 'The main data access class.';
        
        $this->_login_id = NULL;
        $this->_data_db_object = NULL;
        $this->_security_db_object = NULL;
        $this->error = NULL;
        $this->valid = false;
        $this->version = __BADGER_VERSION__;
        
        if ( !defined('LGV_ERROR_CATCHER') ) {
            define('LGV_ERROR_CATCHER', 1);
        }
        
        require_once(CO_Config::badger_shared_class_dir().'/error.class.php');
        
        if ( !defined('LGV_DB_CATCHER') ) {
            define('LGV_DB_CATCHER', 1);
        }
        
        require_once(CO_Config::db_class_dir().'/co_pdo.class.php');
        
        // We only load the security DB if there was a login/password (or API key) sent in.
        if ((isset($in_login_id) && $in_login_id) && ((isset($in_hashed_password) && $in_hashed_password) || (isset($in_raw_password) && $in_raw_password)) || (isset($in_api_key) && $in_api_key)) {
            try {
                $pdo_security_db = new CO_PDO(CO_Config::$sec_db_type, CO_Config::$sec_db_host, CO_Config::$sec_db_name, CO_Config::$sec_db_login, CO_Config::$sec_db_password);
                $this->_security_db_object = new CO_Security_DB($pdo_security_db, $this);
                $dont_create_new_api_key = false;
                
                // If they have provided an API key, then the first thing we do, is see if it's valid.
                // If so, then we ignore the passed-in password and login, and use the ones provided from the API-key-related login, instead.
                if (isset($in_api_key) && $in_api_key) {
                    $api_results = $this->_security_db_object->get_credentials_by_api_key($in_api_key);
                    
                    if (isset($api_results) && is_array($api_results) && (2 == count($api_results))) {
                        $in_login_id = $api_results['login_id'];
                        $in_hashed_password = $api_results['hashed_password'];
                        $dont_create_new_api_key = true;
                    }
                }
        
                $login_record = $this->_security_db_object->get_initial_record_by_login_id($in_login_id);
                if ($this->_security_db_object->error) {
                    $this->error = $this->_security_db_object->error;
                    
                    return;
                }
                if (isset($login_record) && ($login_record instanceof CO_Security_Login)) {
                    if (!$login_record->is_login_valid($in_login_id, $in_hashed_password, $in_raw_password, $dont_create_new_api_key)) {
                        $this->error = new LGV_Error(   CO_Lang_Common::$pdo_error_code_invalid_login,
                                                        CO_Lang::$pdo_error_name_invalid_login,
                                                        CO_Lang::$pdo_error_desc_invalid_login);
                
                        $this->_security_db_object = NULL;
                        return;
                    }
                } else {
                    $this->error = new LGV_Error(   CO_Lang_Common::$pdo_error_code_invalid_login,
                                                    CO_Lang::$pdo_error_name_invalid_login,
                                                    CO_Lang::$pdo_error_desc_invalid_login);
            
                    $this->_security_db_object = NULL;
                    return;
                }
                
                $this->_login_id = $login_record->id();
                $login_record->update_db(); // This forces the login to update its last_access field and API key. We use this to track logins.
            } catch (Exception $exception) {
                $this->error = new LGV_Error(   CO_Lang_Common::$pdo_error_code_failed_to_open_security_db,
                                                CO_Lang::$pdo_error_name_failed_to_open_security_db,
                                                CO_Lang::$pdo_error_desc_failed_to_open_security_db,
                                                $exception->getFile(),
                                                $exception->getLine(),
                                                $exception->getMessage());
                $this->_security_db_object = NULL;
                return;
            }
        }
        
        try {
            $pdo_data_db = new CO_PDO(CO_Config::$data_db_type, CO_Config::$data_db_host, CO_Config::$data_db_name, CO_Config::$data_db_login, CO_Config::$data_db_password);
            $this->_data_db_object = new CO_Main_Data_DB($pdo_data_db, $this);
        } catch (Exception $exception) {
            $this->error = new LGV_Error(   CO_Lang_Common::$pdo_error_code_failed_to_open_data_db,
                                            CO_Lang::$pdo_error_name_failed_to_open_data_db,
                                            CO_Lang::$pdo_error_desc_failed_to_open_data_db,
                                            $exception->getFile(),
                                            $exception->getLine(),
                                            $exception->getMessage());
            $this->_data_db_object = NULL;
            $this->_security_db_object = NULL;
            return;
        }
        
        $this->valid = true;
    }
    
    /***********************/
    public function item_exists(    $in_id,                     
                                    $in_visibility_test = false 
                                ) {
        return $this->_data_db_object->item_exists($in_id, $in_visibility_test);
    }
    
    /***********************/
    public function get_security_ids($no_personal = false   
                                    ) {
        $ret = Array();
        
        if ($this->god_mode()) {
            $ret = Array(-1);
        } else {
            $login_id = $this->get_login_id();
            if (isset($login_id) && $login_id && $this->_security_db_object) {
                $ret = $this->_security_db_object->get_security_ids_for_id($this->get_login_id(), $no_personal);
                
                if ($this->_security_db_object->error) {
                    $this->error = $this->_security_db_object->error;
                    
                    $ret = Array();
                } else {
                    array_unshift($ret, 1); // We always add 1, as that's the "all logged-in users" token.
                }
            }
        }
        return $ret;
    }
    
    /***********************/
    public function get_personal_security_ids() {
        $ret = Array();
        
        if (CO_Config::use_personal_tokens()) {
            $login_id = $this->get_login_id();
            if (isset($login_id) && $login_id && $this->_security_db_object) {
                $ret = $this->_security_db_object->get_personal_ids_for_id($login_id);
                
                if ($this->_security_db_object->error) {
                    $this->error = $this->_security_db_object->error;
                    $ret = Array();
                }
            }
        }
        return $ret;
    }
    
    /***********************/
    public function get_all_personal_ids_except_for_id( $in_id = 0  
                                                        ) {
        $ret = $this->_security_db_object->get_all_personal_ids_except_for_id($in_id);
    
        if ($this->_security_db_object->error) {
            $this->error = $this->_security_db_object->error;
            $ret = Array();
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_logins_with_personal_ids() {
        $ret = $this->_security_db_object->get_logins_with_personal_ids();
    
        if ($this->_security_db_object->error) {
            $this->error = $this->_security_db_object->error;
            $ret = Array();
        }
        
        return $ret;
    }
        
    /***********************/
    public function is_this_a_personal_id(  $in_id  
                                            ) {
        $ret = $this->_security_db_object->is_this_a_personal_id($in_id);
 
        if ($this->_security_db_object->error) {
            $this->error = $this->_security_db_object->error;
        } else {
            return $ret;
        }
 
        return false;
    }
    
    /***********************/
    public function add_personal_token_from_current_login(  $in_to_id,  
                                                            $in_id      
                                                            ) {
        if (in_array($in_id, $this->get_personal_security_ids())) {
            $ret = $this->_security_db_object->add_personal_token_from_current_login($in_to_id, $in_id);
 
            if ($this->_security_db_object->error) {
                $this->error = $this->_security_db_object->error;
            } else {
                return $ret;
            }
        }
        
        return false;
    }
    
    /***********************/
    public function remove_personal_token_from_this_login(  $in_to_id,  
                                                            $in_id      
                                                            ) {
        if (in_array($in_id, $this->get_personal_security_ids())) {
            $ret = $this->_security_db_object->remove_personal_token_from_this_login($in_to_id, $in_id);
 
            if ($this->_security_db_object->error) {
                $this->error = $this->_security_db_object->error;
            } else {
                return $ret;
            }
        }
        
        return false;
    }
    
    /***********************/
    public function get_logins_that_have_any_of_my_ids() {
        return $this->_security_db_object->get_logins_that_have_any_of_my_ids();
    }
            
    /***********************/
    public function is_this_a_login_id( $in_id  
                                            ) {
        $ret = $this->_security_db_object->is_this_a_login_id($in_id);
 
        if ($this->_security_db_object->error) {
            $this->error = $this->_security_db_object->error;
        } else {
            return $ret;
        }
 
        return false;
    }
    
    /***********************/
    public function get_available_tokens($no_personal = false   
                                        ) {
        $ret = Array();
        
        if ($this->god_mode()) {
           $logins = $this->_security_db_object->get_all_readable_records();
           
            foreach ($logins as $login) {
                $ret[] = $login->id();
            }
        } else {
            $login_id = $this->get_login_id();
            if (isset($login_id) && $login_id && $this->_security_db_object) {
                $ret = $this->_security_db_object->get_security_ids_for_id($this->get_login_id(), $no_personal);
                
                if ($this->_security_db_object->error) {
                    $this->error = $this->_security_db_object->error;
                    
                    $ret = Array();
                } else {
                    $ret[] = 1;
                }
            }
        }
        
        sort($ret);
        array_unshift($ret, $this->get_login_id());
        $ret = array_values(array_unique($ret));
        
        return $ret;
    }
    
    /***********************/
    public function main_db_available() {
        return NULL != $this->_data_db_object;
    }
    
    /***********************/
    public function get_login_id(   $in_login_id = NULL 
                                ) {
        $ret = $this->_login_id;
 
        $in_login_id = intval($in_login_id);
        
        // See if they are looking up an ID for another login.
        if ($in_login_id) {
            $ret = 0;   // If the lookup fails, we get back 0.
            
            $record = $this->get_single_security_record_by_id($login_id);
            
            if ($record) {
                $ret = $record->id();
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_login_item( $in_login_id = NULL 
                                    ) {
        $login_id = 0;
        
        if (isset($in_login_id) && (0 < intval($in_login_id))) {
            $login_id = intval($in_login_id);
        } else {
            $login_id = $this->get_login_id();
        }
        
        $ret = (1 < $login_id) ? $this->get_single_security_record_by_id($login_id) : NULL;
        
        return $ret;
    }
    
    /***********************/
    public function get_lang(   $in_login_id = NULL 
                            ) {
        $ret = CO_Config::$lang;
        
        $login_item = $this->get_login_item($in_login_id);
        
        if ($login_item) {
            $ret = $login_item->get_lang();
        }
        
        return $ret;
    }
    
    /***********************/
    public function god_mode() {
        // We look at the hard property (as opposed to using the accessor) just to avoid subclasses messing with things.
        return intval($this->_login_id) == intval(CO_Config::god_mode_id());
    }
 
    /***********************/
    public function check_login_exists( $in_login_id    
                                        ) {
        $ret = NULL;
        
        if ($this->security_db_available()) {
            $ret = false;
            
            if ($this->_security_db_object->get_initial_record_by_id(intval($in_login_id))) {
                $ret = true;
            }
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_remaining_time($in_login_id = NULL 
                                    ) {
        return $this->get_login_item($in_login_id)->get_remaining_time();
    }
    
    /***********************/
    public function check_login_exists_by_login_string( $in_login_id_string    
                                                        ) {
        $ret = NULL;
        
        if ($this->security_db_available()) {
            $ret = false;
            
            if ($this->_security_db_object->get_initial_record_by_login_id($in_login_id_string)) {
                $ret = true;
            }
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_login_item_by_login_string( $in_login_id_string    
                                                    ) {
        $ret = NULL;
        
        if ($this->security_db_available()) {
            $ret = $this->_security_db_object->get_single_record_by_login_id($in_login_id_string);
        }
        
        return $ret;
    }
 
    /***********************/
    public function check_user_exists(  $in_login_id    
                                    ) {
        // We first check for a login.
        $ret = $this->check_login_exists($in_login_id);
        
        if (NULL == $ret) {
            $ret = false;
        } elseif (true == $ret) {   // If it exists, we check further, for a user with that login.
            $ret = $this->_data_db_object->see_if_user_exists($in_login_id);
        }
        
        return $ret;
    }
    
    /***********************/
    public function make_new_blank_record(  $in_classname   
                                        ) {
        $ret = NULL;
        
        // We create an empty instance to test which database gets assigned.
        if ($in_classname) {
            $filename = CO_Config::db_classes_class_dir().'/'.strtolower($in_classname).'.class.php';
            if (!class_exists($in_classname)) {
                if (!file_exists($filename)) {
                    $filename = NULL;
                    
                    $dir_array = CO_Config::db_classes_extension_class_dir();
                    
                    if (!is_array($dir_array)) {
                        $dir_array = Array($dir_array);
                    }
                
                    foreach ($dir_array as $dir) {
                        $filename = $dir.'/'.strtolower($in_classname).'.class.php';                
                        if (file_exists($filename)) {
                            require_once($filename);
                            break;
                        } else {
                            $filename = NULL;
                        }
                    }
                } else {
                    require_once($filename);
                }
                
                if (!$filename) {
                    $this->error = new LGV_Error(   CO_Lang_Common::$access_error_code_class_file_not_found,
                                                    CO_Lang::$access_error_name_class_file_not_found,
                                                    CO_Lang::$access_error_desc_class_file_not_found,
                                                    __FILE__,
                                                    __LINE__,
                                                    __METHOD__
                                                );
                    return NULL;
                }
            }
 
            if (class_exists($in_classname) && $this->_data_db_object && $this->_security_db_object) {    // Quick test. Not allowed to do anything unless we are logged in.
                $test_instance = new $in_classname();
 
                if ($test_instance instanceof CO_Main_DB_Record) {
                    $ret = new $in_classname($this->_data_db_object);
                } elseif ($test_instance instanceof CO_Security_Node) {
                    $ret = new $in_classname($this->_security_db_object);
                }
        
                if ($ret) {
                    $ret->write_security_id = intval($this->get_login_id());
                    $ret->update_db();   // Make sure it gets saved.
                } else {
                    $this->error = new LGV_Error(   CO_Lang_Common::$access_error_code_class_not_created,
                                                    CO_Lang::$access_error_name_class_not_created,
                                                    CO_Lang::$access_error_desc_class_not_created,
                                                    __FILE__,
                                                    __LINE__,
                                                    __METHOD__
                                                );
                }
            } elseif (!$this->_security_db_object) {
                $this->error = new LGV_Error(   CO_Lang_Common::$access_error_code_user_not_authorized,
                                                CO_Lang::$access_error_name_user_not_authorized,
                                                CO_Lang::$access_error_desc_user_not_authorized,
                                                __FILE__,
                                                __LINE__,
                                                __METHOD__
                                            );
            } else {
                $this->error = new LGV_Error(   CO_Lang_Common::$access_error_code_class_not_created,
                                                CO_Lang::$access_error_name_class_not_created,
                                                CO_Lang::$access_error_desc_class_not_created,
                                                __FILE__,
                                                __LINE__,
                                                __METHOD__
                                            );
            }
        }
        
        return $ret;
    }
        
    /***********************/
    public function get_multiple_data_records_by_id(    $in_id_array    
                                                    ) {
        $ret = NULL;
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->get_multiple_records_by_id($in_id_array);
            if ($this->_data_db_object->error) {
                $this->error = $this->_data_db_object->error;
                
                return NULL;
            }
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_single_data_record_by_id(   $in_id  
                                                ) {
        $ret = NULL;
        
        $tmp = $this->get_multiple_data_records_by_id(Array($in_id));
        if (isset($tmp) && is_array($tmp) && (1 == count($tmp))) {
            $ret = $tmp[0];
        }
    
        return $ret;
    }
    
    /***********************/
    public function get_data_access_class_by_id( $in_id  
                                                ) {
        $ret = NULL;
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->get_access_class_by_id($in_id);
            $this->error = $this->_data_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_security_access_class_by_id(    $in_id  
                                                    ) {
        $ret = NULL;
        if (isset($this->_security_db_object) && $this->_security_db_object) {
            $ret = $this->_security_db_object->get_access_class_by_id($in_id);
            $this->error = $this->_security_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function can_i_see_this_data_record( $in_id  
                                                ) {
        $ret = false;
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->can_i_see_this_record($in_id);
            $this->error = $this->_data_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function can_i_see_this_security_record( $in_id  
                                                ) {
        $ret = false;
        
        if (isset($this->_security_db_object) && $this->_security_db_object) {
            $ret = $this->_security_db_object->can_i_see_this_record($in_id);
            $this->error = $this->_security_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_all_data_readable_records(  $open_only = false, 
                                                    $in_this_id = NULL  
                                                ) {
        $ret = NULL;
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->get_all_readable_records($open_only, $in_this_id);
            $this->error = $this->_data_db_object->error;
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_all_data_writeable_records( $in_this_id = NULL  
                                                    ) {
        $ret = NULL;
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->get_all_writeable_records($in_this_id);
        
            if ($this->_data_db_object->error) {
                $this->error = $this->_data_db_object->error;
                
                return NULL;
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function security_db_available() {
        return NULL != $this->_security_db_object;
    }
    
    /***********************/
    public function i_have_this_token(  $in_token_to_test   
                                    ) {
        $ret = $this->god_mode();   // God sees everything.
        
        if (!$ret && isset($in_token_to_test) && ctype_digit(strval($in_token_to_test))) {
            if (0 == intval($in_token_to_test)) {
                $ret = true;
            } elseif (1 == intval($in_token_to_test)) {
                $ret = $this->security_db_available();
            } else {
                $tokens = $this->get_security_ids();
                
                if (isset($tokens) && is_array($tokens) && count($tokens)) {
                    $ret = in_array(intval($in_token_to_test), $tokens);
                }
            }
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_multiple_security_records_by_id(    $in_id_array    
                                                        ) {
        $ret = NULL;
        
        if (isset($this->_security_db_object) && $this->_security_db_object) {
            $ret = $this->_security_db_object->get_multiple_records_by_id($in_id_array);
        
            if ($this->_security_db_object->error) {
                $this->error = $this->_security_db_object->error;
                
                return NULL;
            }
        }
 
        return $ret;
    }
 
    /***********************/
    public function get_single_security_record_by_id(   $in_id  
                                                    ) {
        $ret = NULL;
        
        $tmp = $this->get_multiple_security_records_by_id(Array($in_id));
        
        if (isset($tmp) && is_array($tmp) && (1 == count($tmp))) {
            $ret = $tmp[0];
        }
    
        return $ret;
    }
 
    /***********************/
    public function get_all_security_readable_records(  $in_this_id = NULL  
                                                    ) {
        $ret = NULL;
        
        if (isset($this->_security_db_object) && $this->_security_db_object) {
            $ret = $this->_security_db_object->get_all_readable_records($in_this_id);
        
            if ($this->_security_db_object->error) {
                $this->error = $this->_security_db_object->error;
                
                return NULL;
            }
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_all_security_writeable_records( $in_this_id = NULL  
                                                        ) {
        $ret = NULL;
        
        if (isset($this->_security_db_object) && $this->_security_db_object) {
            $ret = $this->_security_db_object->get_all_writeable_records($in_this_id);
        
            if ($this->_security_db_object->error) {
                $this->error = $this->_security_db_object->error;
                
                return NULL;
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function write_data_record(  $params_associative_array   
                                    ) {
        $ret = false;
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->write_record($params_associative_array);
            $this->error = $this->_data_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function delete_data_record( $id 
                                        ) {
        $ret = false;
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->delete_record($id);
            $this->error = $this->_data_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function generic_search( $in_search_parameters = NULL,   
                                    $or_search = false,             
                                    $page_size = 0,                 
                                    $initial_page = 0,              
                                    $and_writeable = false,         
                                    $count_only = false,            
                                    $ids_only = false               
                                    ) {
        $ret = Array();
        
        if (isset($this->_data_db_object) && $this->_data_db_object) {
            $ret = $this->_data_db_object->generic_search($in_search_parameters, $or_search, $page_size, $initial_page, $and_writeable, $count_only, $ids_only);
            $this->error = $this->_data_db_object->error;
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_all_login_objects ( $and_write = false  
                                            ) {
        if (!isset($this->_security_db_object) || !$this->_security_db_object) {
            return Array();
        }
        
        return $this->_security_db_object->get_all_login_objects($and_write);
    }
    
    /***********************/
    public function get_all_tokens ( ) {
        return $this->_security_db_object->get_all_tokens();
    }
    
    /***********************/
    public function get_all_login_objects_with_access(  $in_security_token, 
                                                        $and_write = false  
                                                ) {
        if (!isset($this->_security_db_object) || !$this->_security_db_object) {
            return Array();
        }
        
        return $this->_security_db_object->get_all_login_objects_with_access($in_security_token, $and_write);
    }
    
    /***********************/
    public function get_all_user_objects_with_access(   $in_security_token  
                                                    ) {
        if (!isset($this->_security_db_object) || !$this->_security_db_object) {
            return Array();
        }
        
        return $this->_security_db_object->get_all_user_objects_with_access($in_security_token);
    }
};