src/Core/Cache/Type/CompareSetTrait.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\Core\Cache\Type;
  23
  24 use Friendica\Core\Cache\Enum\Duration;
  25
  26 /**
  27  * This Trait is to compensate nonnative "exclusive" sets/deletes in caches
  28  */
  29 trait CompareSetTrait
  30 {
  31         abstract public function get(string $key);
  32
  33         abstract public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES);
  34
  35         abstract public function delete(string $key);
  36
  37         abstract public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES);
  38
  39         /**
  40          * NonNative - Compares if the old value is set and sets the new value
  41          *
  42          * @param string $key      The cache key
  43          * @param mixed  $oldValue The old value we know from the cache
  44          * @param mixed  $newValue The new value we want to set
  45          * @param int    $ttl      The cache lifespan, must be one of the Cache constants
  46          *
  47          * @return bool
  48          */
  49         public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool
  50         {
  51                 if ($this->add($key . "_lock", true)) {
  52                         if ($this->get($key) === $oldValue) {
  53                                 $this->set($key, $newValue, $ttl);
  54                                 $this->delete($key . "_lock");
  55                                 return true;
  56                         } else {
  57                                 $this->delete($key . "_lock");
  58                                 return false;
  59                         }
  60                 } else {
  61                         return false;
  62                 }
  63         }
  64 }