3 V4.22 15 Apr 2004 (c) 2000-2004 John Lim (jlim#natsoft.com.my). 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://php.weblogs.com/
11 Requires ODBC. Works on Windows and Unix.
13 define("_ADODB_ODBC_LAYER", 2);
15 /*--------------------------------------------------------------------------------------
16 --------------------------------------------------------------------------------------*/
18 class ADODB_odbc extends ADOConnection
20 var $databaseType = "odbc";
21 var $fmtDate = "'Y-m-d'";
22 var $fmtTimeStamp = "'Y-m-d, h:i:sA'";
23 var $replaceQuote = "''"; // string to use to replace quotes
24 var $dataProvider = "odbc";
25 var $hasAffectedRows = true;
26 var $binmode = ODBC_BINMODE_RETURN;
27 var $useFetchArray = false; // setting this to true will make array elements in FETCH_ASSOC mode case-sensitive
28 // breaking backward-compat
29 //var $longreadlen = 8000; // default number of chars to return for a Blob/Long field
30 var $_bindInputArray = false;
31 var $curmode = SQL_CUR_USE_DRIVER; // See sqlext.h, SQL_CUR_DEFAULT == SQL_CUR_USE_DRIVER == 2L
32 var $_genSeqSQL = "create table %s (id integer)";
33 var $_autocommit = true;
34 var $_haserrorfunctions = true;
35 var $_has_stupid_odbc_fetch_api_change = true;
36 var $_lastAffectedRows = 0;
40 $this->_haserrorfunctions = ADODB_PHPVER >= 0x4050;
41 $this->_has_stupid_odbc_fetch_api_change = ADODB_PHPVER >= 0x4200;
47 if (!empty($this->host) && ADODB_PHPVER >= 0x4300) {
48 $dsn = strtoupper($this->host);
52 if (!function_exists('odbc_data_source')) return false;
56 $rez = odbc_data_source($this->_connectionID,
57 $first ? SQL_FETCH_FIRST : SQL_FETCH_NEXT);
59 if (!is_array($rez)) break;
60 if (strtoupper($rez['server']) == $dsn) {
65 if (!$found) return ADOConnection::ServerInfo();
66 if (!isset($rez['version'])) $rez['version'] = '';
69 return ADOConnection::ServerInfo();
73 function CreateSequence($seqname = 'adodbseq', $start = 1)
75 if (empty($this->_genSeqSQL)) return false;
76 $ok = $this->Execute(sprintf($this->_genSeqSQL, $seqname));
77 if (!$ok) return false;
79 return $this->Execute("insert into $seqname values($start)");
82 var $_dropSeqSQL = 'drop table %s';
84 function DropSequence($seqname)
86 if (empty($this->_dropSeqSQL)) return false;
87 return $this->Execute(sprintf($this->_dropSeqSQL, $seqname));
91 This algorithm is not very efficient, but works even if table locking
94 Will return false if unable to generate an ID after $MAXLOOPS attempts.
96 function GenID($seq = 'adodbseq', $start = 1)
98 // if you have to modify the parameter below, your database is overloaded,
99 // or you need to implement generation of id's yourself!
102 while (--$MAXLOOPS >= 0) {
103 $num = $this->GetOne("select id from $seq");
104 if ($num === false) {
105 $this->Execute(sprintf($this->_genSeqSQL, $seq));
108 $ok = $this->Execute("insert into $seq values($start)");
109 if (!$ok) return false;
111 $this->Execute("update $seq set id=id+1 where id=$num");
113 if ($this->affected_rows() > 0) {
119 if ($fn = $this->raiseErrorFn) {
120 $fn($this->databaseType, 'GENID', -32000, "Unable to generate unique id after $MAXLOOPS attempts", $seq, $num);
128 if ($this->_haserrorfunctions) {
129 if ($this->_errorMsg !== false) return $this->_errorMsg;
130 if (empty($this->_connectionID)) return @odbc_errormsg();
131 return @odbc_errormsg($this->_connectionID);
132 } else return ADOConnection::ErrorMsg();
138 if ($this->_haserrorfunctions) {
139 if ($this->_errorCode !== false) {
140 // bug in 4.0.6, error number can be corrupted string (should be 6 digits)
141 return (strlen($this->_errorCode) <= 2) ? 0 : $this->_errorCode;
144 if (empty($this->_connectionID)) $e = @odbc_error();
145 else $e = @odbc_error($this->_connectionID);
147 // bug in 4.0.6, error number can be corrupted string (should be 6 digits)
148 // so we check and patch
149 if (strlen($e) <= 2) return 0;
151 } else return ADOConnection::ErrorNo();
155 // returns true or false
156 function _connect($argDSN, $argUsername, $argPassword, $argDatabasename)
158 global $php_errormsg;
160 if (!function_exists('odbc_connect')) return false;
162 if ($this->debug && $argDatabasename && $this->databaseType != 'vfp') {
163 ADOConnection::outp("For odbc Connect(), $argDatabasename is not used. Place dsn in 1st parameter.");
166 if ($this->curmode === false) $this->_connectionID = odbc_connect($argDSN, $argUsername, $argPassword);
167 else $this->_connectionID = odbc_connect($argDSN, $argUsername, $argPassword, $this->curmode);
168 $this->_errorMsg = $php_errormsg;
169 if (isset($this->connectStmt)) $this->Execute($this->connectStmt);
171 //if ($this->_connectionID) odbc_autocommit($this->_connectionID,true);
172 return $this->_connectionID != false;
175 // returns true or false
176 function _pconnect($argDSN, $argUsername, $argPassword, $argDatabasename)
178 global $php_errormsg;
180 if (!function_exists('odbc_connect')) return false;
183 if ($this->debug && $argDatabasename) {
184 ADOConnection::outp("For odbc PConnect(), $argDatabasename is not used. Place dsn in 1st parameter.");
186 // print "dsn=$argDSN u=$argUsername p=$argPassword<br>"; flush();
187 if ($this->curmode === false) $this->_connectionID = odbc_connect($argDSN, $argUsername, $argPassword);
188 else $this->_connectionID = odbc_pconnect($argDSN, $argUsername, $argPassword, $this->curmode);
190 $this->_errorMsg = $php_errormsg;
191 if ($this->_connectionID && $this->autoRollback) @odbc_rollback($this->_connectionID);
192 if (isset($this->connectStmt)) $this->Execute($this->connectStmt);
194 return $this->_connectionID != false;
197 function BeginTrans()
199 if (!$this->hasTransactions) return false;
200 if ($this->transOff) return true;
201 $this->transCnt += 1;
202 $this->_autocommit = false;
203 return odbc_autocommit($this->_connectionID, false);
206 function CommitTrans($ok = true)
208 if ($this->transOff) return true;
209 if (!$ok) return $this->RollbackTrans();
210 if ($this->transCnt) $this->transCnt -= 1;
211 $this->_autocommit = true;
212 $ret = odbc_commit($this->_connectionID);
213 odbc_autocommit($this->_connectionID, true);
217 function RollbackTrans()
219 if ($this->transOff) return true;
220 if ($this->transCnt) $this->transCnt -= 1;
221 $this->_autocommit = true;
222 $ret = odbc_rollback($this->_connectionID);
223 odbc_autocommit($this->_connectionID, true);
227 function MetaPrimaryKeys($table)
229 global $ADODB_FETCH_MODE;
231 $savem = $ADODB_FETCH_MODE;
232 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
233 $qid = @odbc_primarykeys($this->_connectionID, '', '', $table);
236 $ADODB_FETCH_MODE = $savem;
239 $rs = new ADORecordSet_odbc($qid);
240 $ADODB_FETCH_MODE = $savem;
242 if (!$rs) return false;
243 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
245 $arr =& $rs->GetArray();
249 for ($i = 0; $i < sizeof($arr); $i++) {
250 if ($arr[$i][3]) $arr2[] = $arr[$i][3];
256 function &MetaTables($ttype = false)
258 global $ADODB_FETCH_MODE;
260 $savem = $ADODB_FETCH_MODE;
261 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
262 $qid = odbc_tables($this->_connectionID);
264 $rs = new ADORecordSet_odbc($qid);
266 $ADODB_FETCH_MODE = $savem;
267 if (!$rs) return false;
269 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
271 $arr =& $rs->GetArray();
278 $isview = strncmp($ttype, 'V', 1) === 0;
280 for ($i = 0; $i < sizeof($arr); $i++) {
281 if (!$arr[$i][2]) continue;
285 if (strncmp($type, 'V', 1) === 0) $arr2[] = $arr[$i][2];
286 } elseif (strncmp($type, 'SYS', 3) !== 0) $arr2[] = $arr[$i][2];
287 } elseif (strncmp($type, 'SYS', 3) !== 0) $arr2[] = $arr[$i][2];
293 / SQL data type codes /
294 #define SQL_UNKNOWN_TYPE 0
296 #define SQL_NUMERIC 2
297 #define SQL_DECIMAL 3
298 #define SQL_INTEGER 4
299 #define SQL_SMALLINT 5
303 #if (ODBCVER >= 0x0300)
304 #define SQL_DATETIME 9
306 #define SQL_VARCHAR 12
308 / One-parameter shortcuts for date/time data types /
309 #if (ODBCVER >= 0x0300)
310 #define SQL_TYPE_DATE 91
311 #define SQL_TYPE_TIME 92
312 #define SQL_TYPE_TIMESTAMP 93
314 #define SQL_UNICODE (-95)
315 #define SQL_UNICODE_VARCHAR (-96)
316 #define SQL_UNICODE_LONGVARCHAR (-97)
318 function ODBCTypes($t)
320 switch ((integer)$t) {
346 case -11: // uniqidentifier
356 function &MetaColumns($table)
358 global $ADODB_FETCH_MODE;
360 $table = strtoupper($table);
362 $this->_findschema($table, $schema);
364 $savem = $ADODB_FETCH_MODE;
365 $ADODB_FETCH_MODE = ADODB_FETCH_NUM;
367 if (false) { // after testing, confirmed that the following does not work becoz of a bug
368 $qid2 = odbc_tables($this->_connectionID);
369 $rs = new ADORecordSet_odbc($qid2);
370 $ADODB_FETCH_MODE = $savem;
371 if (!$rs) return false;
372 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
376 if ($table == strtoupper($rs->fields[2])) {
385 $qid = odbc_columns($this->_connectionID, $q, $o, strtoupper($table), '%');
386 } else switch ($this->databaseType) {
390 $qid = odbc_columns($this->_connectionID);
394 $qid = @odbc_columns($this->_connectionID, '%', '%', strtoupper($table), '%');
395 if (empty($qid)) $qid = odbc_columns($this->_connectionID);
398 if (empty($qid)) return false;
400 $rs = new ADORecordSet_odbc($qid);
401 $ADODB_FETCH_MODE = $savem;
403 if (!$rs) return false;
405 $rs->_has_stupid_odbc_fetch_api_change = $this->_has_stupid_odbc_fetch_api_change;
425 //adodb_pr($rs->fields);
426 if (strtoupper($rs->fields[2]) == $table && (!$schema || strtoupper($rs->fields[1]) == $schema)) {
427 $fld = new ADOFieldObject();
428 $fld->name = $rs->fields[3];
429 $fld->type = $this->ODBCTypes($rs->fields[4]);
431 // ref: http://msdn.microsoft.com/library/default.asp?url=/archive/en-us/dnaraccgen/html/msdn_odk.asp
432 // access uses precision to store length for char/varchar
433 if ($fld->type == 'C' or $fld->type == 'X') {
434 if ($this->databaseType == 'access')
435 $fld->max_length = $rs->fields[6];
436 else if ($rs->fields[4] <= -95) // UNICODE
437 $fld->max_length = $rs->fields[7] / 2;
439 $fld->max_length = $rs->fields[7];
441 $fld->max_length = $rs->fields[7];
442 $fld->not_null = !empty($rs->fields[10]);
443 $fld->scale = $rs->fields[8];
444 $retarr[strtoupper($fld->name)] = $fld;
445 } elseif (sizeof($retarr) > 0)
449 $rs->Close(); //-- crashes 4.03pl1 -- why?
454 function Prepare($sql)
456 if (!$this->_bindInputArray) return $sql; // no binding
457 $stmt = odbc_prepare($this->_connectionID, $sql);
459 // we don't know whether odbc driver is parsing prepared stmts, so just return sql
462 return array($sql, $stmt, false);
465 /* returns queryID or false */
466 function _query($sql, $inputarr = false)
468 GLOBAL $php_errormsg;
473 if (is_array($sql)) {
476 $stmtid = odbc_prepare($this->_connectionID, $sql);
478 if ($stmtid == false) {
479 $this->_errorMsg = $php_errormsg;
484 if (!odbc_execute($stmtid, $inputarr)) {
485 //@odbc_free_result($stmtid);
486 if ($this->_haserrorfunctions) {
487 $this->_errorMsg = odbc_errormsg();
488 $this->_errorCode = odbc_error();
493 } elseif (is_array($sql)) {
495 if (!odbc_execute($stmtid)) {
496 //@odbc_free_result($stmtid);
497 if ($this->_haserrorfunctions) {
498 $this->_errorMsg = odbc_errormsg();
499 $this->_errorCode = odbc_error();
504 $stmtid = odbc_exec($this->_connectionID, $sql);
506 $this->_lastAffectedRows = 0;
508 if (@odbc_num_fields($stmtid) == 0) {
509 $this->_lastAffectedRows = odbc_num_rows($stmtid);
512 $this->_lastAffectedRows = 0;
513 odbc_binmode($stmtid, $this->binmode);
514 odbc_longreadlen($stmtid, $this->maxblobsize);
517 if ($this->_haserrorfunctions) {
518 $this->_errorMsg = '';
519 $this->_errorCode = 0;
521 $this->_errorMsg = $php_errormsg;
523 if ($this->_haserrorfunctions) {
524 $this->_errorMsg = odbc_errormsg();
525 $this->_errorCode = odbc_error();
527 $this->_errorMsg = $php_errormsg;
533 Insert a null into the blob field of the table first.
534 Then use UpdateBlob to store the blob.
538 $conn->Execute('INSERT INTO blobtable (id, blobcol) VALUES (1, null)');
539 $conn->UpdateBlob('blobtable','blobcol',$blob,'id=1');
541 function UpdateBlob($table, $column, $val, $where, $blobtype = 'BLOB')
543 return $this->Execute("UPDATE $table SET $column=? WHERE $where", array($val)) != false;
546 // returns true or false
549 $ret = @odbc_close($this->_connectionID);
550 $this->_connectionID = false;
554 function _affectedrows()
556 return $this->_lastAffectedRows;
561 /*--------------------------------------------------------------------------------------
562 Class Name: Recordset
563 --------------------------------------------------------------------------------------*/
565 class ADORecordSet_odbc extends ADORecordSet
569 var $databaseType = "odbc";
570 var $dataProvider = "odbc";
572 var $_has_stupid_odbc_fetch_api_change;
574 function ADORecordSet_odbc($id, $mode = false)
576 if ($mode === false) {
577 global $ADODB_FETCH_MODE;
578 $mode = $ADODB_FETCH_MODE;
580 $this->fetchMode = $mode;
582 $this->_queryID = $id;
584 // the following is required for mysql odbc driver in 4.3.1 -- why?
586 $this->_currentRow = -1;
587 //$this->ADORecordSet($id);
590 // returns the field object
591 function &FetchField($fieldOffset = -1)
594 $off = $fieldOffset + 1; // offsets begin at 1
596 $o = new ADOFieldObject();
597 $o->name = @odbc_field_name($this->_queryID, $off);
598 $o->type = @odbc_field_type($this->_queryID, $off);
599 $o->max_length = @odbc_field_len($this->_queryID, $off);
600 if (ADODB_ASSOC_CASE == 0) $o->name = strtolower($o->name);
601 else if (ADODB_ASSOC_CASE == 1) $o->name = strtoupper($o->name);
605 /* Use associative array to get fields array */
606 function Fields($colname)
608 if ($this->fetchMode & ADODB_FETCH_ASSOC) return $this->fields[$colname];
610 $this->bind = array();
611 for ($i = 0; $i < $this->_numOfFields; $i++) {
612 $o = $this->FetchField($i);
613 $this->bind[strtoupper($o->name)] = $i;
617 return $this->fields[$this->bind[strtoupper($colname)]];
622 global $ADODB_COUNTRECS;
623 $this->_numOfRows = ($ADODB_COUNTRECS) ? @odbc_num_rows($this->_queryID) : -1;
624 $this->_numOfFields = @odbc_num_fields($this->_queryID);
625 // some silly drivers such as db2 as/400 and intersystems cache return _numOfRows = 0
626 if ($this->_numOfRows == 0) $this->_numOfRows = -1;
627 //$this->useFetchArray = $this->connection->useFetchArray;
628 $this->_has_stupid_odbc_fetch_api_change = ADODB_PHPVER >= 0x4200;
636 // speed up SelectLimit() by switching to ADODB_FETCH_NUM as ADODB_FETCH_ASSOC is emulated
637 function &GetArrayLimit($nrows, $offset = -1)
640 $rs =& $this->GetArray($nrows);
643 $savem = $this->fetchMode;
644 $this->fetchMode = ADODB_FETCH_NUM;
645 $this->Move($offset);
646 $this->fetchMode = $savem;
648 if ($this->fetchMode & ADODB_FETCH_ASSOC) {
649 $this->fields =& $this->GetRowAssoc(ADODB_ASSOC_CASE);
654 while (!$this->EOF && $nrows != $cnt) {
655 $results[$cnt++] = $this->fields;
664 if ($this->_numOfRows != 0 && !$this->EOF) {
665 $this->_currentRow++;
667 if ($this->_has_stupid_odbc_fetch_api_change)
668 $rez = @odbc_fetch_into($this->_queryID, $this->fields);
670 $rez = @odbc_fetch_into($this->_queryID, $row, $this->fields);
672 if ($this->fetchMode & ADODB_FETCH_ASSOC) {
673 $this->fields =& $this->GetRowAssoc(ADODB_ASSOC_CASE);
678 $this->fields = false;
686 if ($this->_has_stupid_odbc_fetch_api_change)
687 $rez = @odbc_fetch_into($this->_queryID, $this->fields, $row);
689 $rez = @odbc_fetch_into($this->_queryID, $row, $this->fields);
692 if ($this->fetchMode & ADODB_FETCH_ASSOC) {
693 $this->fields =& $this->GetRowAssoc(ADODB_ASSOC_CASE);
697 $this->fields = false;
703 return @odbc_free_result($this->_queryID);