Inheritance diagram for ilServicesFileServicesTest:

Collaboration diagram for ilServicesFileServicesTest:

Public Member Functions
	testSanitizing ()

	testBlacklistedUpload ()

	testBlacklistedUploadWithPermission ()

	testRenamingNonWhitelistedFile ()

	testActualWhitelist ()

	testFileNamePolicyOnDownloading ()

Protected Member Functions
	setUp ()

	tearDown ()

Private Attributes
Container	$dic_backup

ilDBInterface	$db_mock = null

Detailed Description

Definition at line 31 of file ilServicesFileServicesTest.php.

Member Function Documentation

◆ setUp()

ilServicesFileServicesTest::setUp ( )

protected

Definition at line 39 of file ilServicesFileServicesTest.php.

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

References $DIC.

◆ tearDown()

ilServicesFileServicesTest::tearDown ( )

protected

Definition at line 48 of file ilServicesFileServicesTest.php.

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

References $DIC, and $dic_backup.

◆ testActualWhitelist()

ilServicesFileServicesTest::testActualWhitelist ( )

Definition at line 130 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) {
                    [$expected, $return] = array_shift($consecutive);
                    $this->assertEquals($expected, $k);
                    return $return;
                }
            );
 
        $settings = new ilFileServicesSettings($settings_mock, $ini_mock, $this->db_mock);
        $this->assertSame(['bl001', 'bl002'], $settings->getBlackListedSuffixes());
        $this->assertSame(['bl001', 'bl002'], $settings->getProhibited());
        $this->assertEquals($default_whitelist, $settings->getDefaultWhitelist());
        $this->assertSame(['docx', 'doc'], $settings->getWhiteListNegative());
        $this->assertSame(['wl001', 'wl002'], $settings->getWhiteListPositive());
 
        $whitelist = array_merge(
            array_diff($default_whitelist, ['docx', 'doc']),
            ['wl001', 'wl002', '']
        );
        $diff = array_diff($whitelist, $settings->getWhiteListedSuffixes());
 
        $this->assertSame([], $diff);
        $this->assertCount(0, $diff);
    }

◆ testBlacklistedUpload()

ilServicesFileServicesTest::testBlacklistedUpload ( )

Definition at line 67 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->assertSame(ProcessingStatus::REJECTED, $status->getCode());
    }

◆ testBlacklistedUploadWithPermission()

ilServicesFileServicesTest::testBlacklistedUploadWithPermission ( )

Definition at line 90 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->assertSame(ProcessingStatus::OK, $status->getCode());
    }

◆ testFileNamePolicyOnDownloading()

ilServicesFileServicesTest::testFileNamePolicyOnDownloading ( )

Definition at line 183 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->assertSame('testmp3.sec', $policy->prepareFileNameForConsumer('test.mp3'));
        $this->assertSame('test.png', $policy->prepareFileNameForConsumer('test.png'));
        $this->assertSame('test.pdf', $policy->prepareFileNameForConsumer('test.pdf'));
        $this->assertSame('aeaeaeaeaeaeaeaeae.pdf', $policy->prepareFileNameForConsumer('äääääääää.pdf'));
        $this->assertSame('oeoeoeoeoeoeoeoeoe.pdf', $policy->prepareFileNameForConsumer('ööööööööö.pdf'));
        $this->assertSame('ueueueueueueueueue.pdf', $policy->prepareFileNameForConsumer('üüüüüüüüü.pdf'));
    }

◆ testRenamingNonWhitelistedFile()

ilServicesFileServicesTest::testRenamingNonWhitelistedFile ( )

Definition at line 113 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->assertSame($sane_filename, $sanitizer->sanitize($sane_filename));
 
        $insane_filename = 'bellerophon.docx';
        $this->assertNotSame($insane_filename, $sanitizer->sanitize($insane_filename));
        $this->assertSame('bellerophondocx.sec', $sanitizer->sanitize($insane_filename));
    }

◆ testSanitizing()

ilServicesFileServicesTest::testSanitizing ( )

Definition at line 54 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->assertSame('/lib/testxml.sec', $sanitizer->sanitize('/lib/test.xml'));
    }

Field Documentation

◆ $db_mock

ilDBInterface ilServicesFileServicesTest::$db_mock = null

private

Definition at line 37 of file ilServicesFileServicesTest.php.

◆ $dic_backup

Container ilServicesFileServicesTest::$dic_backup