privatebin-mirror/tst/ModelTest.php

<?php declare(strict_types=1);

use Jdenticon\Identicon;
use PHPUnit\Framework\TestCase;
use PrivateBin\Configuration;
use PrivateBin\Data\Database;
use PrivateBin\Model;
use PrivateBin\Model\Comment;
use PrivateBin\Model\Paste;
use PrivateBin\Persistence\ServerSalt;
use PrivateBin\Persistence\TrafficLimiter;
use PrivateBin\Vizhash16x16;

class ModelTest extends TestCase
{
    private $_conf;

    private $_model;

    protected $_path;

    public function setUp(): void
    {
        /* Setup Routine */
        $this->_path = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'privatebin_data';
        if (!is_dir($this->_path)) {
            mkdir($this->_path);
        }
        $options = parse_ini_file(CONF_SAMPLE, true);
        $options['purge']['limit'] = 0;
        $options['model'] = [
            'class' => 'Database',
        ];
        $options['model_options'] = [
            'dsn' => 'sqlite::memory:',
            'usr' => null,
            'pwd' => null,
            'opt' => [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION],
        ];
        Helper::confBackup();
        Helper::createIniFile(CONF, $options);
        ServerSalt::setStore(new Database($options['model_options']));
        $this->_conf = new Configuration;
        $this->_model = new Model($this->_conf);
        $_SERVER['REMOTE_ADDR'] = '::1';
    }

    public function tearDown(): void
    {
        /* Tear Down Routine */
        unlink(CONF);
        Helper::confRestore();
        Helper::rmDir($this->_path);
    }

    public function testBasicWorkflow()
    {
        // storing pastes
        $pasteData = Helper::getPastePost();
        unset($pasteData['meta']['created'], $pasteData['meta']['salt']);
        $this->_model->getPaste(Helper::getPasteId())->delete();
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $this->assertFalse($paste->exists(), 'paste does not yet exist');

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $paste = $this->_model->getPaste(Helper::getPasteId());
        $this->assertTrue($paste->exists(), 'paste exists after storing it');
        $paste = $paste->get();
        unset(
            $pasteData['meta'],
            $paste['meta'],
            $paste['comments'],
            $paste['comment_count'],
            $paste['comment_offset'],
            $paste['@context']
        );
        $this->assertEquals($pasteData, $paste);

        // storing comments
        $commentData = Helper::getCommentPost();
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $comment = $paste->getComment(Helper::getPasteId(), Helper::getCommentId());
        $this->assertFalse($comment->exists(), 'comment does not yet exist');

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->store();

        $comments = $this->_model->getPaste(Helper::getPasteId())->get()['comments'];
        $this->assertTrue(count($comments) === 1, 'comment exists after storing it');
        $commentData['id'] = Helper::getCommentId();
        $commentData['meta']['created'] = current($comments)['meta']['created'];
        $commentData['meta']['icon'] = current($comments)['meta']['icon'];
        $this->assertEquals($commentData, current($comments));

        // deleting pastes
        $this->_model->getPaste(Helper::getPasteId())->delete();
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $this->assertFalse($paste->exists(), 'paste successfully deleted');
        $this->assertEquals([], $paste->getComments(), 'comment was deleted with paste');
    }

    public function testCommentDefaults()
    {
        $class = 'PrivateBin\\Data\\' . $this->_conf->getKey('class', 'model');
        $comment = new Comment(
            $this->_conf,
            new $class(
                $this->_conf->getSection('model_options')
            )
        );
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $comment->setPaste($paste);
        $this->assertEquals(Helper::getPasteId(), $comment->getParentId(), 'comment parent ID gets initialized to paste ID');
    }

    public function testPasteDuplicate()
    {
        $pasteData = Helper::getPastePost();

        $this->_model->getPaste(Helper::getPasteId())->delete();
        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $this->expectException(Exception::class);
        $this->expectExceptionCode(75);
        $paste->store();
    }

    public function testStoreFail()
    {
        $path = $this->_path . DIRECTORY_SEPARATOR . 'model-store-test.sq3';
        if (is_file($path)) {
            unlink($path);
        }
        $options = parse_ini_file(CONF_SAMPLE, true);
        $options['purge']['limit'] = 0;
        $options['model'] = [
            'class' => 'Database',
        ];
        $options['model_options'] = [
            'dsn' => 'sqlite:' . $path,
            'usr' => null,
            'pwd' => null,
            'opt' => [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION],
        ];
        Helper::createIniFile(CONF, $options);
        $model = new Model(new Configuration);

        $pasteData = Helper::getPastePost();
        $model->getPaste(Helper::getPasteId())->delete();
        $model->getPaste(Helper::getPasteId())->exists();

        $db = new PDO(
            $options['model_options']['dsn'],
            $options['model_options']['usr'],
            $options['model_options']['pwd'],
            $options['model_options']['opt']
        );
        $statement = $db->prepare('DROP TABLE paste');
        $statement->execute();
        $statement->closeCursor();

        $paste = $model->getPaste();
        $paste->setData($pasteData);
        $this->expectException(Exception::class);
        $this->expectExceptionCode(76);
        $paste->store();
    }

    public function testCommentStoreFail()
    {
        $path = $this->_path . DIRECTORY_SEPARATOR . 'model-test.sq3';
        if (is_file($path)) {
            unlink($path);
        }
        $options = parse_ini_file(CONF_SAMPLE, true);
        $options['purge']['limit'] = 0;
        $options['model'] = [
            'class' => 'Database',
        ];
        $options['model_options'] = [
            'dsn' => 'sqlite:' . $path,
            'usr' => null,
            'pwd' => null,
            'opt' => [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION],
        ];
        Helper::createIniFile(CONF, $options);
        $model = new Model(new Configuration);

        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $model->getPaste(Helper::getPasteId())->delete();

        $paste = $model->getPaste();
        $paste->setData($pasteData);
        $paste->store();
        $this->assertTrue($paste->exists(), 'paste exists before creating comment');

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);

        $db = new PDO(
            $options['model_options']['dsn'],
            $options['model_options']['usr'],
            $options['model_options']['pwd'],
            $options['model_options']['opt']
        );
        $statement = $db->prepare('DROP TABLE comment');
        $statement->execute();
        $statement->closeCursor();

        $this->expectException(Exception::class);
        $this->expectExceptionCode(70);
        $comment->store();
    }

    public function testCommentRequireIds()
    {
        $options = parse_ini_file(CONF, true);
        $options['main']['discussionrequireids'] = 'true';
        Helper::createIniFile(CONF, $options);
        $model = new Model(new Configuration);

        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $model->getPaste(Helper::getPasteId())->delete();

        $paste = $model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $commentData['adata'][] = $commentData['pasteid'];
        $commentData['adata'][] = $commentData['parentid'];
        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->store();
        $this->assertTrue($comment->exists(), 'comment with authenticated IDs can be stored');

        $commentData = Helper::getCommentPost();
        $commentData['ct'] = base64_encode('other ciphertext');
        $comment = $paste->getComment(Helper::getPasteId());
        $this->expectException(Exception::class);
        $this->expectExceptionCode(77);
        $comment->setData($commentData);
    }

    public function testCommentDuplicate()
    {
        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $this->_model->getPaste(Helper::getPasteId())->delete();

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $this->expectException(Exception::class);
        $this->expectExceptionCode(69);
        $comment->store();
    }

    public function testCommentDuplicateOtherParent()
    {
        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $this->_model->getPaste(Helper::getPasteId())->delete();

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->store();
        $firstCommentId = $comment->getId();

        // reply to the first comment, using a different ciphertext
        $replyData = $commentData;
        $replyData['ct'] = base64_encode('reply ciphertext');
        $replyData['parentid'] = $firstCommentId;
        $reply = $paste->getComment($firstCommentId);
        $reply->setData($replyData);
        $reply->store();
        $this->assertTrue($reply->exists(), 'reply to existing comment can be stored');

        // replay of the first comment under the reply as parent
        $commentData['parentid'] = $reply->getId();
        $comment = $paste->getComment($reply->getId());
        $comment->setData($commentData);
        $this->expectException(Exception::class);
        $this->expectExceptionCode(69);
        $comment->store();
    }

    public function testCommentNonexistentParent()
    {
        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $commentData['parentid'] = '1111111111111111';
        $this->_model->getPaste(Helper::getPasteId())->delete();

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment('1111111111111111');
        $comment->setData($commentData);
        $this->expectException(Exception::class);
        $this->expectExceptionCode(71);
        $comment->store();
    }

    public function testCommentEqualsPaste()
    {
        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $commentData['ct'] = $pasteData['ct'];
        $this->_model->getPaste(Helper::getPasteId())->delete();

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $this->expectException(Exception::class);
        $this->expectExceptionCode(72);
        $comment->store();
    }

    public function testImplicitDefaults()
    {
        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $this->_model->getPaste(Helper::getPasteId())->delete();

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->get();
        $comment->store();

        $identicon = new Identicon([
            'hash'  => TrafficLimiter::getHash(),
            'size'  => 16,
            'style' => [
                'backgroundColor'   => '#fff0', // fully transparent, for dark mode
                'padding'           => 0,
            ],
        ]);
        $pngdata = $identicon->getImageDataUri('png');
        $comment = current($this->_model->getPaste(Helper::getPasteId())->get()['comments']);
        $this->assertEquals($pngdata, $comment['meta']['icon'], 'icon gets set');
    }

    public function testPasteIdValidation()
    {
        $this->assertTrue(Paste::isValidId('a242ab7bdfb2581a'), 'valid paste id');
        $this->assertFalse(Paste::isValidId('foo'), 'invalid hex values & length');
        $this->assertFalse(Paste::isValidId('f00'), 'invalid length');
        $this->assertFalse(Paste::isValidId('foo bar baz quux'), 'invalid hex values');
        $this->assertFalse(Paste::isValidId("\n01234567feedcafe"), 'invalid line breaks');
        $this->assertFalse(Paste::isValidId("deadbeef01234567\n"), 'invalid line breaks');
        $this->assertFalse(Paste::isValidId('../bar/baz'), 'path attack');
    }

    public function testInvalidPaste()
    {
        $this->_model->getPaste(Helper::getPasteId())->delete();
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $this->expectException(Exception::class);
        $this->expectExceptionCode(64);
        $paste->get();
    }

    public function testInvalidPasteFormat()
    {
        $pasteData = Helper::getPastePost();
        $pasteData['adata'][1] = 'format does not exist';
        $paste = $this->_model->getPaste();
        $this->expectException(Exception::class);
        $this->expectExceptionCode(75);
        $paste->setData($pasteData);
    }

    public function testInvalidPasteId()
    {
        $this->expectException(Exception::class);
        $this->expectExceptionCode(60);
        $this->_model->getPaste('');
    }

    public function testInvalidComment()
    {
        $paste = $this->_model->getPaste();
        $this->expectException(Exception::class);
        $this->expectExceptionCode(62);
        $paste->getComment(Helper::getPasteId());
    }

    public function testInvalidCommentDeletedPaste()
    {
        $pasteData = Helper::getPastePost();
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $paste->delete();
        $this->expectException(Exception::class);
        $this->expectExceptionCode(67);
        $comment->store();
    }

    public function testInvalidCommentData()
    {
        $pasteData = Helper::getPastePost();
        $pasteData['adata'][2] = 0;
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $this->expectException(Exception::class);
        $this->expectExceptionCode(68);
        $comment->store();
    }

    public function testInvalidCommentParent()
    {
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $this->expectException(Exception::class);
        $this->expectExceptionCode(65);
        $paste->getComment('');
    }

    public function testExpiration()
    {
        $pasteData = Helper::getPastePost();
        $this->_model->getPaste(Helper::getPasteId())->delete();
        $paste = $this->_model->getPaste(Helper::getPasteId());
        $this->assertFalse($paste->exists(), 'paste does not yet exist');

        $paste = $this->_model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $paste = $paste->get();
        $this->assertEquals((float) 300, (float) $paste['meta']['time_to_live'], 'remaining time is set correctly', 1.0);
    }

    public function testPurge()
    {
        $conf = new Configuration;
        $store = new Database($conf->getSection('model_options'));
        $store->delete(Helper::getPasteId());
        $expired = Helper::getPaste(['expire_date' => 1344803344]);
        $paste = Helper::getPaste(['expire_date' => time() + 3600]);
        $keys = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'x', 'y', 'z'];
        $ids = [];
        foreach ($keys as $key) {
            $ids[$key] = hash('fnv164', $key);
            $store->delete($ids[$key]);
            $this->assertFalse($store->exists($ids[$key]), "paste $key does not yet exist");
            if (in_array($key, ['x', 'y', 'z'])) {
                $this->assertTrue($store->create($ids[$key], $paste), "store $key paste");
            } else {
                $this->assertTrue($store->create($ids[$key], $expired), "store $key paste");
            }
            $this->assertTrue($store->exists($ids[$key]), "paste $key exists after storing it");
        }
        $this->_model->purge(10);
        foreach ($ids as $key => $id) {
            if (in_array($key, ['x', 'y', 'z'])) {
                $this->assertTrue($this->_model->getPaste($id)->exists(), "paste $key exists after purge");
                $this->_model->getPaste($id)->delete();
            } else {
                $this->assertFalse($this->_model->getPaste($id)->exists(), "paste $key was purged");
            }
        }
    }

    public function testCommentWithDisabledVizhash()
    {
        $options = parse_ini_file(CONF, true);
        $options['main']['discussiondatedisplay'] = 'false';
        $options['main']['icon'] = 'none';
        $options['model'] = [
            'class' => 'Database',
        ];
        $options['model_options'] = [
            'dsn' => 'sqlite::memory:',
            'usr' => null,
            'pwd' => null,
            'opt' => [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION],
        ];
        Helper::createIniFile(CONF, $options);
        $model = new Model(new Configuration);

        $pasteData = Helper::getPastePost();
        $this->_model->getPaste(Helper::getPasteId())->delete();
        $paste = $model->getPaste(Helper::getPasteId());
        $this->assertFalse($paste->exists(), 'paste does not yet exist');

        $paste = $model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $paste = $model->getPaste(Helper::getPasteId());
        $this->assertTrue($paste->exists(), 'paste exists after storing it');

        // storing comments
        $commentData = Helper::getCommentPost();
        unset($commentData['meta']['icon']);
        $paste = $model->getPaste(Helper::getPasteId());
        $comment = $paste->getComment(Helper::getPasteId(), Helper::getCommentId());
        $this->assertFalse($comment->exists(), 'comment does not yet exist');

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->store();

        $comment = $paste->getComment(Helper::getPasteId(), Helper::getCommentId());
        $this->assertTrue($comment->exists(), 'comment exists after storing it');

        $comment = current($this->_model->getPaste(Helper::getPasteId())->get()['comments']);
        $this->assertFalse(array_key_exists('icon', $comment['meta']), 'icon was not generated');
        $this->assertTrue(array_key_exists('created', $comment['meta']), 'creation is set, when using default configuration');

        $comment = current($paste->get()['comments']);
        $this->assertFalse(array_key_exists('created', $comment['meta']), 'creation is not set, if using disabled configuration');
    }

    public function testCommentVizhash()
    {
        $options = parse_ini_file(CONF, true);
        $options['main']['icon'] = 'vizhash';
        $options['model'] = [
            'class' => 'Database',
        ];
        $options['model_options'] = [
            'dsn' => 'sqlite::memory:',
            'usr' => null,
            'pwd' => null,
            'opt' => [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION],
        ];
        Helper::createIniFile(CONF, $options);
        $model = new Model(new Configuration);

        $pasteData = Helper::getPastePost();
        $commentData = Helper::getCommentPost();
        $model->getPaste(Helper::getPasteId())->delete();

        $paste = $model->getPaste();
        $paste->setData($pasteData);
        $paste->store();

        $comment = $paste->getComment(Helper::getPasteId());
        $comment->setData($commentData);
        $comment->store();

        $vz = new Vizhash16x16();
        $pngdata = 'data:image/png;base64,' . base64_encode($vz->generate(TrafficLimiter::getHash()));
        $comment = current($this->_model->getPaste(Helper::getPasteId())->get()['comments']);
        $this->assertEquals($pngdata, $comment['meta']['icon'], 'vizhash was generated');
    }
}