DatabaseAdapterRegistry::getDatabaseConfigurationHelper() - Code Metrics - Inspection of "Merge pull request #9627 from creative-commoners/p..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.6 ( 52d38a...e368c3 )

by Loz

created 2020-08-03 08:19 UTC

getDatabaseConfigurationHelper() A

↳ Parent: DatabaseAdapterRegistry

Complexity

Conditions	5
Paths	5

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	7
nc	5
nop	1
dl	0
loc	15
rs	9.6111
c	0
b	0
f	0

<?php

namespace SilverStripe\Dev\Install;

use InvalidArgumentException;
use Psr\SimpleCache\CacheInterface;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\Deprecation;
use SilverStripe\Core\Flushable;

/**
 * This class keeps track of the available database adapters
 * and provides a meaning of registering community built
 * adapters in to the installer process.
 *
 * @author Tom Rix
 */
class DatabaseAdapterRegistry implements Flushable
{

    /**
     * Default database connector registration fields
     *
     * @var array
     */
    private static $default_fields = [
        'server' => [
            'title' => 'Database server',
            'envVar' => 'SS_DATABASE_SERVER',
            'default' => 'localhost'
        ],
        'username' => [
            'title' => 'Database username',
            'envVar' => 'SS_DATABASE_USERNAME',
            'default' => 'root'
        ],
        'password' => [
            'title' => 'Database password',
            'envVar' => 'SS_DATABASE_PASSWORD',
            'default' => 'password'
        ],
        'database' => [
            'title' => 'Database name',
            'default' => 'SS_mysite',
            'attributes' => [
                "onchange" => "this.value = this.value.replace(/[\/\\:*?&quot;<>|. \t]+/g,'');"
            ]
        ],
    ];

    /**
     * Internal array of registered database adapters
     *
     * @var array
     */
    private static $adapters = [];

    /**
     * Add new adapter to the registry
     *
     * @param array $config Associative array of configuration details. This must include:
     *  - title
     *  - class
     *  - helperClass
     *  - supported
     * This SHOULD include:
     *  - fields
     *  - helperPath (if helperClass can't be autoloaded via psr-4/-0)
     *  - missingExtensionText
     *  - module OR missingModuleText
     */
    public static function register($config)
    {
        // Validate config
        $missing = array_diff(['title', 'class', 'helperClass', 'supported'], array_keys($config));
        if ($missing) {

            throw new InvalidArgumentException(
                "Missing database helper config keys: '" . implode("', '", $missing) . "'"
            );
        }

        // Guess missing module text if not given
        if (empty($config['missingModuleText'])) {
            if (empty($config['module'])) {
                $moduleText = 'Module for database connector ' . $config['title'] . 'is missing.';
            } else {
                $moduleText = "The SilverStripe module '" . $config['module'] . "' is missing.";
            }
            $config['missingModuleText'] = $moduleText
                . ' Please install it via composer or from http://addons.silverstripe.org/.';
        }

        // Set missing text
        if (empty($config['missingExtensionText'])) {
            $config['missingExtensionText'] = 'The PHP extension is missing, please enable or install it.';
        }

        // set default fields if none are defined already
        if (!isset($config['fields'])) {
            $config['fields'] = self::$default_fields;
        }

        self::$adapters[$config['class']] = $config;
    }

    /**
     * Unregisters a database connector by classname
     *
     * @param string $class
     */
    public static function unregister($class)
    {
        unset(self::$adapters[$class]);
    }

    /**
     * Detects all _register_database.php files and invokes them.
     * Searches through vendor/*\/* folders only,
     * does not support "legacy" folder location in webroot
     */
    public static function autodiscover()
    {
        // Search through all composer packages in vendor
        foreach (glob(BASE_PATH . '/vendor/*', GLOB_ONLYDIR) as $vendor) {
            foreach (glob($vendor . '/*', GLOB_ONLYDIR) as $directory) {
                if (file_exists($directory . '/_register_database.php')) {
                    include_once($directory . '/_register_database.php');
                }
            }
        }
    }

    /**
     * Detects all _configure_database.php files and invokes them
     * Called by ConfigureFromEnv.php.
     * Searches through vendor/ folder only,
     * does not support "legacy" folder location in webroot
     *
     * @param array $config Config to update. If not provided fall back to global $databaseConfig.
     * In 5.0.0 this will be mandatory and the global will be removed.
     */
    public static function autoconfigure(&$config = null)
    {
        if (!isset($config)) {
            Deprecation::notice('5.0', 'Configuration via global is deprecated');
            global $databaseConfig;
        } else {
            $databaseConfig = $config;
        }
        foreach (static::getConfigureDatabasePaths() as $configureDatabasePath) {
            include_once $configureDatabasePath;
        }
        // Update modified variable
        $config = $databaseConfig;
    }

    /**
     * Including _configure_database.php is a legacy method of configuring a database
     * It's still used by https://github.com/silverstripe/silverstripe-sqlite3
     */
    protected static function getConfigureDatabasePaths(): array
    {
        // autoconfigure() will get called before flush() on ?flush, so manually flush just to ensure no weirdness
        if (isset($_GET['flush'])) {
            static::flush();
        }
        try {
            $cache = static::getCache();
        } catch (\LogicException $e) {
            // This try/catch statement is here rather than in getCache() for semver
            // A LogicException may be thrown from `Symfony\Component\Finder\Finder::getIterator()`
            // if the config manifest is empty.  There are some edge cases where this can happen, for instance
            // running `sspak save` on a fresh install without ?flush
            $cache = null;
        }
        $key = __FUNCTION__;
        if ($cache && $cache->has($key)) {
            return (array) $cache->get($key);
        } else {
            try {
                $paths = glob(BASE_PATH . '/vendor/*/*/_configure_database.php');
            } catch (Exception $e) {

                $paths = [];
            }
            if ($cache) {
                $cache->set($key, $paths);
            }
            return $paths;
        }
    }

    /**
     * @return CacheInterface
     */
    public static function getCache(): CacheInterface
    {
        return Injector::inst()->get(CacheInterface::class . '.DatabaseAdapterRegistry');
    }

    public static function flush()
    {
        static::getCache()->clear();
    }

    /**
     * Return all registered adapters
     *
     * @return array
     */
    public static function get_adapters()
    {
        return self::$adapters;
    }

    /**
     * Returns registry data for a class
     *
     * @param string $class
     * @return array List of adapter properties
     */
    public static function get_adapter($class)
    {
        if (isset(self::$adapters[$class])) {
            return self::$adapters[$class];
        }
        return null;
    }

    /**
     * Retrieves default field configuration
     *
     * @return array
     */
    public static function get_default_fields()
    {
        return self::$default_fields;
    }

    /**
     * Build configuration helper for a given class
     *
     * @param string $databaseClass Name of class
     * @return DatabaseConfigurationHelper|null Instance of helper, or null if cannot be loaded
     */
    public static function getDatabaseConfigurationHelper($databaseClass)
    {
        $adapters = static::get_adapters();
        if (empty($adapters[$databaseClass]) || empty($adapters[$databaseClass]['helperClass'])) {
            return null;
        }

        // Load if path given
        if (isset($adapters[$databaseClass]['helperPath'])) {
            include_once $adapters[$databaseClass]['helperPath'];
        }

        // Construct
        $class = $adapters[$databaseClass]['helperClass'];
        return (class_exists($class)) ? new $class() : null;
    }
}


1			<?php
2
3			namespace SilverStripe\Dev\Install;
4
5			use InvalidArgumentException;
6			use Psr\SimpleCache\CacheInterface;
7			use SilverStripe\Core\Injector\Injector;
8			use SilverStripe\Dev\Deprecation;
9			use SilverStripe\Core\Flushable;
10
11			/**
12			* This class keeps track of the available database adapters
13			* and provides a meaning of registering community built
14			* adapters in to the installer process.
15			*
16			* @author Tom Rix
17			*/
18			class DatabaseAdapterRegistry implements Flushable
19			{
20
21			/**
22			* Default database connector registration fields
23			*
24			* @var array
25			*/
26			private static $default_fields = [
27			'server' => [
28			'title' => 'Database server',
29			'envVar' => 'SS_DATABASE_SERVER',
30			'default' => 'localhost'
31			],
32			'username' => [
33			'title' => 'Database username',
34			'envVar' => 'SS_DATABASE_USERNAME',
35			'default' => 'root'
36			],
37			'password' => [
38			'title' => 'Database password',
39			'envVar' => 'SS_DATABASE_PASSWORD',
40			'default' => 'password'
41			],
42			'database' => [
43			'title' => 'Database name',
44			'default' => 'SS_mysite',
45			'attributes' => [
46			"onchange" => "this.value = this.value.replace(/[\/\\:*?"<>\|. \t]+/g,'');"
47			]
48			],
49			];
50
51			/**
52			* Internal array of registered database adapters
53			*
54			* @var array
55			*/
56			private static $adapters = [];
57
58			/**
59			* Add new adapter to the registry
60			*
61			* @param array $config Associative array of configuration details. This must include:
62			* - title
63			* - class
64			* - helperClass
65			* - supported
66			* This SHOULD include:
67			* - fields
68			* - helperPath (if helperClass can't be autoloaded via psr-4/-0)
69			* - missingExtensionText
70			* - module OR missingModuleText
71			*/
72			public static function register($config)
73			{
74			// Validate config
75			$missing = array_diff(['title', 'class', 'helperClass', 'supported'], array_keys($config));
76			if ($missing) {
			0 ignored issues – show Bug Best Practice introduced 2017-11-28 04:26 UTC by Report Bug Copy Issue Report The expression `$missing` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
77			throw new InvalidArgumentException(
78			"Missing database helper config keys: '" . implode("', '", $missing) . "'"
79			);
80			}
81
82			// Guess missing module text if not given
83			if (empty($config['missingModuleText'])) {
84			if (empty($config['module'])) {
85			$moduleText = 'Module for database connector ' . $config['title'] . 'is missing.';
86			} else {
87			$moduleText = "The SilverStripe module '" . $config['module'] . "' is missing.";
88			}
89			$config['missingModuleText'] = $moduleText
90			. ' Please install it via composer or from http://addons.silverstripe.org/.';
91			}
92
93			// Set missing text
94			if (empty($config['missingExtensionText'])) {
95			$config['missingExtensionText'] = 'The PHP extension is missing, please enable or install it.';
96			}
97
98			// set default fields if none are defined already
99			if (!isset($config['fields'])) {
100			$config['fields'] = self::$default_fields;
101			}
102
103			self::$adapters[$config['class']] = $config;
104			}
105
106			/**
107			* Unregisters a database connector by classname
108			*
109			* @param string $class
110			*/
111			public static function unregister($class)
112			{
113			unset(self::$adapters[$class]);
114			}
115
116			/**
117			* Detects all _register_database.php files and invokes them.
118			* Searches through vendor/\/ folders only,
119			* does not support "legacy" folder location in webroot
120			*/
121			public static function autodiscover()
122			{
123			// Search through all composer packages in vendor
124			foreach (glob(BASE_PATH . '/vendor/*', GLOB_ONLYDIR) as $vendor) {
125			foreach (glob($vendor . '/*', GLOB_ONLYDIR) as $directory) {
126			if (file_exists($directory . '/_register_database.php')) {
127			include_once($directory . '/_register_database.php');
128			}
129			}
130			}
131			}
132
133			/**
134			* Detects all _configure_database.php files and invokes them
135			* Called by ConfigureFromEnv.php.
136			* Searches through vendor/ folder only,
137			* does not support "legacy" folder location in webroot
138			*
139			* @param array $config Config to update. If not provided fall back to global $databaseConfig.
140			* In 5.0.0 this will be mandatory and the global will be removed.
141			*/
142			public static function autoconfigure(&$config = null)
143			{
144			if (!isset($config)) {
145			Deprecation::notice('5.0', 'Configuration via global is deprecated');
146			global $databaseConfig;
147			} else {
148			$databaseConfig = $config;
149			}
150			foreach (static::getConfigureDatabasePaths() as $configureDatabasePath) {
151			include_once $configureDatabasePath;
152			}
153			// Update modified variable
154			$config = $databaseConfig;
155			}
156
157			/**
158			* Including _configure_database.php is a legacy method of configuring a database
159			* It's still used by https://github.com/silverstripe/silverstripe-sqlite3
160			*/
161			protected static function getConfigureDatabasePaths(): array
162			{
163			// autoconfigure() will get called before flush() on ?flush, so manually flush just to ensure no weirdness
164			if (isset($_GET['flush'])) {
165			static::flush();
166			}
167			try {
168			$cache = static::getCache();
169			} catch (\LogicException $e) {
170			// This try/catch statement is here rather than in getCache() for semver
171			// A LogicException may be thrown from `Symfony\Component\Finder\Finder::getIterator()`
172			// if the config manifest is empty. There are some edge cases where this can happen, for instance
173			// running `sspak save` on a fresh install without ?flush
174			$cache = null;
175			}
176			$key = __FUNCTION__;
177			if ($cache && $cache->has($key)) {
178			return (array) $cache->get($key);
179			} else {
180			try {
181			$paths = glob(BASE_PATH . '/vendor///_configure_database.php');
182			} catch (Exception $e) {
			0 ignored issues – show Bug introduced 2020-04-10 11:13 UTC by Report Bug Copy Issue Report The type `SilverStripe\Dev\Install\Exception` was not found. Did you mean `Exception`? If so, make sure to prefix the type with `\`. Loading history...
183			$paths = [];
184			}
185			if ($cache) {
186			$cache->set($key, $paths);
187			}
188			return $paths;
189			}
190			}
191
192			/**
193			* @return CacheInterface
194			*/
195			public static function getCache(): CacheInterface
196			{
197			return Injector::inst()->get(CacheInterface::class . '.DatabaseAdapterRegistry');
198			}
199
200			public static function flush()
201			{
202			static::getCache()->clear();
203			}
204
205			/**
206			* Return all registered adapters
207			*
208			* @return array
209			*/
210			public static function get_adapters()
211			{
212			return self::$adapters;
213			}
214
215			/**
216			* Returns registry data for a class
217			*
218			* @param string $class
219			* @return array List of adapter properties
220			*/
221			public static function get_adapter($class)
222			{
223			if (isset(self::$adapters[$class])) {
224			return self::$adapters[$class];
225			}
226			return null;
227			}
228
229			/**
230			* Retrieves default field configuration
231			*
232			* @return array
233			*/
234			public static function get_default_fields()
235			{
236			return self::$default_fields;
237			}
238
239			/**
240			* Build configuration helper for a given class
241			*
242			* @param string $databaseClass Name of class
243			* @return DatabaseConfigurationHelper\|null Instance of helper, or null if cannot be loaded
244			*/
245			public static function getDatabaseConfigurationHelper($databaseClass)
246			{
247			$adapters = static::get_adapters();
248			if (empty($adapters[$databaseClass]) \|\| empty($adapters[$databaseClass]['helperClass'])) {
249			return null;
250			}
251
252			// Load if path given
253			if (isset($adapters[$databaseClass]['helperPath'])) {
254			include_once $adapters[$databaseClass]['helperPath'];
255			}
256
257			// Construct
258			$class = $adapters[$databaseClass]['helperClass'];
259			return (class_exists($class)) ? new $class() : null;
260			}
261			}
262

silverstripe / silverstripe-framework

Push — 4.6 ( 52d38a...e368c3 )

getDatabaseConfigurationHelper() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like