AnonymousFox

/home/develito/public_html/components/com_sobipro/lib/base/message.php

<?php
/**
 * @package: SobiPro Library
 *
 * @author
 * Name: Sigrid Suski & Radek Suski, Sigsiu.NET GmbH
 * Email: sobi[at]sigsiu.net
 * Url: https://www.Sigsiu.NET
 *
 * @copyright Copyright (C) 2006 - 2020 Sigsiu.NET GmbH (https://www.sigsiu.net). All rights reserved.
 * @license GNU/LGPL Version 3
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation, and under the additional terms according section 7 of GPL v3.
 * See https://www.gnu.org/licenses/lgpl.html and https://www.sigsiu.net/licenses.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * @created 01 December 2012 by Radek Suski
 * @modified 15 July 2020 by Sigrid Suski
 */

use Sobi\Input\Input;

/**
 * Class SPMessage
 */
class SPMessage
{
	/** @var array */
	private $messages = [];
	/** @var bool */
	private $reset = false;
	/** @var bool */
	private $langLoadedAdm = false;
	/** @var bool */
	private $langLoadedSite = false;
	/** @var array */
	private $store = [];
	/** @var array */
	private $reports = [];
	/** @var array */
	private $current = [];

/**
	 * SPMessage constructor.
	 */
	private function __construct()
	{
		$this->messages = Sobi::GetUserData( 'messages-queue', $this->messages );
		$registry = SPFactory::registry()
			->loadDBSection( 'messages' )
			->get( 'messages.queue.params' );
		if ( $registry ) {
			try {
				$this->store = SPConfig::unserialize( $registry );
			}
			catch ( SPException $x ) {
				Sobi::Error( 'Message', 'Cannot uncompress messages', SPC::WARNING );
			}
		}
		$reports = SPFactory::registry()
			->loadDBSection( 'reports' )
			->get( 'reports.queue.params' );
		if ( $reports ) {
			try {
				$this->reports = SPConfig::unserialize( $reports );
			}
			catch ( SPException $x ) {
				Sobi::Error( 'Message', 'Cannot uncompress reports', SPC::WARNING );
			}
		}
	}

/**
	 * @param $action
	 * @param int $sid
	 * @param array $changes
	 * @param null $message
	 *
	 * @return SPMessage
	 * @throws \Sobi\Error\Exception
	 */
	public function & logAction( $action, $sid = 0, $changes = [], $message = null )
	{
		if ( Sobi::Cfg( 'entry.versioning', true ) ) {
			$log = [
				'revision'     => microtime( true ) . '.' . $sid . '.' . Sobi::My( 'id' ),
				'changedAt'    => 'FUNCTION:NOW()',
				'uid'          => Sobi::My( 'id' ),
				'userName'     => Sobi::My( 'name' ),
				'userEmail'    => Sobi::My( 'mail' ),
				'changeAction' => $action,
				'site'         => defined( 'SOBIPRO_ADM' ) ? 'adm' : 'site',
				'sid'          => $sid,
				'changes'      => SPConfig::serialize( $changes ),
				'params'       => null,
				'reason'       => $message,
				'language'     => Sobi::Lang(),
			];
			SPFactory::db()->insert( 'spdb_history', $log );
		}

return $this;
	}

/**
	 * @param $sid
	 *
	 * @return array
	 * @throws \Sobi\Error\Exception
	 */
	public function getHistory( $sid )
	{
		if ( Sobi::Cfg( 'entry.versioning', true ) ) {
			$log = ( array ) SPFactory::db()
				->select( '*', 'spdb_history', [ 'sid' => $sid ], 'changedAt.desc', 100 )
				->loadAssocList( 'revision' );
			if ( is_array( $log ) && count( $log ) ) {
				foreach ( $log as $revision => $data ) {
					try {
						$log[ $revision ][ 'changes' ] = SPConfig::unserialize( $data[ 'changes' ] );
					}
					catch ( Exception $x ) {
						$this->warning( sprintf( "Can't restore revision from %s. Error was '%s'", $data[ 'changedAt' ], $x->getMessage() ), false );
					}
				}
			}

return $log;
		}
		else {
			return [];
		}
	}

/**
	 * @param $rev
	 *
	 * @return array
	 * @throws SPException
	 * @throws \Sobi\Error\Exception
	 */
	public function getRevision( $rev )
	{
		if ( Sobi::Cfg( 'entry.versioning', true ) ) {
			$log = ( array ) SPFactory::db()
				->select( '*', 'spdb_history', [ 'revision' => $rev ] )
				->loadObject( 'revision' );
			if ( is_array( $log ) && count( $log ) ) {
				$log[ 'changes' ] = SPConfig::unserialize( $log[ 'changes' ] );
			}

return $log;
		}
		else {
			return [];
		}
	}

/**
	 * @param $rev
	 *
	 * @return array
	 * @throws \Sobi\Error\Exception
	 */
	public function deleteRevision( $rev )
	{
		if ( Sobi::Cfg( 'entry.versioning', true ) ) {
			try {
				SPFactory::db()
					->delete( 'spdb_history', [ 'revision' => $rev ] );
			}
			catch ( SPException $x ) {
				Sobi::Error( __FUNCTION__, SPLang::e( 'Cannot delete history version. Db reports %s.', $x->getMessage() ), SPC::WARNING, 0, __LINE__, __FILE__ );
			}
		}
		else {
			return [];
		}
	}

/**
	 * @param $sid
	 *
	 * @return array
	 * @throws \Sobi\Error\Exception
	 */
	public function deleteAllRevisions( $sid )
	{
		if ( Sobi::Cfg( 'entry.versioning', true ) ) {
			try {
				SPFactory::db()
					->delete( 'spdb_history', [ 'sid' => $sid ] );
			}
			catch ( SPException $x ) {
				Sobi::Error( __FUNCTION__, SPLang::e( 'Cannot delete history for entry. Db reports %s.', $x->getMessage() ), SPC::WARNING, 0, __LINE__, __FILE__ );
			}
		}
		else {
			return [];
		}
	}

/**
	 *
	 */
	public function storeMessages()
	{
		Sobi::SetUserData( 'messages-queue', $this->messages );
	}

/**
	 * @param bool $reset
	 *
	 * @return array|mixed
	 */
	public function getMessages( $reset = true )
	{
		$r = $this->messages;
		if ( $reset ) {
			$this->reset();
		}

return $r;
	}

/**
	 * @return SPMessage
	 */
	public function resetSystemMessages()
	{
		$this->store = [];
		$this->storeMessages();
		$store = [
			'params'      => [],
			'key'         => 'queue',
			'value'       => date( DATE_RFC822 ),
			'description' => null,
			'options'     => null,
		];
		SPFactory::registry()->saveDBSection( [ 'messages' => $store ], 'messages' );

return $this;
	}

/**
	 * @return SPMessage
	 */
	public function reset()
	{
		$this->messages = [];
		$this->reset = true;
		$this->storeMessages();

return $this;
	}

/**
	 * @return SPMessage
	 */
	public static function & getInstance()
	{
		static $message = null;
		if ( !$message || !( $message instanceof SPMessage ) ) {
			$message = new self();
		}

return $message;
	}

/**
	 * @param string|array $message
	 * @param bool $translate
	 * @param string $type
	 * @param bool $display
	 *
	 * @return $this|SPMessage
	 * @throws SPException
	 */
	public function & setMessage( $message, $translate = true, $type = 'warning', $display = true )
	{
		if ( $translate ) {
			if ( defined( 'SOBIPRO_ADM' ) && !( $this->langLoadedAdm ) ) {
				$this->langLoadedAdm = SPLang::load( 'com_sobipro.messages' );
			}
			else {
				if ( !( $this->langLoadedSite ) ) {
					$this->langLoadedSite = SPLang::load( 'com_sobipro.err' );
				}
			}
			//$this->langLoaded = true;
		}
		if ( $type == 'message' ) {
			$type = 'info';
		}
		/* Somehow the message are doubled. Do we need the array at all? Decided we do not need the array here */
//		if ( is_array( $message ) && !( is_string( $message ) ) ) {
//			foreach ( $message as $msg ) {
//				$this->setMessage( $msg[ 'text' ], $translate, $msg[ 'type' ], $display );
//			}
//		}

if ( !( is_array( $message ) ) && is_string( $message ) ) {
			$messageText = $translate ? Sobi::Txt( strtoupper( $type ) . '.' . $message ) : $message;
			if ( $display ) {
				if ( !( is_array( $message ) ) ) {
					$this->messages[ $type ][ preg_replace( "/[^a-zA-Z0-9]/", "", $message ) ] = $messageText;
				}
			}
			$this->current = [ 'message' => $messageText, 'type' => $type, 'section' => [ 'id' => Sobi::Section(), 'name' => Sobi::Section( true ) ] ];
			$this->storeMessages();
		}

return $this;
	}

/**
	 * @param string $section
	 *
	 * @return SPMessage
	 * @throws SPException
	 * @throws \Sobi\Error\Exception
	 */
	public function & setSystemMessage( $section = 'configuration' )
	{
		$change = count( $this->store );
		$this->current[ 'issue-type' ] = $section;
		$this->store[ md5( serialize( $this->current ) ) ] = $this->current;
		if ( count( $this->store ) > $change ) {
			$messages = SPConfig::serialize( $this->store );
			$store = [
				'params'      => $messages,
				'key'         => 'queue',
				'value'       => date( DATE_RFC822 ),
				'description' => null,
				'options'     => null,
			];
			SPFactory::registry()->saveDBSection( [ 'messages' => $store ], 'messages' );
			SPFactory::cache()->cleanSection( -1, false );
		}

return $this;
	}

/**
	 * @param $message
	 * @param string $type
	 * @param string $section
	 *
	 * @return SPMessage
	 * @throws SPException
	 * @throws \Sobi\Error\Exception
	 */
	public function & setSilentSystemMessage( $message, $type = SPC::NOTICE_MSG, $section = 'configuration' )
	{
		$this->current = [ 'message' => $message, 'type' => $type, 'section' => [ 'id' => Sobi::Section(), 'name' => Sobi::Section( true ) ] ];
		$this->current[ 'issue-type' ] = $section;
		$this->store[ md5( serialize( $this->current ) ) ] = $this->current;
		if ( count( $this->store ) ) {
			$messages = SPConfig::serialize( $this->store );
			$store = [
				'params'      => $messages,
				'key'         => 'queue',
				'value'       => date( DATE_RFC822 ),
				'description' => null,
				'options'     => null,
			];
			SPFactory::registry()->saveDBSection( [ 'messages' => $store ], 'messages' );
			SPFactory::cache()->cleanSection( -1, false );
		}

return $this;
	}

/**
	 * @param $message
	 * @param $spsid string
	 * @param string $type
	 *
	 * @return SPMessage
	 */
	public function & setReport( $message, $spsid, $type = SPC::INFO_MSG )
	{
		$this->reports[ $spsid ][ $type ][] = $message;
		if ( count( $this->reports ) ) {
			$messages = SPConfig::serialize( $this->reports );
			$store = [
				'params'      => $messages,
				'key'         => 'queue',
				'value'       => date( DATE_RFC822 ),
				'description' => null,
				'options'     => null,
			];
			SPFactory::registry()->saveDBSection( [ 'reports' => $store ], 'reports' );
		}

return $this;
	}

/**
	 * @param null $spsid
	 *
	 * @return array
	 */
	public function getReports( $spsid )
	{
		$reports = [];
		if ( $this->reports[ $spsid ] ) {
//			$messages = SPConfig::serialize( $this->reports );
			$reports = $this->reports[ $spsid ];
			unset( $this->reports[ $spsid ] );
			/** Thu, Jul 31, 2014 11:12:02
			 * Why the hell we are setting these messages into the db again?
			 */
			$store = [
				'params'      => [],//$messages,
				'key'         => 'queue',
				'value'       => date( DATE_RFC822 ),
				'description' => null,
				'options'     => null,
			];
			SPFactory::registry()->saveDBSection( [ 'reports' => $store ], 'reports' );
		}

return $reports;
	}

/**
	 * @param null $spsid
	 *
	 * @return array
	 */
	public function getSystemMessages( $spsid = null )
	{
		return $spsid ? ( isset( $this->reports[ $spsid ] ) ? $this->reports[ $spsid ] : [] ) : $this->store;
	}

//	/**
//	 * @param $id string
//	 * @return SPMessage
//	 */
//	public function & addSystemMessage( $id )
//	{
//		$change = count( $this->store );
//		$this->current[ 'issue-type' ] = $id;
//		$this->store[ md5( serialize( $this->current ) ) ] = $this->current;
//		if ( count( $this->store ) > $change ) {
//			$messages = SPConfig::serialize( $this->store );
//			$store = array(
//				'params' => $messages,
//				'key' => 'queue',
//				'value' => date( DATE_RFC822 ),
//				'description' => null,
//				'options' => null
//			);
//			SPFactory::registry()->saveDBSection( array( 'messages' => $store ), 'messages' );
//			SPFactory::cache()->cleanSection( -1, false );
//		}
//		return $this;
//	}

/**
	 * @param $message
	 * @param bool $translate
	 * @param bool $display
	 *
	 * @return $this|SPMessage
	 * @throws SPException
	 */
	public function & info( $message, $translate = true, $display = true )
	{
		return $this->setMessage( $message, $translate, 'info', $display );
	}

/**
	 * @param $message
	 * @param bool $translate
	 * @param bool $display
	 *
	 * @return $this|SPMessage
	 * @throws SPException
	 */
	public function & warning( $message, $translate = true, $display = true )
	{
		return $this->setMessage( $message, $translate, 'warning', $display );
	}

/**
	 * @param $message
	 * @param bool $translate
	 * @param bool $display
	 *
	 * @return $this|SPMessage
	 * @throws SPException
	 */
	public function & error( $message, $translate = true, $display = true )
	{
		return $this->setMessage( $message, $translate, 'error', $display );
	}

/**
	 * @param $message
	 * @param bool $translate
	 * @param bool $display
	 *
	 * @return $this|SPMessage
	 * @throws SPException
	 */
	public function & success( $message, $translate = true, $display = true )
	{
		return $this->setMessage( $message, $translate, 'success', $display );
	}
}