summaryrefslogtreecommitdiffstats
path: root/system/drivers/DB_oci8.php
blob: 2f936da123be1b491b7f3923b0d8f3386f3f4475 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');
/**
 * Code Igniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      Rick Ellis
 * @copyright   Copyright (c) 2006, pMachine, Inc.
 * @license     http://www.codeignitor.com/user_guide/license.html 
 * @link        http://www.codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

// ------------------------------------------------------------------------

/**
 * oci8 Database Adapter Class
 *
 * Note: _DB is an extender class that the app controller
 * creates dynamically based on whether the active record
 * class is being used or not.
 *
 * @package     CodeIgniter
 * @subpackage  Drivers
 * @category    Database
 * @author      Rick Ellis
 * @link        http://www.codeigniter.com/user_guide/libraries/database/
 */

/**
 * oci8 Database Adapter Class
 *
 * This is a modification of the DB_driver class to 
 * permit access to oracle databases
 *
 * NOTE: this uses the PHP 4 oci methods
 *
 * @author      Kelly McArdle
 *
 */

class CI_DB_oci8 extends CI_DB {

	// Set "auto commit" by default
    var $_commit = OCI_COMMIT_ON_SUCCESS;

    // need to track statement id and cursor id
    var $stmt_id;
    var $curs_id;

    // if we use a limit, we will add a field that will
    // throw off num_fields later
    var $limit_used;
    
    /**
     * Non-persistent database connection
     *
     * @access  private called by the base class
     * @return  resource
     */
    function db_connect()
    {
        return ocilogon($this->username, $this->password, $this->hostname);
    }

    // --------------------------------------------------------------------

    /**
     * Persistent database connection
     *
     * @access  private called by the base class
     * @return  resource
     */
    function db_pconnect()
    {
        return ociplogon($this->username, $this->password, $this->hostname);
    }

    // --------------------------------------------------------------------

    /**
     * Select the database
     *
     * @access  private called by the base class
     * @return  resource
     */
    function db_select()
    {
        return TRUE;
    }

    // --------------------------------------------------------------------

    /**
     * Execute the query
     *
     * @access  private called by the base class
     * @param   string  an SQL query
     * @return  resource
     */
    function _execute($sql)
    {
        // oracle must parse the query before it
        // is run, all of the actions with
        // the query are based off the statement id
        // returned by ociparse        
        $this->_set_stmt_id($sql);
        ocisetprefetch($this->stmt_id, 1000);
        return @ociexecute($this->stmt_id, $this->_commit);
    }
    
    /**
     * Generate a statement ID
     *
     * @access  private
     * @param   string  an SQL query
     * @return  none
     */
    function _set_stmt_id($sql)
    {
        if ( ! is_resource($this->stmt_id))
        {
			$this->stmt_id = ociparse($this->conn_id, $this->_prep_query($sql));
        }
    }

    // --------------------------------------------------------------------

    /**
     * Prep the query
     *
     * If needed, each database adapter can prep the query string
     *
     * @access  private called by execute()
     * @param   string  an SQL query
     * @return  string
     */
    function _prep_query($sql)
    {
        return $sql;
    }

    // --------------------------------------------------------------------

    /**
     * getCursor.  Returns a cursor from the datbase
     *
     * @access  public
     * @return  cursor id
     */
    function get_cursor()
    {
		return $this->curs_id = ocinewcursor($this->conn_id);
    }

    // --------------------------------------------------------------------

    /**
     * Stored Procedure.  Executes a stored procedure
     *
     * @access  public
     * @param   package     package stored procedure is in
     * @param   procedure   stored procedure to execute
     * @param   params      array of parameters
     * @return  array
     *
     * params array keys
     *
     * KEY      OPTIONAL    NOTES
     * name     no          the name of the parameter should be in :<param_name> format
     * value    no          the value of the parameter.  If this is an OUT or IN OUT parameter,
     *                      this should be a reference to a variable
     * type     yes         the type of the parameter
     * length   yes         the max size of the parameter
     */
    function stored_procedure($package, $procedure, $params)
    {
        if ($package == '' OR $procedure == '' OR ! is_array($params))
        {
            if ($this->db_debug)
            {
                log_message('error', 'Invalid query: '.$package.'.'.$procedure);
                return $this->display_error('db_invalid_query');
            }
            return FALSE;
        }
		
		// build the query string
		$sql = "begin $package.$procedure(";

		$have_cursor = FALSE;
		foreach($params as $param)
		{
			$sql .= $param['name'] . ",";
			
			if (array_key_exists('type', $param) && ($param['type'] == OCI_B_CURSOR))
			{
				$have_cursor = TRUE;
			}
		}
		$sql = trim($sql, ",") . "); end;";
				
		$this->stmt_id = FALSE;
		$this->_set_stmt_id($sql);
		$this->_bind_params($params); 
		$this->query($sql, FALSE, $have_cursor);
	}
	
    // --------------------------------------------------------------------

    /**
     * Bind parameters
     *
     * @access  private
     * @return  none
     */
	function _bind_params($params)
	{
		if ( ! is_array($params) OR ! is_resource($this->stmt_id))
		{
			return;
		}
		
        foreach ($params as $param)
        {
 			foreach (array('name', 'value', 'type', 'length') as $val)
        	{
        		if ( ! isset($param[$val]))
        		{
        			$param[$val] = '';
        		}
        	}
 
			ocibindbyname($this->stmt_id, $param['name'], $param['value'], $param['length'], $param['type']);
        }
	}

	// --------------------------------------------------------------------

	/**
	 * Begin Transaction
	 * 
	 * @access	public
	 * @return	bool		 
	 */	
	function trans_begin()
	{
		if ( ! $this->trans_enabled)
		{
			return TRUE;
		}
		
		// When transactions are nested we only begin/commit/rollback the outermost ones
		if ($this->_trans_depth > 0)
		{
			return TRUE;
		}
		
		$this->_commit = OCI_DEFAULT;
		return TRUE;
	}

	// --------------------------------------------------------------------

	/**
	 * Commit Transaction
	 * 
	 * @access	public
	 * @return	bool		 
	 */	
	function trans_commit()
	{
		if ( ! $this->trans_enabled)
		{
			return TRUE;
		}

		// When transactions are nested we only begin/commit/rollback the outermost ones
		if ($this->_trans_depth > 0)
		{
			return TRUE;
		}

		$ret = OCIcommit($this->conn_id);
		$this->_commit = OCI_COMMIT_ON_SUCCESS;
		return $ret;
	}

	// --------------------------------------------------------------------

	/**
	 * Rollback Transaction
	 * 
	 * @access	public
	 * @return	bool		 
	 */	
	function trans_rollback()
	{
		if ( ! $this->trans_enabled)
		{
			return TRUE;
		}

		// When transactions are nested we only begin/commit/rollback the outermost ones
		if ($this->_trans_depth > 0)
		{
			return TRUE;
		}

		$ret = OCIrollback($this->conn_id);
		$this->_commit = OCI_COMMIT_ON_SUCCESS;
		return $ret;
	}

    // --------------------------------------------------------------------

    /**
     * Escape String
     *
     * @access  public
     * @param   string
     * @return  string
     */
    function escape_str($str)
    {
        return $str;
    }

    // --------------------------------------------------------------------

    /**
     * Close DB Connection
     *
     * @access  public
     * @param   resource
     * @return  void
     */
    function destroy($conn_id)
    {
        ocilogoff($conn_id);
    }

    // --------------------------------------------------------------------

    /**
     * Affected Rows
     *
     * @access  public
     * @return  integer
     */
    function affected_rows()
    {
        return @ocirowcount($this->stmt_id);
    }

    // --------------------------------------------------------------------

    /**
     * Insert ID
     *
     * @access  public
     * @return  integer
     */
    function insert_id()
    {
        // not supported in oracle
        return 0;
    }

    // --------------------------------------------------------------------

    /**
     * "Count All" query
     *
     * Generates a platform-specific query string that counts all records in
     * the specified database
     *
     * @access  public
     * @param   string
     * @return  string
     */
    function count_all($table = '')
    {
        if ($table == '')
            return '0';

        $query = $this->query("SELECT COUNT(1) AS numrows FROM ".$table);

        if ($query == FALSE)
            {
            return 0;
            }

        $row = $query->row();
        return $row->NUMROWS;
    }

    // --------------------------------------------------------------------

    /**
     * The error message string
     *
     * @access  public
     * @return  string
     */
    function error_message()
    {
        $error = ocierror($this->conn_id);
        return $error['message'];
    }

    // --------------------------------------------------------------------

    /**
     * The error message number
     *
     * @access  public
     * @return  integer
     */
    function error_number()
    {
        $error = ocierror($this->conn_id);
        return $error['code'];
    }

    // --------------------------------------------------------------------

    /**
     * Escape Table Name
     *
     * This function adds backticks if the table name has a period
     * in it. Some DBs will get cranky unless periods are escaped
     *
     * @access  public
     * @param   string  the table name
     * @return  string
     */
    function escape_table($table)
    {
        if (stristr($table, '.'))
        {
            $table = preg_replace("/\./", "`.`", $table);
        }

        return $table;
    }

    // --------------------------------------------------------------------

    /**
     * Field data query
     *
     * Generates a platform-specific query so that the column data can be retrieved
     *
     * @access  public
     * @param   string  the table name
     * @return  object
     */
    function _field_data($table)
    {
        $sql = "SELECT * FROM ".$this->escape_table($table)." where rownum = 1";
        $query = $this->query($sql);
        return $query->field_data();
    }

    // --------------------------------------------------------------------

    /**
     * Insert statement
     *
     * Generates a platform-specific insert string from the supplied data
     *
     * @access  public
     * @param   string  the table name
     * @param   array   the insert keys
     * @param   array   the insert values
     * @return  string
     */
    function _insert($table, $keys, $values)
    {
    return "INSERT INTO ".$this->escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
    }

    // --------------------------------------------------------------------

    /**
     * Update statement
     *
     * Generates a platform-specific update string from the supplied data
     *
     * @access  public
     * @param   string  the table name
     * @param   array   the update data
     * @param   array   the where clause
     * @return  string
     */
    function _update($table, $values, $where)
    {
        foreach($values as $key => $val)
        {
            $valstr[] = $key." = ".$val;
        }

        return "UPDATE ".$this->escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where);
    }

    // --------------------------------------------------------------------

    /**
     * Delete statement
     *
     * Generates a platform-specific delete string from the supplied data
     *
     * @access  public
     * @param   string  the table name
     * @param   array   the where clause
     * @return  string
     */
    function _delete($table, $where)
    {
        return "DELETE FROM ".$this->escape_table($table)." WHERE ".implode(" ", $where);
    }

    // --------------------------------------------------------------------

    /**
     * Version number query string
     *
     * @access  public
     * @return  string
     */
    function _version()
    {
        $ver = ociserverversion($this->conn_id);
        return $ver;
    }

    // --------------------------------------------------------------------

    /**
     * Show table query
     *
     * Generates a platform-specific query string so that the table names can be fetched
     *
     * @access  public
     * @return  string
     */
    function _show_tables()
    {
        return "select TABLE_NAME FROM ALL_TABLES";
    }

    // --------------------------------------------------------------------

    /**
     * Show columnn query
     *
     * Generates a platform-specific query string so that the column names can be fetched
     *
     * @access  public
     * @param   string  the table name
     * @return  string
     */
    function _show_columns($table = '')
    {
        return "SELECT COLUMN_NAME FROM all_tab_columns WHERE table_name = '$table'";
    }

    // --------------------------------------------------------------------

    /**
     * Limit string
     *
     * Generates a platform-specific LIMIT clause
     *
     * @access  public
     * @param   string  the sql query string
     * @param   integer the number of rows to limit the query to
     * @param   integer the offset value
     * @return  string
     */
    function _limit($sql, $limit, $offset)
    {
        $limit = $offset + $limit;
        $newsql = "SELECT * FROM (select inner_query.*, rownum rnum FROM ($sql) inner_query WHERE rownum < $limit)";

        if ($offset != 0)
        {
            $newsql .= " WHERE rnum >= $offset";
        }

        // remember that we used limits
        $this->limit_used = TRUE;

        return $newsql;
    }	

}


/**
 * oci8 Result Class
 *
 * This class extends the parent result class: CI_DB_result
 *
 * @category    Database
 * @author      Rick Ellis
 * @link        http://www.codeigniter.com/user_guide/libraries/database/
 */
class CI_DB_oci8_result extends CI_DB_result {

    var $stmt_id;
    var $curs_id;
    var $limit_used;

    /**
     * Number of rows in the result set
     *
     * @access  public
     * @return  integer
     */
    function num_rows()
    {
        // get the results, count them,
        // rerun query - otherwise we
        // won't have data after calling 
        // num_rows()
        $this->result_array();
        $rowcount = count($this->result_array);
        @ociexecute($this->stmt_id);
        if ($this->curs_id)
            {
            @ociexecute($this->curs_id);
            }
        return $rowcount;
    }

    // --------------------------------------------------------------------

    /**
     * Number of fields in the result set
     *
     * @access  public
     * @return  integer
     */
    function num_fields()
    {
        $count = @ocinumcols($this->stmt_id);

        // if we used a limit, we added a field,
        // subtract it out
        if ($this->limit_used)
        {
            $count = $count - 1;
        }

        return $count;
    }

    // --------------------------------------------------------------------

    /**
     * Field data
     *
     * Generates an array of objects containing field meta-data
     *
     * @access  public
     * @return  array
     */
    function field_data()
    {
        $retval = array();
        $fieldCount = $this->num_fields();
        for ($c = 1; $c <= $fieldCount; $c++)
        {
            $F              = new stdClass();
            $F->name        = ocicolumnname($this->stmt_id, $c);
            $F->type        = ocicolumntype($this->stmt_id, $c);
            $F->max_length  = ocicolumnsize($this->stmt_id, $c);

            $retval[] = $F;
        }

        return $retval;
    }

    // --------------------------------------------------------------------

    /**
     * Result - associative array
     *
     * Returns the result set as an array
     *
     * @access  private
     * @return  array
     */
    function _fetch_assoc(&$row)
    {
        // if pulling from a cursor, use curs_id
        if ($this->curs_id)
		{
			return ocifetchinto($this->curs_id, $row, OCI_ASSOC + OCI_RETURN_NULLS);
		}
		else
		{
			return ocifetchinto($this->stmt_id, $row, OCI_ASSOC + OCI_RETURN_NULLS);
		}
    }

    // --------------------------------------------------------------------

    /**
     * Result - object
     *
     * Returns the result set as an object
     *
     * @access  private
     * @return  object
     */
    function _fetch_object()
    {
        // the PHP 4 version of the oracle functions do not
        // have a fetch method so we call the array version
        // and build an object from that

        $row = array();
        $res = $this->_fetch_assoc($row);
        if ($res != FALSE)
		{
			$obj = new stdClass();
			foreach ($row as $key => $value)
			{
				$obj->{$key} = $value;
			}
			
			$res = $obj;
		}
        return $res;
    }

    /**
     * Query result.  "array" version.
     *
     * @access  public
     * @return  array
     */
    function result_array()
    {
        if (count($this->result_array) > 0)
        {
            return $this->result_array;
        }

        // oracle's fetch functions do not
        // return arrays, the information
        // is returned in reference parameters
        //
        $row = NULL;
        while ($this->_fetch_assoc($row))
        {
            $this->result_array[] = $row;
        }

        if (count($this->result_array) == 0)
        {
            return FALSE;
        }

        return $this->result_array;
    }

}

?>