218 lines
4.0 KiB
PHP
218 lines
4.0 KiB
PHP
<?php defined('BLUDIT') or die('Bludit CMS.');
|
|
|
|
class Plugin {
|
|
|
|
// (string) Plugin's directory name
|
|
public $directoryName;
|
|
|
|
// (string) Database path and filename
|
|
public $filenameDb;
|
|
|
|
public $filenameMetadata;
|
|
|
|
// (array) Database unserialized
|
|
public $db;
|
|
|
|
// (array) Database fields, only for initialize.
|
|
public $dbFields;
|
|
|
|
// (string) Plugin's class name.
|
|
public $className;
|
|
|
|
// (array) Plugin's information.
|
|
public $metadata;
|
|
|
|
function __construct()
|
|
{
|
|
$this->dbFields = array();
|
|
|
|
$reflector = new ReflectionClass(get_class($this));
|
|
|
|
// Directory name
|
|
$this->directoryName = basename(dirname($reflector->getFileName()));
|
|
|
|
// Class Name
|
|
$this->className = $reflector->getName();
|
|
|
|
// Initialize dbFields from the children.
|
|
$this->init();
|
|
|
|
// Init empty database
|
|
$this->db = $this->dbFields;
|
|
|
|
$this->filenameDb = PATH_PLUGINS_DATABASES.$this->directoryName.DS.'db.php';
|
|
|
|
// --- Metadata ---
|
|
$this->filenameMetadata = PATH_PLUGINS.$this->directoryName().DS.'metadata.json';
|
|
$metadataString = file_get_contents($this->filenameMetadata);
|
|
$this->metadata = json_decode($metadataString, true);
|
|
|
|
// If the plugin is installed then get the database.
|
|
if($this->installed())
|
|
{
|
|
$Tmp = new dbJSON($this->filenameDb);
|
|
$this->db = $Tmp->db;
|
|
}
|
|
}
|
|
|
|
public function htmlPath()
|
|
{
|
|
return HTML_PATH_PLUGINS.$this->directoryName.'/';
|
|
}
|
|
|
|
public function phpPath()
|
|
{
|
|
return PATH_PLUGINS.$this->directoryName.DS;
|
|
}
|
|
|
|
public function phpPathDB()
|
|
{
|
|
return PATH_PLUGINS_DATABASES.$this->directoryName.DS;
|
|
}
|
|
|
|
// Returns the item from plugin-data.
|
|
public function getMetadata($key)
|
|
{
|
|
if(isset($this->metadata[$key])) {
|
|
return $this->metadata[$key];
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
public function setMetadata($key, $value)
|
|
{
|
|
$this->metadata[$key] = $value;
|
|
return true;
|
|
}
|
|
|
|
public function getDbField($key, $html=true)
|
|
{
|
|
if(isset($this->db[$key])) {
|
|
|
|
if($html) {
|
|
// All fields from DBField are sanitized.
|
|
return $this->db[$key];
|
|
}
|
|
else {
|
|
// Decode HTML tags, this action unsanitized the variable.
|
|
return Sanitize::htmlDecode($this->db[$key]);
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
public function setDb($args)
|
|
{
|
|
$tmp = $this->db;
|
|
|
|
foreach($this->dbFields as $key=>$value)
|
|
{
|
|
if(isset($args[$key]))
|
|
{
|
|
// Sanitize value
|
|
$tmpValue = Sanitize::html( $args[$key] );
|
|
|
|
// Set type
|
|
settype($tmpValue, gettype($value));
|
|
|
|
// Set value
|
|
$tmp[$key] = $tmpValue;
|
|
}
|
|
}
|
|
|
|
$this->db = $tmp;
|
|
|
|
// Save db on file
|
|
$Tmp = new dbJSON($this->filenameDb);
|
|
$Tmp->db = $tmp;
|
|
$Tmp->save();
|
|
}
|
|
|
|
public function name()
|
|
{
|
|
return $this->getMetadata('name');
|
|
}
|
|
|
|
public function description()
|
|
{
|
|
return $this->getMetadata('description');
|
|
}
|
|
|
|
public function author()
|
|
{
|
|
return $this->getMetadata('author');
|
|
}
|
|
|
|
public function email()
|
|
{
|
|
return $this->getMetadata('email');
|
|
}
|
|
|
|
public function website()
|
|
{
|
|
return $this->getMetadata('website');
|
|
}
|
|
|
|
public function version()
|
|
{
|
|
return $this->getMetadata('version');
|
|
}
|
|
|
|
public function releaseDate()
|
|
{
|
|
return $this->getMetadata('releaseDate');
|
|
}
|
|
|
|
public function className()
|
|
{
|
|
return $this->className;
|
|
}
|
|
|
|
public function directoryName()
|
|
{
|
|
return $this->directoryName;
|
|
}
|
|
|
|
// Return TRUE if the installation success, otherwise FALSE.
|
|
public function install($position=0)
|
|
{
|
|
if($this->installed()) {
|
|
return false;
|
|
}
|
|
|
|
// Create plugin directory for databases and other files
|
|
mkdir(PATH_PLUGINS_DATABASES.$this->directoryName, 0755, true);
|
|
|
|
// Create database
|
|
$this->dbFields['position'] = $position;
|
|
$this->setDb($this->dbFields);
|
|
|
|
return true;
|
|
}
|
|
|
|
public function uninstall()
|
|
{
|
|
// Delete all files.
|
|
$files = Filesystem::listFiles( $this->phpPathDB() );
|
|
foreach($files as $file) {
|
|
unlink($file);
|
|
}
|
|
|
|
// Delete the directory.
|
|
rmdir(PATH_PLUGINS_DATABASES.$this->directoryName);
|
|
}
|
|
|
|
public function installed()
|
|
{
|
|
return file_exists($this->filenameDb);
|
|
}
|
|
|
|
public function init()
|
|
{
|
|
// This method is used on childre classes.
|
|
// The user can define your own dbFields.
|
|
}
|
|
|
|
} |