blob: b0113b6f4bba305149caf470f58a5cc9ff24ee84 [file] [log] [blame]
Andrey Andreev24276a32012-01-08 02:44:38 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreev24276a32012-01-08 02:44:38 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev24276a32012-01-08 02:44:38 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * Initialize the database
30 *
31 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050032 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000033 * @link http://codeigniter.com/user_guide/database/
David Behler07b53422011-08-15 00:25:06 +020034 * @param string
Jamie Rumbelow7efad202012-02-19 12:37:00 +000035 * @param bool Determines if query builder should be used or not
Derek Allard2067d1a2008-11-13 22:59:24 +000036 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +000037function &DB($params = '', $query_builder_override = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +000038{
39 // Load the DB config file if a DSN string wasn't passed
Andrey Andreevc2697db2012-03-26 13:05:24 +030040 if (is_string($params) && strpos($params, '://') === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000041 {
Phil Sturgeon05fa6112011-04-06 22:57:43 +010042 // Is the config file in the environment folder?
Andrey Andreev24276a32012-01-08 02:44:38 +020043 if (( ! defined('ENVIRONMENT') OR ! file_exists($file_path = APPPATH.'config/'.ENVIRONMENT.'/database.php'))
Andrey Andreevc2697db2012-03-26 13:05:24 +030044 && ! file_exists($file_path = APPPATH.'config/database.php'))
joelcoxe3da4282011-01-16 15:00:04 +010045 {
Andrey Andreev24276a32012-01-08 02:44:38 +020046 show_error('The configuration file database.php does not exist.');
joelcoxe3da4282011-01-16 15:00:04 +010047 }
David Behler07b53422011-08-15 00:25:06 +020048
joelcoxe3da4282011-01-16 15:00:04 +010049 include($file_path);
Barry Mienydd671972010-10-04 16:33:58 +020050
Andrey Andreev24276a32012-01-08 02:44:38 +020051 if ( ! isset($db) OR count($db) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +000052 {
53 show_error('No database connection settings were found in the database config file.');
54 }
Barry Mienydd671972010-10-04 16:33:58 +020055
Alex Bilbie48a2baf2012-06-02 11:09:54 +010056 if ($params !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +000057 {
58 $active_group = $params;
59 }
Barry Mienydd671972010-10-04 16:33:58 +020060
Derek Allard2067d1a2008-11-13 22:59:24 +000061 if ( ! isset($active_group) OR ! isset($db[$active_group]))
62 {
63 show_error('You have specified an invalid database connection group.');
64 }
Barry Mienydd671972010-10-04 16:33:58 +020065
Derek Allard2067d1a2008-11-13 22:59:24 +000066 $params = $db[$active_group];
67 }
68 elseif (is_string($params))
69 {
Barry Mienydd671972010-10-04 16:33:58 +020070
Derek Allard2067d1a2008-11-13 22:59:24 +000071 /* parse the URL from the DSN string
Derek Jones37f4b9c2011-07-01 17:56:50 -050072 * Database settings can be passed as discreet
73 * parameters or as a data source name in the first
74 * parameter. DSNs must have this prototype:
75 * $dsn = 'driver://username:password@hostname/database';
Barry Mienydd671972010-10-04 16:33:58 +020076 */
Andrey Andreevc2697db2012-03-26 13:05:24 +030077 if (($dsn = @parse_url($params)) === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000078 {
79 show_error('Invalid DB Connection String');
80 }
Barry Mienydd671972010-10-04 16:33:58 +020081
Derek Allard2067d1a2008-11-13 22:59:24 +000082 $params = array(
Andrey Andreevc2697db2012-03-26 13:05:24 +030083 'dbdriver' => $dsn['scheme'],
84 'hostname' => isset($dsn['host']) ? rawurldecode($dsn['host']) : '',
85 'port' => isset($dsn['port']) ? rawurldecode($dsn['port']) : '',
86 'username' => isset($dsn['user']) ? rawurldecode($dsn['user']) : '',
87 'password' => isset($dsn['pass']) ? rawurldecode($dsn['pass']) : '',
88 'database' => isset($dsn['path']) ? rawurldecode(substr($dsn['path'], 1)) : ''
Andrey Andreev24276a32012-01-08 02:44:38 +020089 );
Barry Mienydd671972010-10-04 16:33:58 +020090
Derek Allard2067d1a2008-11-13 22:59:24 +000091 // were additional config items set?
Andrey Andreevc2697db2012-03-26 13:05:24 +030092 if (isset($dsn['query']))
Derek Allard2067d1a2008-11-13 22:59:24 +000093 {
Andrey Andreevc2697db2012-03-26 13:05:24 +030094 parse_str($dsn['query'], $extra);
Taufan Adityaee2f5d02012-03-30 06:29:11 +070095
Pascal Krietec3a4a8d2011-02-14 13:40:08 -050096 foreach ($extra as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +000097 {
Taufan Adityaee2f5d02012-03-30 06:29:11 +070098 if (is_string($val) && in_array(strtoupper($val), array('TRUE', 'FALSE', 'NULL')))
Derek Allard2067d1a2008-11-13 22:59:24 +000099 {
Taufan Adityaee2f5d02012-03-30 06:29:11 +0700100 $val = var_export($val);
Derek Allard2067d1a2008-11-13 22:59:24 +0000101 }
102
103 $params[$key] = $val;
104 }
105 }
106 }
Barry Mienydd671972010-10-04 16:33:58 +0200107
Andrey Andreev24276a32012-01-08 02:44:38 +0200108 // No DB specified yet? Beat them senseless...
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100109 if ( ! isset($params['dbdriver']) OR $params['dbdriver'] === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000110 {
111 show_error('You have not selected a database type to connect to.');
112 }
113
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000114 // Load the DB classes. Note: Since the query builder class is optional
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 // we need to dynamically create a class that extends proper parent class
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000116 // based on whether we're using the query builder class or not.
117 if ($query_builder_override !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000119 $query_builder = $query_builder_override;
Derek Allard2067d1a2008-11-13 22:59:24 +0000120 }
Andrey Andreevd45f9502012-05-24 19:31:39 +0300121 // Backwards compatibility work-around for keeping the
122 // $active_record config variable working. Should be
123 // removed in v3.1
124 elseif ( ! isset($query_builder) && isset($active_record))
125 {
126 $query_builder = $active_record;
127 }
Barry Mienydd671972010-10-04 16:33:58 +0200128
Greg Aker3a746652011-04-19 10:59:47 -0500129 require_once(BASEPATH.'database/DB_driver.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000130
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100131 if ( ! isset($query_builder) OR $query_builder === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000133 require_once(BASEPATH.'database/DB_query_builder.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 if ( ! class_exists('CI_DB'))
135 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000136 class CI_DB extends CI_DB_query_builder { }
Derek Allard2067d1a2008-11-13 22:59:24 +0000137 }
138 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200139 elseif ( ! class_exists('CI_DB'))
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 {
Andrey Andreev24276a32012-01-08 02:44:38 +0200141 class CI_DB extends CI_DB_driver { }
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 }
Barry Mienydd671972010-10-04 16:33:58 +0200143
Taufan Adityaa8a2e332012-03-29 03:56:46 +0700144 // Load the DB driver
145 $driver_file = BASEPATH.'database/drivers/'.$params['dbdriver'].'/'.$params['dbdriver'].'_driver.php';
146
147 if ( ! file_exists($driver_file)) show_error('Invalid DB driver');
148
149 require_once($driver_file);
Derek Allard2067d1a2008-11-13 22:59:24 +0000150
151 // Instantiate the DB adapter
152 $driver = 'CI_DB_'.$params['dbdriver'].'_driver';
Pascal Kriete58560022010-11-10 16:01:20 -0500153 $DB = new $driver($params);
Barry Mienydd671972010-10-04 16:33:58 +0200154
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100155 if ($DB->autoinit === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000156 {
157 $DB->initialize();
158 }
Barry Mienydd671972010-10-04 16:33:58 +0200159
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100160 if (isset($params['stricton']) && $params['stricton'] === TRUE)
Derek Jonesc34e5782010-03-02 17:35:55 -0600161 {
Barry Mienydd671972010-10-04 16:33:58 +0200162 $DB->query('SET SESSION sql_mode="STRICT_ALL_TABLES"');
Derek Jonesc34e5782010-03-02 17:35:55 -0600163 }
Barry Mienydd671972010-10-04 16:33:58 +0200164
Derek Allard2067d1a2008-11-13 22:59:24 +0000165 return $DB;
Barry Mienydd671972010-10-04 16:33:58 +0200166}
Derek Allard2067d1a2008-11-13 22:59:24 +0000167
Derek Allard2067d1a2008-11-13 22:59:24 +0000168/* End of file DB.php */
Andrey Andreev7f57a012012-05-24 18:40:50 +0300169/* Location: ./system/database/DB.php */