<?php
/**
 * 数据库操作
 * 
 * 
 * @name Util_Dao_SqlMap_MapQuery
 * @version 557 (2009-4-21 上午11:06:07)
 * @package Q.Dao.SqlMap
 * @author Peter.zyliu liuziyang@zadooo.com
 * @since 1.0
 */
class Util_Dao_SqlMap_MapQuery {
	
	/**
	 * Dao 配置
	 * 
	 * @var Array
	 */
	
	private $mapConfig = array(
		'configPath' => '/', 
		'defaultConfig' => '/'
	);
	
	/**
	 * server 配置
	 *
	 * @var Array
	 */
	private $serverConfig;
	
	/**
	 * 配置信息
	 *
	 * @var Array
	 */
	private $config;
	
	/**
	 * Enter description here...
	 *
	 * @var unknown_type
	 */
	private $parser;
	
	/**
	 * 数据库对象数组
	 *
	 * @var array
	 */
	private $connectors = array();
	
	/**
	 * 数据库
	 *
	 * @var unknown_type
	 */
	private $dbname;
	
	/**
	 * 对应SqlMap根节点nameSpace 也就是数据库名
	 * 
	 * 主要是为了多库下同样的表结构 使用指定的sqlmap
	 *
	 * @var String
	 */
	private $nameSpace;
	
	/**
	 * tag名称 对Cache Tags使用 
	 * @var mixed
	 **/
	private $tagName;
	
	/**
	 * 列的位置
	 *
	 * @var Integer
	 */
	private $columnIndex = 0;
	
	/**
	 * Util_Cache
	 *
	 * @var Util_Cache
	 */
	private $dbCacheObj;
	
	/**
	 * 设置缓存 是否开启
	 *
	 */
	private $sql_map_db_cache = true;
	
	/**
	 * 默认缓存SQL 1分钟
	 *
	 */
	private $sql_map_db_cache_expire = 60;
	
	/**
	 * 设置缓存key
	 *
	 * @var String
	 */
	private $sql_map_db_cache_key = null;
	
	/**
	 * 临时key 用于获取key (因为每次执行完查询会吧key置为空 所以用这个临时key保存)
	 *
	 * @var String
	 */
	private $sql_map_db_cache_tmp_key = null;
	
	/**
	 * key前缀使用在刷新范围内的Cache
	 * 
	 * 如：
	 * $prefix = 'list_';
	 * 范围：1,10 or a,z
	 * 结果就是删除 'list_1'、'list_2'、'list_3' ... 'list_10'
	 * @var unknown_type
	 */
	private $sql_map_db_cache_key_prefix = null;
	
	/**
	 * Sql domain
	 *
	 */
	const SQL_CACHE_DOMAIN = 'sql.yoho.cn';
	
	/**
	 * 域
	 *
	 */
	const SQL_CACHE_CLASS = 'default';
	
	/**
	 * 缓存class
	 * @var String
	 */
	private $cacheClass = '';
	
	/**
	 * 缓存连接时间
	 * @var integer
	 */
	private $connectCacheTime = '';
	
	/**
	 * 连接最大时间
	 * @var integer
	 */
	private $connectMaxSeconds = 70;
	
	/**
	 * 数据库字符编码
	 * @var string
	 */
	private $charset = 'UTF8MB4';
	
	/**
	 * 初始化
	 *
	 * @param String $project
	 * @example project 
	 * <pre>
	 * default.dbtest.feed
	 * |       |    |
	 * 项目名   数据库名  sqlMap文件
	 * 
	 * 默认 sqlMap文件是不需要的
	 * </pre>
	 * @param String $configPath
	 */
	public function __construct($project, $configPath = null) {
	    $this->sql_map_db_cache = defined('UTIL_DB_CACHE') ?  UTIL_DB_CACHE : true;
	    $this->sql_map_db_cache_expire = defined('UTIL_DB_CACHE_EXPIRE') ?  UTIL_DB_CACHE_EXPIRE : true;
		if (!empty($configPath)) {
			$this->mapConfig['configPath'] = $configPath;
//			$this->mapConfig['defaultConfig'] = '';
		}
		if (empty($project) || stristr($project, '.') === FALSE) {
			throw new Util_Dao_Exception('SqlMap init, project it\'s parameter error (null or Incorrect format)');
		}
		$projectMass = explode('.', $project);
		$this->cacheClass = $this->dbname = $projectMass[1];
		/** 判断是否使用多库同map **/
		$this->nameSpace = $sqlMapMid = (count($projectMass) == 3) ? $projectMass[2] : $projectMass[0];
		#组合配置文件地址
		$path = array(
			$this->mapConfig['configPath'], 
			$projectMass[0], 
//			$this->mapConfig['defaultConfig'], 
			'sqlmap-' . $sqlMapMid . '.xml'
		);
		$sqlMapXmlFile = realpath(implode(DIRECTORY_SEPARATOR, $path));
		if ($sqlMapXmlFile == false) {
			throw new Util_Dao_Exception(' configPath not find --> ' . $project . ' <--');
		}
		/** 分析器 **/
		$this->parser = new Util_Dao_SqlMap_ElementParser($sqlMapXmlFile);
		$this->connectCacheTime = time();
	}
	
	/**
	 * 设置数据库连接字符编码
	 * @param unknown_type $charset
	 */
	public function setChar($charset)
	{
	    $this->charset = $charset;
	    return $this;
	}
	
	/**
	 * 
	 * 获取并连接数据库
	 * @param bool $readtag
	 * @return Util_Dao_Db_PdoQuery
	 */
	private function connectDb($readtag = true) {
		if (!isset($this->connectors[$this->dbname . ',' . $readtag])) {
			$this->serverConfig = Util_Dao_Dsn::getDbServer($this->dbname, $readtag,'Mysql',$this->charset);
			$this->connectors[$this->dbname . ',' . $readtag] = new Util_Dao_Db_Driver($this->serverConfig);
		}
		return $this->connectors[$this->dbname . ',' . $readtag];
	}
	
	/**
	 * 获取Db Server 服务器 Map
	 *
	 */
	public function getServerInfo() {
		return $this->serverConfig;
	}
	
	/**
	 * 获取key
	 *
	 * @param variable $key
	 * @return String
	 */
	public function getKey() {
		return $this->sql_map_db_cache_tmp_key;
	}
	
	/**
	 * 组合key
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @param String $act
	 */
	private function _makeKey($sqlId, $parameterMap, $replaceMap, $act) {
		$this->sql_map_db_cache_tmp_key = $this->sql_map_db_cache_key = md5($this->getSql($sqlId, $parameterMap, $replaceMap));
	}
	
	/**
	 * 执行Sql 真对Select 使用 
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @param Util_Dao_Db_PdoQuery $act
	 * @return Util_Dao_Db_PdoQuery
	 */
	private function query($sqlId, $parameterMap, $replaceMap, $act) {
		if ($this->sql_map_db_cache === true) {
			if (!isset($this->dbCacheObj)) {
				$this->initCache();
			}
			if (empty($this->sql_map_db_cache_key)) {
				$this->_makeKey($sqlId, $parameterMap, $replaceMap, $act);
			}
			else {
				$this->sql_map_db_cache_key = $this->sql_map_db_cache_key;
			}
			/** 判定是否获取Tag **/
			$dbCacheVal = '';
			if (!empty($this->tagName)) {
				$dbCacheVal = $this->dbCacheObj->tag($this->tagName)->get($this->sql_map_db_cache_key);
			}
			else {
				$dbCacheVal = $this->dbCacheObj->get($this->sql_map_db_cache_key);
			}
			if (!empty($dbCacheVal)) {
				$this->_resetStatus();
				return $dbCacheVal;
			}
		}
		$this->checkElement($sqlId);
		$this->parser->setReplaceMap($replaceMap);
		$sql = $this->parser->sql($this->nameSpace . '.' . $sqlId);
		$readTag = $this->parser->elementReadTag($this->nameSpace . '.' . $sqlId);
		$dbVal = $this->connectDb($readTag)->stmt($sql, $parameterMap)->$act($this->columnIndex);
		if ($this->sql_map_db_cache === true && $dbVal !== false) {
			if (!empty($this->tagName)) {
				if (!is_string($this->tagName)) {
					throw new Util_Dao_Exception(' When database inquiry Cache tag must establish is String ');
				}
				$this->dbCacheObj->tag($this->tagName)->set($this->sql_map_db_cache_key, $dbVal, $this->sql_map_db_cache_expire);
			}
			else {
				$this->dbCacheObj->set($this->sql_map_db_cache_key, $dbVal, $this->sql_map_db_cache_expire);
			}
		}
		$this->_resetStatus();
		return $dbVal;
	}
	
	/**
	 * 所在位置 用与fetchOne
	 *
	 */
	public function columnIndex($column = 0) {
		$this->columnIndex = intval($column);
		return $this;
	}
	
	/**
	 * 初始化cache
	 *
	 */
	private function initCache() {
		$sqlCacheClass = $this->cacheClass == '' ? self::SQL_CACHE_CLASS : $this->cacheClass;
		$opt = array(
			'domain' => self::SQL_CACHE_DOMAIN, 
			'class' => $sqlCacheClass
		);
		$this->dbCacheObj = Util_Cache::factory($opt);
	}
	
	/**
	 * 返回 Dao cache 对象
	 *
	 * @return Util_Cache_Adapter_Memcache
	 */
	public function cacheObj() {
		$this->initCache();
		return $this->dbCacheObj;
	}
	
	/**
	 * 取回结果集中所有字段的值,作为连续数组返回
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchAll($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 检查节点是否存在
	 *
	 * @param String $sqlId
	 * @return bool
	 */
	private function checkElement($sqlId) {
		$element = $this->parser->element($this->nameSpace . '.' . $sqlId);
		if ($element == NULL) {
			throw new Util_Dao_Exception($sqlId . ' element not find');
		}
		return true;
	}
	
	/**
	 * 取回结果集中所有字段的值,作为关联数组返回  第一个字段作为码
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchAssoc($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 取回所有结果行的第一个字段名
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchCol($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 只取回第一个字段值
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchOne($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 取回一个相关数组,第一个字段值为码
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表

	 * @return Array
	 */
	public function fetchPairs($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 只取回结果集的第一行
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchRow($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 返回第一行  数据使用对象表示 
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchObject($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * 取出所有数据并放入数组中，其中每条数据使用对象表示
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Array
	 */
	public function fetchAllObject($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->query($sqlId, $parameterMap, $replaceMap, __FUNCTION__);
	}
	
	/**
	 * @return Zend_Db_Adapter_Abstract
	 */
	public function zendDB() {
		return $this->connectDb(false)->zendDB();
	}
	
	/**
	 * 开始事务
	 *
	 */
	public function beginTransaction() {
		$this->connectDb(false)->beginTransaction();
	}
	
	/**
	 * 提交事务
	 *
	 */
	public function commit() {
		$this->connectDb(false)->commit();
	}
	
	/**
	 * 回滚事务
	 *
	 */
	public function rollBack() {
		$this->connectDb(false)->rollBack();
	}
	
	public function ping()	{
		$reader = $this->dbname . ',' . true;
		$writer = $this->dbname . ',' . false;
		$this->_resetStatus();
		$this->initCache();
		$lastSeconds = time() - $this->connectCacheTime;
		if(isset($this->connectors[$reader])) {
			$status = $this->connectors[$reader]->isConnected();
			if(!$status || $lastSeconds > $this->connectMaxSeconds) {
				unset($this->connectors[$reader]);
			}
		} else if(isset($this->connectors[$writer])) {
			$status = $this->connectors[$writer]->isConnected();
			if(!$status || $lastSeconds > $this->connectMaxSeconds) {
				unset($this->connectors[$writer]);
			}
		}
	}
	
	/**
	 * 缓存
	 * @param bool $status
	 * @return  Util_Dao_SqlMap_MapQuery
	 */
	public function cache($status = true) {
	    $db_cache = defined('UTIL_DB_CACHE') ?  UTIL_DB_CACHE: true;
	    if(!$db_cache) {
	       return $this;
	    }
		if (is_bool($status) === false) {
			throw new Util_Dao_Exception(' Db Cache status is error ');
		}
		$this->sql_map_db_cache = $status;
		return $this;
	}
	
	/**
	 * 设置缓存时间
	 *
	 * @param integer $expire 秒 
	 * @return  Util_Dao_SqlMap_MapQuery
	 */
	public function expire($expire) {
		$expire = intval($expire);
		if ($expire > 0) {
			$this->sql_map_db_cache_expire = $expire;
		}
		return $this;
	}
	
	/**
	 * 设置cache key
	 *
	 * @param String $key
	 * @return  Util_Dao_SqlMap_MapQuery
	 */
	public function key($key = null, $prefix = null) {
		if (!empty($key)) {
			$this->sql_map_db_cache_key = $key;
		}
		$this->sql_map_db_cache_key_prefix = trim($prefix);
		return $this;
	}
	
	/**
	 * 执行 针对 insert 、 update 、delete 、command
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Util_Dao_Db_PdoQuery
	 */
	private function exec($sqlId, $parameterMap = array(), $replaceMap = null, $act) {
		$this->checkElement($sqlId);
		$this->parser->setReplaceMap($replaceMap);
		$sql = $this->parser->sql($this->nameSpace . '.' . $sqlId);
		#刷新tags 和 删除自己设定的查询key(如果tags和key同时存在 则会删除tags中的key 值),getSql 情况下不使用
		$act != 'getSql' ? $this->delCache() : true;
		return $this->connectDb(false)->stmt($sql, $parameterMap);
	}
	
	/**
	 * 插入信息
	 * 默认返回pdoquery对象
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Util_Dao_Db_FinaleExec
	 */
	public function insert($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->exec($sqlId, $parameterMap, $replaceMap, __FUNCTION__)->insert();
	}
	
	/**
	 * 更新数据
	 * 默认返回pdoquery对象
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Util_Dao_Db_FinaleExec
	 */
	public function update($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->exec($sqlId, $parameterMap, $replaceMap, __FUNCTION__)->update();
	}
	/**
	 * 删除
	 * 默认返回pdoquery对象
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return Util_Dao_Db_FinaleExec
	 */
	public function delete($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->exec($sqlId, $parameterMap, $replaceMap, __FUNCTION__)->delete();
	}
	
	/**
	 * 获取当前执行sql 
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 * @return String
	 */
	public function getSql($sqlId, $parameterMap = array(), $replaceMap = null) {
		return $this->exec($sqlId, $parameterMap, $replaceMap, __FUNCTION__)->getSql();
	}
	
	/**
	 * 执行mysql系统命令
	 *
	 * @param string $sqlId sql定义ID
	 * @param array $parameterMap 参数集
	 * @param array $replaceMap 替换列表
	 */
	public function command($sqlId, $parameterMap = array(), $replaceMap = null) {
		$this->exec($sqlId, $parameterMap, $replaceMap, __FUNCTION__)->command();
	}
	
	/**
	 * 关闭连接
	 *
	 */
	public function close() {
		foreach ($this->connectors as $v) {
			$v->close();
		}
	}
	
	/**
	 * 设置Cache Tag
	 *
	 * @param String $tagName
	 * @return Util_Dao_SqlMap_MapQuery
	 **/
	public function tag($tagName) {
		if (!empty($tagName)) {
			$this->tagName = $tagName;
		}
		return $this;
	}
	
   /**
     * 删除一个或多个tag
     * 
     * ->delTags(array('list','info'))
     * 
     * @param mixed $tags
     * @return Util_Dao_Mysql_SqlMap_MapQuery
     */
    public function delTags( $tags ) {
        if (empty($tags) || !$this->sql_map_db_cache) {
            return $this;
        }
        !isset($this->dbCacheObj) ? $this->initCache() : true;
        $this->dbCacheObj->deleteTag($tags);
        return $this;
    }
    
    /**
     * 删除一个或多个key
     * 
     * ->delKeys(array('list','info'))
     * 
     * @param mixed $keys
     * @return Util_Dao_Mysql_SqlMap_MapQuery
     */
    public function delKeys($keys) {
        if(!empty($this->tagName) && $this->sql_map_db_cache) {
            $this->initCache();
            $this->dbCacheObj->tag($this->tagName)->delete($keys);
        }
        return $this;
    }
    
	/**
	 * 删除Cache 只限于自己设定的key
	 * 
	 **/
	public function delCache() {
	    if(!$this->sql_map_db_cache) {
	       return true;
	    }
		#删除Tag 里面 的 key
		if (!empty($this->sql_map_db_cache_key) && !empty($this->tagName)) {
			$this->delCaches('tag');
		}
		elseif (!empty($this->tagName)) {
			$this->initCache();
			$this->dbCacheObj->deleteTag($this->tagName);
		}
		elseif (!empty($this->sql_map_db_cache_key)) {
			$this->delCaches();
		}
		#重置一些默认值
		$this->_resetStatus();
	}
	
	/**
	 * 删除多个Cache key 和 范围Cache key
	 * 
	 * 例子:1,10 或 a,z
	 *
	 * @param String $act
	 */
	private function delCaches($act = '') {
	    if(!$this->sql_map_db_cache) {
           return true;
        }
		$this->initCache();
		#sql_map_db_cache_key 类型是 数字或字母  Case: 1,10 or a-z
		if (is_string($this->sql_map_db_cache_key) && substr_count($this->sql_map_db_cache_key, ',') == 1) {
			$keyArray = explode(',', $this->sql_map_db_cache_key);
			#验证key是否合法
			$keyRange = range($keyArray[0], $keyArray[1]);
			foreach ($keyRange as $val) {
				$rangeKey = '';
				$rangeKey = empty($this->sql_map_db_cache_key_prefix) ? $val : $this->sql_map_db_cache_key_prefix . $val;
				if ($act == 'tag') {
					$this->dbCacheObj->tag($this->tagName)->delete($rangeKey);
				}
				else {
					$this->dbCacheObj->delete($rangeKey);
				}
			}
		
		#如果是数组的情况下
		}
		elseif (is_array($this->sql_map_db_cache_key)) {
			foreach ($this->sql_map_db_cache_key as $val) {
				if ($act == 'tag') {
					$this->dbCacheObj->tag($this->tagName)->delete($val);
				}
				else {
					$this->dbCacheObj->delete($val);
				}
			}
		
		#是字符的情况下
		}
		elseif (is_string($this->sql_map_db_cache_key)) {
			if ($act == 'tag') {
				$this->dbCacheObj->tag($this->tagName)->delete($this->sql_map_db_cache_key);
			}
			else {
				$this->dbCacheObj->delete($this->sql_map_db_cache_key);
			}
		}
	}
	
	/**
	 * 初始化cache状态
	 *
	 */
	private function _resetStatus() {
		unset($this->sql_map_db_cache_key);
		unset($this->tagName);
		unset($this->sql_map_db_cache_key_prefix);
		$this->sql_map_db_cache = true;
	}
	
	/**
	 * 注销对象
	 *
	 */
	public function __destruct() {
		unset($this->dbCacheObj);
		$this->_resetStatus();
	}
	
	/**
	 * 对参数进行验证和过滤
	 * ' ; 对加入 \
	 *
	 * @param mixed $value
	 * @param mixed $type
	 * @return mixed An SQL-safe quoted value (or string of separated values).
	 */
	public function quote($value, $type = null) {
		if (is_array($value)) {
			foreach ($value as &$val) {
				$val = $this->quote($val, $type);
			}
			return implode(', ', $value);
		}
		return $this->_quote($value);
	}
	
	/**
	 * 转换
	 *
	 * @param string $value     Raw string
	 * @return string           Quoted string
	 */
	private function _quote($value) {
		if (is_int($value)) {
			return $value;
		}
		elseif (is_float($value)) {
			return sprintf('%F', $value);
		}
		return addcslashes($value, "\000\n\r\\'\"\032");
	}
}