co_chameleon.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('__CHAMELEON_VERSION__', '1.1.2.3000');
 
require_once(CO_Config::badger_main_class_dir().'/co_access.class.php');
 
if ( !defined('LGV_LANG_CATCHER') ) {
    define('LGV_LANG_CATCHER', 1);
}
 
require_once(CO_Config::chameleon_lang_class_dir().'/common.inc.php');
 
/***************************************************************************************************************************/
class CO_Chameleon extends CO_Access {
    protected $_special_access_id;  
    
    /***********************************************************************************************************************/    
    /***********************/
    public function __construct(    $in_login_id = NULL,        
                                    $in_hashed_password = NULL, 
                                    $in_raw_password = NULL,    
                                    $in_api_key = NULL          
                                ) {
        parent::__construct($in_login_id, $in_hashed_password, $in_raw_password, $in_api_key);
        $this->version = __CHAMELEON_VERSION__;
    }
    
    /***********************/
    public function fetch_backup() {
        // Have to be "God," and the variable in the config needs to be set.
        if ($this->god_mode()) {
            $security_db_backup = $this->_security_db_object->get_db_backup();
            $data_db_backup = $this->_data_db_object->get_db_backup();
            
            return ['security' => $security_db_backup, 'data' => $data_db_backup];
        }
        
        return NULL;
    }
    
    /***********************/
    public function get_security_ids(   $no_personal = false    
                                    ) {
        $ret = parent::get_security_ids($no_personal);
        
        if (isset($this->_special_access_id)) {
            $id = $this->_special_access_id;
            unset($this->_special_access_id);
            $ret[] = intval($id);
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_all_collections_for_element(    $in_element 
                                                    ) {
        $ret = NULL;
        
        if (isset($in_element) && $in_element && ($in_element->get_access_object() == $this)) {
            $collection_objects = $this->generic_search(Array('access_class' => Array('%_collection', 'use_like' => true)));
 
            if (isset($collection_objects) && is_array($collection_objects) && count($collection_objects)) {
                foreach ($collection_objects as $parent_object) {
                    if ($parent_object->areYouMyDaddy($in_element, false)) {
                        if (!$ret) {
                            $ret = Array();
                        }
                        array_push($ret, $parent_object);
                    }
                }
            }
        } else {    // If the item is invalid, we not only give a NULL, we also flag an error.
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_collection_error_code_item_not_valid,
                                            CO_CHAMELEON_Lang::$co_collection_error_name_item_not_valid,
                                            CO_CHAMELEON_Lang::$co_collection_error_desc_item_not_valid);
        }
        
        return $ret;
    }
    
    /***********************/
    public function count_all_login_objects_with_access($in_security_token  
                                                        ) {
        return $this->_security_db_object->count_all_login_objects_with_access($in_security_token);
    }
    
    /***********************/
    public function get_all_login_objects_with_access(  $in_security_token, 
                                                        $and_write = false  
                                                        ) {
        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  
                                                        ) {
        return $this->_security_db_object->get_all_user_objects_with_access($in_security_token);
    }
    
    /***********************/
    public function get_lang(   $in_login_id = NULL 
                            ) {
        $ret = parent::get_lang();
        
        $login_item = $this->get_login_item($in_login_id);
        
        if ($login_item) {
            $user_item = $this->get_user_from_login($login_item->login_id);
            if ($user_item) {
                $ret = $user_item->get_lang();
            }
        }
        
        return $ret;
    }
        
    /***********************/
    public function test_access(    $in_login_id    
                                ) {
        $ret = false;
        
        // Yeah, this will crash if we're not in COBRA. Good.
        if ($this->security_db_available() && ($this->get_login_item() instanceof CO_Login_Manager)) {
            $item_to_test = $this->_security_db_object->get_initial_record_by_id($in_login_id);
            
            if (($item_to_test instanceof CO_Cobra_Login) || ($item_to_test instanceof CO_Security_ID)) {
                $ret = $item_to_test->security_exemption();
                if ($ret) {
                    $this->_special_access_id = $in_login_id;
                }
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function get_value_for_key(  $in_key,                        
                                        $in_classname = 'CO_KeyValue_CO_Collection'   
                                    ) {
        $ret = NULL;
        $value_object_array = $this->generic_search(Array('access_class' => $in_classname, 'tags' => Array(strval($in_key))));
        
        if (isset($value_object_array) && is_array($value_object_array) && count($value_object_array)) {
            $value_object = $value_object_array[0]; // If the DB is messed up, we could get more than one. In that case, we only take the first one.
            if (isset($value_object) && ($value_object instanceof CO_KeyValue_CO_Collection)) {
                $ret = $value_object->get_value();
            }
        }
        
        return $ret;
    }
    
    /***********************/
    public function key_is_unique(  $in_key,                                    
                                    $in_classname = 'CO_KeyValue_CO_Collection' 
                                    ) {
        return $this->_data_db_object->tag0_is_unique($in_key, $in_classname);
    }
    
    /***********************/
    public function get_object_for_key( $in_key 
                                        ) {
        $ret = NULL;
        $value_object_array = $this->generic_search(Array('access_class' => Array('%_KeyValue%', 'use_like' => 1), 'tags' => Array(strval($in_key))));
        
        if (isset($value_object_array) && is_array($value_object_array) && count($value_object_array)) {
            $ret = $value_object_array[0]; // If the DB is messed up, we could get more than one. In that case, we only take the first one.
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_value_for_key(  $in_key,                        
                                        $in_value,                      
                                        $in_classname = 'CO_KeyValue_CO_Collection'   
                                    ) {
        $ret = false;
        
        if ($this->security_db_available()) {   // Must be logged in.
            // First, we look for the object.
            $value_object = $this->generic_search(Array('access_class' => $in_classname, 'tags' => Array(strval($in_key))));
        
            if ((NULL != $in_value) && (!isset($value_object) || !$value_object)) {
                $value_object = $this->make_new_blank_record($in_classname);
                if (isset($value_object) && ($value_object instanceof CO_KeyValue_CO_Collection) && $value_object->user_can_write()) {
                    $ret = $value_object->set_name($in_key);
                    $ret = $value_object->set_key($in_key);
                    if (!$ret) {
                        $this->error = $value_object->error;
                        $value_object->delete_from_db();
                        $value_object = NULL;
                        if (!$this->error) {
                            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_instance_failed_to_initialize,
                                                            CO_CHAMELEON_Lang::$co_key_value_error_name_instance_failed_to_initialize,
                                                            CO_CHAMELEON_Lang::$co_key_value_error_desc_instance_failed_to_initialize);
                        }
                    }
               }
            } elseif (isset($value_object) && is_array($value_object) && count($value_object)) {
                $value_object = $value_object[0];
            } else {
                $value_object = NULL;
                $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_instance_failed_to_initialize,
                                                CO_CHAMELEON_Lang::$co_key_value_error_name_instance_failed_to_initialize,
                                                CO_CHAMELEON_Lang::$co_key_value_error_desc_instance_failed_to_initialize);
            }
 
            if (isset($value_object) && ($value_object instanceof CO_KeyValue_CO_Collection) && $value_object->user_can_write()) {
                if (NULL == $in_value) {    // If we are deleting, we ask the object to go quietly into the great beyond.
                    $ret = $value_object->delete_from_db();
                } else {                    // Otherwise, we just set the value.
                    $ret = $value_object->set_tag(0, $in_key);
                    if ($ret) {
                        $ret = $value_object->set_value($in_value);
                    } else {
                        $this->error = $value_object->error;
                        
                        if (!$this->error) {
                            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_instance_failed_to_initialize,
                                                            CO_CHAMELEON_Lang::$co_key_value_error_name_instance_failed_to_initialize,
                                                            CO_CHAMELEON_Lang::$co_key_value_error_desc_instance_failed_to_initialize);
                        }
                    }
                }
            } else {
                if (isset($value_object) && ($value_object instanceof CO_KeyValue_CO_Collection) && !$value_object->user_can_write()) {
                    $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_user_not_authorized,
                                                    CO_CHAMELEON_Lang::$co_key_value_error_name_user_not_authorized,
                                                    CO_CHAMELEON_Lang::$co_key_value_error_desc_user_not_authorized);
                } else {
                    $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_instance_failed_to_initialize,
                                                    CO_CHAMELEON_Lang::$co_key_value_error_name_instance_failed_to_initialize,
                                                    CO_CHAMELEON_Lang::$co_key_value_error_desc_instance_failed_to_initialize);
                }
            }
        } else {
            $this->error = new LGV_Error(   CO_CHAMELEON_Lang_Common::$co_key_value_error_code_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_key_value_error_name_user_not_authorized,
                                            CO_CHAMELEON_Lang::$co_key_value_error_desc_user_not_authorized);
        }
        
        return $ret;
    }
 
    /***********************/
    public function get_all_visible_users() {
        return $this->_data_db_object->get_all_visible_users();
    }
 
    /***********************/
    public function get_all_visible_logins() {
        return $this->_security_db_object->get_all_visible_users();
    }
    
    /***********************/
    public function get_user_from_login(    $in_login_id = NULL 
                                        ) {
        $ret = NULL;
 
        $login_id = $this->get_login_id();  // Default is the current login.
        
        if (isset($in_login_id) && (0 < intval($in_login_id))) {    // See if they seek a different login.
            $login_id = intval($in_login_id);
        }
        
        $tag0 = strval($login_id);
        
        $ret_temp = $this->generic_search(Array('access_class' => Array('%_user_collection', 'use_like' => true), 'tags' => Array($tag0)));
        
        if (isset($ret_temp) && is_array($ret_temp) && count($ret_temp)) {
            $ret = $ret_temp[0];    // We only get the first one. Multiple responses mean the DB is not so healthy.
        }
        
        return $ret;
    }
};