util.php 13 KB
Newer Older
1
<?php
2

3
4
5
6
7
8
/**
 * Copyright (c) 2012 Lukas Reschke <lukas@statuscode.ch>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */
9
class Test_Util extends \Test\TestCase {
kondou's avatar
kondou committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
	public function testGetVersion() {
		$version = \OC_Util::getVersion();
		$this->assertTrue(is_array($version));
		foreach ($version as $num) {
			$this->assertTrue(is_int($num));
		}
	}

	public function testGetVersionString() {
		$version = \OC_Util::getVersionString();
		$this->assertTrue(is_string($version));
	}

	public function testGetEditionString() {
		$edition = \OC_Util::getEditionString();
		$this->assertTrue(is_string($edition));
	}
27

28
	function testFormatDate() {
29
		date_default_timezone_set("UTC");
30
31

		$result = OC_Util::formatDate(1350129205);
32
		$expected = 'October 13, 2012 at 11:53:25 AM GMT+0';
Thomas Müller's avatar
Thomas Müller committed
33
		$this->assertEquals($expected, $result);
34
35
36

		$result = OC_Util::formatDate(1102831200, true);
		$expected = 'December 12, 2004';
37
		$this->assertEquals($expected, $result);
38
39
	}

40
41
42
43
	function testFormatDateWithTZ() {
		date_default_timezone_set("UTC");

		$result = OC_Util::formatDate(1350129205, false, 'Europe/Berlin');
Joas Schilling's avatar
Joas Schilling committed
44
		$expected = 'October 13, 2012 at 1:53:25 PM GMT+2';
45
46
47
48
49
50
51
52
53
54
55
56
57
		$this->assertEquals($expected, $result);
	}

	/**
	 * @expectedException Exception
	 */
	function testFormatDateWithInvalidTZ() {
		OC_Util::formatDate(1350129205, false, 'Mordor/Barad-dûr');
	}

	function testFormatDateWithTZFromSession() {
		date_default_timezone_set("UTC");

Joas Schilling's avatar
Joas Schilling committed
58
		$oldDateTimeFormatter = \OC::$server->query('DateTimeFormatter');
59
		\OC::$server->getSession()->set('timezone', 3);
60
		$newDateTimeFormatter = new \OC\DateTimeFormatter(\OC::$server->getDateTimeZone()->getTimeZone(), new \OC_L10N('lib', 'en'));
Joas Schilling's avatar
Joas Schilling committed
61
62
		$this->setDateFormatter($newDateTimeFormatter);

63
		$result = OC_Util::formatDate(1350129205, false);
Joas Schilling's avatar
Joas Schilling committed
64
		$expected = 'October 13, 2012 at 2:53:25 PM GMT+3';
65
		$this->assertEquals($expected, $result);
Joas Schilling's avatar
Joas Schilling committed
66
67
68
69
70
71
72
73

		$this->setDateFormatter($oldDateTimeFormatter);
	}

	protected function setDateFormatter($formatter) {
		\OC::$server->registerService('DateTimeFormatter', function ($c) use ($formatter) {
			return $formatter;
		});
74
75
	}

76
77
	function testCallRegister() {
		$result = strlen(OC_Util::callRegister());
78
		$this->assertEquals(30, $result);
79
80
81
	}

	function testSanitizeHTML() {
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
		$badArray = array(
			'While it is unusual to pass an array',
			'this function actually <blink>supports</blink> it.',
			'And therefore there needs to be a <script>alert("Unit"+\'test\')</script> for it!'
		);
		$goodArray = array(
			'While it is unusual to pass an array',
			'this function actually &lt;blink&gt;supports&lt;/blink&gt; it.',
			'And therefore there needs to be a &lt;script&gt;alert(&quot;Unit&quot;+&#039;test&#039;)&lt;/script&gt; for it!'
		);
		$result = OC_Util::sanitizeHTML($badArray);
		$this->assertEquals($goodArray, $result);

		$badString = '<img onload="alert(1)" />';
		$result = OC_Util::sanitizeHTML($badString);
		$this->assertEquals('&lt;img onload=&quot;alert(1)&quot; /&gt;', $result);

99
100
		$badString = "<script>alert('Hacked!');</script>";
		$result = OC_Util::sanitizeHTML($badString);
101
		$this->assertEquals('&lt;script&gt;alert(&#039;Hacked!&#039;);&lt;/script&gt;', $result);
102

103
		$goodString = 'This is a good string without HTML.';
104
		$result = OC_Util::sanitizeHTML($goodString);
105
		$this->assertEquals('This is a good string without HTML.', $result);
Lukas Reschke's avatar
Lukas Reschke committed
106
	}
107

108
	function testEncodePath() {
Victor Dubiniuk's avatar
Victor Dubiniuk committed
109
110
111
112
		$component = '/§#@test%&^ä/-child';
		$result = OC_Util::encodePath($component);
		$this->assertEquals("/%C2%A7%23%40test%25%26%5E%C3%A4/-child", $result);
	}
113

kondou's avatar
kondou committed
114
115
116
117
118
119
120
121
122
123
124
125
126
	public function testFileInfoLoaded() {
		$expected = function_exists('finfo_open');
		$this->assertEquals($expected, \OC_Util::fileInfoLoaded());
	}

	public function testIsInternetConnectionEnabled() {
		\OC_Config::setValue("has_internet_connection", false);
		$this->assertFalse(\OC_Util::isInternetConnectionEnabled());

		\OC_Config::setValue("has_internet_connection", true);
		$this->assertTrue(\OC_Util::isInternetConnectionEnabled());
	}

kondou's avatar
kondou committed
127
128
	function testGenerateRandomBytes() {
		$result = strlen(OC_Util::generateRandomBytes(59));
129
		$this->assertEquals(59, $result);
130
	}
131
132
133

	function testGetDefaultEmailAddress() {
		$email = \OCP\Util::getDefaultEmailAddress("no-reply");
134
		$this->assertEquals('no-reply@localhost', $email);
itheiss's avatar
itheiss committed
135
136
137
	}

	function testGetDefaultEmailAddressFromConfig() {
138
139
140
141
		OC_Config::setValue('mail_domain', 'example.com');
		$email = \OCP\Util::getDefaultEmailAddress("no-reply");
		$this->assertEquals('no-reply@example.com', $email);
		OC_Config::deleteKey('mail_domain');
142
	}
143

144
145
146
147
148
149
150
151
152
	function testGetConfiguredEmailAddressFromConfig() {
		OC_Config::setValue('mail_domain', 'example.com');
		OC_Config::setValue('mail_from_address', 'owncloud');
		$email = \OCP\Util::getDefaultEmailAddress("no-reply");
		$this->assertEquals('owncloud@example.com', $email);
		OC_Config::deleteKey('mail_domain');
		OC_Config::deleteKey('mail_from_address');
	}

153
154
	function testGetInstanceIdGeneratesValidId() {
		OC_Config::deleteKey('instanceid');
Lukas Reschke's avatar
Lukas Reschke committed
155
156
157
158
		$instanceId = OC_Util::getInstanceId();
		$this->assertStringStartsWith('oc', $instanceId);
		$matchesRegex = preg_match('/^[a-z0-9]+$/', $instanceId);
		$this->assertSame(1, $matchesRegex);
159
160
	}

161
162
163
164
	/**
	 * Tests that the home storage is not wrapped when no quota exists.
	 */
	function testHomeStorageWrapperWithoutQuota() {
165
		$user1 = $this->getUniqueID();
166
		\OC_User::createUser($user1, 'test');
167
		\OC::$server->getConfig()->setUserValue($user1, 'files', 'quota', 'none');
168
169
170
171
172
173
174
175
176
177
178
		\OC_User::setUserId($user1);

		\OC_Util::setupFS($user1);

		$userMount = \OC\Files\Filesystem::getMountManager()->find('/' . $user1 . '/');
		$this->assertNotNull($userMount);
		$this->assertNotInstanceOf('\OC\Files\Storage\Wrapper\Quota', $userMount->getStorage());

		// clean up
		\OC_User::setUserId('');
		\OC_User::deleteUser($user1);
179
		\OC::$server->getConfig()->deleteAllUserValues($user1);
180
181
182
183
184
185
186
		\OC_Util::tearDownFS();
	}

	/**
	 * Tests that the home storage is not wrapped when no quota exists.
	 */
	function testHomeStorageWrapperWithQuota() {
187
		$user1 = $this->getUniqueID();
188
		\OC_User::createUser($user1, 'test');
189
		\OC::$server->getConfig()->setUserValue($user1, 'files', 'quota', '1024');
190
191
192
193
194
195
		\OC_User::setUserId($user1);

		\OC_Util::setupFS($user1);

		$userMount = \OC\Files\Filesystem::getMountManager()->find('/' . $user1 . '/');
		$this->assertNotNull($userMount);
196
		$this->assertTrue($userMount->getStorage()->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota'));
197
198
199
200
201
202
203
204
205

		// ensure that root wasn't wrapped
		$rootMount = \OC\Files\Filesystem::getMountManager()->find('/');
		$this->assertNotNull($rootMount);
		$this->assertNotInstanceOf('\OC\Files\Storage\Wrapper\Quota', $rootMount->getStorage());

		// clean up
		\OC_User::setUserId('');
		\OC_User::deleteUser($user1);
206
		\OC::$server->getConfig()->deleteAllUserValues($user1);
207
208
209
		\OC_Util::tearDownFS();
	}

210
211
212
	/**
	 * @dataProvider baseNameProvider
	 */
213
	public function testBaseName($expected, $file) {
214
215
216
217
		$base = \OC_Util::basename($file);
		$this->assertEquals($expected, $base);
	}

218
	public function baseNameProvider() {
219
220
221
222
		return array(
			array('public_html', '/home/user/public_html/'),
			array('public_html', '/home/user/public_html'),
			array('', '/'),
Thomas Müller's avatar
Thomas Müller committed
223
			array('public_html', 'public_html'),
224
225
226
			array('442aa682de2a64db1e010f50e60fd9c9', 'local::C:\Users\ADMINI~1\AppData\Local\Temp\2/442aa682de2a64db1e010f50e60fd9c9/')
		);
	}
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

	/**
	 * @dataProvider filenameValidationProvider
	 */
	public function testFilenameValidation($file, $valid) {
		// private API
		$this->assertEquals($valid, \OC_Util::isValidFileName($file));
		// public API
		$this->assertEquals($valid, \OCP\Util::isValidFileName($file));
	}

	public function filenameValidationProvider() {
		return array(
			// valid names
			array('boringname', true),
			array('something.with.extension', true),
			array('now with spaces', true),
			array('.a', true),
			array('..a', true),
			array('.dotfile', true),
			array('single\'quote', true),
			array('  spaces before', true),
			array('spaces after   ', true),
			array('allowed chars including the crazy ones $%&_-^@!,()[]{}=;#', true),
			array('汉字也能用', true),
			array('und Ümläüte sind auch willkommen', true),
			// disallowed names
			array('', false),
			array('     ', false),
			array('.', false),
			array('..', false),
			array('back\\slash', false),
			array('sl/ash', false),
			array('lt<lt', false),
			array('gt>gt', false),
			array('col:on', false),
			array('double"quote', false),
			array('pi|pe', false),
			array('dont?ask?questions?', false),
			array('super*star', false),
			array('new\nline', false),
			// better disallow these to avoid unexpected trimming to have side effects
			array(' ..', false),
			array('.. ', false),
			array('. ', false),
			array(' .', false),
		);
	}
275
276
277
278
279
280
281
282
283
284
285
286
287
288

	/**
	 * @dataProvider dataProviderForTestIsSharingDisabledForUser
	 * @param array $groups existing groups
	 * @param array $membership groups the user belong to
	 * @param array $excludedGroups groups which should be excluded from sharing
	 * @param bool $expected expected result
	 */
	function testIsSharingDisabledForUser($groups, $membership, $excludedGroups, $expected) {
		$uid = "user1";
		\OC_User::setUserId($uid);

		\OC_User::createUser($uid, "passwd");

289
		foreach ($groups as $group) {
290
291
292
			\OC_Group::createGroup($group);
		}

293
		foreach ($membership as $group) {
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
			\OC_Group::addToGroup($uid, $group);
		}

		$appConfig = \OC::$server->getAppConfig();
		$appConfig->setValue('core', 'shareapi_exclude_groups_list', implode(',', $excludedGroups));
		$appConfig->setValue('core', 'shareapi_exclude_groups', 'yes');

		$result = \OCP\Util::isSharingDisabledForUser();

		$this->assertSame($expected, $result);

		// cleanup
		\OC_User::deleteUser($uid);
		\OC_User::setUserId('');

309
		foreach ($groups as $group) {
310
311
312
313
314
315
316
317
			\OC_Group::deleteGroup($group);
		}

		$appConfig->setValue('core', 'shareapi_exclude_groups_list', '');
		$appConfig->setValue('core', 'shareapi_exclude_groups', 'no');

	}

318
	public function dataProviderForTestIsSharingDisabledForUser() {
319
320
321
322
323
324
325
326
327
		return array(
			// existing groups, groups the user belong to, groups excluded from sharing, expected result
			array(array('g1', 'g2', 'g3'), array(), array('g1'), false),
			array(array('g1', 'g2', 'g3'), array(), array(), false),
			array(array('g1', 'g2', 'g3'), array('g2'), array('g1'), false),
			array(array('g1', 'g2', 'g3'), array('g2'), array(), false),
			array(array('g1', 'g2', 'g3'), array('g1', 'g2'), array('g1'), false),
			array(array('g1', 'g2', 'g3'), array('g1', 'g2'), array('g1', 'g2'), true),
			array(array('g1', 'g2', 'g3'), array('g1', 'g2'), array('g1', 'g2', 'g3'), true),
328
329
		);
	}
330
331
332
333
334
335
336
337
338
339
340
341

	/**
	 * Test default apps
	 *
	 * @dataProvider defaultAppsProvider
	 */
	function testDefaultApps($defaultAppConfig, $expectedPath, $enabledApps) {
		$oldDefaultApps = \OCP\Config::getSystemValue('core', 'defaultapp', '');
		// CLI is doing messy stuff with the webroot, so need to work it around
		$oldWebRoot = \OC::$WEBROOT;
		\OC::$WEBROOT = '';

342
343
344
345
346
347
348
349
		$appManager = $this->getMock('\OCP\App\IAppManager');
		$appManager->expects($this->any())
			->method('isEnabledForUser')
			->will($this->returnCallback(function($appId) use ($enabledApps){
				return in_array($appId, $enabledApps);
		}));
		Dummy_OC_Util::$appManager = $appManager;

350
		// need to set a user id to make sure enabled apps are read from cache
351
		\OC_User::setUserId($this->getUniqueID());
352
		\OCP\Config::setSystemValue('defaultapp', $defaultAppConfig);
353
		$this->assertEquals('http://localhost/' . $expectedPath, Dummy_OC_Util::getDefaultPageUrl());
354
355
356
357

		// restore old state
		\OC::$WEBROOT = $oldWebRoot;
		\OCP\Config::setSystemValue('defaultapp', $oldDefaultApps);
358
		\OC_User::setUserId(null);
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
	}

	function defaultAppsProvider() {
		return array(
			// none specified, default to files
			array(
				'',
				'index.php/apps/files/',
				array('files'),
			),
			// unexisting or inaccessible app specified, default to files
			array(
				'unexist',
				'index.php/apps/files/',
				array('files'),
			),
			// non-standard app
			array(
				'calendar',
				'index.php/apps/calendar/',
				array('files', 'calendar'),
			),
			// non-standard app with fallback
			array(
				'contacts,calendar',
				'index.php/apps/calendar/',
				array('files', 'calendar'),
			),
		);
	}

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
	/**
	 * Test needUpgrade() when the core version is increased
	 */
	public function testNeedUpgradeCore() {
		$oldConfigVersion = OC_Config::getValue('version', '0.0.0');
		$oldSessionVersion = \OC::$server->getSession()->get('OC_Version');

		$this->assertFalse(\OCP\Util::needUpgrade());

		OC_Config::setValue('version', '7.0.0.0');
		\OC::$server->getSession()->set('OC_Version', array(7, 0, 0, 1));

		$this->assertTrue(\OCP\Util::needUpgrade());

		OC_Config::setValue('version', $oldConfigVersion);
		$oldSessionVersion = \OC::$server->getSession()->set('OC_Version', $oldSessionVersion);

		$this->assertFalse(\OCP\Util::needUpgrade());
	}
409
410
411
}

/**
412
 * Dummy OC Util class to make it possible to override the app manager
413
 */
414
415
416
417
418
class Dummy_OC_Util extends OC_Util {
	/**
	 * @var \OCP\App\IAppManager
	 */
	public static $appManager;
419

420
421
	protected static function getAppManager() {
		return self::$appManager;
422
	}
423
}