query($query); } function db_($query='') {} // only for NOT useing ADOdb /** * @return int current connection id */ function link_id() { return $this->Link_ID; } /** * @return int id of current query */ function query_id() { return $this->Query_ID; } /** * Open a connection to a database * * @param string $Database name of database to use (optional) * @param string $Host database host to connect to (optional) * @param string $Port database port to connect to (optional) * @param string $User name of database user (optional) * @param string $Password password for database user (optional) */ function connect($Database = NULL, $Host = NULL, $Port = NULL, $User = NULL, $Password = NULL,$Type = NULL) { /* Handle defaults */ if (!is_null($Database) && $Database) { $this->Database = $Database; } if (!is_null($Host) && $Host) { $this->Host = $Host; } if (!is_null($Port) && $Port) { $this->Port = $Port; } if (!is_null($User) && $User) { $this->User = $User; } if (!is_null($Password) && $Password) { $this->Password = $Password; } if (!is_null($Type) && $Type) { $this->Type = $Type; } elseif (!$this->Type) { $this->Type = $GLOBALS['phpgw_info']['server']['db_type']; } if (!$this->Link_ID) { foreach(array('Host','Database','User','Password') as $name) { $$name = $this->$name; } $type = $this->Type; switch($this->Type) // convert to ADO db-type-names { case 'pgsql': $type = 'postgres'; // create our own pgsql connection-string, to allow unix domain soccets if !$Host $Host = "dbname=$this->Database".($this->Host ? " host=$this->Host".($this->Port ? " port=$this->Port" : '') : ''). " user=$this->User".($this->Password ? " password='".addslashes($this->Password)."'" : ''); $User = $Password = $Database = ''; // to indicate $Host is a connection-string break; case 'mssql': if ($this->Port) $Host .= ','.$this->Port; break; default: if ($this->Port) $Host .= ':'.$this->Port; break; } if (!is_object($GLOBALS['phpgw']->ADOdb) || // we have no connection so far (is_object($GLOBALS['phpgw']->db) && // we connect to a different db, then the global one ($this->Type != $GLOBALS['phpgw']->db->Type || $this->Database != $GLOBALS['phpgw']->db->Database || $this->User != $GLOBALS['phpgw']->db->User || $this->Host != $GLOBALS['phpgw']->db->Host || $this->Port != $GLOBALS['phpgw']->db->Port))) { if (!is_object($GLOBALS['phpgw']->ADOdb)) // use the global object to store the connection { $this->Link_ID = &$GLOBALS['phpgw']->ADOdb; } else { $this->privat_Link_ID = True; // remember that we use a privat Link_ID for disconnect } $this->Link_ID = ADONewConnection($type); if (!$this->Link_ID) { $this->halt("No ADOdb support for '$type' !!!"); return 0; // in case error-reporting = 'no' } $connect = $GLOBALS['phpgw_info']['server']['db_persistent'] ? 'PConnect' : 'Connect'; if (!$this->Link_ID->$connect($Host, $User, $Password, $Database)) { $this->halt("ADOdb::$connect($Host, $User, \$Password, $Database) failed."); return 0; // in case error-reporting = 'no' } //echo "new ADOdb connection
".print_r($GLOBALS['phpgw']->ADOdb,True)."\n"; if ($this->Type == 'mssql') { // this is the format ADOdb expects $this->Link_ID->Execute('SET DATEFORMAT ymd'); // sets the limit to the maximum ini_set('mssql.textlimit',2147483647); ini_set('mssql.sizelimit',2147483647); } } else { $this->Link_ID = &$GLOBALS['phpgw']->ADOdb; } } //echo "
".print_r($this->Link_ID->ServerInfo(),true)."
\n"; return $this->Link_ID; } /** * Close a connection to a database */ function disconnect() { if (!$this->privat_Link_ID) { unset($GLOBALS['phpgw']->ADOdb); } unset($this->Link_ID); $this->Link_ID = 0; } /** * Escape strings before sending them to the database * * @param string $str the string to be escaped * @return string escaped sting */ function db_addslashes($str) { if (!isset($str) || $str == '') { return ''; } if (!$this->Link_ID && !$this->connect()) { return False; } // the substring is needed as the string is already in quotes return substr($this->Link_ID->quote($str),1,-1); } /** * Convert a unix timestamp to a rdms specific timestamp * * @param int unix timestamp * @return string rdms specific timestamp */ function to_timestamp($epoch) { if (!$this->Link_ID && !$this->connect()) { return False; } // the substring is needed as the string is already in quotes return substr($this->Link_ID->DBTimeStamp($epoch),1,-1); } /** * Convert a rdms specific timestamp to a unix timestamp * * @param string rdms specific timestamp * @return int unix timestamp */ function from_timestamp($timestamp) { if (!$this->Link_ID && !$this->connect()) { return False; } return $this->Link_ID->UnixTimeStamp($timestamp); } /** * @deprecated * @see limit_query() */ function limit($start) {} /** * Discard the current query result */ function free() { unset($this->Query_ID); // else copying of the db-object does not work $this->Query_ID = 0; } /** * Execute a query * * @param string $Query_String the query to be executed * @param mixed $line the line method was called from - use __LINE__ * @param string $file the file method was called from - use __FILE__ * @param int $offset row to start from * @param int $num_rows number of rows to return (optional), if unset will use $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs'] * @return int current query id if sucesful and null if fails */ function query($Query_String, $line = '', $file = '', $offset=0, $num_rows=-1) { if ($Query_String == '') { return 0; } if (!$this->Link_ID && !$this->connect()) { return False; } # New query, discard previous result. if ($this->Query_ID) { $this->free(); } if ($this->Link_ID->fetchMode != ADODB_FETCH_BOTH) { $this->Link_ID->SetFetchMode(ADODB_FETCH_BOTH); } if (! $num_rows) { $num_rows = $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs']; } if ($num_rows > 0) { $this->Query_ID = $this->Link_ID->SelectLimit($Query_String,$num_rows,(int)$offset); } else { $this->Query_ID = $this->Link_ID->Execute($Query_String); } $this->Row = 0; $this->Errno = $this->Link_ID->ErrorNo(); $this->Error = $this->Link_ID->ErrorMsg(); if (! $this->Query_ID) { $this->halt("Invalid SQL: ".$Query_String, $line, $file); } return $this->Query_ID; } /** * Execute a query with limited result set * * @param string $Query_String the query to be executed * @param int $offset row to start from * @param mixed $line the line method was called from - use __LINE__ * @param string $file the file method was called from - use __FILE__ * @param int $num_rows number of rows to return (optional), if unset will use $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs'] * @return int current query id if sucesful and null if fails */ function limit_query($Query_String, $offset, $line = '', $file = '', $num_rows = '') { return $this->query($Query_String,$line,$file,$offset,$num_rows); } /** * Move to the next row in the results set * * @return bool was another row found? */ function next_record() { if (!$this->Query_ID) { $this->halt('next_record called with no query pending.'); return 0; } if ($this->Row) // first row is already fetched { $this->Query_ID->MoveNext(); } ++$this->Row; $this->Record = $this->Query_ID->fields; if ($this->Query_ID->EOF || !$this->Query_ID->RecordCount() || !is_array($this->Record)) { return False; } if ($this->Type == 'sapdb') { foreach($this->Record as $column => $value) { // add a lowercase version $this->Record[strtolower($column)] = $value; // add a numeric version $this->Record[] = $value; } } return True; } /** * Move to position in result set * * @param int $pos required row (optional), default first row * @return int 1 if sucessful or 0 if not found */ function seek($pos = 0) { if (!$this->Query_ID || !$this->Query_ID->Move($this->Row = $pos)) { $this->halt("seek($pos) failed: resultset has " . $this->num_rows() . " rows"); $this->Query_ID->Move( $this->num_rows() ); $this->Row = $this->num_rows(); return False; } return True; } /** * Begin Transaction * * @return int current transaction id */ function transaction_begin() { if (!$this->Link_ID && !$this->connect()) { return False; } //return $this->Link_ID->BeginTrans(); return $this->Link_ID->StartTrans(); } /** * Complete the transaction * * @return bool True if sucessful, False if fails */ function transaction_commit() { if (!$this->Link_ID && !$this->connect()) { return False; } //return $this->Link_ID->CommitTrans(); return $this->Link_ID->CompleteTrans(); } /** * Rollback the current transaction * * @return bool True if sucessful, False if fails */ function transaction_abort() { if (!$this->Link_ID && !$this->connect()) { return False; } //return $this->Link_ID->RollbackTrans(); return $this->Link_ID->FailTrans(); } /** * Find the primary key of the last insertion on the current db connection * * @param string $table name of table the insert was performed on * @param string $field the autoincrement primary key of the table * @return int the id, -1 if fails */ function get_last_insert_id($table, $field) { if (!$this->Link_ID && !$this->connect()) { return False; } //$id = $this->Link_ID->PO_Insert_ID($table,$field); $id = $this->Link_ID->PO_Insert_ID($table,$field); // simulates Insert_ID with "SELECT MAX($field) FROM $table" if not native availible if ($id === False) // function not supported { echo "db::get_last_insert_id(table='$table',field='$field') not yet implemented for db-type '$this->Type'
\n"; return -1; } return $id; } /** * Lock a table * * @param string $table name of table to lock * @param string $mode type of lock required (optional), default write * @return bool True if sucessful, False if fails */ function lock($table, $mode='write') {} /** * Unlock a table * * @return bool True if sucessful, False if fails */ function unlock() {} /** * Get the number of rows affected by last update * * @return int number of rows */ function affected_rows() { if (!$this->Link_ID && !$this->connect()) { return False; } return $this->Link_ID->Affected_Rows(); } /** * Number of rows in current result set * * @return int number of rows */ function num_rows() { return $this->Query_ID ? $this->Query_ID->RecordCount() : False; } /** * Number of fields in current row * * @return int number of fields */ function num_fields() { return $this->Query_ID ? $this->Query_ID->FieldCount() : False; } /** * short hand for @see num_rows() */ function nf() { return $this->num_rows(); } /** * short hand for print @see num_rows */ function np() { print $this->num_rows(); } /** * Return the value of a column * * @param string/integer $Name name of field or positional index starting from 0 * @param bool $strip_slashes string escape chars from field(optional), default false * @return string the field value */ function f($Name, $strip_slashes = False) { if ($strip_slashes || ($this->auto_stripslashes && ! $strip_slashes)) { return stripslashes($this->Record[$Name]); } else { return $this->Record[$Name]; } } /** * Print the value of a field * * @param string $Name name of field to print * @param bool $strip_slashes string escape chars from field(optional), default false */ function p($Name, $strip_slashes = True) { print $this->f($Name, $strip_slashes); } /** * Returns a query-result-row as an associative array (no numerical keys !!!) * * @param bool $do_next_record should next_record() be called or not (default not) * @return array/bool the associative array or False if no (more) result-row is availible */ function row($do_next_record=False) { if ($do_next_record && !$this->next_record() || !is_array($this->Record)) { return False; } $result = array(); foreach($this->Record as $column => $value) { if (!is_numeric($column)) { if ($this->Type == 'sapdb') $column = strtolower($column); $result[$column] = $value; } } return $result; } /** * Get the id for the next sequence - not implemented! * * This seems not to be used anywhere in eGroupWhere !!! * * @param string $seq_name name of the sequence * @return int sequence id */ function nextid($seq_name) { echo "db::nextid(sequence='$seq_name') not yet implemented
\n"; } /** * Error handler * * @param string $msg error message * @param int $line line of calling method/function (optional) * @param string $file file of calling method/function (optional) */ function halt($msg, $line = '', $file = '') { if ($this->Link_ID) // only if we have a link, else infinite loop { $this->Error = $this->Link_ID->ErrorMsg(); // need to be BEFORE unlock, $this->Errno = $this->Link_ID->ErrorNo(); // else we get its error or none $this->unlock(); /* Just in case there is a table currently locked */ } if ($this->Halt_On_Error == "no") { return; } $this->haltmsg($msg); if ($file) { printf("Session halted."; if (is_object($GLOBALS['phpgw']->common)) { $GLOBALS['phpgw']->common->phpgw_exit(True); } else // happens eg. in setup { exit(); } } } function haltmsg($msg) { printf("
Database error: %s
\n", $msg);
if (($this->Errno || $this->Error) && $this->Error != "()")
{
printf("$this->Type Error: %s (%s)
\n",$this->Errno,$this->Error);
}
}
/**
* Get description of a table
*
* Beside the column-name all other data depends on the db-type !!!
*
* @param string $table name of table to describe
* @param bool $full optional, default False summary information, True full information
* @return array table meta data
*/
function metadata($table='',$full=false)
{
if (!$this->Link_ID && !$this->connect())
{
return False;
}
$columns = $this->Link_ID->MetaColumns($table);
//$columns = $this->Link_ID->MetaColumnsSQL($table);
//echo "metadata('$table')=
\n".print_r($columns,True)."\n"; $metadata = array(); $i = 0; foreach($columns as $column) { // for backwards compatibilty (depreciated) unset($flags); if($column->auto_increment) $flags .= "auto_increment "; if($column->primary_key) $flags .= "primary_key "; if($column->binary) $flags .= "binary "; // _debug_array($column); $metadata[$i] = array( 'table' => $table, 'name' => $column->name, 'type' => $column->type, 'len' => $column->max_length, 'flags' => $flags, // for backwards compatibilty (depreciated) used by JiNN atm 'not_null' => $column->not_null, 'auto_increment' => $column->auto_increment, 'primary_key' => $column->primary_key, 'binary' => $column->binary, 'has_default' => $column->has_default, 'default' => $column->default_value, ); $metadata[$i]['table'] = $table; if ($full) { $metadata['meta'][$column->name] = $i; } ++$i; } if ($full) { $metadata['num_fields'] = $i; } return $metadata; } /** * Get a list of table names in the current database * * @return array list of the tables */ function table_names() { if (!$this->Link_ID && !$this->connect()) { return False; } $result = array(); $tables = $this->Link_ID->MetaTables('TABLES'); if (is_array($tables)) { foreach($tables as $table) { if ($this->Type == 'sapdb') { $table = strtolower($table); } $result[] = array( 'table_name' => $table, 'tablespace_name' => $this->Database, 'database' => $this->Database ); } } return $result; } /** * Return a list of indexes in current database * * @return array list of indexes */ function index_names() { $indices = array(); if ($this->Type != 'pgsql') { echo "
db::index_names() not yet implemented for db-type '$this->Type'
\n"; return $indices; } $this->query("SELECT relname FROM pg_class WHERE NOT relname ~ 'pg_.*' AND relkind ='i' ORDER BY relname"); while ($this->next_record()) { $indices[] = array( 'index_name' => $this->f(0), 'tablespace_name' => $this->Database, 'database' => $this->Database, ); } return $indices; } /** * Returns an array containing column names that are the primary keys of $tablename. * * @return array of columns */ function pkey_columns($tablename) { if (!$this->Link_ID && !$this->connect()) { return False; } return $this->Link_ID->MetaPrimaryKeys($tablename); } /** * Create a new database * * @param string $adminname name of database administrator user (optional) * @param string $adminpasswd password for the database administrator user (optional) */ function create_database($adminname = '', $adminpasswd = '') { $currentUser = $this->User; $currentPassword = $this->Password; $currentDatabase = $this->Database; $extra = array(); switch ($this->Type) { case 'pgsql': $meta_db = 'template1'; break; case 'mysql': $meta_db = 'mysql'; $extra[] = "grant all on $currentDatabase.* to $currentUser@localhost identified by '$currentPassword'"; break; default: echo "db::create_database(user='$adminname',\$pw) not yet implemented for DB-type '$this->Type'
\n"; break; } if ($adminname != '') { $this->User = $adminname; $this->Password = $adminpasswd; $this->Database = $meta_db; } $this->disconnect(); $this->query("CREATE DATABASE $currentDatabase"); foreach($extra as $sql) { $this->query($sql); } $this->disconnect(); $this->User = $currentUser; $this->Password = $currentPassword; $this->Database = $currentDatabase; $this->connect(); } /** * concat a variable number of strings together, to be used in a query * * Example: $db->concat($db->quote('Hallo '),'username') would return * for mysql "concat('Hallo ',username)" or "'Hallo ' || username" for postgres * @param $str1 string already quoted stringliteral or column-name, variable number of arguments * @return string to be used in a query */ function concat($str1) { $args = func_get_args(); if (!$this->Link_ID && !$this->connect()) { return False; } return call_user_func_array(array(&$this->Link_ID,'concat'),$args); } /** * Correctly Quote Identifiers like table- or colmnnames for use in SQL-statements * * This is mostly copy & paste from adodb's datadict class * @param $name string * @return string quoted string */ function name_quote($name = NULL) { if (!is_string($name)) { return FALSE; } $name = trim($name); if (!$this->Link_ID && !$this->connect()) { return False; } $quote = $this->Link_ID->nameQuote; // if name is of the form `name`, quote it if ( preg_match('/^`(.+)`$/', $name, $matches) ) { return $quote . $matches[1] . $quote; } // if name contains special characters, quote it if ( preg_match('/\W/', $name) ) { return $quote . $name . $quote; } return $name; } /** * Escape values before sending them to the database - prevents SQL injunction and SQL errors ;-) * * Please note that the quote function already returns necessary quotes: quote('Hello') === "'Hello'". * Int and Auto types are casted to int: quote('1','int') === 1, quote('','int') === 0, quote('Hello','int') === 0 * * @param $value mixed the value to be escaped * @param $type string the type of the db-column, default False === varchar * @return string escaped sting */ function quote($value,$type=False) { if ($this->Debug) echo "db::quote('$value','$type')
\n"; switch($type) { case 'int': case 'auto': return (int) $value; } if (!$this->Link_ID && !$this->connect()) { return False; } switch($type) { case 'blob': if ($this->Type == 'mysql') { break; // ADOdb has no BlobEncode for mysql and returns an unquoted string !!! } return "'" . $this->Link_ID->BlobEncode($value) . "'"; case 'date': return $this->Link_ID->DBDate($value); case 'timestamp': return $this->Link_ID->DBTimeStamp($value); } return $this->Link_ID->quote($value); } /** * Implodes an array of column-value pairs for the use in sql-querys. * All data is run through quote (does either addslashes() or (int)) - prevents SQL injunction and SQL errors ;-). * * @author RalfBeckerdb::column_data_implode('$glue',".print_r($array,True).",'$use_key',".print_r($only,True).",
".print_r($column_definitions,True)."\n"; $keys = $values = array(); foreach($array as $key => $data) { if (!$only || $only === True && isset($column_definitions[$key]) || is_array($only) && in_array($key,$only)) { $keys[] = $this->name_quote($key); $column_type = is_array($column_definitions) ? @$column_definitions[$key]['type'] : False; if (is_array($data)) { foreach($data as $k => $v) { $data[$k] = $this->quote($v,$column_type); } $values[] = ($use_key===True ? $key.' IN ' : '') . '('.implode(',',$data).')'; } elseif (is_int($key) && $use_key===True) { $values[] = $data; } else { $values[] = ($use_key===True ? $this->name_quote($key) . '=' : '') . $this->quote($data,$column_type); } } } return ($use_key==='VALUES' ? '('.implode(',',$keys).') VALUES (' : ''). implode($glue,$values) . ($use_key==='VALUES' ? ')' : ''); } /** * Sets the default column-definitions for use with column_data_implode() * * @author RalfBecker
db::insert('$table',".print_r($data,True).",".print_r($where,True).",$line,$file,'$app')
\n"; $table_def = $this->get_table_definitions($app,$table); $sql_append = ''; if (is_array($where) && count($where)) { if ($this->Type == 'sapdb') { $sql_append = ' UPDATE DUPLICATES'; } else { $this->select($table,'count(*)',$where,$line,$file); if ($this->next_record() && $this->f(0)) { return $this->update($table,$data,$where,$line,$file,$app); } } $data = array_merge($where,$data); // the checked values need to be inserted too, value in data has precedence } $sql = "INSERT INTO $table ".$this->column_data_implode(',',$data,'VALUES',False,$table_def['fd']).$sql_append; return $this->query($sql,$line,$file); } /** * Updates the data of one or more rows in a table, all data is quoted according to it's type * * @author RalfBeckerdb::expression($table,
".print_r(func_get_args(),True).") ='$sql'\n"; return $sql; } /** * Selects one or more rows in table depending on where, all data is quoted according to it's type * * @author RalfBecker
db::select('$table',".print_r($cols,True).",".print_r($where,True).",$line,$file,$offset,'$app')
\n"; $table_def = $this->get_table_definitions($app,$table); if (is_array($cols)) { $cols = implode(',',$cols); } if (is_array($where)) { $where = $this->column_data_implode(' AND ',$where,True,False,$table_def['fd']); } $sql = "SELECT $cols FROM $table WHERE ".($where ? $where : '1=1'); if ($this->Debug) echo "sql='$sql'
"; return $this->query($sql,$line,$file,$offset,$offset===False ? -1 : 0); } }