make siteconfig, admin et db connection optionnal

lekoala · Jan 13, 2021 · 412a6c2 · 412a6c2
1 parent 1df17c9
commit 412a6c2
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -128,6 +128,8 @@ There is a variety of other useful information available via various tabs and in
 * **Parameters:** Displays all GET, POST and REQUEST parameters from the current request
 * **Config:** Displays a list of the current [SiteConfig](https://github.com/silverstripe/silverstripe-siteconfig) settings from the CMS
 * **Requirements:** Shows a list of all [`Requirements`](https://docs.silverstripe.org/en/developer_guides/templates/requirements/) calls made during a page's execution
+* **Mails:** Shows a list of all emails sent
+* **Headers:** Shows a list of all headers
 
 #### Indicators
 
@@ -214,6 +216,7 @@ LeKoala\DebugBar\DebugBar:
 | `warn_request_time_seconds` | int | Threshold (seconds) for what constitutes a *dangerously* long page request (upper limit) |
 | `warn_warning_ratio` | float | Ratio to divide the warning request time by to get the *warning* level (default 0.5) |
 | `show_namespace` | bool | Show the fully qualified namespace in the Database tab when set to true. Defaults to false |
+| `db_collector` | bool | Show the db tab. Defaults to true |
 | `config_collector` | bool | Show the config tab. Defaults to true |
 | `partial_cache_collector` | bool | Show the partial cache tab. Defaults to true |
 | `email_collector` | bool | Show the email tab. Defaults to true |

diff --git a/_config/debugbar.yml b/_config/debugbar.yml
@@ -36,6 +36,7 @@ LeKoala\DebugBar\DebugBar:
   show_namespaces: false
   # Enable or disable collectors below
   config_collector: true
+  db_collector: true
   partial_cache_collector: true
   email_collector: true
   header_collector: true
@@ -51,12 +52,16 @@ SilverStripe\Core\Injector\Injector:
     properties:
       Middlewares:
         DebugBarMiddleware: '%$DebugBarMiddleware'
-SilverStripe\Admin\LeftAndMain:
-  extensions:
-    - LeKoala\DebugBar\Extension\LeftAndMainExtension
 SilverStripe\Control\Controller:
   extensions:
     - LeKoala\DebugBar\Extension\ControllerExtension
 TractorCow\SilverStripeProxyDB\ProxyDBFactory:
   extensions:
     - LeKoala\DebugBar\Extension\ProxyDBExtension
+---
+Only:
+  moduleexists: silverstripe/admin
+---
+SilverStripe\Admin\LeftAndMain:
+  extensions:
+    - LeKoala\DebugBar\Extension\LeftAndMainExtension
diff --git a/code/Collector/SilverStripeCollector.php b/code/Collector/SilverStripeCollector.php
@@ -30,7 +30,7 @@ public function collect()
             'session' => self::getSessionData(),
             'config' => self::getConfigData(),
             'locale' => i18n::get_locale(),
-            'version' => LeftAndMain::create()->CMSVersion(),
+            'version' => class_exists(LeftAndMain::class) ? LeftAndMain::create()->CMSVersion() : 'unknown',
             'cookies' => self::getCookieData(),
             'parameters' => self::getRequestParameters(),
             'requirements' => self::getRequirementsData(),
@@ -123,6 +123,9 @@ public static function getSessionData()
 
     public static function getConfigData()
     {
+        if (!class_exists(SiteConfig::class)) {
+            return [];
+        }
         return SiteConfig::current_site_config()->toMap();
     }
 
@@ -177,6 +180,7 @@ public function getWidgets()
             $userIcon = 'user';
             $userText = 'Logged in as ' . $memberTag;
 
+            // TODO: upgrade to newer version of the module
             // Masquerade integration
             if (DebugBar::getRequest()->getSession()->get('Masquerade.Old.loggedInAs')) {
                 $userIcon = 'user-secret';
@@ -192,7 +196,7 @@ public function getWidgets()
             ),
             "version" => array(
                 "icon" => "hashtag",
-                "tooltip" => LeftAndMain::create()->CMSVersion(),
+                "tooltip" => class_exists(LeftAndMain::class) ? LeftAndMain::create()->CMSVersion() : 'unknown',
                 "default" => ""
             ),
             "locale" => array(
@@ -218,12 +222,6 @@ public function getWidgets()
                 "map" => "$name.parameters",
                 "default" => "{}"
             ),
-            "SiteConfig" => array(
-                "icon" => "sliders",
-                "widget" => "PhpDebugBar.Widgets.VariableListWidget",
-                "map" => "$name.config",
-                "default" => "{}"
-            ),
             "requirements" => array(
                 "icon" => "file-text-o",
                 "widget" => "PhpDebugBar.Widgets.ListWidget",
@@ -242,6 +240,15 @@ public function getWidgets()
             )
         );
 
+        if (!empty($this->getConfigData())) {
+            $widgets["SiteConfig"] = array(
+                "icon" => "sliders",
+                "widget" => "PhpDebugBar.Widgets.VariableListWidget",
+                "map" => "$name.config",
+                "default" => "{}"
+            );
+        }
+
         if (!empty(self::$debug)) {
             $widgets["debug"] = array(
                 "icon" => "list-alt",

diff --git a/code/DebugBar.php b/code/DebugBar.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace LeKoala\DebugBar;
 
 use DebugBar\JavascriptRenderer;
@@ -148,18 +149,20 @@ public static function initDebugBar()
             }
         }
 
-        $connector = DB::get_connector();
-        if (!self::config()->get('force_proxy') && $connector instanceof PDOConnector) {
-            // Use a little bit of magic to replace the pdo instance
-            $refObject = new ReflectionObject($connector);
-            $refProperty = $refObject->getProperty('pdoConnection');
-            $refProperty->setAccessible(true);
-            $traceablePdo = new TraceablePDO($refProperty->getValue($connector));
-            $refProperty->setValue($connector, $traceablePdo);
+        if (self::config()->db_collector) {
+            $connector = DB::get_connector();
+            if (!self::config()->get('force_proxy') && $connector instanceof PDOConnector) {
+                // Use a little bit of magic to replace the pdo instance
+                $refObject = new ReflectionObject($connector);
+                $refProperty = $refObject->getProperty('pdoConnection');
+                $refProperty->setAccessible(true);
+                $traceablePdo = new TraceablePDO($refProperty->getValue($connector));
+                $refProperty->setValue($connector, $traceablePdo);
 
-            $debugbar->addCollector(new PDOCollector($traceablePdo));
-        } else {
-            $debugbar->addCollector(new DatabaseCollector);
+                $debugbar->addCollector(new PDOCollector($traceablePdo));
+            } else {
+                $debugbar->addCollector(new DatabaseCollector);
+            }
         }
 
         // Add message collector last so other collectors can send messages to the console using it
@@ -449,7 +452,11 @@ public static function isDevUrl()
     public static function isAdminUrl()
     {
         $baseUrl = rtrim(BASE_URL, '/');
-        $adminUrl = AdminRootController::config()->get('url_base');
+        if (class_exists(AdminRootController::class)) {
+            $adminUrl = AdminRootController::config()->get('url_base');
+        } else {
+            $adminUrl = 'admin';
+        }
 
         return strpos(self::getRequestUrl(), $baseUrl . '/' . $adminUrl . '/') === 0;
     }

diff --git a/code/Extension/LeftAndMainExtension.php b/code/Extension/LeftAndMainExtension.php
@@ -3,14 +3,12 @@
 namespace LeKoala\DebugBar\Extension;
 
 use LeKoala\DebugBar\DebugBar;
-use SilverStripe\Admin\LeftAndMainExtension as BaseLeftAndMainExtension;
+use SilverStripe\Core\Extension;
 
 /**
- * Description of DebugBarLeftAndMainExtension
- *
  * @author Koala
  */
-class LeftAndMainExtension extends BaseLeftAndMainExtension
+class LeftAndMainExtension extends Extension
 {
     public function accessedCMS()
     {

diff --git a/composer.json b/composer.json
@@ -18,13 +18,13 @@
     "require": {
         "php": ">=5.6",
         "silverstripe/framework": "^4.0",
-        "silverstripe/siteconfig": "^4.0",
-        "silverstripe/admin": "^1.0",
         "maximebf/debugbar": "^1.13",
         "jdorn/sql-formatter": "1.3.x-dev",
         "tractorcow/silverstripe-proxy-db": "^0.1.0"
     },
     "require-dev": {
+        "silverstripe/siteconfig": "^4.0",
+        "silverstripe/admin": "^1.0",
         "sminnee/phpunit": "^5.7",
         "squizlabs/php_codesniffer": "^3.0"
     },