Make Database trait a singleton (#222)

fixes #219
Icinga · Nov 16, 2023 · 7676092 · 7676092
2 parents b1bfd82 + d3bfeac
commit 7676092
Show file tree

Hide file tree

Showing 20 changed files with 49 additions and 55 deletions.
diff --git a/application/clicommands/DownloadCommand.php b/application/clicommands/DownloadCommand.php
@@ -7,6 +7,7 @@
 use Icinga\Exception\NotFoundError;
 use Icinga\Module\Pdfexport\ProvidedHook\Pdfexport;
 use Icinga\Module\Reporting\Cli\Command;
+use Icinga\Module\Reporting\Database;
 use Icinga\Module\Reporting\Model;
 use Icinga\Module\Reporting\Report;
 use InvalidArgumentException;
@@ -48,7 +49,7 @@ public function defaultAction()
         }
 
         /** @var Model\Report $report */
-        $report = Model\Report::on($this->getDb())
+        $report = Model\Report::on(Database::get())
             ->with('timeframe')
             ->filter(Filter::equal('id', $id))
             ->first();

diff --git a/application/clicommands/ListCommand.php b/application/clicommands/ListCommand.php
@@ -5,6 +5,7 @@
 namespace Icinga\Module\Reporting\Clicommands;
 
 use Icinga\Module\Reporting\Cli\Command;
+use Icinga\Module\Reporting\Database;
 use Icinga\Module\Reporting\Model;
 use InvalidArgumentException;
 use ipl\Stdlib\Filter;
@@ -56,7 +57,7 @@ public function indexAction()
 
         $direction = $this->params->get('direction', 'ASC');
 
-        $reports = Model\Report::on($this->getDb());
+        $reports = Model\Report::on(Database::get());
         $reports
             ->with(['reportlets'])
             ->orderBy($sort, $direction);

diff --git a/application/clicommands/ScheduleCommand.php b/application/clicommands/ScheduleCommand.php
@@ -10,6 +10,7 @@
 use Icinga\Application\Logger;
 use Icinga\Data\ResourceFactory;
 use Icinga\Module\Reporting\Cli\Command;
+use Icinga\Module\Reporting\Database;
 use Icinga\Module\Reporting\Model;
 use Icinga\Module\Reporting\Report;
 use Icinga\Module\Reporting\Schedule;
@@ -103,7 +104,7 @@ public function runAction()
     protected function fetchSchedules(): array
     {
         $schedules = [];
-        $query = Model\Schedule::on($this->getDb())->with(['report.timeframe', 'report']);
+        $query = Model\Schedule::on(Database::get())->with(['report.timeframe', 'report']);
 
         foreach ($query as $schedule) {
             $schedule = Schedule::fromModel($schedule, Report::fromModel($schedule->report));

diff --git a/application/controllers/ReportController.php b/application/controllers/ReportController.php
@@ -26,8 +26,6 @@
 
 class ReportController extends Controller
 {
-    use Database;
-
     /** @var Report */
     protected $report;
 
@@ -36,7 +34,7 @@ public function init()
         $reportId = $this->params->getRequired('id');
 
         /** @var Model\Report $report */
-        $report = Model\Report::on($this->getDb())
+        $report = Model\Report::on(Database::get())
             ->with(['timeframe'])
             ->filter(Filter::equal('id', $reportId))
             ->first();

diff --git a/application/controllers/ReportsController.php b/application/controllers/ReportsController.php
@@ -18,7 +18,6 @@
 
 class ReportsController extends Controller
 {
-    use Database;
     use ReportsTimeframesAndTemplatesTabs;
 
     public function indexAction()
@@ -37,7 +36,7 @@ public function indexAction()
 
         $tableRows = [];
 
-        $reports = Report::on($this->getDb())
+        $reports = Report::on(Database::get())
             ->withColumns(['report.timeframe.name']);
 
         $sortControl = $this->createSortControl(

diff --git a/application/controllers/TemplateController.php b/application/controllers/TemplateController.php
@@ -22,8 +22,6 @@
 
 class TemplateController extends Controller
 {
-    use Database;
-
     /** @var Model\Template */
     protected $template;
 
@@ -32,7 +30,7 @@ public function init()
         parent::init();
 
         /** @var Model\Template $template */
-        $template = Model\Template::on($this->getDb())
+        $template = Model\Template::on(Database::get())
             ->filter(Filter::equal('id', $this->params->getRequired('id')))
             ->first();
 

diff --git a/application/controllers/TemplatesController.php b/application/controllers/TemplatesController.php
@@ -17,7 +17,6 @@
 
 class TemplatesController extends Controller
 {
-    use Database;
     use ReportsTimeframesAndTemplatesTabs;
 
     public function indexAction()
@@ -36,7 +35,7 @@ public function indexAction()
             );
         }
 
-        $templates = Model\Template::on($this->getDb());
+        $templates = Model\Template::on(Database::get());
 
         $sortControl = $this->createSortControl(
             $templates,

diff --git a/application/controllers/TimeframeController.php b/application/controllers/TimeframeController.php
@@ -17,15 +17,13 @@
 
 class TimeframeController extends Controller
 {
-    use Database;
-
     /** @var Timeframe */
     protected $timeframe;
 
     public function init()
     {
         /** @var Model\Timeframe $timeframe */
-        $timeframe = Model\Timeframe::on($this->getDb())
+        $timeframe = Model\Timeframe::on(Database::get())
             ->filter(Filter::equal('id', $this->params->getRequired('id')))
             ->first();
 

diff --git a/application/controllers/TimeframesController.php b/application/controllers/TimeframesController.php
@@ -17,7 +17,6 @@
 
 class TimeframesController extends Controller
 {
-    use Database;
     use ReportsTimeframesAndTemplatesTabs;
 
     public function indexAction()
@@ -38,7 +37,7 @@ public function indexAction()
 
         $tableRows = [];
 
-        $timeframes = Model\Timeframe::on($this->getDb());
+        $timeframes = Model\Timeframe::on(Database::get());
 
         $sortControl = $this->createSortControl(
             $timeframes,

diff --git a/library/Reporting/Cli/Command.php b/library/Reporting/Cli/Command.php
@@ -6,12 +6,9 @@
 
 use Icinga\Application\Icinga;
 use Icinga\Application\Version;
-use Icinga\Module\Reporting\Database;
 
 class Command extends \Icinga\Cli\Command
 {
-    use Database;
-
     // Fix Web 2 issue where $configs is not properly initialized
     protected $configs = [];
 

diff --git a/library/Reporting/Database.php b/library/Reporting/Database.php
@@ -10,9 +10,30 @@
 use PDO;
 use stdClass;
 
-trait Database
+final class Database
 {
-    protected function getDb(): RetryConnection
+    /** @var RetryConnection Database connection */
+    private static $instance;
+
+    private function __construct()
+    {
+    }
+
+    /**
+     * Get the database connection
+     *
+     * @return RetryConnection
+     */
+    public static function get(): RetryConnection
+    {
+        if (self::$instance === null) {
+            self::$instance = self::getDb();
+        }
+
+        return self::$instance;
+    }
+
+    private static function getDb(): RetryConnection
     {
         $config = new Sql\Config(
             ResourceFactory::getResourceConfig(
@@ -34,9 +55,9 @@ protected function getDb(): RetryConnection
      *
      * @return array<int, string>
      */
-    protected function listTimeframes(): array
+    public static function listTimeframes(): array
     {
-        return $this->list(
+        return self::list(
             (new Sql\Select())
                 ->from('timeframe')
                 ->columns(['id', 'name'])
@@ -48,9 +69,9 @@ protected function listTimeframes(): array
      *
      * @return array<int, string>
      */
-    protected function listTemplates(): array
+    public static function listTemplates(): array
     {
-        return $this->list(
+        return self::list(
             (new Sql\Select())
                 ->from('template')
                 ->columns(['id', 'name'])
@@ -64,11 +85,11 @@ protected function listTemplates(): array
      *
      * @return array<int, string>
      */
-    private function list(Sql\Select $select): array
+    private static function list(Sql\Select $select): array
     {
         $result = [];
         /** @var stdClass $row */
-        foreach ($this->getDb()->select($select) as $row) {
+        foreach (self::get()->select($select) as $row) {
             /** @var int $id */
             $id = $row->id;
             /** @var string $name */

diff --git a/library/Reporting/ProvidedHook/DbMigration.php b/library/Reporting/ProvidedHook/DbMigration.php
@@ -12,10 +12,6 @@
 
 class DbMigration extends DbMigrationHook
 {
-    use Database {
-        getDb as private getReportingDb;
-    }
-
     public function getName(): string
     {
         return $this->translate('Icinga Reporting');
@@ -40,7 +36,7 @@ protected function getSchemaQuery(): Query
 
     public function getDb(): Connection
     {
-        return $this->getReportingDb();
+        return Database::get();
     }
 
     public function getVersion(): string

diff --git a/library/Reporting/Report.php b/library/Reporting/Report.php
@@ -17,8 +17,6 @@
 
 class Report
 {
-    use Database;
-
     /** @var int */
     protected $id;
 

diff --git a/library/Reporting/Timeframe.php b/library/Reporting/Timeframe.php
@@ -8,8 +8,6 @@
 
 class Timeframe
 {
-    use Database;
-
     /** @var int */
     protected $id;
 

diff --git a/library/Reporting/Web/Forms/ReportForm.php b/library/Reporting/Web/Forms/ReportForm.php
@@ -15,7 +15,6 @@
 
 class ReportForm extends CompatForm
 {
-    use Database;
     use ProvidedReports;
 
     protected $id;
@@ -125,15 +124,15 @@ protected function assemble()
             'required'    => true,
             'class'       => 'autosubmit',
             'label'       => $this->translate('Timeframe'),
-            'options'     => [null => $this->translate('Please choose')] + $this->listTimeframes(),
+            'options'     => [null => $this->translate('Please choose')] + Database::listTimeframes(),
             'description' => $this->translate(
                 'Specifies the time frame in which this report is to be generated'
             )
         ]);
 
         $this->addElement('select', 'template', [
             'label'       => $this->translate('Template'),
-            'options'     => [null => $this->translate('Please choose')] + $this->listTemplates(),
+            'options'     => [null => $this->translate('Please choose')] + Database::listTemplates(),
             'description' => $this->translate(
                 'Specifies the template to use when exporting this report to pdf. (Default Icinga template)'
             )
@@ -193,7 +192,7 @@ protected function assemble()
 
     public function onSuccess()
     {
-        $db = $this->getDb();
+        $db = Database::get();
 
         if ($this->getPopulatedValue('remove')) {
             $db->delete('report', ['id = ?' => $this->id]);

diff --git a/library/Reporting/Web/Forms/ScheduleForm.php b/library/Reporting/Web/Forms/ScheduleForm.php
@@ -25,7 +25,6 @@
 
 class ScheduleForm extends CompatForm
 {
-    use Database;
     use ProvidedActions;
 
     /** @var Report */
@@ -144,7 +143,7 @@ protected function assemble()
 
     public function onSuccess()
     {
-        $db = $this->getDb();
+        $db = Database::get();
         $schedule = $this->report->getSchedule();
         if ($this->getPopulatedValue('remove')) {
             $db->delete('schedule', ['id = ?' => $schedule->getId()]);

diff --git a/library/Reporting/Web/Forms/SendForm.php b/library/Reporting/Web/Forms/SendForm.php
@@ -5,14 +5,12 @@
 namespace Icinga\Module\Reporting\Web\Forms;
 
 use Icinga\Module\Reporting\Actions\SendMail;
-use Icinga\Module\Reporting\Database;
 use Icinga\Module\Reporting\ProvidedReports;
 use Icinga\Module\Reporting\Report;
 use ipl\Web\Compat\CompatForm;
 
 class SendForm extends CompatForm
 {
-    use Database;
     use ProvidedReports;
 
     /** @var Report */

diff --git a/library/Reporting/Web/Forms/TemplateForm.php b/library/Reporting/Web/Forms/TemplateForm.php
@@ -16,8 +16,6 @@
 
 class TemplateForm extends CompatForm
 {
-    use Database;
-
     protected $template;
 
     public function getTemplate()
@@ -158,7 +156,7 @@ protected function assemble()
     public function onSuccess()
     {
         if ($this->getPopulatedValue('remove')) {
-            $this->getDb()->delete('template', ['id = ?' => $this->template->id]);
+            Database::get()->delete('template', ['id = ?' => $this->template->id]);
 
             return;
         }
@@ -178,7 +176,7 @@ public function onSuccess()
                 }
             }
 
-            $db = $this->getDb();
+            $db = Database::get();
 
             $now = time() * 1000;
 

diff --git a/library/Reporting/Web/Forms/TimeframeForm.php b/library/Reporting/Web/Forms/TimeframeForm.php
@@ -15,8 +15,6 @@
 
 class TimeframeForm extends CompatForm
 {
-    use Database;
-
     /** @var int */
     protected $id;
 
@@ -184,7 +182,7 @@ protected function assemble()
 
     public function onSuccess()
     {
-        $db = $this->getDb();
+        $db = Database::get();
 
         if ($this->getPopulatedValue('remove')) {
             $db->delete('timeframe', ['id = ?' => $this->id]);