mirror of
https://github.com/PrivateBin/PrivateBin.git
synced 2024-10-01 01:26:10 -04:00
65a626f940
using filter_vars instead of filter_input, because our unit tests depend on manipulating global arrays, which are not used by filter_input - we would have to mock the function in the unit testing, it therefore is cleaner to use the same code paths in testing as in production some inputs in I18n and TrafficLimiter remain unfiltered, since we already validate them by other means (IP lib and/or preg_match) our minimum PHP version is 7.3, so we can drop the two < 5.6 fallback checks
182 lines
3.3 KiB
PHP
182 lines
3.3 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.7.1
|
|
*/
|
|
|
|
namespace PrivateBin\Model;
|
|
|
|
use Exception;
|
|
use PrivateBin\Configuration;
|
|
use PrivateBin\Data\AbstractData;
|
|
|
|
/**
|
|
* AbstractModel
|
|
*
|
|
* Abstract model for PrivateBin objects.
|
|
*/
|
|
abstract class AbstractModel
|
|
{
|
|
/**
|
|
* Instance ID.
|
|
*
|
|
* @access protected
|
|
* @var string
|
|
*/
|
|
protected $_id = '';
|
|
|
|
/**
|
|
* Instance data.
|
|
*
|
|
* @access protected
|
|
* @var array
|
|
*/
|
|
protected $_data = array('meta' => array());
|
|
|
|
/**
|
|
* Configuration.
|
|
*
|
|
* @access protected
|
|
* @var Configuration
|
|
*/
|
|
protected $_conf;
|
|
|
|
/**
|
|
* Data storage.
|
|
*
|
|
* @access protected
|
|
* @var AbstractData
|
|
*/
|
|
protected $_store;
|
|
|
|
/**
|
|
* Instance constructor.
|
|
*
|
|
* @access public
|
|
* @param Configuration $configuration
|
|
* @param AbstractData $storage
|
|
*/
|
|
public function __construct(Configuration $configuration, AbstractData $storage)
|
|
{
|
|
$this->_conf = $configuration;
|
|
$this->_store = $storage;
|
|
}
|
|
|
|
/**
|
|
* Get ID.
|
|
*
|
|
* @access public
|
|
* @return string
|
|
*/
|
|
public function getId()
|
|
{
|
|
return $this->_id;
|
|
}
|
|
|
|
/**
|
|
* Set ID.
|
|
*
|
|
* @access public
|
|
* @param string $id
|
|
* @throws Exception
|
|
*/
|
|
public function setId($id)
|
|
{
|
|
if (!self::isValidId($id)) {
|
|
throw new Exception('Invalid paste ID.', 60);
|
|
}
|
|
$this->_id = $id;
|
|
}
|
|
|
|
/**
|
|
* Set data and recalculate ID.
|
|
*
|
|
* @access public
|
|
* @param array $data
|
|
* @throws Exception
|
|
*/
|
|
public function setData(array $data)
|
|
{
|
|
$data = $this->_sanitize($data);
|
|
$this->_validate($data);
|
|
$this->_data = $data;
|
|
|
|
// calculate a 64 bit checksum to avoid collisions
|
|
$this->setId(hash('fnv1a64', $data['ct']));
|
|
}
|
|
|
|
/**
|
|
* Get instance data.
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function get()
|
|
{
|
|
return $this->_data;
|
|
}
|
|
|
|
/**
|
|
* Store the instance's data.
|
|
*
|
|
* @access public
|
|
* @throws Exception
|
|
*/
|
|
abstract public function store();
|
|
|
|
/**
|
|
* Delete the current instance.
|
|
*
|
|
* @access public
|
|
* @throws Exception
|
|
*/
|
|
abstract public function delete();
|
|
|
|
/**
|
|
* Test if current instance exists in store.
|
|
*
|
|
* @access public
|
|
* @return bool
|
|
*/
|
|
abstract public function exists();
|
|
|
|
/**
|
|
* Validate ID.
|
|
*
|
|
* @access public
|
|
* @static
|
|
* @param string $id
|
|
* @return bool
|
|
*/
|
|
public static function isValidId($id)
|
|
{
|
|
return (bool) preg_match('#\A[a-f\d]{16}\z#', (string) $id);
|
|
}
|
|
|
|
/**
|
|
* Sanitizes data to conform with current configuration.
|
|
*
|
|
* @access protected
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
abstract protected function _sanitize(array $data);
|
|
|
|
/**
|
|
* Validate data.
|
|
*
|
|
* @access protected
|
|
* @param array $data
|
|
* @throws Exception
|
|
*/
|
|
protected function _validate(array $data)
|
|
{
|
|
}
|
|
}
|