egroupware/mail/tests/SaveToVfsTest.php

<?php

/**
 * Test the save to VFS functions
 *
 * @link http://www.egroupware.org
 * @author Nathan Gray
 * @package mail
 * @copyright (c) 2018 by Nathan Gray
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 */


namespace EGroupware\Mail;

require_once realpath(__DIR__.'/../../api/tests/AppTest.php');	// Application test base

use Egroupware\Api;

class SaveToVfsTest extends \EGroupware\Api\AppTest
{

	// Mail object under test
	protected $ui = null;

	/**
	 * Create a custom status we can use to test
	 */
	public static function setUpBeforeClass()
	{
		parent::setUpBeforeClass();

	}
	public static function tearDownAfterClass()
	{

		// Have to remove custom status first, before the DB is gone
		parent::tearDownAfterClass();
	}

	public function setUp()
	{
		$this->ui = new VfsTestMailUi(false);
	}

	public function tearDown()
	{
		$this->ui = null;
	}

	/**
	 * Test that we make nice filenames for the VFS
	 *
	 * Under Windows the characters < > ? " : | \ / * are not allowed.
	 * % causes problems with VFS UI
	 *
	 * @param String $filename
	 * @dataProvider filenameProvider
	 */
	public function testVfsFilename($filename, $replacements)
	{
		$cleaned = $this->ui->clean_subject_for_filename($filename);

		$this->assertNotContains('<', $cleaned);
		$this->assertNotContains('>', $cleaned);
		$this->assertNotContains('"', $cleaned);
		$this->assertNotContains('#', $cleaned);
		$this->assertNotContains(':', $cleaned);
		$this->assertNotContains('|', $cleaned);
		$this->assertNotContains('\\', $cleaned);
		$this->assertNotContains('*', $cleaned);
		$this->assertNotContains('/', $cleaned);
		$this->assertNotContains('?', $cleaned);

		// Length should stay the same
		$this->assertEquals(strlen($filename), strlen($cleaned));

		if(!$replacements)
		{
			$this->assertEquals($filename, $cleaned);
		}
		else
		{
			$this->assertNotEquals($filename, $cleaned);
		}
	}

	public function filenameProvider()
	{
		return array(
			array('Normal! All allowed (!@$^&) {\'} []', false),
			array('Contains a >', true),
			array('Contains a <', true),
			array('Contains a "', true),
			array('Contains a #', true),
			array('Contains a :', true),
			array('Contains a |', true),
			array('Contains a \ ', true),
			array('Contains a *', true),
			array('Contains a /', true),
			array('Contains a ?', true),
			array('Contains a %', true),
			array('This one contains them all < > " : | \ * / ? % are not allowed', true)
		);
	}
}


class VfsTestMailUi extends \mail_ui
{
	// Expose for testing
	public function clean_subject_for_filename($filename)
	{
		return parent::clean_subject_for_filename($filename);
	}
}