3 V5.18 3 Sep 2012 (c) 2000-2012 John Lim (jlim#natsoft.com). All rights reserved.
4 Released under both BSD license and Lesser GPL library license.
5 Whenever there is any discrepancy between the two licenses,
6 the BSD license will take precedence.
7 Set tabs to 4 for best viewing.
9 Latest version is available at http://adodb.sourceforge.net
11 Requires ODBC. Works on Windows and Unix.
13 // security - hide paths
14 if (!defined('ADODB_DIR')) die();
16 define("_ADODB_ODBC_LAYER", 2 );
18 /*--------------------------------------------------------------------------------------
19 --------------------------------------------------------------------------------------*/
22 class ADODB_odbc extends ADOConnection {
23 var $databaseType = "odbc";
24 var $fmtDate = "'Y-m-d'";
25 var $fmtTimeStamp = "'Y-m-d, h:i:sA'";
26 var $replaceQuote = "''"; // string to use to replace quotes
27 var $dataProvider = "odbc";
28 var $hasAffectedRows = true;
29 var $binmode = ODBC_BINMODE_RETURN;
30 var $useFetchArray = false; // setting this to true will make array elements in FETCH_ASSOC mode case-sensitive
31 // breaking backward-compat
32 //var $longreadlen = 8000; // default number of chars to return for a Blob/Long field
33 var $_bindInputArray = false;
34 var $curmode = SQL_CUR_USE_DRIVER; // See sqlext.h, SQL_CUR_DEFAULT == SQL_CUR_USE_DRIVER == 2L
35 var $_genSeqSQL = "create table %s (id integer)";
36 var $_autocommit = true;
37 var $_haserrorfunctions = true;
38 var $_has_stupid_odbc_fetch_api_change = true;
39 var $_lastAffectedRows = 0;
40 var $uCaseTables = true; // for meta* functions, uppercase table names
44 $this->_haserrorfunctions = ADODB_PHPVER >= 0x4050;
45 $this->_has_stupid_odbc_fetch_api_change = ADODB_PHPVER >= 0x4200;
48 // returns true or false
49 function _connect($argDSN, $argUsername, $argPassword, $argDatabasename)
53 if (!function_exists('odbc_connect')) return null;
55 if (!empty($argDatabasename) && stristr($argDSN, 'Database=') === false) {
56 $argDSN = trim($argDSN);
57 $endDSN = substr($argDSN, strlen($argDSN) - 1);
58 if ($endDSN != ';') $argDSN .= ';';
59 $argDSN .= 'Database='.$argDatabasename;
62 if (isset($php_errormsg)) $php_errormsg = '';
63 if ($this->curmode === false) $this->_connectionID = odbc_connect($argDSN,$argUsername,$argPassword);
64 else $this->_connectionID = odbc_connect($argDSN,$argUsername,$argPassword,$this->curmode);
65 $this->_errorMsg = isset($php_errormsg) ? $php_errormsg : '';
66 if (isset($this->connectStmt)) $this->Execute($this->connectStmt);
68 return $this->_connectionID != false;
71 // returns true or false
72 function _pconnect($argDSN, $argUsername, $argPassword, $argDatabasename)
76 if (!function_exists('odbc_connect')) return null;
78 if (isset($php_errormsg)) $php_errormsg = '';
79 $this->_errorMsg = isset($php_errormsg) ? $php_errormsg : '';
80 if ($this->debug && $argDatabasename) {
81 ADOConnection::outp("For odbc PConnect(), $argDatabasename is not used. Place dsn in 1st parameter.");
83 // print "dsn=$argDSN u=$argUsername p=$argPassword<br>"; flush();
84 if ($this->curmode === false) $this->_connectionID = odbc_connect($argDSN,$argUsername,$argPassword);
85 else $this->_connectionID = odbc_pconnect($argDSN,$argUsername,$argPassword,$this->curmode);
87 $this->_errorMsg = isset($php_errormsg) ? $php_errormsg : '';
88 if ($this->_connectionID && $this->autoRollback) @odbc_rollback($this->_connectionID);
89 if (isset($this->connectStmt)) $this->Execute($this->connectStmt);
91 return $this->_connectionID != false;
98 if (!empty($this->host) && ADODB_PHPVER >= 0x4300) {
99 $dsn = strtoupper($this->host);
103 if (!function_exists('odbc_data_source')) return false;
107 $rez = @odbc_data_source($this->_connectionID,
108 $first ? SQL_FETCH_FIRST : SQL_FETCH_NEXT);
110 if (!is_array($rez)) break;
111 if (strtoupper($rez['server']) == $dsn) {
116 if (!$found) return ADOConnection::ServerInfo();
117 if (!isset($rez['version'])) $rez['version'] = '';
120 return ADOConnection::ServerInfo();
125 function CreateSequence($seqname='adodbseq',$start=1)
127 if (empty($this->_genSeqSQL)) return false;
128 $ok = $this->Execute(sprintf($this->_genSeqSQL,$seqname));
129 if (!$ok) return false;
131 return $this->Execute("insert into $seqname values($start)");
134 var $_dropSeqSQL = 'drop table %s';
135 function DropSequence($seqname)
137 if (empty($this->_dropSeqSQL)) return false;
138 return $this->Execute(sprintf($this->_dropSeqSQL,$seqname));
142 This algorithm is not very efficient, but works even if table locking
145 Will return false if unable to generate an ID after $MAXLOOPS attempts.
147 function GenID($seq='adodbseq',$start=1)
149 // if you have to modify the parameter below, your database is overloaded,
150 // or you need to implement generation of id's yourself!
153 while (--$MAXLOOPS>=0) {
154 $num = $this->GetOne("select id from $seq");
155 if ($num === false) {
156 $this->Execute(sprintf($this->_genSeqSQL ,$seq));
159 $ok = $this->Execute("insert into $seq values($start)");
160 if (!$ok) return false;
162 $this->Execute("update $seq set id=id+1 where id=$num");
164 if ($this->affected_rows() > 0) {
168 } elseif ($this->affected_rows() == 0) {
169 // some drivers do not return a valid value => try with another method
170 $value = $this->GetOne("select id from $seq");
171 if ($value == $num + 1) {
176 if ($fn = $this->raiseErrorFn) {
177 $fn($this->databaseType,'GENID',-32000,"Unable to generate unique id after $MAXLOOPS attempts",$seq,$num);
185 if ($this->_haserrorfunctions) {
186 if ($this->_errorMsg !== false) return $this->_errorMsg;
187 if (empty($this->_connectionID)) return @odbc_errormsg();
188 return @odbc_errormsg($this->_connectionID);
189 } else return ADOConnection::ErrorMsg();
195 if ($this->_haserrorfunctions) {
196 if ($this->_errorCode !== false) {
197 // bug in 4.0.6, error number can be corrupted string (should be 6 digits)
198 return (strlen($this->_errorCode)<=2) ? 0 : $this->_errorCode;
201 if (empty($this->_connectionID)) $e = @odbc_error();
202 else $e = @odbc_error($this->_connectionID);
204 // bug in 4.0.6, error number can be corrupted string (should be 6 digits)
205 // so we check and patch
206 if (strlen($e)<=2) return 0;
208 } else return ADOConnection::ErrorNo();
213 function BeginTrans()
215 if (!$this->hasTransactions) return false;
216 if ($this->transOff) return true;
217 $this->transCnt += 1;
218 $this->_autocommit = false;
219 return odbc_autocommit($this->_connectionID,false);
222 function CommitTrans($ok=true)
224 if ($this->transOff) return true;
225 if (!$ok) return $this->RollbackTrans();
226 if ($this->transCnt) $this->transCnt -= 1;
227 $this->_autocommit = true;
228 $ret = odbc_commit($this->_connectionID);
229 odbc_autocommit($this->_connectionID,true);
233 function RollbackTrans()
235 if ($this->transOff) return true;
236 if ($this->transCnt) $this->transCnt -= 1;
237 $this->_autocommit = true;
238 $ret = odbc_rollback($this->_connectionID);
239 odbc_autocommit($this->_connectionID,true);
243 function MetaPrimaryKeys($table)
245 global $ADODB_FETCH_MODE;
247 if ($this->uCaseTables) $table = strtoupper($table);
249 $this->_findschema($table,$schema);
251 $savem = $ADODB_FETCH_MODE;
252 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
253 $qid = @odbc_primarykeys($this->_connectionID,'',$schema,$table);
256 $ADODB_FETCH_MODE = $savem;
259 $rs = new ADORecordSet_odbc($qid);
260 $ADODB_FETCH_MODE = $savem;
262 if (!$rs) return false;
263 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
265 $arr = $rs->GetArray();
269 for ($i=0; $i < sizeof($arr); $i++) {
270 if ($arr[$i][3]) $arr2[] = $arr[$i][3];
277 function MetaTables($ttype=false)
279 global $ADODB_FETCH_MODE;
281 $savem = $ADODB_FETCH_MODE;
282 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
283 $qid = odbc_tables($this->_connectionID);
285 $rs = new ADORecordSet_odbc($qid);
287 $ADODB_FETCH_MODE = $savem;
292 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
294 $arr = $rs->GetArray();
301 $isview = strncmp($ttype,'V',1) === 0;
303 for ($i=0; $i < sizeof($arr); $i++) {
304 if (!$arr[$i][2]) continue;
308 if (strncmp($type,'V',1) === 0) $arr2[] = $arr[$i][2];
309 } else if (strncmp($type,'SYS',3) !== 0) $arr2[] = $arr[$i][2];
310 } else if (strncmp($type,'SYS',3) !== 0) $arr2[] = $arr[$i][2];
316 See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/odbc/htm/odbcdatetime_data_type_changes.asp
317 / SQL data type codes /
318 #define SQL_UNKNOWN_TYPE 0
320 #define SQL_NUMERIC 2
321 #define SQL_DECIMAL 3
322 #define SQL_INTEGER 4
323 #define SQL_SMALLINT 5
327 #if (ODBCVER >= 0x0300)
328 #define SQL_DATETIME 9
330 #define SQL_VARCHAR 12
333 / One-parameter shortcuts for date/time data types /
334 #if (ODBCVER >= 0x0300)
335 #define SQL_TYPE_DATE 91
336 #define SQL_TYPE_TIME 92
337 #define SQL_TYPE_TIMESTAMP 93
339 #define SQL_UNICODE (-95)
340 #define SQL_UNICODE_VARCHAR (-96)
341 #define SQL_UNICODE_LONGVARCHAR (-97)
343 function ODBCTypes($t)
345 switch ((integer)$t) {
373 case -11: // uniqidentifier
383 function MetaColumns($table, $normalize=true)
385 global $ADODB_FETCH_MODE;
388 if ($this->uCaseTables) $table = strtoupper($table);
390 $this->_findschema($table,$schema);
392 $savem = $ADODB_FETCH_MODE;
393 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
395 /*if (false) { // after testing, confirmed that the following does not work becoz of a bug
396 $qid2 = odbc_tables($this->_connectionID);
397 $rs = new ADORecordSet_odbc($qid2);
398 $ADODB_FETCH_MODE = $savem;
399 if (!$rs) return false;
400 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
404 if ($table == strtoupper($rs->fields[2])) {
413 $qid = odbc_columns($this->_connectionID,$q,$o,strtoupper($table),'%');
416 switch ($this->databaseType) {
419 $qid = odbc_columns($this->_connectionID);#,'%','',strtoupper($table),'%');
425 $qid = odbc_columns($this->_connectionID, "", $schema, $table, $colname);
429 $qid = @odbc_columns($this->_connectionID,'%','%',strtoupper($table),'%');
430 if (empty($qid)) $qid = odbc_columns($this->_connectionID);
433 if (empty($qid)) return $false;
435 $rs = new ADORecordSet_odbc($qid);
436 $ADODB_FETCH_MODE = $savem;
438 if (!$rs) return $false;
439 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
460 // adodb_pr($rs->fields);
461 if (strtoupper(trim($rs->fields[2])) == $table && (!$schema || strtoupper($rs->fields[1]) == $schema)) {
462 $fld = new ADOFieldObject();
463 $fld->name = $rs->fields[3];
464 $fld->type = $this->ODBCTypes($rs->fields[4]);
466 // ref: http://msdn.microsoft.com/library/default.asp?url=/archive/en-us/dnaraccgen/html/msdn_odk.asp
467 // access uses precision to store length for char/varchar
468 if ($fld->type == 'C' or $fld->type == 'X') {
469 if ($this->databaseType == 'access')
470 $fld->max_length = $rs->fields[6];
471 else if ($rs->fields[4] <= -95) // UNICODE
472 $fld->max_length = $rs->fields[7]/2;
474 $fld->max_length = $rs->fields[7];
476 $fld->max_length = $rs->fields[7];
477 $fld->not_null = !empty($rs->fields[10]);
478 $fld->scale = $rs->fields[8];
479 $retarr[strtoupper($fld->name)] = $fld;
480 } else if (sizeof($retarr)>0)
484 $rs->Close(); //-- crashes 4.03pl1 -- why?
486 if (empty($retarr)) $retarr = false;
490 function Prepare($sql)
492 if (! $this->_bindInputArray) return $sql; // no binding
493 $stmt = odbc_prepare($this->_connectionID,$sql);
495 // we don't know whether odbc driver is parsing prepared stmts, so just return sql
498 return array($sql,$stmt,false);
501 /* returns queryID or false */
502 function _query($sql,$inputarr=false)
504 GLOBAL $php_errormsg;
505 if (isset($php_errormsg)) $php_errormsg = '';
509 if (is_array($sql)) {
512 $stmtid = odbc_prepare($this->_connectionID,$sql);
514 if ($stmtid == false) {
515 $this->_errorMsg = isset($php_errormsg) ? $php_errormsg : '';
520 if (! odbc_execute($stmtid,$inputarr)) {
521 //@odbc_free_result($stmtid);
522 if ($this->_haserrorfunctions) {
523 $this->_errorMsg = odbc_errormsg();
524 $this->_errorCode = odbc_error();
529 } else if (is_array($sql)) {
531 if (!odbc_execute($stmtid)) {
532 //@odbc_free_result($stmtid);
533 if ($this->_haserrorfunctions) {
534 $this->_errorMsg = odbc_errormsg();
535 $this->_errorCode = odbc_error();
540 $stmtid = odbc_exec($this->_connectionID,$sql);
542 $this->_lastAffectedRows = 0;
544 if (@odbc_num_fields($stmtid) == 0) {
545 $this->_lastAffectedRows = odbc_num_rows($stmtid);
548 $this->_lastAffectedRows = 0;
549 odbc_binmode($stmtid,$this->binmode);
550 odbc_longreadlen($stmtid,$this->maxblobsize);
553 if ($this->_haserrorfunctions) {
554 $this->_errorMsg = '';
555 $this->_errorCode = 0;
557 $this->_errorMsg = isset($php_errormsg) ? $php_errormsg : '';
559 if ($this->_haserrorfunctions) {
560 $this->_errorMsg = odbc_errormsg();
561 $this->_errorCode = odbc_error();
563 $this->_errorMsg = isset($php_errormsg) ? $php_errormsg : '';
569 Insert a null into the blob field of the table first.
570 Then use UpdateBlob to store the blob.
574 $conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)');
575 $conn->UpdateBlob('blobtable','blobcol',$blob,'id=1');
577 function UpdateBlob($table,$column,$val,$where,$blobtype='BLOB')
579 return $this->Execute("UPDATE $table SET $column=? WHERE $where",array($val)) != false;
582 // returns true or false
585 $ret = @odbc_close($this->_connectionID);
586 $this->_connectionID = false;
590 function _affectedrows()
592 return $this->_lastAffectedRows;
597 /*--------------------------------------------------------------------------------------
598 Class Name: Recordset
599 --------------------------------------------------------------------------------------*/
601 class ADORecordSet_odbc extends ADORecordSet {
604 var $databaseType = "odbc";
605 var $dataProvider = "odbc";
607 var $_has_stupid_odbc_fetch_api_change;
609 function ADORecordSet_odbc($id,$mode=false)
611 if ($mode === false) {
612 global $ADODB_FETCH_MODE;
613 $mode = $ADODB_FETCH_MODE;
615 $this->fetchMode = $mode;
617 $this->_queryID = $id;
619 // the following is required for mysql odbc driver in 4.3.1 -- why?
621 $this->_currentRow = -1;
622 //$this->ADORecordSet($id);
626 // returns the field object
627 function FetchField($fieldOffset = -1)
630 $off=$fieldOffset+1; // offsets begin at 1
632 $o= new ADOFieldObject();
633 $o->name = @odbc_field_name($this->_queryID,$off);
634 $o->type = @odbc_field_type($this->_queryID,$off);
635 $o->max_length = @odbc_field_len($this->_queryID,$off);
636 if (ADODB_ASSOC_CASE == 0) $o->name = strtolower($o->name);
637 else if (ADODB_ASSOC_CASE == 1) $o->name = strtoupper($o->name);
641 /* Use associative array to get fields array */
642 function Fields($colname)
644 if ($this->fetchMode & ADODB_FETCH_ASSOC) return $this->fields[$colname];
646 $this->bind = array();
647 for ($i=0; $i < $this->_numOfFields; $i++) {
648 $o = $this->FetchField($i);
649 $this->bind[strtoupper($o->name)] = $i;
653 return $this->fields[$this->bind[strtoupper($colname)]];
659 global $ADODB_COUNTRECS;
660 $this->_numOfRows = ($ADODB_COUNTRECS) ? @odbc_num_rows($this->_queryID) : -1;
661 $this->_numOfFields = @odbc_num_fields($this->_queryID);
662 // some silly drivers such as db2 as/400 and intersystems cache return _numOfRows = 0
663 if ($this->_numOfRows == 0) $this->_numOfRows = -1;
664 //$this->useFetchArray = $this->connection->useFetchArray;
665 $this->_has_stupid_odbc_fetch_api_change = ADODB_PHPVER >= 0x4200;
673 // speed up SelectLimit() by switching to ADODB_FETCH_NUM as ADODB_FETCH_ASSOC is emulated
674 function GetArrayLimit($nrows,$offset=-1)
677 $rs = $this->GetArray($nrows);
680 $savem = $this->fetchMode;
681 $this->fetchMode = ADODB_FETCH_NUM;
682 $this->Move($offset);
683 $this->fetchMode = $savem;
685 if ($this->fetchMode & ADODB_FETCH_ASSOC) {
686 $this->fields = $this->GetRowAssoc(ADODB_ASSOC_CASE);
691 while (!$this->EOF && $nrows != $cnt) {
692 $results[$cnt++] = $this->fields;
702 if ($this->_numOfRows != 0 && !$this->EOF) {
703 $this->_currentRow++;
705 if ($this->_has_stupid_odbc_fetch_api_change)
706 $rez = @odbc_fetch_into($this->_queryID,$this->fields);
709 $rez = @odbc_fetch_into($this->_queryID,$row,$this->fields);
712 if ($this->fetchMode & ADODB_FETCH_ASSOC) {
713 $this->fields = $this->GetRowAssoc(ADODB_ASSOC_CASE);
718 $this->fields = false;
726 if ($this->_has_stupid_odbc_fetch_api_change)
727 $rez = @odbc_fetch_into($this->_queryID,$this->fields);
730 $rez = @odbc_fetch_into($this->_queryID,$row,$this->fields);
733 if ($this->fetchMode & ADODB_FETCH_ASSOC) {
734 $this->fields = $this->GetRowAssoc(ADODB_ASSOC_CASE);
738 $this->fields = false;
744 return @odbc_free_result($this->_queryID);