aboutsummaryrefslogtreecommitdiffstats
path: root/tests/lib/Files/PathVerificationTest.php
blob: e13dbe4f2070429958a45f11cb60c443eccdebc2 (plain)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace Test\Files;

use OC\Files\Storage\Local;
use OC\Files\View;
use OCP\Files\InvalidPathException;
use OCP\IDBConnection;
use OCP\Server;

/**
 * Class PathVerificationTest
 *
 * @group DB
 *
 * @package Test\Files
 */
class PathVerificationTest extends \Test\TestCase {
	/**
	 * @var View
	 */
	private $view;

	protected function setUp(): void {
		parent::setUp();
		$this->view = new View();
	}


	public function testPathVerificationFileNameTooLong(): void {
		$this->expectException(InvalidPathException::class);
		$this->expectExceptionMessage('Filename is too long');

		$fileName = str_repeat('a', 500);
		$this->view->verifyPath('', $fileName);
	}


	#[\PHPUnit\Framework\Attributes\DataProvider('providesEmptyFiles')]
	public function testPathVerificationEmptyFileName($fileName): void {
		$this->expectException(InvalidPathException::class);
		$this->expectExceptionMessage('Empty filename is not allowed');

		$this->view->verifyPath('', $fileName);
	}

	public static function providesEmptyFiles(): array {
		return [
			[''],
			[' '],
		];
	}

	#[\PHPUnit\Framework\Attributes\DataProvider('providesDotFiles')]
	public function testPathVerificationDotFiles($fileName): void {
		$this->expectException(InvalidPathException::class);
		$this->expectExceptionMessage('Dot files are not allowed');

		$this->view->verifyPath('', $fileName);
	}

	public static function providesDotFiles(): array {
		return [
			['.'],
			['..'],
			[' .'],
			[' ..'],
			['. '],
			['.. '],
			[' . '],
			[' .. '],
		];
	}

	#[\PHPUnit\Framework\Attributes\DataProvider('providesAstralPlane')]
	public function testPathVerificationAstralPlane($fileName): void {
		$connection = Server::get(IDBConnection::class);

		if (!$connection->supports4ByteText()) {
			$this->expectException(InvalidPathException::class);
			$this->expectExceptionMessage('File name contains at least one invalid character');
		} else {
			$this->addToAssertionCount(1);
		}

		$this->view->verifyPath('', $fileName);
	}

	public static function providesAstralPlane(): array {
		return [
			// this is the monkey emoji - http://en.wikipedia.org/w/index.php?title=%F0%9F%90%B5&redirect=no
			['🐵'],
			['🐵.txt'],
			['txt.💩'],
			['💩🐵.txt'],
			['💩🐵'],
		];
	}

	#[\PHPUnit\Framework\Attributes\DataProvider('providesValidPosixPaths')]
	public function testPathVerificationValidPaths($fileName): void {
		$storage = new Local(['datadir' => '']);

		self::invokePrivate($storage, 'verifyPosixPath', [$fileName]);
		// nothing thrown
		$this->addToAssertionCount(1);
	}

	public static function providesValidPosixPaths(): array {
		return [
			['simple'],
			['simple.txt'],
			['\''],
			['`'],
			['%'],
			['()'],
			['[]'],
			['!'],
			['$'],
			['_'],
		];
	}
}