bludit/bl-kernel/dbpages.class.php

535 lines
12 KiB
PHP
Raw Normal View History

2015-05-05 03:00:01 +02:00
<?php defined('BLUDIT') or die('Bludit CMS.');
class dbPages extends dbJSON
{
private $parentKeyList = array();
private $dbFields = array(
2015-08-17 02:24:22 +02:00
'title'=> array('inFile'=>true, 'value'=>''),
'content'=> array('inFile'=>true, 'value'=>''),
2015-05-05 03:00:01 +02:00
'description'=> array('inFile'=>false, 'value'=>''),
'username'=> array('inFile'=>false, 'value'=>''),
2015-09-18 05:24:10 +02:00
'tags'=> array('inFile'=>false, 'value'=>array()),
2017-05-08 21:26:06 +02:00
'status'=> array('inFile'=>false, 'value'=>'draft'), // published, draft, scheduled
2015-11-13 02:25:59 +01:00
'date'=> array('inFile'=>false, 'value'=>''),
2016-05-29 02:54:18 +02:00
'dateModified'=> array('inFile'=>false, 'value'=>''),
'position'=> array('inFile'=>false, 'value'=>0),
2017-04-26 18:56:10 +02:00
'coverImage'=> array('inFile'=>false, 'value'=>''),
2017-04-26 21:26:17 +02:00
'category'=> array('inFile'=>false, 'value'=>''),
2017-05-08 21:26:06 +02:00
'md5file'=> array('inFile'=>false, 'value'=>''),
'uuid'=> array('inFile'=>false, 'value'=>''),
2017-05-30 20:28:55 +02:00
'allowComments'=> array('inFile'=>false, 'value'=>true)
2015-05-05 03:00:01 +02:00
);
function __construct()
{
2017-05-08 21:26:06 +02:00
parent::__construct(DB_PAGES);
2015-05-05 03:00:01 +02:00
}
2017-05-08 21:26:06 +02:00
// Create a new page
2015-05-05 03:00:01 +02:00
public function add($args)
{
$dataForDb = array(); // This data will be saved in the database
$dataForFile = array(); // This data will be saved in the file
2017-05-08 21:26:06 +02:00
// The user is always the one loggued
2015-05-05 03:00:01 +02:00
$args['username'] = Session::get('username');
2015-05-31 03:06:55 +02:00
if( Text::isEmpty($args['username']) ) {
2015-05-05 03:00:01 +02:00
return false;
}
2017-05-08 21:26:06 +02:00
// Generate key
$key = $this->generateKey($args['slug'], $args['parent']);
// Generate UUID
$args['uuid'] = md5( uniqid() );
2017-05-16 00:46:20 +02:00
// Date
$currentDate = Date::current(DB_DATE_FORMAT);
// Validate date
if(!Valid::date($args['date'], DB_DATE_FORMAT)) {
$args['date'] = $currentDate;
}
// Schedule page
if( ($args['date']>$currentDate) && ($args['status']=='published') ) {
$args['status'] = 'scheduled';
}
2015-05-05 03:00:01 +02:00
2017-05-08 21:26:06 +02:00
foreach($this->dbFields as $field=>$options) {
if( isset($args[$field]) ) {
2015-09-18 05:24:10 +02:00
if($field=='tags') {
2017-05-08 21:26:06 +02:00
$value = $this->generateTags($args['tags']);
2015-05-05 03:00:01 +02:00
}
else {
2015-09-18 05:24:10 +02:00
if( !$options['inFile'] ) {
2017-05-08 21:26:06 +02:00
// Sanitize if will be stored on database
$value = Sanitize::html($args[$field]);
2015-09-18 05:24:10 +02:00
}
else {
2017-05-08 21:26:06 +02:00
$value = $args[$field];
2015-09-18 05:24:10 +02:00
}
2015-05-05 03:00:01 +02:00
}
}
2017-05-08 21:26:06 +02:00
else {
// Default value for the field
$value = $options['value'];
2015-05-05 03:00:01 +02:00
}
2017-05-08 21:26:06 +02:00
// Where the data is stored
2015-05-05 03:00:01 +02:00
if($options['inFile']) {
2017-05-08 21:26:06 +02:00
$dataForFile[$field] = Text::firstCharUp($field).': '.$value;
2015-05-05 03:00:01 +02:00
}
2017-05-08 21:26:06 +02:00
else {
2015-05-05 03:00:01 +02:00
// Set type
2017-05-08 21:26:06 +02:00
settype($value, gettype($options['value']));
2015-05-05 03:00:01 +02:00
// Save on database
2017-05-08 21:26:06 +02:00
$dataForDb[$field] = $value;
2015-05-05 03:00:01 +02:00
}
}
2017-05-08 21:26:06 +02:00
// Create the directory
2015-05-31 03:06:55 +02:00
if( Filesystem::mkdir(PATH_PAGES.$key, true) === false ) {
2015-05-05 03:00:01 +02:00
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to create the directory '.PATH_PAGES.$key);
return false;
}
// Make the index.txt and save the file.
$data = implode("\n", $dataForFile);
2016-07-26 01:40:51 +02:00
if( file_put_contents(PATH_PAGES.$key.DS.FILENAME, $data) === false ) {
2017-05-08 21:26:06 +02:00
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to put the content in the file '.FILENAME);
2015-05-05 03:00:01 +02:00
return false;
}
2017-05-16 00:46:20 +02:00
// Insert in database
2015-05-05 03:00:01 +02:00
$this->db[$key] = $dataForDb;
2017-05-16 00:46:20 +02:00
// Sort database
$this->sortBy();
2017-05-16 00:46:20 +02:00
// Save database
2015-05-05 03:00:01 +02:00
if( $this->save() === false ) {
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to save the database file.');
return false;
}
2016-01-08 00:43:09 +01:00
return $key;
2015-05-05 03:00:01 +02:00
}
public function edit($args)
{
$dataForDb = array();
$dataForFile = array();
2017-05-08 21:26:06 +02:00
// The user is always the one loggued
2015-05-05 03:00:01 +02:00
$args['username'] = Session::get('username');
2015-05-31 03:06:55 +02:00
if( Text::isEmpty($args['username']) ) {
2015-05-05 03:00:01 +02:00
return false;
}
2017-05-08 21:26:06 +02:00
$newKey = $this->generateKey($args['slug'], $args['parent'], false, $args['key']);
// If the page is draft then the time created is now
2015-08-22 18:33:33 +02:00
if( $this->db[$args['key']]['status']=='draft' ) {
2015-08-26 05:42:32 +02:00
$args['date'] = Date::current(DB_DATE_FORMAT);
2015-08-22 18:33:33 +02:00
}
else {
2015-08-26 05:42:32 +02:00
$args['date'] = $this->db[$args['key']]['date'];
2015-08-22 18:33:33 +02:00
}
2015-05-05 03:00:01 +02:00
2017-05-08 21:26:06 +02:00
// Current UUID
$args['uuid'] = $this->db[$args['key']]['uuid'];
2016-05-29 02:54:18 +02:00
// Modified date
$args['dateModified'] = Date::current(DB_DATE_FORMAT);
2017-05-08 21:26:06 +02:00
foreach($this->dbFields as $field=>$options) {
if( isset($args[$field]) ) {
2015-09-18 05:24:10 +02:00
if($field=='tags') {
2017-05-08 21:26:06 +02:00
$value = $this->generateTags($args['tags']);
2015-05-05 03:00:01 +02:00
}
else {
2015-09-18 05:24:10 +02:00
if( !$options['inFile'] ) {
2017-05-08 21:26:06 +02:00
// Sanitize if will be stored on database
$value = Sanitize::html($args[$field]);
2015-09-18 05:24:10 +02:00
}
else {
2017-05-08 21:26:06 +02:00
// Default value for the field
$value = $args[$field];
2015-09-18 05:24:10 +02:00
}
2015-05-05 03:00:01 +02:00
}
}
2017-05-08 21:26:06 +02:00
else {
$value = $options['value'];
2015-05-05 03:00:01 +02:00
}
2017-05-08 21:26:06 +02:00
// Where the data is stored
2015-05-05 03:00:01 +02:00
if($options['inFile']) {
2017-05-08 21:26:06 +02:00
$dataForFile[$field] = Text::firstCharUp($field).': '.$value;
2015-05-05 03:00:01 +02:00
}
2017-05-08 21:26:06 +02:00
else {
2015-05-05 03:00:01 +02:00
// Set type
2017-05-08 21:26:06 +02:00
settype($value, gettype($options['value']));
2015-05-05 03:00:01 +02:00
// Save on database
2017-05-08 21:26:06 +02:00
$dataForDb[$field] = $value;
2015-05-05 03:00:01 +02:00
}
}
2015-06-26 06:31:53 +02:00
// Move the directory from old key to new key.
2017-05-08 21:26:06 +02:00
if($newKey!==$args['key']) {
2015-05-31 03:06:55 +02:00
if( Filesystem::mv(PATH_PAGES.$args['key'], PATH_PAGES.$newKey) === false ) {
2015-05-05 03:00:01 +02:00
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to move the directory to '.PATH_PAGES.$newKey);
return false;
}
}
// Make the index.txt and save the file.
$data = implode("\n", $dataForFile);
if( file_put_contents(PATH_PAGES.$newKey.DS.FILENAME, $data) === false ) {
2017-05-08 21:26:06 +02:00
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to put the content in the file '.FILENAME);
2015-05-05 03:00:01 +02:00
return false;
}
2017-05-08 21:26:06 +02:00
// Remove the old key
unset( $this->db[$args['key']] );
2015-05-05 03:00:01 +02:00
2017-05-16 00:46:20 +02:00
// Insert in database
2015-05-05 03:00:01 +02:00
$this->db[$newKey] = $dataForDb;
2017-05-16 00:46:20 +02:00
// Sort database
$this->sortBy();
2017-05-16 00:46:20 +02:00
// Save database
2015-05-05 03:00:01 +02:00
if( $this->save() === false ) {
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to save the database file.');
return false;
}
2016-01-08 00:43:09 +01:00
return $newKey;
2015-05-05 03:00:01 +02:00
}
public function delete($key)
{
2017-05-08 21:26:06 +02:00
// Page doesn't exist in database
2017-05-17 00:04:53 +02:00
if(!$this->exists($key)) {
2015-05-05 03:00:01 +02:00
Log::set(__METHOD__.LOG_SEP.'The page does not exist. Key: '.$key);
}
2017-05-08 21:26:06 +02:00
// Delete the index.txt file
if( Filesystem::rmfile(PATH_PAGES.$key.DS.FILENAME) === false ) {
2017-05-08 21:26:06 +02:00
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to delete the file '.FILENAME);
2015-05-05 03:00:01 +02:00
}
2017-05-08 21:26:06 +02:00
// Delete the directory
2015-05-31 03:06:55 +02:00
if( Filesystem::rmdir(PATH_PAGES.$key) === false ) {
2015-05-05 03:00:01 +02:00
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to delete the directory '.PATH_PAGES.$key);
}
2017-05-08 21:26:06 +02:00
// Remove from database
2015-05-05 03:00:01 +02:00
unset($this->db[$key]);
// Save the database.
if( $this->save() === false ) {
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to save the database file.');
}
return true;
}
2017-05-10 20:40:28 +02:00
// Returns a database with published pages
public function getPublishedDB()
{
$tmp = $this->db;
foreach($tmp as $key=>$fields) {
if($fields['status']!='published') {
unset($tmp[$key]);
}
}
return $tmp;
}
// Returns a database with drafts pages
public function getDraftDB()
{
$tmp = $this->db;
foreach($tmp as $key=>$fields) {
if($fields['status']!='draft') {
unset($tmp[$key]);
}
}
return $tmp;
}
2015-05-05 03:00:01 +02:00
// Return an array with the database for a page, FALSE otherwise.
2016-01-08 00:43:09 +01:00
public function getPageDB($key)
2015-05-05 03:00:01 +02:00
{
2017-05-17 00:04:53 +02:00
if( $this->exists($key) ) {
2015-05-05 03:00:01 +02:00
return $this->db[$key];
}
return false;
}
2017-05-10 20:40:28 +02:00
// Returns an array with a list of pages
// (int) $pageNumber, the page number
// (int) $amountOfItems, amount of items to return
// (boolean) $onlyPublished, TRUE to return only published pages
public function getList($pageNumber, $amountOfItems, $onlyPublished=true)
2017-05-10 20:40:28 +02:00
{
$db = $this->db;
if( $onlyPublished ) {
$db = $this->getPublishedDB();
}
2017-05-24 00:48:29 +02:00
// The first page number is 1, so the real is 0
$realPageNumber = $pageNumber - 1;
2017-05-10 20:40:28 +02:00
$total = count($db);
2017-05-24 00:48:29 +02:00
$init = (int) $amountOfItems * $realPageNumber;
2017-05-10 20:40:28 +02:00
$end = (int) min( ($init + $amountOfItems - 1), $total );
$outrange = $init<0 ? true : $init>$end;
if(!$outrange) {
return array_slice($db, $init, $amountOfItems, true);
}
return array();
}
// Returns the amount of pages
// (boolean) $total, TRUE returns the total of pages
// (boolean) $total, FALSE returns the total of published pages (without draft and scheduled)
2017-05-16 00:46:20 +02:00
public function count($onlyPublished=true)
2017-05-10 20:40:28 +02:00
{
if( $onlyPublished ) {
$db = $this->getPublishedDB();
return count($db);
}
return count($this->db);
}
2017-05-16 00:46:20 +02:00
public function getParents($onlyPublished=true)
{
if( $onlyPublished ) {
$db = $this->getPublishedDB();
}
else {
$db = $this->db;
}
foreach( $db as $key=>$fields ) {
if( Text::stringContains($key, '/') ) {
unset($db[$key]);
}
}
return $db;
}
2017-05-17 00:04:53 +02:00
// Return TRUE if the page exists, FALSE otherwise.
public function exists($key)
{
return isset( $this->db[$key] );
}
public function sortBy()
{
if( ORDER_BY=='date' ) {
return $this->sortByDate(true);
} else {
return $this->sortByPosition(false);
}
}
// Sort pages by position
public function sortByPosition($HighToLow=false)
{
if($HighToLow) {
uasort($this->db, array($this, 'sortByPositionHighToLow'));
}
else {
uasort($this->db, array($this, 'sortByPositionLowToHigh'));
}
return true;
}
private function sortByPositionLowToHigh($a, $b) {
return $a['position']>$b['position'];
}
private function sortByPositionHighToLow($a, $b) {
return $a['position']<$b['position'];
}
2017-05-16 00:46:20 +02:00
// Sort pages by date
public function sortByDate($HighToLow=true)
{
if($HighToLow) {
uasort($this->db, array($this, 'sortByDateHighToLow'));
2017-05-16 00:46:20 +02:00
}
else {
uasort($this->db, array($this, 'sortByDateLowToHigh'));
2017-05-16 00:46:20 +02:00
}
return true;
}
private function sortByDateLowToHigh($a, $b) {
2017-05-16 00:46:20 +02:00
return $a['date']>$b['date'];
}
private function sortByDateHighToLow($a, $b) {
2017-05-16 00:46:20 +02:00
return $a['date']<$b['date'];
}
2017-05-10 20:40:28 +02:00
// ----- OLD
2017-05-08 21:26:06 +02:00
// Set a field of the database
public function setField($key, $field, $value)
2016-01-29 17:07:29 +01:00
{
2017-05-17 00:04:53 +02:00
if( $this->exists($key) ) {
2017-05-08 21:26:06 +02:00
settype($value, gettype($this->dbFields[$key]['value']));
2016-01-29 17:07:29 +01:00
$this->db[$key][$field] = $value;
}
return false;
}
2017-05-17 00:04:53 +02:00
2015-05-05 03:00:01 +02:00
public function parentKeyList()
{
return $this->parentKeyList;
}
public function parentKeyExists($key)
{
2017-05-08 21:26:06 +02:00
return isset( $this->parentKeyList[$key] );
2015-05-05 03:00:01 +02:00
}
public function addParentKey($key)
{
$this->parentKeyList[$key] = $key;
}
// Generate a valid Key/Slug.
public function generateKey($text, $parent=NO_PARENT_CHAR, $returnSlug=false, $oldKey='')
{
2015-05-31 03:06:55 +02:00
if(Text::isEmpty($text)) {
2015-05-05 03:00:01 +02:00
$text = 'empty';
}
2015-05-31 03:06:55 +02:00
if( Text::isEmpty($parent) || ($parent==NO_PARENT_CHAR) ) {
$newKey = Text::cleanUrl($text);
2015-05-05 03:00:01 +02:00
}
else {
2015-05-31 03:06:55 +02:00
$newKey = Text::cleanUrl($parent).'/'.Text::cleanUrl($text);
2015-05-05 03:00:01 +02:00
}
2017-05-08 22:01:16 +02:00
if($newKey!==$oldKey) {
// Verify if the key is already been used
if( isset($this->db[$newKey]) ) {
2015-05-31 03:06:55 +02:00
if( !Text::endsWithNumeric($newKey) ) {
2015-05-19 01:22:05 +02:00
$newKey = $newKey.'-0';
}
2015-05-05 03:00:01 +02:00
2015-05-19 01:22:05 +02:00
while( isset($this->db[$newKey]) ) {
$newKey++;
}
2015-05-05 03:00:01 +02:00
}
}
2017-05-08 22:01:16 +02:00
if($returnSlug) {
2015-05-05 03:00:01 +02:00
$explode = explode('/', $newKey);
if(isset($explode[1])) {
return $explode[1];
}
return $explode[0];
}
return $newKey;
}
2016-01-08 00:43:09 +01:00
// Returns the database
public function getDB()
2015-05-05 03:00:01 +02:00
{
return $this->db;
}
2015-09-18 05:24:10 +02:00
// Returns an Array, array('tagSlug'=>'tagName')
// (string) $tags, tag list separeted by comma.
public function generateTags($tags)
{
$tmp = array();
$tags = trim($tags);
if(empty($tags)) {
return $tmp;
}
// Make array
$tags = explode(',', $tags);
foreach($tags as $tag)
{
$tag = trim($tag);
$tagKey = Text::cleanUrl($tag);
$tmp[$tagKey] = $tag;
}
return $tmp;
}
2017-04-17 12:49:03 +02:00
// Change all posts with the old category key for the new category key
public function changeCategory($oldCategoryKey, $newCategoryKey)
{
foreach($this->db as $key=>$value) {
if($value['category']==$oldCategoryKey) {
$this->db[$key]['category'] = $newCategoryKey;
}
}
// Save database
return $this->save();
}
2017-05-08 22:20:53 +02:00
// Return TRUE if there are new pages published, FALSE otherwise.
public function scheduler()
{
// Get current date
$currentDate = Date::current(DB_DATE_FORMAT);
$saveDatabase = false;
2017-05-09 00:24:15 +02:00
// The database need to be sorted by date
foreach($this->db as $pageKey=>$fields) {
if($fields['status']=='scheduled') {
if($fields['date']<=$currentDate) {
$this->db[$pageKey]['status'] = 'published';
2017-05-08 22:20:53 +02:00
$saveDatabase = true;
}
}
2017-05-09 00:24:15 +02:00
elseif($fields['status']=='published') {
2017-05-08 22:20:53 +02:00
break;
}
}
if($saveDatabase) {
if( $this->save() === false ) {
Log::set(__METHOD__.LOG_SEP.'Error occurred when trying to save the database file.');
return false;
}
2017-05-09 00:24:15 +02:00
Log::set(__METHOD__.LOG_SEP.'New pages published from the scheduler.');
2017-05-08 22:20:53 +02:00
return true;
}
return false;
}
}