From d4760bb15c447d2c288c77f0a8fbed8d25564a47 Mon Sep 17 00:00:00 2001 From: Ralf Becker Date: Sun, 19 Jun 2005 12:43:00 +0000 Subject: [PATCH] renamed our db-class to egw_db to allow easier integration of other code (eg. Lars SyncML stuff which is partially from horde) --- phpgwapi/inc/class.db.inc.php | 1473 +-------------------------- phpgwapi/inc/class.egw_db.inc.php | 1539 +++++++++++++++++++++++++++++ phpgwapi/inc/functions.inc.php | 63 +- setup/inc/class.setup.inc.php | 2 +- 4 files changed, 1572 insertions(+), 1505 deletions(-) create mode 100644 phpgwapi/inc/class.egw_db.inc.php diff --git a/phpgwapi/inc/class.db.inc.php b/phpgwapi/inc/class.db.inc.php index 333eeef8db..32edaa0106 100644 --- a/phpgwapi/inc/class.db.inc.php +++ b/phpgwapi/inc/class.db.inc.php @@ -10,10 +10,12 @@ /* $Id$ */ + require_once(EGW_API_INC.'/class.egw_db.inc.php'); + /* * Database abstraction library * - * This allows eGroupWare to use multiple database backends via ADOdb 4.20 + * This is only for compatibility with old code, the DB class is now called egw_db. * * @package phpgwapi * @subpackage db @@ -21,1473 +23,6 @@ * @license LGPL */ - // some constanst for pre php4.3 - if (!defined('PHP_SHLIB_SUFFIX')) + class db extends egw_db { - define('PHP_SHLIB_SUFFIX',strtoupper(substr(PHP_OS, 0,3)) == 'WIN' ? 'dll' : 'so'); - } - if (!defined('PHP_SHLIB_PREFIX')) - { - define('PHP_SHLIB_PREFIX',PHP_SHLIB_SUFFIX == 'dll' ? 'php_' : ''); - } - if(empty($GLOBALS['phpgw_info']['server']['db_type'])) - { - $GLOBALS['phpgw_info']['server']['db_type'] = 'mysql'; - } - include_once(PHPGW_API_INC.'/adodb/adodb.inc.php'); - - class db - { - /** - * @var string $type database type - */ - var $Type = ''; - - /** - * @var string $Host database host to connect to - */ - var $Host = ''; - - /** - * @var string $Port port number of database to connect to - */ - var $Port = ''; - - /** - * @var string $Database name of database to use - */ - var $Database = ''; - - /** - * @var string $User name of database user - */ - var $User = ''; - - /** - * @var string $Password password for database user - */ - var $Password = ''; - - /** - * @var bool $auto_stripslashes automatically remove slashes when returning field values - default False - */ - var $auto_stripslashes = False; - - /** - * @var int $Auto_Free automatically free results - 0 no, 1 yes - */ - var $Auto_Free = 0; - - /** - * @var int $Debug enable debuging - 0 no, 1 yes - */ - var $Debug = 0; - - /** - * @var string $Halt_On_Error "yes" (halt with message), "no" (ignore errors quietly), "report" (ignore errror, but spit a warning) - */ - var $Halt_On_Error = 'no';//'yes'; - - /** - * @var string $Seq_Table table for storing sequences ???? - */ - var $Seq_Table = 'db_sequence'; - - /** - * @var array $Record current record - */ - var $Record = array(); - - /** - * @var int row number for current record - */ - var $Row; - - /** - * @var int $Errno internal rdms error number for last error - */ - var $Errno = 0; - - /** - * @var string descriptive text from last error - */ - var $Error = ''; - - //i am not documenting private vars - skwashd :) - var $xmlrpc = False; - var $soap = False; - var $Link_ID = 0; - var $privat_Link_ID = False; // do we use a privat Link_ID or a reference to the global ADOdb object - var $Query_ID = 0; - - var $prepared_sql = array(); // sql is the index - - /** - * @param string $query query to be executed (optional) - */ - - function db($query = '') - { - $this->query($query); - } - - /** - * @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; - } - $php_extension = $type = $this->Type; - - switch($this->Type) // convert to ADO db-type-names - { - case 'pgsql': - $type = 'postgres'; // name in ADOdb - // 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 'odbc_mssql': - $php_extension = 'odbc'; - $this->Type = 'mssql'; - // fall through - case 'mssql': - if ($this->Port) $Host .= ','.$this->Port; - break; - - case 'odbc_oracle': - $php_extension = 'odbc'; - $this->Type = 'oracle'; - break; - case 'oracle': - $php_extension = $type = 'oci8'; - break; - - case 'sapdb': - $this->Type = 'maxdb'; - // fall through - case 'maxdb': - $type ='sapdb'; // name in ADOdb - $php_extension = 'odbc'; - 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 (!extension_loaded($php_extension) && (!function_exists('dl') || - !dl(PHP_SHLIB_PREFIX.$php_extension.'.'.PHP_SHLIB_SUFFIX))) - { - $this->halt("Necessary php database support for $this->Type (".PHP_SHLIB_PREFIX.$php_extension.'.'.PHP_SHLIB_SUFFIX.") not loaded and can't be loaded, exiting !!!"); - return 0; // in case error-reporting = 'no' - } - 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' ($this->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' - } - if ($this->Debug) - { - echo function_backtrace(); - echo "

new ADOdb connection to $this->Type://$this->Host/$this->Database: Link_ID".($this->Link_ID === $GLOBALS['egw']->ADOdb ? '===' : '!==')."\$GLOBALS[egw]->ADOdb

"; - //echo "

".print_r($this->Link_ID->ServerInfo(),true)."

\n"; - _debug_array($this); - echo "\$GLOBALS[egw]->db="; _debug_array($GLOBALS[egw]->db); - } - 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; - } - return $this->Link_ID->addq($str); - } - - /** - * 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); - } - - /** - * 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 int $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, default 0 - * @param int $num_rows number of rows to return (optional), default -1 = all, 0 will use $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs'] - * @param array/boolean $inputarr array for binding variables to parameters or false (default) - * @return ADORecordSet or false, if the query fails - */ - function query($Query_String, $line = '', $file = '', $offset=0, $num_rows=-1,$inputarr=false) - { - 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,$inputarr); - } - else - { - $this->Query_ID = $this->Link_ID->Execute($Query_String,$inputarr); - } - $this->Row = 0; - $this->Errno = $this->Link_ID->ErrorNo(); - $this->Error = $this->Link_ID->ErrorMsg(); - - if (! $this->Query_ID) - { - $this->halt("Invalid SQL: ".(is_array($Query_String)?$Query_String[0]:$Query_String). - ($inputarr ? "
Parameters: '".implode("','",$inputarr)."'":''), - $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, default 0 - * @param int $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), default -1 = all, 0 will use $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs'] - * @param array/boolean $inputarr array for binding variables to parameters or false (default) - * @return ADORecordSet or false, if the query fails - */ - function limit_query($Query_String, $offset, $line = '', $file = '', $num_rows = '',$inputarr=false) - { - return $this->query($Query_String,$line,$file,$offset,$num_rows,$inputarr); - } - - /** - * Move to the next row in the results set - * - * Specifying a fetch_mode only works for newly fetched rows, the first row always gets fetched by query!!! - * - * @param int $fetch_mode ADODB_FETCH_BOTH = numerical+assoc keys (eGW default), ADODB_FETCH_ASSOC or ADODB_FETCH_NUM - * @return bool was another row found? - */ - function next_record($fetch_mode=ADODB_FETCH_BOTH) - { - if (!$this->Query_ID) - { - $this->halt('next_record called with no query pending.'); - return 0; - } - if ($this->Link_ID->fetchMode != $fetch_mode) - { - $this->Link_ID->SetFetchMode($fetch_mode); - } - 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; - } - switch ($this->Type) - { - case 'sapdb': - case 'maxdb': - case 'oracle': - foreach($this->Record as $column => $value) - { - // add a lowercase version - $this->Record[strtolower($column)] = $value; - // add a numeric version - $this->Record[] = $value; - } - if (!function_exists('array_change_key_case')) - { - define('CASE_LOWER',0); - define('CASE_UPPER',1); - function array_change_key_case($arr,$mode=CASE_LOWER) - { - foreach($arr as $key => $val) - { - $changed[$mode == CASE_LOWER ? strtolower($key) : strtoupper($key)] = $val; - } - return $changed; - } - } - switch($fetch_mode) - { - case ADODB_FETCH_ASSOC: - $this->Record = array_change_key_case($this->Record); - break; - case ADODB_FETCH_NUM: - $this->Record = array_values($this->Record); - break; - default: - $this->Record = array_change_key_case($this->Record); - $this->Record += array_values($this->Record); - break; - } - break; - } - return True; - } - - /** - * Move to position in result set - * - * @param int $pos required row (optional), default first row - * @return boolean true if sucessful or false 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/boolean current transaction-id, of false if no connection - */ - 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' OR no insert operation before

\n"; - function_backtrace(); - 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) - * @param string $strip string to strip of the column-name, default '' - * @return array/bool the associative array or False if no (more) result-row is availible - */ - function row($do_next_record=False,$strip='') - { - if ($do_next_record && !$this->next_record(ADODB_FETCH_ASSOC) || !is_array($this->Record)) - { - return False; - } - $result = array(); - foreach($this->Record as $column => $value) - { - if (!is_numeric($column)) - { - if ($strip) $column = str_replace($strip,'',$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("
File: %s",$file); - } - if ($line) - { - printf("
Line: %s",$line); - } - printf("
Function: %s\n",function_backtrace(2)); - - if ($this->Halt_On_Error != "report") - { - echo "

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) - { - switch ($this->Type) - { - case 'sapdb': - case 'maxdb': - case 'oracle': - $table = strtolower($table); - break; - } - $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 string $str1 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 mixed $value the value to be escaped - * @param string/boolean $type string the type of the db-column, default False === varchar - * @param boolean $not_null is column NOT NULL, default true, else php null values are written as SQL NULL - * @return string escaped sting - */ - function quote($value,$type=False,$not_null=true) - { - if ($this->Debug) echo "

db::quote(".(is_null($value)?'NULL':"'$value'").",'$type','$not_null')

\n"; - - if (!$not_null && is_null($value)) // writing unset php-variables and those set to NULL now as SQL NULL - { - return 'NULL'; - } - switch($type) - { - case 'int': - case 'auto': - return (int) $value; - } - if (!$this->Link_ID && !$this->connect()) - { - return False; - } - switch($type) - { - case 'blob': - switch ($this->Link_ID->blobEncodeType) - { - case 'C': // eg. postgres - return "'" . $this->Link_ID->BlobEncode($value) . "'"; - case 'I': - return $this->Link_ID->BlobEncode($value); - } - break; // handled like strings - case 'date': - return $this->Link_ID->DBDate($value); - case 'timestamp': - return $this->Link_ID->DBTimeStamp($value); - } - return $this->Link_ID->qstr($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 RalfBeckeroutdoor-training.de - * - * @param string $glue in most cases this will be either ',' or ' AND ', depending you your query - * @param array $array column-name / value pairs, if the value is an array all its array-values will be quoted - * according to the type of the column, and the whole array with be formatted like (val1,val2,...) - * If $use_key == True, an ' IN ' instead a '=' is used. Good for category- or user-lists. - * If the key is numerical (no key given in the array-definition) the value is used as is, eg. - * array('visits=visits+1') gives just "visits=visits+1" (no quoting at all !!!) - * @param boolean/string $use_key If $use_key===True a "$key=" prefix each value (default), typically set to False - * or 'VALUES' for insert querys, on 'VALUES' "(key1,key2,...) VALUES (val1,val2,...)" is returned - * @param array/boolean $only if set to an array only colums which are set (as data !!!) are written - * typicaly used to form a WHERE-clause from the primary keys. - * If set to True, only columns from the colum_definitons are written. - * @param array/boolean $column_definitions this can be set to the column-definitions-array - * of your table ($tables_baseline[$table]['fd'] of the setup/tables_current.inc.php file). - * If its set, the column-type-data determinates if (int) or addslashes is used. - * @return string SQL - */ - function column_data_implode($glue,$array,$use_key=True,$only=False,$column_definitions=False) - { - if (!is_array($array)) // this allows to give an SQL-string for delete or update - { - return $array; - } - if (!$column_definitions) - { - $column_definitions = $this->column_definitions; - } - if ($this->Debug) echo "

db::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); - - if (!is_int($key) && is_array($column_definitions) && !isset($column_definitions[$key])) - { - // give a warning that we have no column-type - $this->halt("db::column_data_implode('$glue',".print_r($array,True).",'$use_key',".print_r($only,True).",
".print_r($column_definitions,True)."
nothing known about column '$key'!"); - } - $column_type = is_array($column_definitions) ? @$column_definitions[$key]['type'] : False; - $not_null = is_array($column_definitions) && isset($column_definitions[$key]['nullable']) ? !$column_definitions[$key]['nullable'] : false; - - if (is_array($data)) - { - $or_null = ''; - foreach($data as $k => $v) - { - if (!$not_null && $use_key===True && is_null($v)) - { - $or_null = ' OR '.$this->name_quote($key).' IS NULL)'; - unset($data[$k]); - continue; - } - $data[$k] = $this->quote($v,$column_type,$not_null); - } - $values[] = ($or_null?'(':'').(!count($data) ? '' : ($use_key===True ? - $this->name_quote($key).' IN ' : '') . '('.implode(',',$data).')').$or_null; - } - elseif (is_int($key) && $use_key===True) - { - $values[] = $data; - } - elseif ($glue != ',' && $use_key === True && !$not_null && is_null($data)) - { - $values[] = $this->name_quote($key) .' IS NULL'; - } - else - { - $values[] = ($use_key===True ? $this->name_quote($key) . '=' : '') . $this->quote($data,$column_type,$not_null); - } - } - } - 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 RalfBeckeroutdoor-training.de - * - * @param array/boolean $column_definitions this can be set to the column-definitions-array - * of your table ($tables_baseline[$table]['fd'] of the setup/tables_current.inc.php file). - * If its set, the column-type-data determinates if (int) or addslashes is used. - */ - function set_column_definitions($column_definitions=False) - { - $this->column_definitions=$column_definitions; - } - - /** - * Sets the application in which the db-class looks for table-defintions - * - * Used by table_definitions, insert, update, select, expression and delete. If the app is not set via set_app, - * it need to be set for these functions on every call - * - * @param string $app the app-name - */ - function set_app($app) - { - $this->app = $app; - } - - /** - * reads the table-definitions from the app's setup/tables_current.inc.php file - * - * The already read table-definitions are shared between all db-instances via $GLOBALS['phpgw_info']['apps'][$app]['table_defs'] - * - * @author RalfBeckeroutdoor-training.de - * - * @param bool/string $app name of the app or default False to use the app set by db::set_app or the current app - * @param bool/string $table if set return only defintions of that table, else return all defintions - * @return mixed array with table-defintions or False if file not found - */ - function get_table_definitions($app=False,$table=False) - { - if (!$app) - { - $app = $this->app ? $this->app : $GLOBALS['phpgw_info']['flags']['currentapp']; - } - if (isset($GLOBALS['phpgw_info']['apps'])) // dont set it, if it does not exist!!! - { - $this->app_data = &$GLOBALS['phpgw_info']['apps'][$app]; - } - // this happens during the eGW startup or in setup - else - { - $this->app_data =& $this->all_app_data[$app]; - } - if (!isset($this->app_data['table_defs'])) - { - $tables_current = PHPGW_INCLUDE_ROOT . "/$app/setup/tables_current.inc.php"; - if (!@file_exists($tables_current)) - { - return $this->app_data['table_defs'] = False; - } - include($tables_current); - $this->app_data['table_defs'] = &$phpgw_baseline; - } - if ($table && (!$this->app_data['table_defs'] || !isset($this->app_data['table_defs'][$table]))) - { - return False; - } - return $table ? $this->app_data['table_defs'][$table] : $this->app_data['table_defs']; - } - - /** - * Insert a row of data into a table or updates it if $where is given, all data is quoted according to it's type - * - * @author RalfBeckeroutdoor-training.de - * - * @param string $table name of the table - * @param array $data with column-name / value pairs - * @param mixed $where string with where clause or array with column-name / values pairs to check if a row with that keys already exists, or false for an unconditional insert - * if the row exists db::update is called else a new row with $date merged with $where gets inserted (data has precedence) - * @param int $line line-number to pass to query - * @param string $file file-name to pass to query - * @param string/boolean $app string with name of app or False to use the current-app - * @return ADORecordSet or false, if the query fails - */ - function insert($table,$data,$where,$line,$file,$app=False,$use_prepared_statement=false) - { - if ($this->Debug) echo "

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 = ''; - $cmd = 'INSERT'; - if (is_array($where) && count($where)) - { - switch($this->Type) - { - case 'sapdb': case 'maxdb': - $sql_append = ' UPDATE DUPLICATES'; - break; - case 'mysql': - // use replace if primary keys are included - if (count(array_intersect(array_keys($where),(array)$table_def['pk'])) == count($table_def['pk'])) - { - $cmd = 'REPLACE'; - break; - } - // fall through !!! - default: - $this->select($table,'count(*)',$where,$line,$file); - if ($this->next_record() && $this->f(0)) - { - return !!$this->update($table,$data,$where,$line,$file,$app); - } - break; - } - $data = array_merge($where,$data); // the checked values need to be inserted too, value in data has precedence - } - $inputarr = false; - if ($use_prepared_statement && $this->Link_ID->_bindInputArray) // eg. MaxDB - { - $this->Link_ID->Param(false); // reset param-counter - $cols = array_keys($data); - foreach($cols as $col) - { - $params[] = $this->Link_ID->Param($col); - } - $sql = "$cmd INTO $table (".implode(',',$cols).') VALUES ('.implode(',',$params).')'.$sql_append; - // check if we already prepared that statement - if (!isset($this->prepared_sql[$sql])) - { - $this->prepared_sql[$sql] = $this->Link_ID->Prepare($sql); - } - $sql = $this->prepared_sql[$sql]; - $inputarr = &$data; - } - else - { - $sql = "$cmd INTO $table ".$this->column_data_implode(',',$data,'VALUES',False,$table_def['fd']).$sql_append; - } - if ($this->Debug) echo "

db::insert('$table',".print_r($data,True).",".print_r($where,True).",$line,$file,'$app') sql='$sql'

\n"; - return $this->query($sql,$line,$file,0,-1,$inputarr); - } - - /** - * Updates the data of one or more rows in a table, all data is quoted according to it's type - * - * @author RalfBeckeroutdoor-training.de - * - * @param string $table name of the table - * @param array $data with column-name / value pairs - * @param array $where column-name / values pairs and'ed together for the where clause - * @param int $line line-number to pass to query - * @param string $file file-name to pass to query - * @param string/boolean $app string with name of app or False to use the current-app - * @return ADORecordSet or false, if the query fails - */ - function update($table,$data,$where,$line,$file,$app=False,$use_prepared_statement=false) - { - if ($this->Debug) echo "

db::update('$table',".print_r($data,true).','.print_r($where,true).",$line,$file,'$app')

\n"; - $table_def = $this->get_table_definitions($app,$table); - - $blobs2update = array(); - // SapDB/MaxDB cant update LONG columns / blob's: if a blob-column is included in the update we remember it in $blobs2update - // and remove it from $data - switch ($this->Type) - { - case 'sapdb': - case 'maxdb': - if ($use_prepared_statement) break; - // check if data contains any LONG columns - foreach($data as $col => $val) - { - switch ($table_def['fd'][$col]['type']) - { - case 'text': - case 'longtext': - case 'blob': - $blobs2update[$col] = &$data[$col]; - unset($data[$col]); - break; - } - } - break; - } - $where = $this->column_data_implode(' AND ',$where,True,False,$table_def['fd']); - - if (count($data)) - { - $inputarr = false; - if ($use_prepared_statement && $this->Link_ID->_bindInputArray) // eg. MaxDB - { - $this->Link_ID->Param(false); // reset param-counter - foreach($data as $col => $val) - { - $params[] = $this->name_quote($col).'='.$this->Link_ID->Param($col); - } - $sql = "UPDATE $table SET ".implode(',',$params).' WHERE '.$where; - // check if we already prepared that statement - if (!isset($this->prepared_sql[$sql])) - { - $this->prepared_sql[$sql] = $this->Link_ID->Prepare($sql); - } - $sql = $this->prepared_sql[$sql]; - $inputarr = &$data; - } - else - { - $sql = "UPDATE $table SET ". - $this->column_data_implode(',',$data,True,False,$table_def['fd']).' WHERE '.$where; - } - $ret = $this->query($sql,$line,$file,0,-1,$inputarr); - if ($this->Debug) echo "

db::query('$sql',$line,$file) = '$ret'

\n"; - } - // if we have any blobs to update, we do so now - if (($ret || !count($data)) && count($blobs2update)) - { - foreach($blobs2update as $col => $val) - { - $ret = $this->Link_ID->UpdateBlob($table,$col,$val,$where,$table_def['fd'][$col]['type'] == 'blob' ? 'BLOB' : 'CLOB'); - if ($this->Debug) echo "

adodb::UpdateBlob('$table','$col','$val','$where') = '$ret'

\n"; - if (!$ret) $this->halt("Error in UpdateBlob($table,$col,\$val,$where)",$line,$file); - } - } - return $ret; - } - - /** - * Deletes one or more rows in table, all data is quoted according to it's type - * - * @author RalfBeckeroutdoor-training.de - * - * @param string $table name of the table - * @param array $where column-name / values pairs and'ed together for the where clause - * @param int $line line-number to pass to query - * @param string $file file-name to pass to query - * @param string/boolean $app string with name of app or False to use the current-app - * @return ADORecordSet or false, if the query fails - */ - function delete($table,$where,$line,$file,$app=False) - { - $table_def = $this->get_table_definitions($app,$table); - $sql = "DELETE FROM $table WHERE ". - $this->column_data_implode(' AND ',$where,True,False,$table_def['fd']); - - return $this->query($sql,$line,$file); - } - - /** - * Formats and quotes a sql expression to be used eg. as where-clause - * - * The function has a variable number of arguments, from which the expession gets constructed - * eg. db::expression('my_table','(',array('name'=>"test'ed",'lang'=>'en'),') OR ',array('owner'=>array('',4,10))) - * gives "(name='test\'ed' AND lang='en') OR 'owner' IN (0,4,5,6,10)" if name,lang are strings and owner is an integer - * @param $table string name of the table - * @param $args mixed variable number of arguments of the following types: - * string: get's as is into the result - * array: column-name / value pairs: the value gets quoted according to the type of the column and prefixed - * with column-name=, multiple pairs are AND'ed together, see db::column_data_implode - * bool: If False or is_null($arg): the next 2 (!) arguments gets ignored - * @return string the expression generated from the arguments - */ - function expression($table,$args) - { - $table_def = $this->get_table_definitions($app,$table); - $sql = ''; - $ignore_next = 0; - foreach(func_get_args() as $n => $arg) - { - if ($n < 1) continue; // table-name - - if ($ignore_next) - { - --$ignore_next; - continue; - } - if (is_null($arg)) $arg = False; - - switch(gettype($arg)) - { - case 'string': - $sql .= $arg; - break; - case 'boolean': - $ignore_next += !$arg ? 2 : 0; - break; - case 'array': - $sql .= $this->column_data_implode(' AND ',$arg,True,False,$table_def['fd']); - break; - } - } - if ($this->Debug) echo "

db::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 RalfBeckeroutdoor-training.de - * - * @param string $table name of the table - * @param array/string $cols string or array of column-names / select-expressions - * @param array/string $where string or array with column-name / values pairs AND'ed together for the where clause - * @param int $line line-number to pass to query - * @param string $file file-name to pass to query - * @param int/bool $offset offset for a limited query or False (default) - * @param string $append string to append to the end of the query, eg. ORDER BY ... - * @param string/boolean $app string with name of app or False to use the current-app - * @param int $num_rows number of rows to return if offset set, default 0 = use default in user prefs - * @param string $join=null sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or - * "LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join! - * @return ADORecordSet or false, if the query fails - */ - function select($table,$cols,$where,$line,$file,$offset=False,$append='',$app=False,$num_rows=0,$join='') - { - if ($this->Debug) echo "

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 $join"; - - // if we have a where clause, we need to add it together with the WHERE statement, if thats not in the join - if ($where) $sql .= strstr($join,"WHERE") ? ' AND ('.$where.')' : ' WHERE '.$where; - - if ($append) $sql .= ' '.$append; - - if ($this->Debug) echo "

sql='$sql'

"; - - return $this->query($sql,$line,$file,$offset,$offset===False ? -1 : (int)$num_rows); - } } diff --git a/phpgwapi/inc/class.egw_db.inc.php b/phpgwapi/inc/class.egw_db.inc.php new file mode 100644 index 0000000000..f0c6dbe3df --- /dev/null +++ b/phpgwapi/inc/class.egw_db.inc.php @@ -0,0 +1,1539 @@ + true, // will be set to false for mysql < 4.1 + 'distinct_on_text' => true, // is the DB able to use DISTINCT with a text or blob column + ); + + var $prepared_sql = array(); // sql is the index + + /** + * @param string $query query to be executed (optional) + */ + + function db($query = '') + { + $this->query($query); + } + + /** + * @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['egw_info']['server']['db_type']; + } + + if (!$this->Link_ID) + { + foreach(array('Host','Database','User','Password') as $name) + { + $$name = $this->$name; + } + $php_extension = $type = $this->Type; + + switch($this->Type) // convert to ADO db-type-names + { + case 'pgsql': + $type = 'postgres'; // name in ADOdb + // 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 'odbc_mssql': + $php_extension = 'odbc'; + $this->Type = 'mssql'; + // fall through + case 'mssql': + if ($this->Port) $Host .= ','.$this->Port; + break; + + case 'odbc_oracle': + $php_extension = 'odbc'; + $this->Type = 'oracle'; + break; + case 'oracle': + $php_extension = $type = 'oci8'; + break; + + case 'sapdb': + $this->Type = 'maxdb'; + // fall through + case 'maxdb': + $type ='sapdb'; // name in ADOdb + $php_extension = 'odbc'; + break; + + default: + if ($this->Port) $Host .= ':'.$this->Port; + break; + } + if (!is_object($GLOBALS['egw']->ADOdb) || // we have no connection so far + (is_object($GLOBALS['egw']->db) && // we connect to a different db, then the global one + ($this->Type != $GLOBALS['egw']->db->Type || + $this->Database != $GLOBALS['egw']->db->Database || + $this->User != $GLOBALS['egw']->db->User || + $this->Host != $GLOBALS['egw']->db->Host || + $this->Port != $GLOBALS['egw']->db->Port))) + { + if (!extension_loaded($php_extension) && (!function_exists('dl') || + !dl(PHP_SHLIB_PREFIX.$php_extension.'.'.PHP_SHLIB_SUFFIX))) + { + $this->halt("Necessary php database support for $this->Type (".PHP_SHLIB_PREFIX.$php_extension.'.'.PHP_SHLIB_SUFFIX.") not loaded and can't be loaded, exiting !!!"); + return 0; // in case error-reporting = 'no' + } + if (!is_object($GLOBALS['egw']->ADOdb)) // use the global object to store the connection + { + $this->Link_ID = &$GLOBALS['egw']->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' ($this->Type) !!!"); + return 0; // in case error-reporting = 'no' + } + $connect = $GLOBALS['egw_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' + } + if ($this->Debug) + { + echo function_backtrace(); + echo "

new ADOdb connection to $this->Type://$this->Host/$this->Database: Link_ID".($this->Link_ID === $GLOBALS['egw']->ADOdb ? '===' : '!==')."\$GLOBALS[egw]->ADOdb

"; + //echo "

".print_r($this->Link_ID->ServerInfo(),true)."

\n"; + _debug_array($this); + echo "\$GLOBALS[egw]->db="; _debug_array($GLOBALS[egw]->db); + } + $this->ServerInfo = $this->Link_ID->ServerInfo(); + $this->set_capabilities($type,$this->ServerInfo['version']); + + 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['egw']->ADOdb; + } + } + //echo "

".print_r($this->Link_ID->ServerInfo(),true)."

\n"; + return $this->Link_ID; + } + + /** + * changes defaults set in class-var $capabilities depending on db-type and -version + * + * @param string $ado_driver mysql, postgres, mssql, sapdb, oci8 + * @param string $db_version version-number of connected db-server, as reported by ServerInfo + */ + function set_capabilities($adodb_driver,$db_version) + { + switch($adodb_driver) + { + case 'mysql': + $this->capabilities['sub_queries'] = $db_version >= 4.1; + break; + + case 'mssql': + $this->capabilities['distinct_on_text'] = false; + break; + + case 'maxdb': // if Lim ever changes it to maxdb ;-) + case 'sapdb': + $this->capabilities['distinct_on_text'] = false; + break; + } + //echo "db::set_capabilities('$adodb_driver',$db_version)"; _debug_array($this->capabilities); + } + + /** + * Close a connection to a database + */ + function disconnect() + { + if (!$this->privat_Link_ID) + { + unset($GLOBALS['egw']->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; + } + return $this->Link_ID->addq($str); + } + + /** + * 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); + } + + /** + * 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 int $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, default 0 + * @param int $num_rows number of rows to return (optional), default -1 = all, 0 will use $GLOBALS['egw_info']['user']['preferences']['common']['maxmatchs'] + * @param array/boolean $inputarr array for binding variables to parameters or false (default) + * @return ADORecordSet or false, if the query fails + */ + function query($Query_String, $line = '', $file = '', $offset=0, $num_rows=-1,$inputarr=false) + { + 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['egw_info']['user']['preferences']['common']['maxmatchs']; + } + if ($num_rows > 0) + { + $this->Query_ID = $this->Link_ID->SelectLimit($Query_String,$num_rows,(int)$offset,$inputarr); + } + else + { + $this->Query_ID = $this->Link_ID->Execute($Query_String,$inputarr); + } + $this->Row = 0; + $this->Errno = $this->Link_ID->ErrorNo(); + $this->Error = $this->Link_ID->ErrorMsg(); + + if (! $this->Query_ID) + { + $this->halt("Invalid SQL: ".(is_array($Query_String)?$Query_String[0]:$Query_String). + ($inputarr ? "
Parameters: '".implode("','",$inputarr)."'":''), + $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, default 0 + * @param int $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), default -1 = all, 0 will use $GLOBALS['egw_info']['user']['preferences']['common']['maxmatchs'] + * @param array/boolean $inputarr array for binding variables to parameters or false (default) + * @return ADORecordSet or false, if the query fails + */ + function limit_query($Query_String, $offset, $line = '', $file = '', $num_rows = '',$inputarr=false) + { + return $this->query($Query_String,$line,$file,$offset,$num_rows,$inputarr); + } + + /** + * Move to the next row in the results set + * + * Specifying a fetch_mode only works for newly fetched rows, the first row always gets fetched by query!!! + * + * @param int $fetch_mode ADODB_FETCH_BOTH = numerical+assoc keys (eGW default), ADODB_FETCH_ASSOC or ADODB_FETCH_NUM + * @return bool was another row found? + */ + function next_record($fetch_mode=ADODB_FETCH_BOTH) + { + if (!$this->Query_ID) + { + $this->halt('next_record called with no query pending.'); + return 0; + } + if ($this->Link_ID->fetchMode != $fetch_mode) + { + $this->Link_ID->SetFetchMode($fetch_mode); + } + 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; + } + switch ($this->Type) + { + case 'sapdb': + case 'maxdb': + case 'oracle': + foreach($this->Record as $column => $value) + { + // add a lowercase version + $this->Record[strtolower($column)] = $value; + // add a numeric version + $this->Record[] = $value; + } + if (!function_exists('array_change_key_case')) + { + define('CASE_LOWER',0); + define('CASE_UPPER',1); + function array_change_key_case($arr,$mode=CASE_LOWER) + { + foreach($arr as $key => $val) + { + $changed[$mode == CASE_LOWER ? strtolower($key) : strtoupper($key)] = $val; + } + return $changed; + } + } + switch($fetch_mode) + { + case ADODB_FETCH_ASSOC: + $this->Record = array_change_key_case($this->Record); + break; + case ADODB_FETCH_NUM: + $this->Record = array_values($this->Record); + break; + default: + $this->Record = array_change_key_case($this->Record); + $this->Record += array_values($this->Record); + break; + } + break; + } + return True; + } + + /** + * Move to position in result set + * + * @param int $pos required row (optional), default first row + * @return boolean true if sucessful or false 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/boolean current transaction-id, of false if no connection + */ + 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' OR no insert operation before

\n"; + function_backtrace(); + 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) + * @param string $strip string to strip of the column-name, default '' + * @return array/bool the associative array or False if no (more) result-row is availible + */ + function row($do_next_record=False,$strip='') + { + if ($do_next_record && !$this->next_record(ADODB_FETCH_ASSOC) || !is_array($this->Record)) + { + return False; + } + $result = array(); + foreach($this->Record as $column => $value) + { + if (!is_numeric($column)) + { + if ($strip) $column = str_replace($strip,'',$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("
File: %s",$file); + } + if ($line) + { + printf("
Line: %s",$line); + } + printf("
Function: %s\n",function_backtrace(2)); + + if ($this->Halt_On_Error != "report") + { + echo "

Session halted."; + if (is_object($GLOBALS['egw']->common)) + { + $GLOBALS['egw']->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) + { + switch ($this->Type) + { + case 'sapdb': + case 'maxdb': + case 'oracle': + $table = strtolower($table); + break; + } + $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 string $str1 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 mixed $value the value to be escaped + * @param string/boolean $type string the type of the db-column, default False === varchar + * @param boolean $not_null is column NOT NULL, default true, else php null values are written as SQL NULL + * @return string escaped sting + */ + function quote($value,$type=False,$not_null=true) + { + if ($this->Debug) echo "

db::quote(".(is_null($value)?'NULL':"'$value'").",'$type','$not_null')

\n"; + + if (!$not_null && is_null($value)) // writing unset php-variables and those set to NULL now as SQL NULL + { + return 'NULL'; + } + switch($type) + { + case 'int': + case 'auto': + return (int) $value; + case 'bool': + return $value ? 1 : 0; + } + if (!$this->Link_ID && !$this->connect()) + { + return False; + } + switch($type) + { + case 'blob': + switch ($this->Link_ID->blobEncodeType) + { + case 'C': // eg. postgres + return "'" . $this->Link_ID->BlobEncode($value) . "'"; + case 'I': + return $this->Link_ID->BlobEncode($value); + } + break; // handled like strings + case 'date': + return $this->Link_ID->DBDate($value); + case 'timestamp': + return $this->Link_ID->DBTimeStamp($value); + } + return $this->Link_ID->qstr($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 RalfBeckeroutdoor-training.de + * + * @param string $glue in most cases this will be either ',' or ' AND ', depending you your query + * @param array $array column-name / value pairs, if the value is an array all its array-values will be quoted + * according to the type of the column, and the whole array with be formatted like (val1,val2,...) + * If $use_key == True, an ' IN ' instead a '=' is used. Good for category- or user-lists. + * If the key is numerical (no key given in the array-definition) the value is used as is, eg. + * array('visits=visits+1') gives just "visits=visits+1" (no quoting at all !!!) + * @param boolean/string $use_key If $use_key===True a "$key=" prefix each value (default), typically set to False + * or 'VALUES' for insert querys, on 'VALUES' "(key1,key2,...) VALUES (val1,val2,...)" is returned + * @param array/boolean $only if set to an array only colums which are set (as data !!!) are written + * typicaly used to form a WHERE-clause from the primary keys. + * If set to True, only columns from the colum_definitons are written. + * @param array/boolean $column_definitions this can be set to the column-definitions-array + * of your table ($tables_baseline[$table]['fd'] of the setup/tables_current.inc.php file). + * If its set, the column-type-data determinates if (int) or addslashes is used. + * @return string SQL + */ + function column_data_implode($glue,$array,$use_key=True,$only=False,$column_definitions=False) + { + if (!is_array($array)) // this allows to give an SQL-string for delete or update + { + return $array; + } + if (!$column_definitions) + { + $column_definitions = $this->column_definitions; + } + if ($this->Debug) echo "

db::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); + + if (!is_int($key) && is_array($column_definitions) && !isset($column_definitions[$key])) + { + // give a warning that we have no column-type + $this->halt("db::column_data_implode('$glue',".print_r($array,True).",'$use_key',".print_r($only,True).",
".print_r($column_definitions,True)."
nothing known about column '$key'!"); + } + $column_type = is_array($column_definitions) ? @$column_definitions[$key]['type'] : False; + $not_null = is_array($column_definitions) && isset($column_definitions[$key]['nullable']) ? !$column_definitions[$key]['nullable'] : false; + + if (is_array($data)) + { + $or_null = ''; + foreach($data as $k => $v) + { + if (!$not_null && $use_key===True && is_null($v)) + { + $or_null = $this->name_quote($key).' IS NULL)'; + unset($data[$k]); + continue; + } + $data[$k] = $this->quote($v,$column_type,$not_null); + } + $values[] = ($or_null?'(':'').(!count($data) ? '' : + ($use_key===True ? $this->name_quote($key).' IN ' : '') . + '('.implode(',',$data).')'.($or_null ? ' OR ' : '')).$or_null; + } + elseif (is_int($key) && $use_key===True) + { + $values[] = $data; + } + elseif ($glue != ',' && $use_key === True && !$not_null && is_null($data)) + { + $values[] = $this->name_quote($key) .' IS NULL'; + } + else + { + $values[] = ($use_key===True ? $this->name_quote($key) . '=' : '') . $this->quote($data,$column_type,$not_null); + } + } + } + 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 RalfBeckeroutdoor-training.de + * + * @param array/boolean $column_definitions this can be set to the column-definitions-array + * of your table ($tables_baseline[$table]['fd'] of the setup/tables_current.inc.php file). + * If its set, the column-type-data determinates if (int) or addslashes is used. + */ + function set_column_definitions($column_definitions=False) + { + $this->column_definitions=$column_definitions; + } + + /** + * Sets the application in which the db-class looks for table-defintions + * + * Used by table_definitions, insert, update, select, expression and delete. If the app is not set via set_app, + * it need to be set for these functions on every call + * + * @param string $app the app-name + */ + function set_app($app) + { + $this->app = $app; + } + + /** + * reads the table-definitions from the app's setup/tables_current.inc.php file + * + * The already read table-definitions are shared between all db-instances via $GLOBALS['egw_info']['apps'][$app]['table_defs'] + * + * @author RalfBeckeroutdoor-training.de + * + * @param bool/string $app name of the app or default False to use the app set by db::set_app or the current app + * @param bool/string $table if set return only defintions of that table, else return all defintions + * @return mixed array with table-defintions or False if file not found + */ + function get_table_definitions($app=False,$table=False) + { + if (!$app) + { + $app = $this->app ? $this->app : $GLOBALS['egw_info']['flags']['currentapp']; + } + if (isset($GLOBALS['egw_info']['apps'])) // dont set it, if it does not exist!!! + { + $this->app_data = &$GLOBALS['egw_info']['apps'][$app]; + } + // this happens during the eGW startup or in setup + else + { + $this->app_data =& $this->all_app_data[$app]; + } + if (!isset($this->app_data['table_defs'])) + { + $tables_current = EGW_INCLUDE_ROOT . "/$app/setup/tables_current.inc.php"; + if (!@file_exists($tables_current)) + { + return $this->app_data['table_defs'] = False; + } + include($tables_current); + $this->app_data['table_defs'] = &$phpgw_baseline; + } + if ($table && (!$this->app_data['table_defs'] || !isset($this->app_data['table_defs'][$table]))) + { + return False; + } + return $table ? $this->app_data['table_defs'][$table] : $this->app_data['table_defs']; + } + + /** + * Insert a row of data into a table or updates it if $where is given, all data is quoted according to it's type + * + * @author RalfBeckeroutdoor-training.de + * + * @param string $table name of the table + * @param array $data with column-name / value pairs + * @param mixed $where string with where clause or array with column-name / values pairs to check if a row with that keys already exists, or false for an unconditional insert + * if the row exists db::update is called else a new row with $date merged with $where gets inserted (data has precedence) + * @param int $line line-number to pass to query + * @param string $file file-name to pass to query + * @param string/boolean $app string with name of app or False to use the current-app + * @return ADORecordSet or false, if the query fails + */ + function insert($table,$data,$where,$line,$file,$app=False,$use_prepared_statement=false) + { + if ($this->Debug) echo "

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 = ''; + $cmd = 'INSERT'; + if (is_array($where) && count($where)) + { + switch($this->Type) + { + case 'sapdb': case 'maxdb': + $sql_append = ' UPDATE DUPLICATES'; + break; + case 'mysql': + // use replace if primary keys are included + if (count(array_intersect(array_keys($where),(array)$table_def['pk'])) == count($table_def['pk'])) + { + $cmd = 'REPLACE'; + break; + } + // fall through !!! + default: + $this->select($table,'count(*)',$where,$line,$file); + if ($this->next_record() && $this->f(0)) + { + return !!$this->update($table,$data,$where,$line,$file,$app); + } + break; + } + $data = array_merge($where,$data); // the checked values need to be inserted too, value in data has precedence + } + $inputarr = false; + if ($use_prepared_statement && $this->Link_ID->_bindInputArray) // eg. MaxDB + { + $this->Link_ID->Param(false); // reset param-counter + $cols = array_keys($data); + foreach($cols as $k => $col) + { + if (!isset($table_def['fd'][$col])) // ignore columns not in this table + { + unset($cols[$k]); + continue; + } + $params[] = $this->Link_ID->Param($col); + } + $sql = "$cmd INTO $table (".implode(',',$cols).') VALUES ('.implode(',',$params).')'.$sql_append; + // check if we already prepared that statement + if (!isset($this->prepared_sql[$sql])) + { + $this->prepared_sql[$sql] = $this->Link_ID->Prepare($sql); + } + $sql = $this->prepared_sql[$sql]; + $inputarr = &$data; + } + else + { + $sql = "$cmd INTO $table ".$this->column_data_implode(',',$data,'VALUES',true,$table_def['fd']).$sql_append; + } + if ($this->Debug) echo "

db::insert('$table',".print_r($data,True).",".print_r($where,True).",$line,$file,'$app') sql='$sql'

\n"; + return $this->query($sql,$line,$file,0,-1,$inputarr); + } + + /** + * Updates the data of one or more rows in a table, all data is quoted according to it's type + * + * @author RalfBeckeroutdoor-training.de + * + * @param string $table name of the table + * @param array $data with column-name / value pairs + * @param array $where column-name / values pairs and'ed together for the where clause + * @param int $line line-number to pass to query + * @param string $file file-name to pass to query + * @param string/boolean $app string with name of app or False to use the current-app + * @return ADORecordSet or false, if the query fails + */ + function update($table,$data,$where,$line,$file,$app=False,$use_prepared_statement=false) + { + if ($this->Debug) echo "

db::update('$table',".print_r($data,true).','.print_r($where,true).",$line,$file,'$app')

\n"; + $table_def = $this->get_table_definitions($app,$table); + + $blobs2update = array(); + // SapDB/MaxDB cant update LONG columns / blob's: if a blob-column is included in the update we remember it in $blobs2update + // and remove it from $data + switch ($this->Type) + { + case 'sapdb': + case 'maxdb': + if ($use_prepared_statement) break; + // check if data contains any LONG columns + foreach($data as $col => $val) + { + switch ($table_def['fd'][$col]['type']) + { + case 'text': + case 'longtext': + case 'blob': + $blobs2update[$col] = &$data[$col]; + unset($data[$col]); + break; + } + } + break; + } + $where = $this->column_data_implode(' AND ',$where,True,true,$table_def['fd']); + + if (count($data)) + { + $inputarr = false; + if ($use_prepared_statement && $this->Link_ID->_bindInputArray) // eg. MaxDB + { + $this->Link_ID->Param(false); // reset param-counter + foreach($data as $col => $val) + { + if (!isset($table_def['fd'][$col])) continue; // ignore columns not in this table + $params[] = $this->name_quote($col).'='.$this->Link_ID->Param($col); + } + $sql = "UPDATE $table SET ".implode(',',$params).' WHERE '.$where; + // check if we already prepared that statement + if (!isset($this->prepared_sql[$sql])) + { + $this->prepared_sql[$sql] = $this->Link_ID->Prepare($sql); + } + $sql = $this->prepared_sql[$sql]; + $inputarr = &$data; + } + else + { + $sql = "UPDATE $table SET ". + $this->column_data_implode(',',$data,True,true,$table_def['fd']).' WHERE '.$where; + } + $ret = $this->query($sql,$line,$file,0,-1,$inputarr); + if ($this->Debug) echo "

db::query('$sql',$line,$file) = '$ret'

\n"; + } + // if we have any blobs to update, we do so now + if (($ret || !count($data)) && count($blobs2update)) + { + foreach($blobs2update as $col => $val) + { + $ret = $this->Link_ID->UpdateBlob($table,$col,$val,$where,$table_def['fd'][$col]['type'] == 'blob' ? 'BLOB' : 'CLOB'); + if ($this->Debug) echo "

adodb::UpdateBlob('$table','$col','$val','$where') = '$ret'

\n"; + if (!$ret) $this->halt("Error in UpdateBlob($table,$col,\$val,$where)",$line,$file); + } + } + return $ret; + } + + /** + * Deletes one or more rows in table, all data is quoted according to it's type + * + * @author RalfBeckeroutdoor-training.de + * + * @param string $table name of the table + * @param array $where column-name / values pairs and'ed together for the where clause + * @param int $line line-number to pass to query + * @param string $file file-name to pass to query + * @param string/boolean $app string with name of app or False to use the current-app + * @return ADORecordSet or false, if the query fails + */ + function delete($table,$where,$line,$file,$app=False) + { + $table_def = $this->get_table_definitions($app,$table); + $sql = "DELETE FROM $table WHERE ". + $this->column_data_implode(' AND ',$where,True,False,$table_def['fd']); + + return $this->query($sql,$line,$file); + } + + /** + * Formats and quotes a sql expression to be used eg. as where-clause + * + * The function has a variable number of arguments, from which the expession gets constructed + * eg. db::expression('my_table','(',array('name'=>"test'ed",'lang'=>'en'),') OR ',array('owner'=>array('',4,10))) + * gives "(name='test\'ed' AND lang='en') OR 'owner' IN (0,4,5,6,10)" if name,lang are strings and owner is an integer + * @param $table string name of the table + * @param $args mixed variable number of arguments of the following types: + * string: get's as is into the result + * array: column-name / value pairs: the value gets quoted according to the type of the column and prefixed + * with column-name=, multiple pairs are AND'ed together, see db::column_data_implode + * bool: If False or is_null($arg): the next 2 (!) arguments gets ignored + * @return string the expression generated from the arguments + */ + function expression($table,$args) + { + $table_def = $this->get_table_definitions($app,$table); + $sql = ''; + $ignore_next = 0; + foreach(func_get_args() as $n => $arg) + { + if ($n < 1) continue; // table-name + + if ($ignore_next) + { + --$ignore_next; + continue; + } + if (is_null($arg)) $arg = False; + + switch(gettype($arg)) + { + case 'string': + $sql .= $arg; + break; + case 'boolean': + $ignore_next += !$arg ? 2 : 0; + break; + case 'array': + $sql .= $this->column_data_implode(' AND ',$arg,True,False,$table_def['fd']); + break; + } + } + if ($this->Debug) echo "

db::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 RalfBeckeroutdoor-training.de + * + * @param string $table name of the table + * @param array/string $cols string or array of column-names / select-expressions + * @param array/string $where string or array with column-name / values pairs AND'ed together for the where clause + * @param int $line line-number to pass to query + * @param string $file file-name to pass to query + * @param int/bool $offset offset for a limited query or False (default) + * @param string $append string to append to the end of the query, eg. ORDER BY ... + * @param string/boolean $app string with name of app or False to use the current-app + * @param int $num_rows number of rows to return if offset set, default 0 = use default in user prefs + * @param string $join=null sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or + * "LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join! + * @return ADORecordSet or false, if the query fails + */ + function select($table,$cols,$where,$line,$file,$offset=False,$append='',$app=False,$num_rows=0,$join='') + { + if ($this->Debug) echo "

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 $join"; + + // if we have a where clause, we need to add it together with the WHERE statement, if thats not in the join + if ($where) $sql .= strstr($join,"WHERE") ? ' AND ('.$where.')' : ' WHERE '.$where; + + if ($append) $sql .= ' '.$append; + + if ($this->Debug) echo "

sql='$sql'

"; + + return $this->query($sql,$line,$file,$offset,$offset===False ? -1 : (int)$num_rows); + } + } diff --git a/phpgwapi/inc/functions.inc.php b/phpgwapi/inc/functions.inc.php index 01a84fb010..cc754d3005 100644 --- a/phpgwapi/inc/functions.inc.php +++ b/phpgwapi/inc/functions.inc.php @@ -37,7 +37,9 @@ exit; } - include(PHPGW_API_INC.'/common_functions.inc.php'); + if (!defined('EGW_API_INC')) define('EGW_API_INC',PHPGW_API_INC); // this is to support the header upgrade + + include(EGW_API_INC.'/common_functions.inc.php'); /*! @function lang @@ -58,7 +60,7 @@ } /* Make sure the header.inc.php is current. */ - if (!isset($GLOBALS['egw_info']) || $GLOBALS['egw_info']['server']['versions']['header'] < $GLOBALS['egw_info']['server']['versions']['current_header']) + if (!isset($GLOBALS['egw_domain']) || $GLOBALS['egw_info']['server']['versions']['header'] < $GLOBALS['egw_info']['server']['versions']['current_header']) { echo '
You need to port your settings to the new header.inc.php version by running setup/headeradmin.
'; exit; @@ -81,12 +83,6 @@ * Multi-Domain support * \****************************************************************************/ - /* make them fix their header */ - if (!isset($GLOBALS['egw_domain'])) - { - echo '
The administrator must upgrade the header.inc.php file before you can continue.
'; - exit; - } if (!isset($GLOBALS['egw_info']['server']['default_domain']) || // allow to overwrite the default domain !isset($GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']])) { @@ -139,13 +135,13 @@ * These lines load up the API, fill up the $phpgw_info array, etc * \****************************************************************************/ /* Load main class */ - $GLOBALS['egw'] = CreateObject('phpgwapi.egw'); + $GLOBALS['egw'] =& CreateObject('phpgwapi.egw'); // for the migration $GLOBALS['phpgw'] =& $GLOBALS['egw']; /************************************************************************\ * Load up the main instance of the db class. * \************************************************************************/ - $GLOBALS['egw']->db = CreateObject('phpgwapi.db'); + $GLOBALS['egw']->db =& CreateObject('phpgwapi.egw_db'); if ($GLOBALS['egw']->debug) { $GLOBALS['egw']->db->Debug = 1; @@ -232,17 +228,17 @@ /************************************************************************\ * Required classes * \************************************************************************/ - $GLOBALS['egw']->log = CreateObject('phpgwapi.errorlog'); - $GLOBALS['egw']->translation = CreateObject('phpgwapi.translation'); - $GLOBALS['egw']->common = CreateObject('phpgwapi.common'); - $GLOBALS['egw']->hooks = CreateObject('phpgwapi.hooks'); - $GLOBALS['egw']->auth = CreateObject('phpgwapi.auth'); - $GLOBALS['egw']->accounts = CreateObject('phpgwapi.accounts'); - $GLOBALS['egw']->acl = CreateObject('phpgwapi.acl'); - $GLOBALS['egw']->session = CreateObject('phpgwapi.sessions',$domain_names); - $GLOBALS['egw']->preferences = CreateObject('phpgwapi.preferences'); - $GLOBALS['egw']->applications = CreateObject('phpgwapi.applications'); - $GLOBALS['egw']->contenthistory = CreateObject('phpgwapi.contenthistory'); + $GLOBALS['egw']->log =& CreateObject('phpgwapi.errorlog'); + $GLOBALS['egw']->translation =& CreateObject('phpgwapi.translation'); + $GLOBALS['egw']->common =& CreateObject('phpgwapi.common'); + $GLOBALS['egw']->hooks =& CreateObject('phpgwapi.hooks'); + $GLOBALS['egw']->auth =& CreateObject('phpgwapi.auth'); + $GLOBALS['egw']->accounts =& CreateObject('phpgwapi.accounts'); + $GLOBALS['egw']->acl =& CreateObject('phpgwapi.acl'); + $GLOBALS['egw']->session =& CreateObject('phpgwapi.sessions',$domain_names); + $GLOBALS['egw']->preferences =& CreateObject('phpgwapi.preferences'); + $GLOBALS['egw']->applications =& CreateObject('phpgwapi.applications'); + $GLOBALS['egw']->contenthistory =& CreateObject('phpgwapi.contenthistory'); print_debug('main class loaded', 'messageonly','api'); if (! isset($GLOBALS['egw_info']['flags']['included_classes']['error']) || ! $GLOBALS['egw_info']['flags']['included_classes']['error']) @@ -301,7 +297,7 @@ print_debug('User ID',$login_id,'app'); $GLOBALS['egw']->accounts->accounts($login_id); $GLOBALS['egw']->preferences->preferences($login_id); - $GLOBALS['egw']->datetime = CreateObject('phpgwapi.datetime'); + $GLOBALS['egw']->datetime =& CreateObject('phpgwapi.datetime'); } } /**************************************************************************\ @@ -331,7 +327,7 @@ exit; } - $GLOBALS['egw']->datetime = CreateObject('phpgwapi.datetime'); + $GLOBALS['egw']->datetime =& CreateObject('phpgwapi.datetime'); /* A few hacker resistant constants that will be used throught the program */ define('EGW_TEMPLATE_DIR', $GLOBALS['egw']->common->get_tpl_dir('phpgwapi')); @@ -366,7 +362,7 @@ { $enable_class = str_replace('enable_','',$phpgw_class_name[0]); $enable_class = str_replace('_class','',$enable_class); - eval('$GLOBALS["phpgw"]->' . $enable_class . ' = createobject(\'phpgwapi.' . $enable_class . '\');'); + eval('$GLOBALS["phpgw"]->' . $enable_class . ' =& CreateObject(\'phpgwapi.' . $enable_class . '\');'); } } unset($enable_class); @@ -377,7 +373,7 @@ \*************************************************************************/ if(!@$GLOBALS['egw_info']['flags']['disable_Template_class']) { - $GLOBALS['egw']->template = CreateObject('phpgwapi.Template',PHPGW_APP_TPL); + $GLOBALS['egw']->template =& CreateObject('phpgwapi.Template',EGW_APP_TPL); } /*************************************************************************\ @@ -464,7 +460,7 @@ if(!is_object($GLOBALS['egw']->datetime)) { - $GLOBALS['egw']->datetime = CreateObject('phpgwapi.datetime'); + $GLOBALS['egw']->datetime =& CreateObject('phpgwapi.datetime'); } $GLOBALS['egw']->applications->read_installed_apps(); // to get translated app-titles @@ -480,17 +476,14 @@ * Load the app include files if the exists * \*************************************************************************/ /* Then the include file */ - if (PHPGW_APP_INC != "" && - ! preg_match ("/phpgwapi/i", PHPGW_APP_INC) && - file_exists(PHPGW_APP_INC . '/functions.inc.php') && - !isset($_GET['menuaction'])) + if (EGW_APP_INC != "" && ! preg_match ('/phpgwapi/i', EGW_APP_INC) && + file_exists(EGW_APP_INC . '/functions.inc.php') && !isset($_GET['menuaction'])) { - include(PHPGW_APP_INC . '/functions.inc.php'); + include(EGW_APP_INC . '/functions.inc.php'); } - if (!@$GLOBALS['egw_info']['flags']['noheader'] && - !@$GLOBALS['egw_info']['flags']['noappheader'] && - file_exists(PHPGW_APP_INC . '/header.inc.php') && !isset($_GET['menuaction'])) + if (!@$GLOBALS['egw_info']['flags']['noheader'] && !@$GLOBALS['egw_info']['flags']['noappheader'] && + file_exists(EGW_APP_INC . '/header.inc.php') && !isset($_GET['menuaction'])) { - include(PHPGW_APP_INC . '/header.inc.php'); + include(EGW_APP_INC . '/header.inc.php'); } } diff --git a/setup/inc/class.setup.inc.php b/setup/inc/class.setup.inc.php index d10c6f93d4..42953a127a 100644 --- a/setup/inc/class.setup.inc.php +++ b/setup/inc/class.setup.inc.php @@ -63,7 +63,7 @@ { $GLOBALS['egw_info']['server']['db_persistent'] = False; } - $this->db =& CreateObject('phpgwapi.db'); + $this->db =& CreateObject('phpgwapi.egw_db'); $this->db->Host = $GLOBALS['egw_domain'][$this->ConfigDomain]['db_host']; $this->db->Port = $GLOBALS['egw_domain'][$this->ConfigDomain]['db_port']; $this->db->Type = $GLOBALS['egw_domain'][$this->ConfigDomain]['db_type'];