'BIGINT', 'number' => 'INTEGER', 'varchar' => 'VARCHAR', 'char' => 'CHAR', 'text' => 'BLOB SUB_TYPE TEXT SEGMENT SIZE 32', 'bigtext' => 'BLOB SUB_TYPE TEXT SEGMENT SIZE 32', 'date' => 'VARCHAR(14)', 'float' => 'FLOAT', ); /** * @brief constructor **/ function DBFireBird() { $this->_setDBInfo(); $this->_connect(); } /** * @brief create an instance of this class */ function create() { return new DBFireBird; } /** * @brief Return if installable **/ function isSupported() { if(!function_exists('ibase_connect')) return false; return true; } /** * @brief DB Connection **/ function __connect($connection) { //if(strpos($this->hostname, ':')===false && $this->port) $this->hostname .= ':'.$this->port; // attempts to connect $host = $connection["db_hostname"]."/".$connection["db_port"].":".$connection["db_database"]; $result = ibase_connect($host, $connection["db_userid"], $connection["db_password"]); if(ibase_errmsg()) { $this->setError(ibase_errcode(), ibase_errmsg()); return; } // Error when Firebird version is lower than 2.0 if (($service = ibase_service_attach($connection["db_hostname"], $connection["db_userid"], $connection["db_password"])) != FALSE) { // get server version and implementation strings $server_info = ibase_server_info($service, IBASE_SVC_SERVER_VERSION); ibase_service_detach($service); } else { $this->setError(ibase_errcode(), ibase_errmsg()); ibase_close($result); return; } $pos = strpos($server_info, "Firebird"); if($pos !== false) { $ver = substr($server_info, $pos+strlen("Firebird")); $ver = trim($ver); } if($ver < "2.0") { $this->setError(-1, "XE cannot be installed under the version of firebird 2.0. Current firebird version is ".$ver); ibase_close($result); return; } return $result; } /** * @brief DB disconnect **/ function _close($connection) { ibase_commit($connection); ibase_close($connection); } /** * @brief handles quatation of the string variables from the query **/ function addQuotes($string) { if(get_magic_quotes_gpc()) $string = stripslashes(str_replace("\\","\\\\",$string)); if(!is_numeric($string)) $string = str_replace("'","''", $string); return $string; } /** * @brief put double quotes for tabls, column names in the query statement **/ function addDoubleQuotes($string) { if($string == "*") return $string; if(strpos($string, "'")!==false) { $string = str_replace("'", "\"", $string); } else if(strpos($string, "\"")!==false) { } else { $string = "\"".$string."\""; } return $string; } /** * @brief put double quotes for tabls, column names in the query statement **/ function autoQuotes($string){ $string = strtolower($string); // for substr function if(strpos($string, "substr(") !== false) { $tokken = strtok($string, "(,)"); $tokken = strtok("(,)"); while($tokken) { $tokkens[] = $tokken; $tokken = strtok("(,)"); } if(count($tokkens) !== 3) return $string; return sprintf("substring(%s from %s for %s)", $this->addDoubleQuotes($tokkens[0]), $tokkens[1], $tokkens[2]); } // as $as = false; if(($no1 = strpos($string," as ")) !== false) { $as = substr($string, $no1, strlen($string)-$no1); $string = substr($string, 0, $no1); $as = str_replace(" as ", "", $as); $as = trim($as); $as = $this->addDoubleQuotes($as); } // for functions $tmpFunc1 = null; $tmpFunc2 = null; if(($no1 = strpos($string,'('))!==false && ($no2 = strpos($string, ')'))!==false) { $tmpFunc1 = substr($string, 0, $no1+1); $tmpFunc2 = substr($string, $no2, strlen($string)-$no2+1); $string = trim(substr($string, $no1+1, $no2-$no1-1)); } // for (table.column) structure preg_match("/((?i)[a-z0-9_-]+)[.]((?i)[a-z0-9_\-\*]+)/", $string, $matches); if($matches) { $string = $this->addDoubleQuotes($matches[1]).".".$this->addDoubleQuotes($matches[2]); } else { $string = $this->addDoubleQuotes($string); } if($tmpFunc1 != null) $string = $tmpFunc1.$string; if($tmpFunc2 != null) $string = $string.$tmpFunc2; if($as !== false) $string = $string." as ".$as; return $string; } function autoValueQuotes($string, $tables){ $tok = strtok($string, ","); while($tok !== false) { $values[] = $tok; $tok = strtok(","); } foreach($values as $val1) { // for (table.column) structure preg_match("/((?i)[a-z0-9_-]+)[.]((?i)[a-z0-9_\-\*]+)/", $val1, $matches); if($matches) { $isTable = false; foreach($tables as $key2 => $val2) { if($key2 == $matches[1]) $isTable = true; if($val2 == $matches[1]) $isTable = true; } if($isTable) { $return[] = $this->addDoubleQuotes($matches[1]).".".$this->addDoubleQuotes($matches[2]); } else { $return[] = $val1; } } else if(!is_numeric($val1)) { if(strpos($val1, "'") !== 0) $return[] = "'".$val1."'"; else $return[] = $val1; } else { $return[] = $val1; } } return implode(",", $return); } /** * @brief Begin transaction **/ function _begin() { return true; } /** * @brief Rollback **/ function _rollback() { $connection = $this->_getConnection('master'); ibase_rollback($connection); return true; } /** * @brief Commits **/ function _commit() { $connection = $this->_getConnection('master'); ibase_commit($connection); return true; } /** * @brief : Run a query and fetch the result * * query: run a query and return the result\n * fetch: NULL if no value returned \n * array object if rows returned \n * object if a row returned \n * return\n **/ function __query($query, $connection, $params = null) { if(count($params) == 0) { // Execute the query statement $result = ibase_query($connection, $query); } else { // Execute the query(for blob type) $query = ibase_prepare($connection, $query); //$fnarr = array_merge(array($query), $params); $result = ibase_execute($query); } // Error Check if(ibase_errmsg()) $this->setError(ibase_errcode(), ibase_errmsg()); return $result; } function _queryInsertUpdateDeleteSelect($query, $params=null, $connection) { if(!$connection) return; if(count($params) == 0) { // Notify to start a query execution $this->actStart($query); // Execute the query statement $trans = ibase_trans(IBASE_DEFAULT,$connection); $result = ibase_query($trans, $query); ibase_commit($trans); unset($trans); } else { // Notify to start a query execution $log = $query."\n\t\t\t"; $log .= implode(",", $params); $this->actStart($log); // Execute the query(for blob type) $query = ibase_prepare($connection, $query); //$fnarr = array_merge(array($query), $params); $result = ibase_execute($query); } // Error Check if(ibase_errmsg()) $this->setError(ibase_errcode(), ibase_errmsg()); // Notify to complete a query execution $this->actFinish(); // Return the result return $result; } function getTableInfo($result){ $coln = ibase_num_fields($result); $column_type = array(); for ($i = 0; $i < $coln; $i++) { $col_info = ibase_field_info($result, $i); if($col_info['name'] === "") $column_type[$col_info['alias']] = $col_info['type']; else $column_type[$col_info['name']] = $col_info['type']; } return $column_type; } /** * @brief Fetch the result **/ function _fetch($result, $output = null) { if(!$this->isConnected() || $this->isError() || !$result) return; $output->column_type = $this->getTableInfo($result); while($tmp = ibase_fetch_object($result)) { foreach($tmp as $key => $val) { $type = $output->column_type[$key]; // type value is null when $key is an alias. so get a type by finding actual coloumn name if($type == null && $output->columns && count($output->columns)) { foreach($output->columns as $cols) { if($cols['alias'] == $key) { // checks if the format is table.column or a regular expression preg_match("/\w+[.](\w+)/", $cols['name'], $matches); if($matches) { $type = $output->column_type[$matches[1]]; } else { $type = $output->column_type[$cols['name']]; } } } } if(($type == "text" || $type == "bigtext" || $type == "BLOB") && $tmp->{$key}) { $blob_data = ibase_blob_info($tmp->{$key}); $blob_hndl = ibase_blob_open($tmp->{$key}); if($blob_data[1] === 1) { $tmp->{$key} = ibase_blob_get($blob_hndl, $blob_data[0]); } else { for ($i = 0; $i < $blob_data[1]; $i++) { $readsize = $blob_data[2]; if ($i == ($blob_data[1] - 1)) { $readsize = $blob_data[0] - (($blob_data[1] - 1) * $blob_data[2]); } $totalimage .= ibase_blob_get($blob_hndl, $readsize); } } ibase_blob_close($blob_hndl); } else if($type == "CHAR") { $tmp->{$key} = trim($tmp->{$key}); // remove blanks generated when DB character set is UTF8 } } $return[] = $tmp; } if(count($return)==1) return $return[0]; return $return; } /** * @brief return sequence value incremented by 1(increase the value of the generator in firebird) **/ function getNextSequence() { //$gen = "GEN_".$this->prefix."sequence_ID"; $gen = 'GEN_XE_SEQUENCE_ID'; $sequence = ibase_gen_id($gen, 1); return $sequence; } /** * @brief returns if the table already exists **/ function isTableExists($target_name) { $query = sprintf("select rdb\$relation_name from rdb\$relations where rdb\$system_flag=0 and rdb\$relation_name = '%s%s';", $this->prefix, $target_name); $result = $this->_query($query); $tmp = $this->_fetch($result); $connection = $this->_getConnection('master'); if(!$tmp) { if(!$this->transaction_started) ibase_rollback($connection); return false; } if(!$this->transaction_started) ibase_commit($connection); return true; } /** * @brief add a column to the table **/ function addColumn($table_name, $column_name, $type='number', $size='', $default = '', $notnull=false) { $type = $this->column_type[$type]; if(strtoupper($type)=='INTEGER') $size = null; else if(strtoupper($type)=='BIGINT') $size = null; else if(strtoupper($type)=='BLOB SUB_TYPE TEXT SEGMENT SIZE 32') $size = null; else if(strtoupper($type)=='VARCHAR' && !$size) $size = 256; $query = sprintf("ALTER TABLE \"%s%s\" ADD \"%s\" ", $this->prefix, $table_name, $column_name); if($size) $query .= sprintf(" %s(%s) ", $type, $size); else $query .= sprintf(" %s ", $type); if(!is_null($default)) $query .= sprintf(" DEFAULT '%s' ", $default); if($notnull) $query .= " NOT NULL "; $this->_query($query); if(!$this->transaction_started) { $connection = $this->_getConnection('master'); ibase_commit($connection); } } /** * @brief drop a column from the table **/ function dropColumn($table_name, $column_name) { $query = sprintf("alter table %s%s drop %s ", $this->prefix, $table_name, $column_name); $this->_query($query); if(!$this->transaction_started) { $connection = $this->_getConnection('master'); ibase_commit($connection); } } /** * @brief return column information of the table **/ function isColumnExists($table_name, $column_name) { $query = sprintf("SELECT RDB\$FIELD_NAME as \"FIELD\" FROM RDB\$RELATION_FIELDS WHERE RDB\$RELATION_NAME = '%s%s'", $this->prefix, $table_name); $result = $this->_query($query); $connection = $this->_getConnection('master'); if($this->isError()) { if(!$this->transaction_started) ibase_rollback($connection); return false; } $output = $this->_fetch($result); if(!$this->transaction_started) ibase_commit($connection); if($output) { $column_name = strtolower($column_name); foreach($output as $key => $val) { $name = trim(strtolower($val->FIELD)); if($column_name == $name) return true; } } return false; } /** * @brief add an index to the table * $target_columns = array(col1, col2) * $is_unique? unique : none **/ function addIndex($table_name, $index_name, $target_columns, $is_unique = false) { // index name size should be limited to 31 byte. no index name assigned // if index name omitted, Firebird automatically assign its name like "RDB $10" // deletes indexes when deleting the table if(!is_array($target_columns)) $target_columns = array($target_columns); $query = sprintf('CREATE %s INDEX "" ON "%s%s" ("%s");', $is_unique?'UNIQUE':'', $this->prefix, $table_name, implode('", "',$target_columns)); $this->_query($query); $connection = $this->_getConnection('master'); if(!$this->transaction_started) ibase_commit($connection); } /** * @brief drop an index from the table **/ function dropIndex($table_name, $index_name, $is_unique = false) { $query = sprintf('DROP INDEX "%s" ON "%s%s"', $index_name, $this->prefix, $table_name); $this->_query($query); $connection = $this->_getConnection('master'); if(!$this->transaction_started) ibase_commit($connection); } /** * @brief return index information of the table **/ function isIndexExists($table_name, $index_name) { $query = "SELECT\n"; $query .= " RDB\$INDICES.rdb\$index_name AS Key_name\n"; $query .= "FROM\n"; $query .= " RDB\$INDICES, rdb\$index_segments\n"; $query .= "WHERE\n"; $query .= " RDB\$INDICES.rdb\$index_name = rdb\$index_segments.rdb\$index_name AND\n"; $query .= " RDB\$INDICES.rdb\$relation_name = '"; $query .= $this->prefix; $query .= $table_name; $query .= "' AND\n"; $query .= " RDB\$INDICES.rdb\$index_name = '"; $query .= $index_name; $query .= "'"; $result = $this->_query($query); if($this->isError()) return; $output = $this->_fetch($result); if(!$output) { $connection = $this->_getConnection('master'); if(!$this->transaction_started) ibase_rollback($connection); return false; } if(!$this->transaction_started) { $connection = $this->_getConnection('master'); ibase_commit($connection); } if(!is_array($output)) $output = array($output); for($i=0;$iKEY_NAME) == $index_name) return true; } return false; } /** * @brief creates a table by using xml file **/ function createTableByXml($xml_doc) { return $this->_createTable($xml_doc); } /** * @brief creates a table by using xml file **/ function createTableByXmlFile($file_name) { if(!file_exists($file_name)) return; // read xml file $buff = FileHandler::readFile($file_name); return $this->_createTable($buff); } /** * @brief create table by using the schema xml * * type : number, varchar, text, char, date, \n * opt : notnull, default, size\n * index : primary key, index, unique\n **/ function _createTable($xml_doc) { // xml parsing $oXml = new XmlParser(); $xml_obj = $oXml->parse($xml_doc); // Create a table schema $table_name = $xml_obj->table->attrs->name; if($this->isTableExists($table_name)) return; $table_name = $this->prefix.$table_name; if(!is_array($xml_obj->table->column)) $columns[] = $xml_obj->table->column; else $columns = $xml_obj->table->column; foreach($columns as $column) { $name = $column->attrs->name; $type = $column->attrs->type; $size = $column->attrs->size; $notnull = $column->attrs->notnull; $primary_key = $column->attrs->primary_key; $index = $column->attrs->index; $unique = $column->attrs->unique; $default = $column->attrs->default; $auto_increment = $column->attrs->auto_increment; if($this->column_type[$type]=='INTEGER') $size = null; else if($this->column_type[$type]=='BIGINT') $size = null; else if($this->column_type[$type]=='BLOB SUB_TYPE TEXT SEGMENT SIZE 32') $size = null; else if($this->column_type[$type]=='VARCHAR' && !$size) $size = 256; $column_schema[] = sprintf('"%s" %s%s %s %s', $name, $this->column_type[$type], $size?'('.$size.')':'', is_null($default)?"":"DEFAULT '".$default."'", $notnull?'NOT NULL':''); if($auto_increment) $auto_increment_list[] = $name; if($primary_key) $primary_list[] = $name; else if($unique) $unique_list[$unique][] = $name; else if($index) $index_list[$index][] = $name; } if(count($primary_list)) { $column_schema[] = sprintf("PRIMARY KEY(\"%s\")%s", implode("\",\"", $primary_list), "\n"); } if(count($unique_list)) { foreach($unique_list as $key => $val) { $column_schema[] = sprintf("UNIQUE(\"%s\")%s", implode("\",\"", $val), "\n"); } } $schema = sprintf("CREATE TABLE \"%s\" (%s%s); \n", $table_name, "\n", implode($column_schema, ",\n")); $output = $this->_query($schema); if(!$this->transaction_started) { $connection = $this->_getConnection('master'); ibase_commit($connection); } if(!$output) return false; if(count($index_list)) { foreach($index_list as $key => $val) { // index name size should be limited to 31 byte. no index name assigned // if index name omitted, Firebird automatically assign its name like "RDB $10" // deletes indexes when deleting the table $schema = sprintf("CREATE INDEX \"\" ON \"%s\" (\"%s\");", $table_name, implode($val, "\",\"")); $output = $this->_query($schema); if(!$this->transaction_started) { $connection = $this->_getConnection('master'); ibase_commit($connection); } if(!$output) return false; } } if($_GLOBALS['XE_EXISTS_SEQUENCE']) return; $schema = 'CREATE GENERATOR GEN_XE_SEQUENCE_ID;'; $output = $this->_query($schema); if(!$this->transaction_started) { $connection = $this->_getConnection('master'); ibase_commit($connection); } if(!$output) return false; $_GLOBALS['XE_EXISTS_SEQUENCE'] = true; /*if($auto_increment_list) foreach($auto_increment_list as $increment) { $schema = sprintf('CREATE GENERATOR GEN_%s_ID;', $table_name); $output = $this->_query($schema); if(!$this->transaction_started) ibase_commit($this->fd); if(!$output) return false;*/ // auto_increment in Firebird creates a generator which activates a trigger when insert occurs // the generator increases the value of the generator and then insert to the table // The trigger below acts like auto_increment however I commented the below because the trigger cannot be defined by a query statement // php api has a function to increase a generator, so // no need to use auto increment in XE /* $schema = 'SET TERM ^ ; '; $schema .= sprintf('CREATE TRIGGER "%s_BI" FOR "%s" ', $table_name, $table_name); $schema .= 'ACTIVE BEFORE INSERT POSITION 0 '; $schema .= sprintf('AS BEGIN IF (NEW."%s" IS NULL) THEN ', $increment); $schema .= sprintf('NEW."%s" = GEN_ID("GEN_%s_ID",1);', $increment, $table_name); $schema .= 'END^ SET TERM ; ^'; $output = $this->_query($schema); if(!$output) return false; */ //} } /** * @brief Handle the insertAct **/ function _executeInsertAct($queryObject) { $query = $this->getInsertSql($queryObject); if(is_a($query, 'Object')) return; return $this->_queryInsertUpdateDeleteSelect($query); } /** * @brief handles updateAct **/ function _executeUpdateAct($queryObject) { $query = $this->getUpdateSql($queryObject); if(is_a($query, 'Object')) return; return $this->_queryInsertUpdateDeleteSelect($query); } /** * @brief handles deleteAct **/ function _executeDeleteAct($queryObject) { $query = $this->getDeleteSql($queryObject); if(is_a($query, 'Object')) return; return $this->_queryInsertUpdateDeleteSelect($query); } /** * @brief Handle selectAct * * In order to get a list of pages easily when selecting \n * it supports a method as navigation **/ function _executeSelectAct($queryObject, $connection) { $query = $this->getSelectSql($queryObject); if(strpos($query, "substr")) { $query = str_replace ("substr", "substring", $query); $query = $this->replaceSubstrFormat($query); } if(is_a($query, 'Object')) return; $query .= (__DEBUG_QUERY__&1 && $queryObject->query_id)?sprintf(' '.$this->comment_syntax,$this->query_id):''; $result = $this->_queryInsertUpdateDeleteSelect ($query, null, $connection); if ($this->isError ()) return $this->queryError($queryObject); else return $this->queryPageLimit($queryObject, $result, $connection); } function queryError($queryObject) { if ($queryObject->getLimit() && $queryObject->getLimit()->isPageHandler()) { $buff = new Object (); $buff->total_count = 0; $buff->total_page = 0; $buff->page = 1; $buff->data = array(); $buff->page_navigation = new PageHandler(/* $total_count */0, /* $total_page */1, /* $page */1, /* $page_count */10); //default page handler values }else return; } function queryPageLimit($queryObject, $result, $connection) { if ($queryObject->getLimit() && $queryObject->getLimit()->isPageHandler()) { // Total count $count_query = sprintf('select count(*) as "count" %s %s', 'FROM ' . $queryObject->getFromString(), ($queryObject->getWhereString() === '' ? '' : ' WHERE ' . $queryObject->getWhereString())); if ($queryObject->getGroupByString() != '') { $count_query = sprintf('select count(*) as "count" from (%s) xet', $count_query); } $count_query .= ( __DEBUG_QUERY__ & 1 && $output->query_id) ? sprintf(' ' . $this->comment_syntax, $this->query_id) : ''; $result_count = $this->_query($count_query, null, $connection); $count_output = $this->_fetch($result_count); $total_count = (int) $count_output->count; $list_count = $queryObject->getLimit()->list_count->getValue(); if (!$list_count) $list_count = 20; $page_count = $queryObject->getLimit()->page_count->getValue(); if (!$page_count) $page_count = 10; $page = $queryObject->getLimit()->page->getValue(); if (!$page) $page = 1; // Total pages if ($total_count) $total_page = (int) (($total_count - 1) / $list_count) + 1; else $total_page = 1; if($page > $total_page) $page = $total_page; $start_count = ($page-1)*$list_count; $query = $this->getSelectSql($queryObject, true, $start_count); if(strpos($query, "substr")) { $query = str_replace ("substr", "substring", $query); $query = $this->replaceSubstrFormat($query); } $query .= (__DEBUG_QUERY__&1 && $queryObject->query_id)?sprintf (' '.$this->comment_syntax, $this->query_id):''; $result = $this->_query ($query, null, $connection); if ($this->isError ()) return $this->queryError($queryObject); $virtual_no = $total_count - ($page - 1) * $list_count; while ($tmp = ibase_fetch_object($result)) $data[$virtual_no--] = $tmp; if (!$this->transaction_started) ibase_commit($connection); $buff = new Object (); $buff->total_count = $total_count; $buff->total_page = $total_page; $buff->page = $page; $buff->data = $data; $buff->page_navigation = new PageHandler($total_count, $total_page, $page, $page_count); }else { $data = $this->_fetch($result); $buff = new Object (); $buff->data = $data; } return $buff; } function getParser() { return new DBParser('"', '"', $this->prefix); } function getSelectSql($query, $with_values = true, $start_count = 0) { if ($query->getLimit() && $query->getLimit()->isPageHandler()) { $list_count = $query->getLimit()->list_count->getValue(); if(!$query->getLimit()->page) $page = 1; else $page = $query->getLimit()->page->getValue(); if(!$start_count) $start_count = ($page - 1) * $list_count; $limit = sprintf('SELECT FIRST %d SKIP %d ', $list_count, $start_count); } $select = $query->getSelectString($with_values); if ($select == '') return new Object(-1, "Invalid query"); if ($query->getLimit() && $query->getLimit()->isPageHandler()) $select = $limit . ' ' . $select; else $select = 'SELECT ' . $select; $from = $query->getFromString($with_values); if ($from == '') return new Object(-1, "Invalid query"); $from = ' FROM ' . $from; $where = $query->getWhereString($with_values); if ($where != '') $where = ' WHERE ' . $where; $groupBy = $query->getGroupByString(); if ($groupBy != '') $groupBy = ' GROUP BY ' . $groupBy; $orderBy = $query->getOrderByString(); if ($orderBy != '') $orderBy = ' ORDER BY ' . $orderBy; return $select . ' ' . $from . ' ' . $where . ' ' . $groupBy . ' ' . $orderBy; } function getDeleteSql($query, $with_values = true){ $sql = 'DELETE '; $from = $query->getFromString($with_values); if($from == '') return new Object(-1, "Invalid query"); $sql .= ' FROM '.$from; $where = $query->getWhereString($with_values); if($where != '') $sql .= ' WHERE ' . $where; return $sql; } function replaceSubstrFormat($queryString){ //replacing substr("string",number,number) with substr("string" from number for number) $pattern = '/substring\("(\w+)",(\d+),(\d+)\)/i'; $replacement = 'substring("${1}" from $2 for $3)'; return preg_replace($pattern, $replacement, $queryString); } } return new DBFireBird; ?>