Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 10 |
|
0.00% |
0 / 2 |
CRAP | |
0.00% |
0 / 1 |
| SecretCalculator | |
0.00% |
0 / 10 |
|
0.00% |
0 / 2 |
12 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getSearchUnsubscribeSecret | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
6 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Secret calculator |
| 5 | * |
| 6 | * PHP version 8 |
| 7 | * |
| 8 | * Copyright (C) Villanova University 2024. |
| 9 | * |
| 10 | * This program is free software; you can redistribute it and/or modify |
| 11 | * it under the terms of the GNU General Public License version 2, |
| 12 | * as published by the Free Software Foundation. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License |
| 20 | * along with this program; if not, write to the Free Software |
| 21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 22 | * |
| 23 | * @category VuFind |
| 24 | * @package Crypt |
| 25 | * @author Demian Katz <demian.katz@villanova.edu> |
| 26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 27 | * @link https://vufind.org/wiki/development Wiki |
| 28 | */ |
| 29 | |
| 30 | namespace VuFind\Crypt; |
| 31 | |
| 32 | use VuFind\Db\Entity\SearchEntityInterface; |
| 33 | |
| 34 | /** |
| 35 | * Secret calculator |
| 36 | * |
| 37 | * @category VuFind |
| 38 | * @package Crypt |
| 39 | * @author Demian Katz <demian.katz@villanova.edu> |
| 40 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 41 | * @link https://vufind.org/wiki/development Wiki |
| 42 | */ |
| 43 | class SecretCalculator |
| 44 | { |
| 45 | /** |
| 46 | * Constructor |
| 47 | * |
| 48 | * @param HMAC $hmac HMAC generator |
| 49 | */ |
| 50 | public function __construct(protected HMAC $hmac) |
| 51 | { |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Utility function for generating a token for unsubscribing a saved search. |
| 56 | * |
| 57 | * @param SearchEntityInterface $search Object representing saved search |
| 58 | * |
| 59 | * @return string token |
| 60 | */ |
| 61 | public function getSearchUnsubscribeSecret(SearchEntityInterface $search): string |
| 62 | { |
| 63 | $user = $search->getUser(); |
| 64 | if (!$user) { |
| 65 | throw new \Exception("Unexpected missing user in search {$search->getId()}"); |
| 66 | } |
| 67 | $data = [ |
| 68 | 'id' => $search->getId(), |
| 69 | 'user_id' => $user->getId(), |
| 70 | 'created' => $user->getCreated()->format('Y-m-d H:i:s'), |
| 71 | ]; |
| 72 | return $this->hmac->generate(array_keys($data), $data); |
| 73 | } |
| 74 | } |