Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
SessionCsrf
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
2 / 2
4
100.00% covered (success)
100.00%
1 / 1
 trimTokenList
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
3
 getTokenCount
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * Extension of Laminas\Validator\Csrf with token counting/clearing functions added.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2018.
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  Validator
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
30namespace VuFind\Validator;
31
32use function array_slice;
33use function count;
34
35/**
36 * Extension of Laminas\Validator\Csrf with token counting/clearing functions added.
37 *
38 * @category VuFind
39 * @package  Solr
40 * @author   Demian Katz <demian.katz@villanova.edu>
41 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
42 * @link     https://vufind.org/wiki/development Wiki
43 */
44class SessionCsrf extends \Laminas\Validator\Csrf implements CsrfInterface
45{
46    /**
47     * Keep only the most recent N tokens.
48     *
49     * @param int $limit Number of tokens to keep.
50     *
51     * @return void
52     */
53    public function trimTokenList($limit)
54    {
55        $session = $this->getSession();
56        if ($limit < 1) {
57            // Reset the array if necessary:
58            $session->tokenList = [];
59        } elseif ($limit < $this->getTokenCount()) {
60            // Trim the array if necessary:
61            $session->tokenList
62                = array_slice($session->tokenList, -1 * $limit, null, true);
63        }
64    }
65
66    /**
67     * How many tokens are currently stored in the session?
68     *
69     * @return int
70     */
71    public function getTokenCount()
72    {
73        return count($this->getSession()->tokenList ?? []);
74    }
75}