// this is necessary to avoid side effects with the DIC disabled More...

Inheritance diagram for ilServicesFileServicesTest:

Collaboration diagram for ilServicesFileServicesTest:

Public Member Functions
	testSanitizing ()

	testBlacklistedUpload ()

	testBlacklistedUploadWithPermission ()

	testRenamingNonWhitelistedFile ()

	testActualWhitelist ()

	testFileNamePolicyOnDownloading ()

Protected Member Functions
	setUp ()

	tearDown ()

Private Attributes
ILIAS DI Container	$dic_backup

ilDBInterface	$db_mock = null

Detailed Description

// this is necessary to avoid side effects with the DIC disabled

Definition at line 33 of file ilServicesFileServicesTest.php.

Member Function Documentation

◆ setUp()

ilServicesFileServicesTest::setUp ( )

protected

Definition at line 41 of file ilServicesFileServicesTest.php.

References $DIC.

                               : void
     {
         global $DIC;
         $this->dic_backup = is_object($DIC) ? clone $DIC : null;
 
         $DIC = new \ILIAS\DI\Container();
         $DIC['ilDB'] = $this->db_mock = $this->createMock(ilDBInterface::class);
     }

◆ tearDown()

ilServicesFileServicesTest::tearDown ( )

protected

Definition at line 50 of file ilServicesFileServicesTest.php.

References $DIC, and $dic_backup.

                                  : void
     {
         global $DIC;
         $DIC = $this->dic_backup;
     }

◆ testActualWhitelist()

ilServicesFileServicesTest::testActualWhitelist ( )

Definition at line 132 of file ilServicesFileServicesTest.php.

                                          : void
     {
         $settings_mock = $this->createMock(ilSetting::class);
         $ini_mock = $this->createMock(ilIniFile::class);
 
         $ref = new stdClass();
         $ref->ref_id = 32;
         $this->db_mock->expects($this->once())
                 ->method('fetchObject')
                 ->willReturn($ref);
 
         $this->db_mock->expects($this->once())
                 ->method('fetchAssoc')
                 ->willReturn([]);
 
         $default_whitelist = include __DIR__ . "/../defaults/default_whitelist.php";
 
         // Blacklist
         $consecutive = [
             ['suffix_custom_expl_black', 'bl001,bl002'], // blacklisted
             ['suffix_repl_additional', 'docx,doc'], // remove from whitelist
             ['suffix_custom_white_list', 'wl001,wl002'] // add whitelist
         ];
         $settings_mock
             ->expects($this->exactly(3))
             ->method('get')
             ->willReturnCallback(
                 function ($k) use (&$consecutive) {
                     list($expected, $return) = array_shift($consecutive);
                     $this->assertEquals($expected, $k);
                     return $return;
                 }
             );
 
         $settings = new ilFileServicesSettings($settings_mock, $ini_mock, $this->db_mock);
         $this->assertEquals(['bl001', 'bl002'], $settings->getBlackListedSuffixes());
         $this->assertEquals(['bl001', 'bl002'], $settings->getProhibited());
         $this->assertEquals($default_whitelist, $settings->getDefaultWhitelist());
         $this->assertEquals(['docx', 'doc'], $settings->getWhiteListNegative());
         $this->assertEquals(['wl001', 'wl002'], $settings->getWhiteListPositive());
 
         $whitelist = array_merge(
             array_diff($default_whitelist, ['docx', 'doc']),
             ['wl001', 'wl002', '']
         );
         $diff = array_diff($whitelist, $settings->getWhiteListedSuffixes());
 
         $this->assertEquals([], $diff);
         $this->assertEquals(0, count($diff));
     }

◆ testBlacklistedUpload()

ilServicesFileServicesTest::testBlacklistedUpload ( )

Definition at line 69 of file ilServicesFileServicesTest.php.

                                            : void
     {
         $settings = $this->createMock(ilFileServicesSettings::class);
         $settings->expects($this->once())
                  ->method('getBlackListedSuffixes')
                  ->willReturn(['pdf']);
 
         $settings->expects($this->once())
                  ->method('isByPassAllowedForCurrentUser')
                  ->willReturn(false);
 
         $stream = $this->createMock(FileStream::class);
         $meta = new Metadata('filename.pdf', 42, 'application/pdf');
 
         $processor = new ilFileServicesPreProcessor(
             $settings,
             'the reason'
         );
         // is ok since user has permission
         $status = $processor->process($stream, $meta);
         $this->assertEquals(ProcessingStatus::REJECTED, $status->getCode());
     }

◆ testBlacklistedUploadWithPermission()

ilServicesFileServicesTest::testBlacklistedUploadWithPermission ( )

Definition at line 92 of file ilServicesFileServicesTest.php.

                                                          : void
     {
         $settings = $this->createMock(ilFileServicesSettings::class);
         $settings->expects($this->once())
                  ->method('getBlackListedSuffixes')
                  ->willReturn(['pdf']);
 
         $settings->expects($this->once())
                  ->method('isByPassAllowedForCurrentUser')
                  ->willReturn(true);
 
         $stream = $this->createMock(FileStream::class);
         $meta = new Metadata('filename.pdf', 42, 'application/pdf');
 
         $processor = new ilFileServicesPreProcessor(
             $settings,
             'the reason'
         );
         // is ok since user has permission
         $status = $processor->process($stream, $meta);
         $this->assertEquals(ProcessingStatus::OK, $status->getCode());
     }

◆ testFileNamePolicyOnDownloading()

ilServicesFileServicesTest::testFileNamePolicyOnDownloading ( )

Definition at line 185 of file ilServicesFileServicesTest.php.

                                                      : void
     {
         $settings = $this->createMock(ilFileServicesSettings::class);
 
         $settings->expects($this->atLeastOnce())
                  ->method('getBlackListedSuffixes')
                  ->willReturn(['mp3']);
 
         $settings->expects($this->atLeastOnce())
                  ->method('getWhiteListedSuffixes')
                  ->willReturn(['pdf', 'png', 'mp3']);
 
         $settings->expects($this->atLeastOnce())
                  ->method('isASCIIConvertionEnabled')
                  ->willReturn(true);
 
         $policy = new ilFileServicesPolicy($settings);
         $this->assertEquals('testmp3.sec', $policy->prepareFileNameForConsumer('test.mp3'));
         $this->assertEquals('test.png', $policy->prepareFileNameForConsumer('test.png'));
         $this->assertEquals('test.pdf', $policy->prepareFileNameForConsumer('test.pdf'));
         $this->assertEquals('aeaeaeaeaeaeaeaeae.pdf', $policy->prepareFileNameForConsumer('äääääääää.pdf'));
         $this->assertEquals('oeoeoeoeoeoeoeoeoe.pdf', $policy->prepareFileNameForConsumer('ööööööööö.pdf'));
         $this->assertEquals('ueueueueueueueueue.pdf', $policy->prepareFileNameForConsumer('üüüüüüüüü.pdf'));
     }

◆ testRenamingNonWhitelistedFile()

ilServicesFileServicesTest::testRenamingNonWhitelistedFile ( )

Definition at line 115 of file ilServicesFileServicesTest.php.

                                                     : void
     {
         $settings = $this->createMock(ilFileServicesSettings::class);
         $settings->expects($this->once())
                  ->method('getWhiteListedSuffixes')
                  ->willReturn(['pdf', 'png', 'jpg']);
 
         $sanitizer = new ilFileServicesFilenameSanitizer($settings);
 
         $sane_filename = 'bellerophon.pdf';
         $this->assertEquals($sane_filename, $sanitizer->sanitize($sane_filename));
 
         $insane_filename = 'bellerophon.docx';
         $this->assertNotEquals($insane_filename, $sanitizer->sanitize($insane_filename));
         $this->assertEquals('bellerophondocx.sec', $sanitizer->sanitize($insane_filename));
     }

◆ testSanitizing()

ilServicesFileServicesTest::testSanitizing ( )

Definition at line 56 of file ilServicesFileServicesTest.php.

                                     : void
     {
         $settings = $this->createMock(ilFileServicesSettings::class);
         $settings->expects($this->once())
                  ->method('getWhiteListedSuffixes')
                  ->willReturn(['pdf', 'jpg']);
 
         $sanitizer = new ilFileServicesFilenameSanitizer($settings);
         $this->assertTrue($sanitizer->isClean('/lib/test.pdf'));
         $this->assertFalse($sanitizer->isClean('/lib/test.xml'));
         $this->assertEquals('/lib/testxml.sec', $sanitizer->sanitize('/lib/test.xml'));
     }

Field Documentation

◆ $db_mock

ilDBInterface ilServicesFileServicesTest::$db_mock = null

private

Definition at line 39 of file ilServicesFileServicesTest.php.

◆ $dic_backup

ILIAS DI Container ilServicesFileServicesTest::$dic_backup