File: //home/cafsindia/lead_cafsinfotech.com/public/legacy/include/database/DBManagerFactory.php
<?php
if (!defined('sugarEntry') || !sugarEntry) {
die('Not A Valid Entry Point');
}
/**
*
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
*
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
* Copyright (C) 2011 - 2018 SalesAgility Ltd.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
*/
/**
* Description: This file generates the appropriate manager for the database
*
* Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
* All Rights Reserved.
* Contributor(s): ______________________________________..
********************************************************************************/
require_once dirname(__DIR__) . '/../include/database/DBManager.php';
/**
* Database driver factory
* @api
* Instantiates and configures appropriate DB drivers
*/
#[\AllowDynamicProperties]
class DBManagerFactory
{
public static $instances = array();
/**
* Returns a reference to the DB object of specific type
*
* @param string $type DB type
* @param array $config DB configuration
* @return object DBManager instance
*/
public static function getTypeInstance($type, $config = array())
{
global $sugar_config;
if (empty($config['db_manager'])) {
// standard types
switch ($type) {
case "mysql":
if (empty($sugar_config['mysqli_disabled']) && function_exists('mysqli_connect')) {
$my_db_manager = 'MysqliManager';
} else {
$my_db_manager = "MysqlManager";
}
break;
case "mssql":
if (function_exists('sqlsrv_connect')
&& (empty($config['db_mssql_force_driver']) || $config['db_mssql_force_driver'] == 'sqlsrv')) {
$my_db_manager = 'SqlsrvManager';
} elseif (self::isFreeTDS()
&& (empty($config['db_mssql_force_driver']) || $config['db_mssql_force_driver'] == 'freetds')) {
$my_db_manager = 'FreeTDSManager';
} else {
$my_db_manager = 'MssqlManager';
}
break;
default:
$my_db_manager = self::getManagerByType($type, false);
if (empty($my_db_manager)) {
$GLOBALS['log']->fatal("unable to load DB manager for: $type");
sugar_die("Cannot load DB manager");
}
}
} else {
$my_db_manager = $config['db_manager'];
}
// sanitize the name
$my_db_manager = preg_replace("/[^A-Za-z0-9_-]/", "", (string) $my_db_manager);
if (!empty($config['db_manager_class'])) {
$my_db_manager = $config['db_manager_class'];
} else {
if (file_exists("custom/include/database/{$my_db_manager}.php")) {
require_once("custom/include/database/{$my_db_manager}.php");
} else {
require_once("include/database/{$my_db_manager}.php");
}
}
if (class_exists($my_db_manager)) {
return new $my_db_manager();
} else {
return null;
}
}
/**
* Returns a reference to the DB object for instance $instanceName, or the default
* instance if one is not specified
*
* @param string $instanceName optional, name of the instance
* @return DBManager instance
*/
public static function getInstance($instanceName = '')
{
global $sugar_config;
if(empty($sugar_config['dbconfig']['db_name']))
{
return null;
}
static $count = 0, $old_count = 0;
//fall back to the default instance name
if (empty($sugar_config['db'][$instanceName])) {
$instanceName = '';
}
if (!isset(self::$instances[$instanceName])) {
$config = $sugar_config['dbconfig'];
$count++;
self::$instances[$instanceName] = self::getTypeInstance($config['db_type'], $config);
if (!empty($sugar_config['dbconfigoption'])) {
self::$instances[$instanceName]->setOptions($sugar_config['dbconfigoption']);
}
self::$instances[$instanceName]->connect($config, true);
self::$instances[$instanceName]->count_id = $count;
self::$instances[$instanceName]->references = 0;
} else {
$old_count++;
self::$instances[$instanceName]->references = $old_count;
}
return self::$instances[$instanceName];
}
/**
* Disconnect all DB connections in the system
*/
public static function disconnectAll()
{
foreach (self::$instances as $instance) {
$instance->disconnect();
}
self::$instances = array();
}
/**
* Get DB manager class name by type name
*
* For use in install
* @param string $type
* @param bool $validate Return only valid drivers or any?
* @return string
*/
public static function getManagerByType($type, $validate = true)
{
$drivers = self::getDbDrivers($validate);
if (!empty($drivers[$type])) {
return get_class($drivers[$type]);
}
return false;
}
/**
* Scan directory for valid DB drivers
* @param string $dir
* @param array $drivers
* @param bool $validate Return only valid drivers or all of them?
*/
protected static function scanDriverDir($dir, &$drivers, $validate = true)
{
if (!is_dir($dir)) {
return;
}
$scandir = opendir($dir);
if ($scandir === false) {
return;
}
while (($name = readdir($scandir)) !== false) {
if (substr($name, -11) != "Manager.php") {
continue;
}
if ($name == "DBManager.php") {
continue;
}
require_once("$dir/$name");
$classname = substr($name, 0, -4);
if (!class_exists($classname)) {
continue;
}
$driver = new $classname;
if (!$validate || $driver->valid()) {
if (empty($drivers[$driver->dbType])) {
$drivers[$driver->dbType] = array();
}
$drivers[$driver->dbType][] = $driver;
}
}
}
/**
* Compares two drivers by priority
* @internal
* @param object $a
* @param object $b
* @return int
*/
public static function _compareDrivers($a, $b)
{
return $b->priority - $a->priority;
}
/**
* Get list of all available DB drivers
* @param bool $validate Return only valid drivers or all of them?
* @return array List of Db drivers, key - variant (mysql, mysqli), value - driver type (mysql, mssql)
*/
public static function getDbDrivers($validate = true)
{
$drivers = array();
self::scanDriverDir("include/database", $drivers, $validate);
self::scanDriverDir("custom/include/database", $drivers, $validate);
$result = array();
foreach ($drivers as $type => $tdrivers) {
if (empty($tdrivers)) {
continue;
}
if ((is_countable($tdrivers) ? count($tdrivers) : 0) > 1) {
usort($tdrivers, array(__CLASS__, "_compareDrivers"));
}
$result[$type] = $tdrivers[0];
}
return $result;
}
/**
* Check if we have freeTDS driver installed
* Invoked when connected to mssql. checks if we have freetds version of mssql library.
* the response is put into a global variable.
* @return bool
*/
public static function isFreeTDS()
{
static $is_freetds = null;
if ($is_freetds === null) {
ob_start();
phpinfo(INFO_MODULES);
$info=ob_get_contents();
ob_end_clean();
$is_freetds = (strpos($info, 'FreeTDS') !== false);
}
return $is_freetds;
}
}