183 lines
4.1 KiB
PHP
183 lines
4.1 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
* @version 1.2.1
|
|
*/
|
|
|
|
namespace PrivateBin\Data;
|
|
|
|
use stdClass;
|
|
|
|
/**
|
|
* AbstractData
|
|
*
|
|
* Abstract model for PrivateBin data access, implemented as a singleton.
|
|
*/
|
|
abstract class AbstractData
|
|
{
|
|
/**
|
|
* singleton instance
|
|
*
|
|
* @access protected
|
|
* @static
|
|
* @var AbstractData
|
|
*/
|
|
protected static $_instance = null;
|
|
|
|
/**
|
|
* enforce singleton, disable constructor
|
|
*
|
|
* Instantiate using {@link getInstance()}, privatebin is a singleton object.
|
|
*
|
|
* @access protected
|
|
*/
|
|
protected function __construct()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* enforce singleton, disable cloning
|
|
*
|
|
* Instantiate using {@link getInstance()}, privatebin is a singleton object.
|
|
*
|
|
* @access private
|
|
*/
|
|
private function __clone()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* get instance of singleton
|
|
*
|
|
* @access public
|
|
* @static
|
|
* @param array $options
|
|
* @return AbstractData
|
|
*/
|
|
public static function getInstance(array $options)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Create a paste.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
* @param array $paste
|
|
* @return bool
|
|
*/
|
|
abstract public function create(string $pasteid, array $paste);
|
|
|
|
/**
|
|
* Read a paste.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
* @return stdClass|false
|
|
*/
|
|
abstract public function read(string $pasteid);
|
|
|
|
/**
|
|
* Delete a paste and its discussion.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
*/
|
|
abstract public function delete(string $pasteid);
|
|
|
|
/**
|
|
* Test if a paste exists.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
* @return bool
|
|
*/
|
|
abstract public function exists(string $pasteid);
|
|
|
|
/**
|
|
* Create a comment in a paste.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
* @param string $parentid
|
|
* @param string $commentid
|
|
* @param array $comment
|
|
* @return bool
|
|
*/
|
|
abstract public function createComment(string $pasteid, string $parentid, string $commentid, array $comment);
|
|
|
|
/**
|
|
* Read all comments of paste.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
* @return array
|
|
*/
|
|
abstract public function readComments(string $pasteid);
|
|
|
|
/**
|
|
* Test if a comment exists.
|
|
*
|
|
* @access public
|
|
* @param string $pasteid
|
|
* @param string $parentid
|
|
* @param string $commentid
|
|
* @return bool
|
|
*/
|
|
abstract public function existsComment(string $pasteid, string $parentid, string $commentid);
|
|
|
|
/**
|
|
* Returns up to batch size number of paste ids that have expired
|
|
*
|
|
* @access protected
|
|
* @param int $batchsize
|
|
* @return array
|
|
*/
|
|
abstract protected function _getExpiredPastes(int $batchsize);
|
|
|
|
/**
|
|
* Perform a purge of old pastes, at most the given batchsize is deleted.
|
|
*
|
|
* @access public
|
|
* @param int $batchsize
|
|
*/
|
|
public function purge(int $batchsize)
|
|
{
|
|
if ($batchsize < 1) {
|
|
return;
|
|
}
|
|
$pastes = $this->_getExpiredPastes($batchsize);
|
|
if (count($pastes)) {
|
|
foreach ($pastes as $pasteid) {
|
|
$this->delete($pasteid);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get next free slot for comment from postdate.
|
|
*
|
|
* @access public
|
|
* @param array $comments
|
|
* @param int|string $postdate
|
|
* @return int|string
|
|
*/
|
|
protected function getOpenSlot(array &$comments, $postdate)
|
|
{
|
|
if (array_key_exists($postdate, $comments)) {
|
|
$parts = explode('.', $postdate, 2);
|
|
if (!array_key_exists(1, $parts)) {
|
|
$parts[1] = 0;
|
|
}
|
|
++$parts[1];
|
|
return $this->getOpenSlot($comments, implode('.', $parts));
|
|
}
|
|
return $postdate;
|
|
}
|
|
}
|