Adapter
6 months ago
Schema
3 months ago
Adapter.php
6 months ago
AdapterInterface.php
3 months ago
BatchInsert.php
6 months ago
Schema.php
3 months ago
SchemaInterface.php
3 months ago
Settings.php
1 year ago
TransactionLevel.php
1 year ago
TransactionalDatabaseDynamicTrait.php
1 year ago
TransactionalDatabaseInterface.php
1 year ago
TransactionalDatabaseStaticTrait.php
1 year ago
Adapter.php
143 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\Db; |
| 10 | |
| 11 | use Zend_Db_Table; |
| 12 | use Piwik\Piwik; |
| 13 | /** |
| 14 | */ |
| 15 | class Adapter |
| 16 | { |
| 17 | /** |
| 18 | * Create adapter |
| 19 | * |
| 20 | * @param string $adapterName database adapter name |
| 21 | * @param array $dbInfos database connection info |
| 22 | * @param bool $connect |
| 23 | * @return AdapterInterface |
| 24 | */ |
| 25 | public static function factory($adapterName, |
| 26 | #[\SensitiveParameter] |
| 27 | &$dbInfos, $connect = \true) |
| 28 | { |
| 29 | if ($connect) { |
| 30 | if (isset($dbInfos['port']) && is_string($dbInfos['port']) && $dbInfos['port'][0] === '/') { |
| 31 | $dbInfos['unix_socket'] = $dbInfos['port']; |
| 32 | unset($dbInfos['host']); |
| 33 | unset($dbInfos['port']); |
| 34 | } |
| 35 | // not used by Zend Framework |
| 36 | unset($dbInfos['tables_prefix']); |
| 37 | unset($dbInfos['adapter']); |
| 38 | unset($dbInfos['schema']); |
| 39 | } |
| 40 | $className = self::getAdapterClassName($adapterName); |
| 41 | // make sure not to pass any references otherwise they will modify $dbInfos |
| 42 | $infos = array(); |
| 43 | foreach ($dbInfos as $key => $val) { |
| 44 | $infos[$key] = $val; |
| 45 | } |
| 46 | $adapter = new $className($infos); |
| 47 | if ($connect) { |
| 48 | try { |
| 49 | $adapter->getConnection(); |
| 50 | Zend_Db_Table::setDefaultAdapter($adapter); |
| 51 | // we don't want the connection information to appear in the logs |
| 52 | $adapter->resetConfig(); |
| 53 | } catch (\Exception $e) { |
| 54 | // we don't want certain exceptions to leak information |
| 55 | $msg = self::overriddenExceptionMessage($e->getMessage()); |
| 56 | if ('' !== $msg) { |
| 57 | throw new \Exception($msg); |
| 58 | } |
| 59 | throw $e; |
| 60 | } |
| 61 | } |
| 62 | return $adapter; |
| 63 | } |
| 64 | /** |
| 65 | * Get adapter class name |
| 66 | * |
| 67 | * @param string $adapterName |
| 68 | * @return string |
| 69 | * @throws \Exception |
| 70 | */ |
| 71 | private static function getAdapterClassName($adapterName) |
| 72 | { |
| 73 | $className = 'Piwik\\Db\\Adapter\\' . str_replace(' ', '\\', ucwords(str_replace(array('_', '\\'), ' ', strtolower($adapterName)))); |
| 74 | if (!class_exists($className)) { |
| 75 | throw new \Exception(sprintf("Adapter '%s' is not valid. Maybe check that your Matomo configuration files in config/*.ini.php are readable by the webserver.", $adapterName)); |
| 76 | } |
| 77 | return $className; |
| 78 | } |
| 79 | /** |
| 80 | * Get default port for named adapter |
| 81 | * |
| 82 | * @deprecated use Schema::getDefaultPortForSchema instead |
| 83 | * @param string $adapterName |
| 84 | * @return int |
| 85 | */ |
| 86 | public static function getDefaultPortForAdapter($adapterName) |
| 87 | { |
| 88 | $className = self::getAdapterClassName($adapterName); |
| 89 | return call_user_func(array($className, 'getDefaultPort')); |
| 90 | } |
| 91 | /** |
| 92 | * Get list of adapters |
| 93 | * |
| 94 | * @return array |
| 95 | */ |
| 96 | public static function getAdapters() |
| 97 | { |
| 98 | static $adapterNames = array( |
| 99 | // currently supported by Piwik |
| 100 | 'Pdo\\Mysql', |
| 101 | 'Mysqli', |
| 102 | ); |
| 103 | $adapters = array(); |
| 104 | foreach ($adapterNames as $adapterName) { |
| 105 | $className = '\\Piwik\\Db\\Adapter\\' . $adapterName; |
| 106 | if (call_user_func(array($className, 'isEnabled'))) { |
| 107 | $adapters[] = strtoupper($adapterName); |
| 108 | } |
| 109 | } |
| 110 | return $adapters; |
| 111 | } |
| 112 | /** |
| 113 | * Checks if the available adapters are recommended by Piwik or not. |
| 114 | * @param string $adapterName |
| 115 | * @return bool |
| 116 | */ |
| 117 | public static function isRecommendedAdapter($adapterName) |
| 118 | { |
| 119 | return strtolower($adapterName) === 'pdo/mysql'; |
| 120 | } |
| 121 | /** |
| 122 | * Intercepts certain exception messages and replaces leaky ones with ones that don't reveal too much info |
| 123 | * @param string $message |
| 124 | * @return string |
| 125 | */ |
| 126 | public static function overriddenExceptionMessage($message) |
| 127 | { |
| 128 | $safeMessageMap = array( |
| 129 | // add any exception search terms and their replacement message here |
| 130 | '[2006]' => Piwik::translate('General_ExceptionDatabaseUnavailable'), |
| 131 | 'MySQL server has gone away' => Piwik::translate('General_ExceptionDatabaseUnavailable'), |
| 132 | '[1698]' => Piwik::translate('General_ExceptionDatabaseAccess'), |
| 133 | 'Access denied' => Piwik::translate('General_ExceptionDatabaseAccess'), |
| 134 | ); |
| 135 | foreach ($safeMessageMap as $search_term => $safeMessage) { |
| 136 | if (strpos($message, $search_term) !== \false) { |
| 137 | return $safeMessage; |
| 138 | } |
| 139 | } |
| 140 | return ''; |
| 141 | } |
| 142 | } |
| 143 |