blob: 676cb9ccdb134337ee0ca6ec47f2a1d0e681d873 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
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 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * Initialize the database
31 *
32 * @category Database
Andrey Andreev75546112012-07-05 11:01:29 +030033 * @author EllisLab Dev Team
34 * @link http://codeigniter.com/user_guide/database/
David Behler07b53422011-08-15 00:25:06 +020035 * @param string
Jamie Rumbelow7efad202012-02-19 12:37:00 +000036 * @param bool Determines if query builder should be used or not
Derek Allard2067d1a2008-11-13 22:59:24 +000037 */
Jamie Rumbelow7efad202012-02-19 12:37:00 +000038function &DB($params = '', $query_builder_override = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +000039{
40 // Load the DB config file if a DSN string wasn't passed
Andrey Andreevc2697db2012-03-26 13:05:24 +030041 if (is_string($params) && strpos($params, '://') === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000042 {
Phil Sturgeon05fa6112011-04-06 22:57:43 +010043 // Is the config file in the environment folder?
Andrey Andreev24276a32012-01-08 02:44:38 +020044 if (( ! defined('ENVIRONMENT') OR ! file_exists($file_path = APPPATH.'config/'.ENVIRONMENT.'/database.php'))
Andrey Andreevc2697db2012-03-26 13:05:24 +030045 && ! file_exists($file_path = APPPATH.'config/database.php'))
joelcoxe3da4282011-01-16 15:00:04 +010046 {
Andrey Andreev24276a32012-01-08 02:44:38 +020047 show_error('The configuration file database.php does not exist.');
joelcoxe3da4282011-01-16 15:00:04 +010048 }
David Behler07b53422011-08-15 00:25:06 +020049
joelcoxe3da4282011-01-16 15:00:04 +010050 include($file_path);
Rene Brokholmd6d18582012-07-05 08:32:39 +020051 //make packages contain database config files
52 foreach(get_instance()->load->get_package_paths() as $path)
Rene Brokholmf5a85302012-07-05 09:05:32 +020053 {
54 if ($path !== APPPATH)
55 {
56 if (file_exists ($file_path = $path.'config/'.ENVIRONMENT.'/database.php'))
57 {
58 include ($file_path);
59 }
60 elseif ( file_exists ($file_path = $path.'config/database.php'))
61 {
62 include ($file_path);
63 }
64 }
65 }
Barry Mienydd671972010-10-04 16:33:58 +020066
Andrey Andreev24276a32012-01-08 02:44:38 +020067 if ( ! isset($db) OR count($db) === 0)
Derek Allard2067d1a2008-11-13 22:59:24 +000068 {
69 show_error('No database connection settings were found in the database config file.');
70 }
Barry Mienydd671972010-10-04 16:33:58 +020071
Alex Bilbie48a2baf2012-06-02 11:09:54 +010072 if ($params !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +000073 {
74 $active_group = $params;
75 }
Barry Mienydd671972010-10-04 16:33:58 +020076
Derek Allard2067d1a2008-11-13 22:59:24 +000077 if ( ! isset($active_group) OR ! isset($db[$active_group]))
78 {
79 show_error('You have specified an invalid database connection group.');
80 }
Barry Mienydd671972010-10-04 16:33:58 +020081
Derek Allard2067d1a2008-11-13 22:59:24 +000082 $params = $db[$active_group];
83 }
84 elseif (is_string($params))
85 {
Barry Mienydd671972010-10-04 16:33:58 +020086
Derek Allard2067d1a2008-11-13 22:59:24 +000087 /* parse the URL from the DSN string
Derek Jones37f4b9c2011-07-01 17:56:50 -050088 * Database settings can be passed as discreet
89 * parameters or as a data source name in the first
90 * parameter. DSNs must have this prototype:
91 * $dsn = 'driver://username:password@hostname/database';
Barry Mienydd671972010-10-04 16:33:58 +020092 */
Andrey Andreevc2697db2012-03-26 13:05:24 +030093 if (($dsn = @parse_url($params)) === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000094 {
95 show_error('Invalid DB Connection String');
96 }
Barry Mienydd671972010-10-04 16:33:58 +020097
Derek Allard2067d1a2008-11-13 22:59:24 +000098 $params = array(
Andrey Andreevc2697db2012-03-26 13:05:24 +030099 'dbdriver' => $dsn['scheme'],
100 'hostname' => isset($dsn['host']) ? rawurldecode($dsn['host']) : '',
101 'port' => isset($dsn['port']) ? rawurldecode($dsn['port']) : '',
102 'username' => isset($dsn['user']) ? rawurldecode($dsn['user']) : '',
103 'password' => isset($dsn['pass']) ? rawurldecode($dsn['pass']) : '',
104 'database' => isset($dsn['path']) ? rawurldecode(substr($dsn['path'], 1)) : ''
Andrey Andreev24276a32012-01-08 02:44:38 +0200105 );
Barry Mienydd671972010-10-04 16:33:58 +0200106
Derek Allard2067d1a2008-11-13 22:59:24 +0000107 // were additional config items set?
Andrey Andreevc2697db2012-03-26 13:05:24 +0300108 if (isset($dsn['query']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000109 {
Andrey Andreevc2697db2012-03-26 13:05:24 +0300110 parse_str($dsn['query'], $extra);
Taufan Adityaee2f5d02012-03-30 06:29:11 +0700111
Pascal Krietec3a4a8d2011-02-14 13:40:08 -0500112 foreach ($extra as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +0000113 {
Taufan Adityaee2f5d02012-03-30 06:29:11 +0700114 if (is_string($val) && in_array(strtoupper($val), array('TRUE', 'FALSE', 'NULL')))
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 {
Taufan Adityaee2f5d02012-03-30 06:29:11 +0700116 $val = var_export($val);
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 }
118
119 $params[$key] = $val;
120 }
121 }
122 }
Barry Mienydd671972010-10-04 16:33:58 +0200123
Andrey Andreev24276a32012-01-08 02:44:38 +0200124 // No DB specified yet? Beat them senseless...
Andrey Andreeve4c30192012-06-04 15:08:24 +0300125 if (empty($params['dbdriver']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000126 {
127 show_error('You have not selected a database type to connect to.');
128 }
129
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000130 // Load the DB classes. Note: Since the query builder class is optional
Derek Allard2067d1a2008-11-13 22:59:24 +0000131 // we need to dynamically create a class that extends proper parent class
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000132 // based on whether we're using the query builder class or not.
133 if ($query_builder_override !== NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000135 $query_builder = $query_builder_override;
Derek Allard2067d1a2008-11-13 22:59:24 +0000136 }
Andrey Andreevd45f9502012-05-24 19:31:39 +0300137 // Backwards compatibility work-around for keeping the
138 // $active_record config variable working. Should be
139 // removed in v3.1
140 elseif ( ! isset($query_builder) && isset($active_record))
141 {
142 $query_builder = $active_record;
143 }
Barry Mienydd671972010-10-04 16:33:58 +0200144
Greg Aker3a746652011-04-19 10:59:47 -0500145 require_once(BASEPATH.'database/DB_driver.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000146
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100147 if ( ! isset($query_builder) OR $query_builder === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000148 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000149 require_once(BASEPATH.'database/DB_query_builder.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 if ( ! class_exists('CI_DB'))
151 {
Jamie Rumbelow7efad202012-02-19 12:37:00 +0000152 class CI_DB extends CI_DB_query_builder { }
Derek Allard2067d1a2008-11-13 22:59:24 +0000153 }
154 }
Andrey Andreev24276a32012-01-08 02:44:38 +0200155 elseif ( ! class_exists('CI_DB'))
Derek Allard2067d1a2008-11-13 22:59:24 +0000156 {
Andrey Andreev24276a32012-01-08 02:44:38 +0200157 class CI_DB extends CI_DB_driver { }
Derek Allard2067d1a2008-11-13 22:59:24 +0000158 }
Barry Mienydd671972010-10-04 16:33:58 +0200159
Taufan Adityaa8a2e332012-03-29 03:56:46 +0700160 // Load the DB driver
161 $driver_file = BASEPATH.'database/drivers/'.$params['dbdriver'].'/'.$params['dbdriver'].'_driver.php';
162
Andrey Andreev3345ee52012-06-23 20:51:47 +0300163 if ( ! file_exists($driver_file))
164 {
165 show_error('Invalid DB driver');
166 }
Taufan Adityaa8a2e332012-03-29 03:56:46 +0700167
168 require_once($driver_file);
Derek Allard2067d1a2008-11-13 22:59:24 +0000169
170 // Instantiate the DB adapter
171 $driver = 'CI_DB_'.$params['dbdriver'].'_driver';
Pascal Kriete58560022010-11-10 16:01:20 -0500172 $DB = new $driver($params);
Barry Mienydd671972010-10-04 16:33:58 +0200173
Andrey Andreev3345ee52012-06-23 20:51:47 +0300174 // Check for a subdriver
Andrey Andreev754e2212012-06-23 20:54:06 +0300175 if ( ! empty($DB->subdriver))
Andrey Andreev3345ee52012-06-23 20:51:47 +0300176 {
Andrey Andreev44107772012-06-25 18:38:34 +0300177 $driver_file = BASEPATH.'database/drivers/'.$DB->dbdriver.'/subdrivers/'.$DB->dbdriver.'_'.$DB->subdriver.'_driver.php';
Andrey Andreev3345ee52012-06-23 20:51:47 +0300178
179 if (file_exists($driver_file))
180 {
181 require_once($driver_file);
Andrey Andreev44107772012-06-25 18:38:34 +0300182 $driver = 'CI_DB_'.$DB->dbdriver.'_'.$DB->subdriver.'_driver';
Andrey Andreev3345ee52012-06-23 20:51:47 +0300183 $DB = new $driver($params);
184 }
185 }
186
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100187 if ($DB->autoinit === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000188 {
189 $DB->initialize();
190 }
Barry Mienydd671972010-10-04 16:33:58 +0200191
Andrey Andreeve4c30192012-06-04 15:08:24 +0300192 if ( ! empty($params['stricton']))
Derek Jonesc34e5782010-03-02 17:35:55 -0600193 {
Barry Mienydd671972010-10-04 16:33:58 +0200194 $DB->query('SET SESSION sql_mode="STRICT_ALL_TABLES"');
Derek Jonesc34e5782010-03-02 17:35:55 -0600195 }
Barry Mienydd671972010-10-04 16:33:58 +0200196
Derek Allard2067d1a2008-11-13 22:59:24 +0000197 return $DB;
Barry Mienydd671972010-10-04 16:33:58 +0200198}
Derek Allard2067d1a2008-11-13 22:59:24 +0000199
Derek Allard2067d1a2008-11-13 22:59:24 +0000200/* End of file DB.php */
Andrey Andreev7f57a012012-05-24 18:40:50 +0300201/* Location: ./system/database/DB.php */