plugins/CustomDimensions/Dimension/Name.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */

namespace Piwik\Plugins\CustomDimensions\Dimension;

use \Exception;
use Piwik\Piwik;

class Name
{
    public function __construct($name)
    {
        $this->name = $name;
    }

    public function check()
    {
        $maxLen = 255;

        if (empty($this->name)) {
            throw new Exception(Piwik::translate('CustomDimensions_NameIsRequired'));
        }

        if (strlen($this->name) > $maxLen) {
            throw new Exception(Piwik::translate('CustomDimensions_NameIsTooLong', $maxLen));
        }

        $blockedCharacters = self::getBlockedCharacters();

        // we do not really have to do this and it is not very effective for preventing XSS but doesn't hurt to have
        if (strip_tags($this->name) !== $this->name || str_replace($blockedCharacters, '', $this->name) !== $this->name) {
            throw new Exception(Piwik::translate('CustomDimensions_NameAllowedCharacters'));
        }
    }

    /**
     * @api
     */
    public static function getBlockedCharacters()
    {
        return [
            '/', '\\', '&', '.', '<', '>',
        ];
    }
}