src/Security/TwoFactor/Repository/TrustedBrowser.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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\Security\TwoFactor\Repository;
  23
  24 use Friendica\Security\TwoFactor;
  25 use Friendica\Database\Database;
  26 use Friendica\Security\TwoFactor\Exception\TrustedBrowserNotFoundException;
  27 use Friendica\Security\TwoFactor\Exception\TrustedBrowserPersistenceException;
  28 use Psr\Log\LoggerInterface;
  29
  30 class TrustedBrowser
  31 {
  32         /** @var Database  */
  33         protected $db;
  34
  35         /** @var LoggerInterface  */
  36         protected $logger;
  37
  38         /** @var TwoFactor\Factory\TrustedBrowser  */
  39         protected $factory;
  40
  41         protected static $table_name = '2fa_trusted_browser';
  42
  43         public function __construct(Database $database, LoggerInterface $logger, TwoFactor\Factory\TrustedBrowser $factory = null)
  44         {
  45                 $this->db      = $database;
  46                 $this->logger  = $logger;
  47                 $this->factory = $factory ?? new TwoFactor\Factory\TrustedBrowser($logger);
  48         }
  49
  50         /**
  51          * @param string $cookie_hash
  52          *
  53          * @return TwoFactor\Model\TrustedBrowser|null
  54          *
  55          * @throws TrustedBrowserPersistenceException
  56          * @throws TrustedBrowserNotFoundException
  57          */
  58         public function selectOneByHash(string $cookie_hash): TwoFactor\Model\TrustedBrowser
  59         {
  60                 try {
  61                         $fields = $this->db->selectFirst(self::$table_name, [], ['cookie_hash' => $cookie_hash]);
  62                 } catch (\Exception $exception) {
  63                         throw new TrustedBrowserPersistenceException(sprintf('Internal server error when retrieving cookie hash \'%s\'', $cookie_hash));
  64                 }
  65                 if (!$this->db->isResult($fields)) {
  66                         throw new TrustedBrowserNotFoundException(sprintf('Cookie hash \'%s\' not found', $cookie_hash));
  67                 }
  68
  69                 return $this->factory->createFromTableRow($fields);
  70         }
  71
  72         /**
  73          * @param int $uid
  74          *
  75          * @return TwoFactor\Collection\TrustedBrowsers
  76          *
  77          * @throws TrustedBrowserPersistenceException
  78          */
  79         public function selectAllByUid(int $uid): TwoFactor\Collection\TrustedBrowsers
  80         {
  81                 try {
  82                         $rows = $this->db->selectToArray(self::$table_name, [], ['uid' => $uid]);
  83
  84                         $trustedBrowsers = [];
  85                         foreach ($rows as $fields) {
  86                                 $trustedBrowsers[] = $this->factory->createFromTableRow($fields);
  87                         }
  88                         return new TwoFactor\Collection\TrustedBrowsers($trustedBrowsers);
  89
  90                 } catch (\Exception $exception) {
  91                         throw new TrustedBrowserPersistenceException(sprintf('selection for uid \'%s\' wasn\'t successful.', $uid));
  92                 }
  93         }
  94
  95         /**
  96          * @param TwoFactor\Model\TrustedBrowser $trustedBrowser
  97          *
  98          * @return bool
  99          *
 100          * @throws TrustedBrowserPersistenceException
 101          */
 102         public function save(TwoFactor\Model\TrustedBrowser $trustedBrowser): bool
 103         {
 104                 try {
 105                         return $this->db->insert(self::$table_name, $trustedBrowser->toArray(), $this->db::INSERT_UPDATE);
 106                 } catch (\Exception $exception) {
 107                         throw new TrustedBrowserPersistenceException(sprintf('Couldn\'t save trusted Browser with cookie_hash \'%s\'', $trustedBrowser->cookie_hash));
 108                 }
 109         }
 110
 111         /**
 112          * @param TwoFactor\Model\TrustedBrowser $trustedBrowser
 113          *
 114          * @return bool
 115          *
 116          * @throws TrustedBrowserPersistenceException
 117          */
 118         public function remove(TwoFactor\Model\TrustedBrowser $trustedBrowser): bool
 119         {
 120                 try {
 121                         return $this->db->delete(self::$table_name, ['cookie_hash' => $trustedBrowser->cookie_hash]);
 122                 } catch (\Exception $exception) {
 123                         throw new TrustedBrowserPersistenceException(sprintf('Couldn\'t delete trusted Browser with cookie hash \'%s\'', $trustedBrowser->cookie_hash));
 124                 }
 125         }
 126
 127         /**
 128          * @param int    $local_user
 129          * @param string $cookie_hash
 130          *
 131          * @return bool
 132          *
 133          * @throws TrustedBrowserPersistenceException
 134          */
 135         public function removeForUser(int $local_user, string $cookie_hash): bool
 136         {
 137                 try {
 138                         return $this->db->delete(self::$table_name, ['cookie_hash' => $cookie_hash, 'uid' => $local_user]);
 139                 } catch (\Exception $exception) {
 140                         throw new TrustedBrowserPersistenceException(sprintf('Couldn\'t delete trusted Browser for user \'%s\' and cookie hash \'%s\'', $local_user, $cookie_hash));
 141                 }
 142         }
 143
 144         /**
 145          * @param int $local_user
 146          * @return bool
 147          */
 148         public function removeAllForUser(int $local_user): bool
 149         {
 150                 try {
 151                         return $this->db->delete(self::$table_name, ['uid' => $local_user]);
 152                 } catch (\Exception $exception) {
 153                         throw new TrustedBrowserPersistenceException(sprintf('Couldn\'t delete trusted Browsers for user \'%s\'', $local_user));
 154                 }
 155         }
 156 }