commitall

This commit is contained in:
Sampanna Rimal
2024-07-10 18:28:19 +05:45
parent 140abda4e6
commit 9cd05ef3cb
15723 changed files with 4818733 additions and 0 deletions

View File

@ -0,0 +1,112 @@
<?php
class HTMLPurifier_DefinitionCache_Decorator extends HTMLPurifier_DefinitionCache
{
/**
* Cache object we are decorating
* @type HTMLPurifier_DefinitionCache
*/
public $cache;
/**
* The name of the decorator
* @var string
*/
public $name;
public function __construct()
{
}
/**
* Lazy decorator function
* @param HTMLPurifier_DefinitionCache $cache Reference to cache object to decorate
* @return HTMLPurifier_DefinitionCache_Decorator
*/
public function decorate(&$cache)
{
$decorator = $this->copy();
// reference is necessary for mocks in PHP 4
$decorator->cache =& $cache;
$decorator->type = $cache->type;
return $decorator;
}
/**
* Cross-compatible clone substitute
* @return HTMLPurifier_DefinitionCache_Decorator
*/
public function copy()
{
return new HTMLPurifier_DefinitionCache_Decorator();
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
return $this->cache->add($def, $config);
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
return $this->cache->set($def, $config);
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
return $this->cache->replace($def, $config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
return $this->cache->get($config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function remove($config)
{
return $this->cache->remove($config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function flush($config)
{
return $this->cache->flush($config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function cleanup($config)
{
return $this->cache->cleanup($config);
}
}
// vim: et sw=4 sts=4

View File

@ -0,0 +1,78 @@
<?php
/**
* Definition cache decorator class that cleans up the cache
* whenever there is a cache miss.
*/
class HTMLPurifier_DefinitionCache_Decorator_Cleanup extends HTMLPurifier_DefinitionCache_Decorator
{
/**
* @type string
*/
public $name = 'Cleanup';
/**
* @return HTMLPurifier_DefinitionCache_Decorator_Cleanup
*/
public function copy()
{
return new HTMLPurifier_DefinitionCache_Decorator_Cleanup();
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
$status = parent::add($def, $config);
if (!$status) {
parent::cleanup($config);
}
return $status;
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
$status = parent::set($def, $config);
if (!$status) {
parent::cleanup($config);
}
return $status;
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
$status = parent::replace($def, $config);
if (!$status) {
parent::cleanup($config);
}
return $status;
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
$ret = parent::get($config);
if (!$ret) {
parent::cleanup($config);
}
return $ret;
}
}
// vim: et sw=4 sts=4

View File

@ -0,0 +1,85 @@
<?php
/**
* Definition cache decorator class that saves all cache retrievals
* to PHP's memory; good for unit tests or circumstances where
* there are lots of configuration objects floating around.
*/
class HTMLPurifier_DefinitionCache_Decorator_Memory extends HTMLPurifier_DefinitionCache_Decorator
{
/**
* @type array
*/
protected $definitions;
/**
* @type string
*/
public $name = 'Memory';
/**
* @return HTMLPurifier_DefinitionCache_Decorator_Memory
*/
public function copy()
{
return new HTMLPurifier_DefinitionCache_Decorator_Memory();
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
$status = parent::add($def, $config);
if ($status) {
$this->definitions[$this->generateKey($config)] = $def;
}
return $status;
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
$status = parent::set($def, $config);
if ($status) {
$this->definitions[$this->generateKey($config)] = $def;
}
return $status;
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
$status = parent::replace($def, $config);
if ($status) {
$this->definitions[$this->generateKey($config)] = $def;
}
return $status;
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
$key = $this->generateKey($config);
if (isset($this->definitions[$key])) {
return $this->definitions[$key];
}
$this->definitions[$key] = parent::get($config);
return $this->definitions[$key];
}
}
// vim: et sw=4 sts=4

View File

@ -0,0 +1,82 @@
<?php
require_once 'HTMLPurifier/DefinitionCache/Decorator.php';
/**
* Definition cache decorator template.
*/
class HTMLPurifier_DefinitionCache_Decorator_Template extends HTMLPurifier_DefinitionCache_Decorator
{
/**
* @type string
*/
public $name = 'Template'; // replace this
public function copy()
{
// replace class name with yours
return new HTMLPurifier_DefinitionCache_Decorator_Template();
}
// remove methods you don't need
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
return parent::add($def, $config);
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
return parent::set($def, $config);
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
return parent::replace($def, $config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
return parent::get($config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function flush($config)
{
return parent::flush($config);
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function cleanup($config)
{
return parent::cleanup($config);
}
}
// vim: et sw=4 sts=4

View File

@ -0,0 +1,76 @@
<?php
/**
* Null cache object to use when no caching is on.
*/
class HTMLPurifier_DefinitionCache_Null extends HTMLPurifier_DefinitionCache
{
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return bool
*/
public function add($def, $config)
{
return false;
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return bool
*/
public function set($def, $config)
{
return false;
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return bool
*/
public function replace($def, $config)
{
return false;
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function remove($config)
{
return false;
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function get($config)
{
return false;
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function flush($config)
{
return false;
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function cleanup($config)
{
return false;
}
}
// vim: et sw=4 sts=4

View File

@ -0,0 +1,311 @@
<?php
class HTMLPurifier_DefinitionCache_Serializer extends HTMLPurifier_DefinitionCache
{
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return int|bool
*/
public function add($def, $config)
{
if (!$this->checkDefType($def)) {
return;
}
$file = $this->generateFilePath($config);
if (file_exists($file)) {
return false;
}
if (!$this->_prepareDir($config)) {
return false;
}
return $this->_write($file, serialize($def), $config);
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return int|bool
*/
public function set($def, $config)
{
if (!$this->checkDefType($def)) {
return;
}
$file = $this->generateFilePath($config);
if (!$this->_prepareDir($config)) {
return false;
}
return $this->_write($file, serialize($def), $config);
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return int|bool
*/
public function replace($def, $config)
{
if (!$this->checkDefType($def)) {
return;
}
$file = $this->generateFilePath($config);
if (!file_exists($file)) {
return false;
}
if (!$this->_prepareDir($config)) {
return false;
}
return $this->_write($file, serialize($def), $config);
}
/**
* @param HTMLPurifier_Config $config
* @return bool|HTMLPurifier_Config
*/
public function get($config)
{
$file = $this->generateFilePath($config);
if (!file_exists($file)) {
return false;
}
return unserialize(file_get_contents($file));
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function remove($config)
{
$file = $this->generateFilePath($config);
if (!file_exists($file)) {
return false;
}
return unlink($file);
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function flush($config)
{
if (!$this->_prepareDir($config)) {
return false;
}
$dir = $this->generateDirectoryPath($config);
$dh = opendir($dir);
// Apparently, on some versions of PHP, readdir will return
// an empty string if you pass an invalid argument to readdir.
// So you need this test. See #49.
if (false === $dh) {
return false;
}
while (false !== ($filename = readdir($dh))) {
if (empty($filename)) {
continue;
}
if ($filename[0] === '.') {
continue;
}
unlink($dir . '/' . $filename);
}
closedir($dh);
return true;
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function cleanup($config)
{
if (!$this->_prepareDir($config)) {
return false;
}
$dir = $this->generateDirectoryPath($config);
$dh = opendir($dir);
// See #49 (and above).
if (false === $dh) {
return false;
}
while (false !== ($filename = readdir($dh))) {
if (empty($filename)) {
continue;
}
if ($filename[0] === '.') {
continue;
}
$key = substr($filename, 0, strlen($filename) - 4);
if ($this->isOld($key, $config)) {
unlink($dir . '/' . $filename);
}
}
closedir($dh);
return true;
}
/**
* Generates the file path to the serial file corresponding to
* the configuration and definition name
* @param HTMLPurifier_Config $config
* @return string
* @todo Make protected
*/
public function generateFilePath($config)
{
$key = $this->generateKey($config);
return $this->generateDirectoryPath($config) . '/' . $key . '.ser';
}
/**
* Generates the path to the directory contain this cache's serial files
* @param HTMLPurifier_Config $config
* @return string
* @note No trailing slash
* @todo Make protected
*/
public function generateDirectoryPath($config)
{
$base = $this->generateBaseDirectoryPath($config);
return $base . '/' . $this->type;
}
/**
* Generates path to base directory that contains all definition type
* serials
* @param HTMLPurifier_Config $config
* @return mixed|string
* @todo Make protected
*/
public function generateBaseDirectoryPath($config)
{
$base = $config->get('Cache.SerializerPath');
$base = is_null($base) ? HTMLPURIFIER_PREFIX . '/HTMLPurifier/DefinitionCache/Serializer' : $base;
return $base;
}
/**
* Convenience wrapper function for file_put_contents
* @param string $file File name to write to
* @param string $data Data to write into file
* @param HTMLPurifier_Config $config
* @return int|bool Number of bytes written if success, or false if failure.
*/
private function _write($file, $data, $config)
{
$result = file_put_contents($file, $data);
if ($result !== false) {
// set permissions of the new file (no execute)
$chmod = $config->get('Cache.SerializerPermissions');
if ($chmod !== null) {
chmod($file, $chmod & 0666);
}
}
return $result;
}
/**
* Prepares the directory that this type stores the serials in
* @param HTMLPurifier_Config $config
* @return bool True if successful
*/
private function _prepareDir($config)
{
$directory = $this->generateDirectoryPath($config);
$chmod = $config->get('Cache.SerializerPermissions');
if ($chmod === null) {
if (!@mkdir($directory) && !is_dir($directory)) {
trigger_error(
'Could not create directory ' . $directory . '',
E_USER_WARNING
);
return false;
}
return true;
}
if (!is_dir($directory)) {
$base = $this->generateBaseDirectoryPath($config);
if (!is_dir($base)) {
trigger_error(
'Base directory ' . $base . ' does not exist,
please create or change using %Cache.SerializerPath',
E_USER_WARNING
);
return false;
} elseif (!$this->_testPermissions($base, $chmod)) {
return false;
}
if (!@mkdir($directory, $chmod) && !is_dir($directory)) {
trigger_error(
'Could not create directory ' . $directory . '',
E_USER_WARNING
);
return false;
}
if (!$this->_testPermissions($directory, $chmod)) {
return false;
}
} elseif (!$this->_testPermissions($directory, $chmod)) {
return false;
}
return true;
}
/**
* Tests permissions on a directory and throws out friendly
* error messages and attempts to chmod it itself if possible
* @param string $dir Directory path
* @param int $chmod Permissions
* @return bool True if directory is writable
*/
private function _testPermissions($dir, $chmod)
{
// early abort, if it is writable, everything is hunky-dory
if (is_writable($dir)) {
return true;
}
if (!is_dir($dir)) {
// generally, you'll want to handle this beforehand
// so a more specific error message can be given
trigger_error(
'Directory ' . $dir . ' does not exist',
E_USER_WARNING
);
return false;
}
if (function_exists('posix_getuid') && $chmod !== null) {
// POSIX system, we can give more specific advice
if (fileowner($dir) === posix_getuid()) {
// we can chmod it ourselves
$chmod = $chmod | 0700;
if (chmod($dir, $chmod)) {
return true;
}
} elseif (filegroup($dir) === posix_getgid()) {
$chmod = $chmod | 0070;
} else {
// PHP's probably running as nobody, so we'll
// need to give global permissions
$chmod = $chmod | 0777;
}
trigger_error(
'Directory ' . $dir . ' not writable, ' .
'please chmod to ' . decoct($chmod),
E_USER_WARNING
);
} else {
// generic error message
trigger_error(
'Directory ' . $dir . ' not writable, ' .
'please alter file permissions',
E_USER_WARNING
);
}
return false;
}
}
// vim: et sw=4 sts=4

View File

@ -0,0 +1,3 @@
This is a dummy file to prevent Git from ignoring this empty directory.
vim: et sw=4 sts=4