Lines 97.39% 187 / 192
Methods 96.55% 28 / 29
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readEntity 100.00% 9 / 9 100.00% 1 / 1 2
 writeEntity 100.00% 9 / 9 100.00% 1 / 1 2
 updateEntity 100.00% 2 / 2 100.00% 1 / 1 1
 readQuota 100.00% 9 / 9 100.00% 1 / 1 1
 readQuotaList 100.00% 9 / 9 100.00% 1 / 1 2
 writeQuota 100.00% 9 / 9 100.00% 1 / 1 1
 updateQuota 100.00% 14 / 14 100.00% 1 / 1 4
 deleteEntity 100.00% 9 / 9 100.00% 1 / 1 4
 readExpiredQuotaListByPeriod 100.00% 2 / 2 100.00% 1 / 1 2
 writeDeletedQuota 100.00% 3 / 3 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] __construct 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] init 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] getWriter 100.00% 4 / 4 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] getReader 100.00% 5 / 5 100.00% 1 / 1 3
 [BO\Zmsbackend\Base] fetchPreparedStatement 100.00% 9 / 9 100.00% 1 / 1 3
 [BO\Zmsbackend\Base] startExecute 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] pdoExceptionHandler 100.00% 13 / 13 100.00% 1 / 1 4
 [BO\Zmsbackend\Base] fetchStatement 100.00% 3 / 3 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchOne 100.00% 7 / 7 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] fetchRow 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchValue 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchAll 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchHandle 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchList 100.00% 8 / 8 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] writeItem 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] deleteItem 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] perform 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchAffected 100.00% 8 / 8 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] readResolvedReferences n/a 0 / 0 n/a 0 / 0 1
 [BO\Zmsbackend\Base] hashStringValue 50.00% 5 / 10 0.00% 0 / 1 8.12
7class Apikey extends \BO\Zmsbackend\Base
8{
9    public static $cache = [];
10
11    public function readEntity($apiKey): Entity
12    {
13        $query = new \BO\Zmsbackend\Apikey\Repository\Apikey(\BO\Zmsbackend\Query\Base::SELECT);
14        $query
15            ->addEntityMapping()
16            ->addResolvedReferences(0)
17            ->addConditionApikey($apiKey);
18        $entity = $this->fetchOne($query, new Entity());
19        if ($entity->hasId()) {
20            $entity->quota = $this->readQuotaList($apiKey);
21        }
22        return $entity;
23    }
24
25    /**
26     * write a new apikey
27     *
28     * @param
29     *      entity
30     *
31     * @return Entity
32     */
33    public function writeEntity(Entity $entity)
34    {
35        $query = new \BO\Zmsbackend\Apikey\Repository\Apikey(\BO\Zmsbackend\Query\Base::INSERT);
36        $query->addValues([
37            'key' => $entity->key,
38            'createIP' => $entity->createIP,
39            'ts' => (new \DateTimeImmutable())->getTimestamp()
40        ]);
41        if ($this->writeItem($query)) {
42            $this->updateQuota($entity->key, $entity);
43        }
44        return $this->readEntity($entity->key);
45    }
46
47    /**
48     * update an existing active apikey quota
49     *
50     * @param
51     *      entity
52     *
53     * @return Entity
54     */
55    public function updateEntity($apiKey, Entity $entity)
56    {
57        $this->updateQuota($apiKey, $entity);
58        return $this->readEntity($apiKey, 1);
59    }
60
61    /**
62     * read specified api quota
63     *
64     * @param
65     *      apiKey
66     *      entity
67     *
68     * @return Entity
69     */
70    public function readQuota($apiKey, $route)
71    {
72        $query = new \BO\Zmsbackend\Apikey\Repository\Apiquota(\BO\Zmsbackend\Query\Base::SELECT);
73        $query
74            ->addEntityMapping()
75            ->addResolvedReferences(0)
76            ->addConditionApikey($apiKey)
77            ->addConditionRoute($route);
78        $statement = $this->fetchStatement($query);
79        $data = $statement->fetch(\PDO::FETCH_ASSOC);
80        return $data;
81    }
82
83    /**
84     * read api quotas by apikey
85     *
86     * @param
87     *      apiKey
88     *      entity
89     *
90     * @return Entity
91     */
92    public function readQuotaList($apiKey)
93    {
94        $data = $this
95        ->getReader()
96        ->fetchAll(
97            \BO\Zmsbackend\Apikey\Repository\Apiquota::getQueryReadApiQuotaListByKey(),
98            [
99                'key' => $apiKey
100            ]
101        );
102        return ($data) ? $data : [];
103    }
104
105    /**
106     * write initial api quotas
107     *
108     * @param
109     *      entity
110     *
111     * @return Entity
112     */
113    public function writeQuota($apiKey, $route, $period, $requests)
114    {
115        $query = new \BO\Zmsbackend\Apikey\Repository\Apiquota(\BO\Zmsbackend\Query\Base::INSERT);
116        $query->addValues([
117            'key' => $apiKey,
118            'route' => $route,
119            'period' => $period,
120            'requests' => $requests,
121            'ts' => (new \DateTimeImmutable())->getTimestamp()
122        ]);
123        $this->writeItem($query);
124    }
125
126    /**
127     * update api quotas
128     *
129     * @param
130     *      apiKey
131     *      entity
132     *
133     * @return Entity
134     */
135    public function updateQuota($apiKey, Entity $entity)
136    {
137        if (isset($entity->quota)) {
138            foreach ($entity->quota as $quota) {
139                if ($this->readQuota($apiKey, $quota['route'])) {
140                    $query = new \BO\Zmsbackend\Apikey\Repository\Apiquota(\BO\Zmsbackend\Query\Base::UPDATE);
141                    $query->addConditionApikey($apiKey);
142                    $query->addConditionRoute($quota['route']);
143                    $query->addValues([
144                        'key' => $apiKey,
145                        'route' => $quota['route'],
146                        'period' => $quota['period'],
147                        'requests' => $quota['requests']
148                    ]);
149                    $this->writeItem($query);
150                } else {
151                    $this->writeQuota($apiKey, $quota['route'], $quota['period'], $quota['requests']);
152                }
153            }
154        }
155    }
156
157    /**
158     * delete an existing outdated apikey
159     *
160     * @param
161     *      apikey
162     *
163     * @return Entity
164     */
165    public function deleteEntity($apiKey)
166    {
167        $entity = $this->readEntity($apiKey);
168        if ($entity) {
169            $query = new \BO\Zmsbackend\Apikey\Repository\Apikey(\BO\Zmsbackend\Query\Base::DELETE);
170            $query->addConditionApikey($apiKey);
171            if ($this->deleteItem($query)) {
172                $queryQuota = new \BO\Zmsbackend\Apikey\Repository\Apiquota(\BO\Zmsbackend\Query\Base::DELETE);
173                $queryQuota->addConditionApikey($apiKey);
174                $this->deleteItem($queryQuota);
175            };
176        }
177
178        return ($entity) ? $entity : null;
179    }
180
181    /**
182     * delete api quota by its period setting and creation timestamp
183     *
184     * @param
185     *      apikey
186     *
187     * @return Entity
188     */
189    public function readExpiredQuotaListByPeriod(\DateTimeInterface $dateTime)
190    {
191        $data = $this->fetchAll(\BO\Zmsbackend\Apikey\Repository\Apiquota::getQueryReadApiQuotaExpired($dateTime));
192        return ($data) ? $data : null;
193    }
194
195    /**
196     * delete an existing outdated apikey
197     *
198     * @param
199     *      apikey
200     *
201     * @return Entity
202     */
203    public function writeDeletedQuota($quotaId)
204    {
205        $query = new \BO\Zmsbackend\Apikey\Repository\Apiquota(\BO\Zmsbackend\Query\Base::DELETE);
206        $query->addConditionQuotaId($quotaId);
207        return $this->deleteItem($query);
208    }
209}

Inherited from BO\Zmsbackend\Base

38    public function __construct(?Connection\Pdo $writeConnection = null, ?Connection\Pdo $readConnection = null)
39    {
40        $this->writeDb = $writeConnection;
41        $this->readDb = $readConnection;
42    }
44    public static function init(?Connection\Pdo $writeConnection = null, ?Connection\Pdo $readConnection = null): static
45    {
46        $instance = new static($writeConnection, $readConnection);
47        return $instance;
48    }
50    public function getWriter(): Connection\Pdo
51    {
52        if (null === $this->writeDb) {
53            $this->writeDb = Connection\Select::getWriteConnection();
54            $this->readDb = $this->writeDb;
55        }
56        return $this->writeDb;
57    }
59    public function getReader(): Connection\Pdo
60    {
61        if (null !== $this->writeDb) {
62            // if readDB gets a reset, still use writeDB
63            return $this->writeDb;
64        }
65        if (null === $this->readDb) {
66            $this->readDb = Connection\Select::getReadConnection();
67        }
68        return $this->readDb;
69    }
71    public function fetchPreparedStatement(Query\Base|string $query)
72    {
73        $sql = "$query";
74        $reader = $this->getReader();
75        if (spl_object_hash($reader) != static::$preparedConnectionId) {
76            // do not use prepared statements on a different connection
77            static::$preparedCache = [];
78            static::$preparedConnectionId = spl_object_hash($reader);
79        }
80        if (!isset(static::$preparedCache[$sql])) {
81            $prepared = $this->getReader()->prepare($sql);
82            static::$preparedCache[$sql] = $prepared;
83        }
84        return static::$preparedCache[$sql];
85    }
87    public function startExecute($statement, array $parameters)
88    {
89        $statement = static::pdoExceptionHandler(function () use ($statement, $parameters) {
90            $statement->execute($parameters);
91            return $statement;
92        });
93        return $statement;
94    }
96    protected static function pdoExceptionHandler(\Closure $pdoFunction, $parameters = [])
97    {
98        try {
99            $statement = $pdoFunction($parameters);
100        } catch (\PDOException $pdoException) {
101            if (stripos($pdoException->getMessage(), 'Lock wait timeout') !== false) {
102                throw new \BO\Zmsbackend\Exception\Pdo\LockTimeout();
103            }
104            //@codeCoverageIgnoreStart
105            if (stripos($pdoException->getMessage(), 'Deadlock found') !== false) {
106                throw new \BO\Zmsbackend\Exception\Pdo\DeadLockFound();
107            }
108            //@codeCoverageIgnoreEnd
109            $message = "SQL: "
110                . " Err: "
111                . $pdoException->getMessage()
112                //. " || Statement: "
113                //.$statement->queryString
114                //." || Parameters=". var_export($parameters, true)
115                ;
116            throw new \BO\Zmsbackend\Exception\Pdo\PDOFailed($message, 0, $pdoException);
117        }
118        return $statement;
119    }
121    public function fetchStatement(Query\Base $query)
122    {
123        $parameters = $query->getParameters();
124        $statement = $this->startExecute($this->fetchPreparedStatement($query), $parameters);
125        return $statement;
126    }
133    public function fetchOne(Query\Base $query, \BO\Zmsentities\Schema\Entity $entity)
134    {
135        $statement = $this->fetchStatement($query);
136        $data = $statement->fetch(\PDO::FETCH_ASSOC);
137        if ($data) {
138            $entity->exchangeArray($query->postProcessJoins($data));
139            $entity->setResolveLevel($query->getResolveLevel());
140        }
141        $statement->closeCursor();
142        return $entity;
143    }
145    public function fetchRow(Query\Base|string $query, array|null $parameters = null)
146    {
147        return static::pdoExceptionHandler(function () use ($query, $parameters) {
148            $prepared = $this->fetchPreparedStatement($query);
149            $prepared->execute($parameters);
150            $row = $prepared->fetch(\PDO::FETCH_ASSOC);
151            $prepared->closeCursor();
152            return $row;
153        });
154    }
156    public function fetchValue(Query\Base|string $query, array|null $parameters = null)
157    {
158        return static::pdoExceptionHandler(function () use ($query, $parameters) {
159            $prepared = $this->fetchPreparedStatement($query);
160            $prepared->execute($parameters);
161            $value = $prepared->fetchColumn();
162            $prepared->closeCursor();
163            return $value;
164        });
165    }
167    public function fetchAll(Query\Base|string $query, array|null $parameters = null)
168    {
169        return static::pdoExceptionHandler(function () use ($query, $parameters) {
170            $prepared = $this->fetchPreparedStatement($query);
171            $prepared->execute($parameters);
172            $list = $prepared->fetchAll(\PDO::FETCH_ASSOC);
173            $prepared->closeCursor();
174            return $list;
175        });
176    }
178    public function fetchHandle(Query\Base|string $query, array|null $parameters = null)
179    {
180        return static::pdoExceptionHandler(function () use ($query, $parameters) {
181            $prepared = $this->fetchPreparedStatement($query);
182            $prepared->execute($parameters);
183            return $prepared;
184        });
185    }
187    public function fetchList(Query\Base $query, \BO\Zmsentities\Schema\Entity $entity, array|\ArrayAccess $resultList = [])
188    {
189        $statement = $this->fetchStatement($query);
190        while ($data = $statement->fetch(\PDO::FETCH_ASSOC)) {
191            $dataEntity = clone $entity;
192            $dataEntity->exchangeArray($query->postProcessJoins($data));
193            $dataEntity->setResolveLevel($query->getResolveLevel());
194            $resultList[] = $dataEntity;
195        }
196        $statement->closeCursor();
197        return $resultList;
198    }
206    public function writeItem(Query\Base $query)
207    {
208        return static::pdoExceptionHandler(function () use ($query) {
209            $this->getWriter(); //Switch to writer for write/delete
210            $statement = $this->fetchPreparedStatement($query);
211            $status = $statement->execute($query->getParameters());
212            $statement->closeCursor();
213            return $status;
214        });
215    }
221    public function deleteItem(Query\Base $query)
222    {
223        return $this->writeItem($query);
224    }
226    public function perform(string $sql, array|null $parameters = null)
227    {
228        return static::pdoExceptionHandler(function () use ($sql, $parameters) {
229            $this->getWriter(); //Switch to writer for perform
230            $prepared = $this->fetchPreparedStatement($sql);
231            $status = $prepared->execute($parameters);
232            $prepared->closeCursor();
233            return $status;
234        });
235    }
237    public function fetchAffected(string $sql, array|null $parameters = null)
238    {
239        return static::pdoExceptionHandler(function () use ($sql, $parameters) {
240            $this->getWriter(); //Switch to writer for perform
241            $prepared = $this->fetchPreparedStatement($sql);
242            $prepared->execute($parameters);
243            $count = $prepared->rowCount();
244            $prepared->closeCursor();
245            return $count;
246        });
247    }
256    public function readResolvedReferences(\BO\Zmsentities\Schema\Entity $entity, int $resolveReferences)
257    {
258        return $entity;
259    }
268    public function hashStringValue(string $value, ?callable $callable = null): string
269    {
270        if ($callable === null) {
271            $callable = 'sha1';
272        }
273
274        if (is_callable($callable)) {
275            $hash = $callable($value);
276
277            if (is_string($callable)) {
278                return $callable . ':' . $hash;
279            }
280            if ($callable instanceof \Closure) {
281                return 'closure:' . $hash;
282            }
283            // else
284            return 'custom:' . $hash;
285        }
286
287        throw new \InvalidArgumentException('hashStringValue() should be called with a callable as second parameter.');
288    }