src/Model/Storage/Database.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Model\Storage;
  23
  24 use Exception;
  25 use Friendica\Database\Database as DBA;
  26
  27 /**
  28  * Database based storage system
  29  *
  30  * This class manage data stored in database table.
  31  */
  32 class Database implements ISelectableStorage
  33 {
  34         const NAME = 'Database';
  35
  36         /** @var DBA */
  37         private $dba;
  38
  39         /**
  40          * @param DBA             $dba
  41          */
  42         public function __construct(DBA $dba)
  43         {
  44                 $this->dba = $dba;
  45         }
  46
  47         /**
  48          * @inheritDoc
  49          */
  50         public function get(string $reference): string
  51         {
  52                 try {
  53                         $result = $this->dba->selectFirst('storage', ['data'], ['id' => $reference]);
  54                         if (!$this->dba->isResult($result)) {
  55                                 throw new ReferenceStorageException(sprintf('Database storage cannot find data for reference %s', $reference));
  56                         }
  57
  58                         return $result['data'];
  59                 } catch (Exception $exception) {
  60                         throw new StorageException(sprintf('Database storage failed to get %s', $reference), $exception->getCode(), $exception);
  61                 }
  62         }
  63
  64         /**
  65          * @inheritDoc
  66          */
  67         public function put(string $data, string $reference = ''): string
  68         {
  69                 if ($reference !== '') {
  70                         try {
  71                                 $result = $this->dba->update('storage', ['data' => $data], ['id' => $reference]);
  72                         } catch (Exception $exception) {
  73                                 throw new StorageException(sprintf('Database storage failed to update %s', $reference), $exception->getCode(), $exception);
  74                         }
  75                         if ($result === false) {
  76                                 throw new StorageException(sprintf('Database storage failed to update %s', $reference), 500, new Exception($this->dba->errorMessage(), $this->dba->errorNo()));
  77                         }
  78
  79                         return $reference;
  80                 } else {
  81                         try {
  82                                 $result = $this->dba->insert('storage', ['data' => $data]);
  83                         } catch (Exception $exception) {
  84                                 throw new StorageException(sprintf('Database storage failed to insert %s', $reference), $exception->getCode(), $exception);
  85                         }
  86                         if ($result === false) {
  87                                 throw new StorageException(sprintf('Database storage failed to update %s', $reference), 500, new Exception($this->dba->errorMessage(), $this->dba->errorNo()));
  88                         }
  89
  90                         return $this->dba->lastInsertId();
  91                 }
  92         }
  93
  94         /**
  95          * @inheritDoc
  96          */
  97         public function delete(string $reference)
  98         {
  99                 try {
 100                         if (!$this->dba->delete('storage', ['id' => $reference])) {
 101                                 throw new ReferenceStorageException(sprintf('Database storage failed to delete %s', $reference));
 102                         }
 103                 } catch (Exception $exception) {
 104                         throw new StorageException(sprintf('Database storage failed to delete %s', $reference), $exception->getCode(), $exception);
 105                 }
 106         }
 107
 108         /**
 109          * @inheritDoc
 110          */
 111         public function getOptions(): array
 112         {
 113                 return [];
 114         }
 115
 116         /**
 117          * @inheritDoc
 118          */
 119         public function saveOptions(array $data): array
 120         {
 121                 return [];
 122         }
 123
 124         /**
 125          * @inheritDoc
 126          */
 127         public static function getName(): string
 128         {
 129                 return self::NAME;
 130         }
 131
 132         public function __toString()
 133         {
 134                 return self::getName();
 135         }
 136 }