privatebin-mirror/lib/Model/Comment.php

<?php declare(strict_types=1);
/**
 * PrivateBin
 *
 * a zero-knowledge paste bin
 *
 * @link      https://github.com/PrivateBin/PrivateBin
 * @copyright 2012 Sébastien SAUVAGE (sebsauvage.net)
 * @license   https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
 */

namespace PrivateBin\Model;

use Identicon\Identicon;
use Jdenticon\Identicon as Jdenticon;
use PrivateBin\Exception\TranslatedException;
use PrivateBin\Persistence\TrafficLimiter;
use PrivateBin\Vizhash16x16;

/**
 * Comment
 *
 * Model of a PrivateBin comment.
 */
class Comment extends AbstractModel
{
    /**
     * Instance's parent.
     *
     * @access private
     * @var Paste
     */
    private $_paste;

    /**
     * Store the comment's data.
     *
     * @access public
     * @throws TranslatedException
     */
    public function store()
    {
        // Make sure paste exists.
        $pasteid = $this->getPaste()->getId();
        if (!$this->getPaste()->exists()) {
            throw new TranslatedException(self::INVALID_DATA_ERROR, 67);
        }

        // Make sure the discussion is opened in this paste and allowed in the configuration.
        if (!$this->getPaste()->isOpendiscussion() || !$this->_conf->getKey('discussion')) {
            throw new TranslatedException(self::INVALID_DATA_ERROR, 68);
        }

        // Check for improbable collision.
        if ($this->exists()) {
            throw new TranslatedException(self::COLLISION_ERROR, 69);
        }

        // Comment IDs must be unique within the paste, regardless of the
        // parent, and the parent must be either the paste or an existing comment.
        $commentid = $this->getId();
        $parentid = $this->getParentId();
        $parentExists = $parentid === $pasteid;
        if ($commentid === $pasteid) {
            throw new TranslatedException(self::COLLISION_ERROR, 72);
        }
        foreach ($this->_store->readComments($pasteid) as $comment) {
            if ($comment['id'] === $commentid) {
                throw new TranslatedException(self::COLLISION_ERROR, 69);
            }
            if ($comment['id'] === $parentid) {
                $parentExists = true;
            }
        }
        if (!$parentExists) {
            throw new TranslatedException(self::INVALID_DATA_ERROR, 71);
        }

        $this->_data['meta']['created'] = time();

        // store comment
        if (
            $this->_store->createComment(
                $pasteid,
                $this->getParentId(),
                $this->getId(),
                $this->_data
            ) === false
        ) {
            throw new TranslatedException('Error saving comment. Sorry.', 70);
        }
    }

    /**
     * Test if comment exists in store.
     *
     * @access public
     * @return bool
     */
    public function exists()
    {
        return $this->_store->existsComment(
            $this->getPaste()->getId(),
            $this->getParentId(),
            $this->getId()
        );
    }

    /**
     * Set paste.
     *
     * @access public
     * @param Paste $paste
     */
    public function setPaste(Paste &$paste)
    {
        $this->_paste = $paste;
        $this->_data['pasteid'] = $paste->getId();
    }

    /**
     * Get paste.
     *
     * @access public
     * @return Paste
     */
    public function getPaste()
    {
        return $this->_paste;
    }

    /**
     * Set parent ID.
     *
     * @access public
     * @param string $id
     * @throws TranslatedException
     */
    public function setParentId($id)
    {
        if (!self::isValidId($id)) {
            throw new TranslatedException('Invalid document ID.', 65);
        }
        $this->_data['parentid'] = $id;
    }

    /**
     * Get parent ID.
     *
     * @access public
     * @return string
     */
    public function getParentId()
    {
        if (!array_key_exists('parentid', $this->_data)) {
            $this->_data['parentid'] = $this->getPaste()->getId();
        }
        return $this->_data['parentid'];
    }

    /**
     * Validate data.
     *
     * @access protected
     * @param  array $data
     * @throws TranslatedException
     */
    protected function _validate(array &$data)
    {
        // reject comments without authenticated IDs, if required
        if ($this->_conf->getKey('discussionrequireids') && count($data['adata']) !== 10) {
            throw new TranslatedException(self::INVALID_DATA_ERROR, 77);
        }
    }

    /**
     * Sanitizes data to conform with current configuration.
     *
     * @access protected
     * @param  array $data
     */
    protected function _sanitize(array &$data)
    {
        // we generate an icon based on a SHA512 HMAC of the users IP, if configured
        $icon = $this->_conf->getKey('icon');
        if ($icon !== 'none') {
            $pngdata = '';
            $hmac = TrafficLimiter::getHash();
            if ($icon === 'identicon') {
                $identicon = new Identicon();
                $pngdata = $identicon->getImageDataUri($hmac, 16);
            } elseif ($icon === 'jdenticon') {
                $jdenticon = new Jdenticon([
                    'hash'  => $hmac,
                    'size'  => 16,
                    'style' => [
                        'backgroundColor'   => '#fff0', // fully transparent, for dark mode
                        'padding'           => 0,
                    ],
                ]);
                $pngdata = $jdenticon->getImageDataUri('png');
            } elseif ($icon === 'vizhash') {
                $vh = new Vizhash16x16();
                $pngdata = 'data:image/png;base64,' . base64_encode(
                    $vh->generate($hmac)
                );
            }
            if (!empty($pngdata)) {
                if (!array_key_exists('meta', $data)) {
                    $data['meta'] = [];
                }
                $data['meta']['icon'] = $pngdata;
            }
        }
    }
}