/** Datei: plugins/logs/library/ARUNOX/API/PHP/Attributes/Logs/Rules/Update.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @since 1.0.0 File is created */ namespace ARUNOX\API\PHP\Attributes\Logs\Rules; use Attribute; use ARUNOX\API\PHP; use ARUNOX\Database\Attribute\Options; #[Attribute( Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE )] class Update extends PHP\Attributes\Attribute { /* ### VARIABLES ################################################ # */ protected array $RULES = []; /* ### PUBLIC FUNCTIONS ######################################### # */ public function add( string $column, null|string $message = NULL, null|string|array $options = NULL ) { if( is_string( $options ) ) { if( class_exists( $options ) ) { if( method_exists( $options, "getAsOptions" ) ) { $options = $options::getAsOptions(); } if( is_a( $options, Options::class, TRUE ) ) { $options = $options::getAll(); } } else $options = NULL; } $this->RULES[ $column ] = [ "message" => $message, "options" => $options, ]; } /* ### PUBLIC STATIC LOG FUNCTIONS ############################## # */ public function getLogRulesUpdated( null|int $id = NULL ) { return $this->RULES; } /* ### MAGIC FUNCTIONS ######################################### # */ /** * @param string $column * @param string|null $message * @param string|array|null $options */ public function __construct( string $column, null|string $message = NULL, null|string|array $options = NULL ) {} } /** Datei: plugins/logs/library/ARUNOX/API/PHP/Attributes/Logs/Rules/Create.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @since 1.0.0 File is created */ namespace ARUNOX\API\PHP\Attributes\Logs\Rules; use Attribute; use ARUNOX\API\PHP; #[Attribute( Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE )] class Create extends PHP\Attributes\Attribute { /* ### VARIABLES ################################################ # */ protected array $RULES = []; /* ### PUBLIC FUNCTIONS ######################################### # */ public function getLogRulesCreated( null|int $id = NULL ) { return $this->RULES; } public function add( null|string $column = "__self", null|string|array $message = NULL ) { $this->RULES[ $column ] = $message ?? []; } /* ################################################################ # */ /* ### DEFINITION FOR IDE ####################################### # */ /* ################################################################ # */ /** * @param string|null $column * @param string|null $message */ public function __construct( null|string $column = "__self", null|string|array $message = NULL ) {} } /** Datei: plugins/logs/library/ARUNOX/Plugins/Logs/Model.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @since 1.0.0 File is created */ namespace ARUNOX\Plugins\Logs; use ARUNOX\API\PHP; use ARUNOX\Database\BaseModel; #[PHP\Attributes\Database\Definitions\Table( "logs" )] #[PHP\Attributes\Database\Definitions\HashID( "log" )] #[PHP\Attributes\Database\Definitions\Entity( Entity::class )] class Model extends BaseModel { /* ### VARIABLES ################################################ # */ /* ### PUBLIC STATIC FUNCTIONS ################################## # */ public static function getByTarget( string $target ) : array { return static::getAll([[ "RELATION" => "OR", [ "source_hid" => $target, "target_hids__SQL" => "JSON_LENGTH( `target_hids` ) = 0", ], [ "source_hid__NOT" => $target, "target_hids__JSON" => $target, ] ]]); } public static function getBySource( string $source ) : array { return static::getAllByColumn( "source_hid", $source ); } } /** Datei: plugins/logs/library/ARUNOX/Plugins/Logs/API/v1/Routes.php **/ * @copyright 2025 ARUNOX * @version 1.1.0 * * @since 1.0.0 File is created */ namespace ARUNOX\Plugins\Logs\API\v1; use ARUNOX\Core\Hooks; use ARUNOX\Core\Router; class Routes { public static function register() : void { /* ### MAIN ROUTES ############################## # */ Router::addAll( Controller::class ); /* ### MENU ROUTES ############################## # */ Hooks::add('router::get->api.v1.rest.routes', function( $routes ) { $routes[] = [ "path" => Controller::getRoute(), "label" => Controller::getLabelGroup(), "icon" => Controller::getIcon(), "menu" => "administration", ]; return $routes; }, 99 ); } } /** Datei: plugins/logs/library/ARUNOX/Plugins/Logs/API/v1/Controller.php **/ * @copyright 2025 ARUNOX * @version 1.1.0 * * @since 1.0.0 File is created */ namespace ARUNOX\Plugins\Logs\API\v1; use ARUNOX\HTTP; use ARUNOX\API\PHP; use ARUNOX\Core\Hooks; use ARUNOX\Core\Router; use ARUNOX\Plugins\Logs; use ARUNOX\Plugins\REST; use ARUNOX\API\BaseController; use ARUNOX\Database\BaseEntity; #[PHP\Attributes\Controller\Label( "Log", "Logs", "Logbuch" )] #[PHP\Attributes\Controller\Icon( REST\Generator\Config\Icon::JournalText )] #[PHP\Attributes\Controller\Route( "logs" )] class Controller extends BaseController { /* ### VARIABLES ################################################ # */ /* ### PUBLIC GET FUNCTIONS ##################################### # */ /** * @api * @method GET * * @route.path /logs * @route.description Listet alle Logeinträge */ public static function getAll() : array { return Logs\Model::getAll(); } /** * @api * @method GET * * @route.path /{*}/{target}/logs * @route.description Listet alle Logeinträge */ public static function getByTarget( string $route, string $target ) : array { return Logs\Model::getByTarget( $target ); } /** * @api * @method GET * * @route.path /logs/{hashid} * @route.description Gibt einen einzelnen Logeintrag anhand der ID zurück */ public static function get( string $hashid ) : BaseEntity | HTTP\Response { if( $result = Logs\Model::get( $hashid ) ) return $result; return REST\Response::autoResponse( 404, static::getNotify("notfound") ); } /* ### PUBLIC SAVE FUNCTIONS #################################### # */ /** * @api * @method DELETE * * @route.path /logs/{hashid} * @route.description Löscht ein Logeintrag anhand der ID */ public static function delete( string $hashid ) : HTTP\Response { if( Logs\Model::delete( $hashid ) ) { return REST\Response::autoResponse( 200, static::getNotify("deleted") ); } return REST\Response::autoResponse( 500, static::getNotify("notfound") ); } /* ### PUBLIC VALIDATE FUNCTIONS ################################ # */ /* ### PUBLIC REST FUNCTIONS #################################### # */ /* ### PUBLIC REST RESPONSE FUNCTIONS ########################### # */ /** * @internal rest * @method GET * * @route.path /logs/{hashid} * @route.description REST-Konfiguration für Detailansicht eines Logeintrags */ public static function restResponseDetails( string $hashid ) : mixed { $log = Logs\Model::get( $hashid ); $source = Logs\Model::resolveHashIDPrefix( $log->source_hid ); $route = $source->callControllerClass( "getRoute", $log->source_hid ); return Router::dispatch( HTTP\Request::method(), "/rest{$route}" ); } /** * @internal rest * @method DELETE * * @route.path /logs/{hashid} * @route.description REST-Antwort nach dem Löschen eines Logeintrag */ public static function restResponseDelete( string $hashid ) : HTTP\Response { REST\Response::closeModals(); $result = static::delete( $hashid ); if( $result->isStatus( 200 ) ) { REST\Response::redirect( "/logs" ); } return static::restResponse( $result ); } /* ### PUBLIC REST CONFIG FUNCTIONS ############################# # */ /** * @internal rest * @method GET * * @route.path /logs * @route.description REST-Konfiguration für Logbuch-Tabelle */ public static function restConfigOverview() : REST\Generator\Base\BaseGenerator { return REST\Response::addWrapper( "overview", static::getLabelGroup() ) ->replaceContent( static::restConfigTable() ); } /** * @internal rest * @method GET * * @route.path /{*}/{target}/logs * @route.description REST-Konfiguration für Logbuch-Tabelle */ public static function restConfigLog( string $route, string $target ) : REST\Generator\Base\BaseGenerator { return REST\Response::addWrapper( "overview", static::getLabelGroup() ) ->replaceContent( static::restConfigTable( $target ) ); } /** * @internal rest * @method GET * * @route.path /logs/{hashid}/delete * @route.description REST-Konfiguration für die Lösch-Bestätigung eines Logeintrags */ public static function restConfigDelete( string $hashid ) : REST\Generator\Base\BaseGenerator { $type = Logs\Model::getValue( $hashid, "type" ); return REST\Response::addModal( "details", "{$type->getLabel()} Löschen" ) ->setSize( REST\Wrapper\Modal\Size::sm ) ->get() ->setAction( "/logs/{$hashid}", "DELETE" ) ->addText( "Möchtest du wirklich den Datensatz (#{$hashid}) löschen? " ) ->addButton(...Hooks::filter( "rest.generator::button.type->cancel", [], NULL, "logs" )) ->addButton(...Hooks::filter( "rest.generator::button.type->delete", [], NULL, "logs" )); } /* ### PUBLIC REST EXTENSION FUNCTIONS ########################## # */ public static function restConfigTab( REST\Generator\Base\BaseGenerator $rest, null|string $hashid = NULL ) : void { $rest->addTab( static::getLabelGroup(), static::getPlural() )->get() ->setIcon( static::getIcon() ) ->addContent( Logs\API\v1\Controller::restConfigTable( $hashid ) ) ; } public static function restConfigTable( null|string $hashid = NULL ) : REST\Generator\Base\BaseGenerator { $route = static::getRoute(); if( $hashid ) { $class = Logs\Model::resolveHashIDPrefix( $hashid ); $class = $class::getControllerClass(); $route = $class::getRoute( $hashid, $route ); } $table = REST\Generator\Data\Table::create() ->setApi( $route ) ->setAction( static::getRoute( "{hashid}" ) ) ->setOrder( "date_create", "desc" ) ->setSearch( TRUE ) ->addColumn(...Hooks::filter( "rest.generator::column.type->datetime", [], "date_create", TRUE, FALSE, TRUE, "logs" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "message", TRUE, TRUE, TRUE, "logs" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "creator_name", TRUE, TRUE, TRUE, "logs" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "source_hid", TRUE, TRUE, TRUE, "logs" )) ; return $table; } } /** Datei: plugins/logs/library/ARUNOX/Plugins/Logs/Entity.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @since 1.0.0 File is created */ namespace ARUNOX\Plugins\Logs; use ARUNOX\API\PHP; use ARUNOX\Plugins; use ARUNOX\Database\Attribute; use ARUNOX\Database\BaseEntity; #[PHP\Attributes\Database\Definitions\Model( Model::class )] class Entity extends BaseEntity { /* ### VARIABLES ################################################ # */ protected static array $ATTRIBUTES = [ "date_create" => Attribute\DateTime::class, "creator_name" => "creator_name", "creator" => "creator", ]; /* ### PUBLIC FUNCTIONS ######################################### # */ public function getCreator() { if( $class = $this->getCreatorClass() ) { return $class::get( $this->created_by ); } } public function getCreatorClass() { if( !$this->created_by ) return NULL; $prefix = explode( "_", $this->created_by ); $prefix = current( $prefix ); if( $prefix == Plugins\Users\Model::getHashIDPrefix() ) { return Plugins\Users\Model::class; } return FALSE; } public function getCreatorName() { if( $class = $this->getCreatorClass() ) { return $class::getValue( $this->created_by, "username" ); } } } /** Datei: plugins/logs/hooks/model/updated.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @hook model::updated * @param mixed $result save result * @param string $table Current Database Table Name * @param object $query Database\QueryBuilder Object * @param string $hook Hook type/name * @param array $changed changed Data * @param string $class Current static class * * @since 1.0.0 File is created */ use ARUNOX\Core\Hooks; use ARUNOX\Plugins\Logs; use ARUNOX\Plugins\Users; if( $result === FALSE ) return $result; if( is_string( $result ) ) $originHID = $result; elseif( is_numeric( $result ) ) $originHID = $class::getHashID( $result ); /* ### LOAD CLASSES ################################################# # */ $modelClass = ARUNOX\Plugins\Logs\Model::resolveTable( $table ); $ctrlClass = $modelClass::getControllerClass(); if( $modelClass ) $rules = $modelClass::getLogRulesUpdated( $result ); /* ### FILTER RULES ################################################# # */ $changed = array_merge( $changed, [ "__self" => TRUE ] ); $rules = Hooks::filter("logs.rules::{$hook}->{$table}", $rules ?? [], $hook, $table, $result ); $rules = array_intersect_key( $rules, $changed ); // show( $modelClass, $hook, $rules, $changed ); if( !$rules || !$ctrlClass ) return $result; $action = explode( "_", $table ); $action = implode(".", $action ); $action = strtolower( $action ); // show( $hook, $rules, $changed ); /* ### CREATE LOGS ################################################## # */ foreach( $rules as $column => $rule ) { if( is_string( $rule ) ) $rule = [ "message" => $rule ]; $targetHIDs = (array)( $rule["target_hids"] ?? [] ); $value = $changed[ $column ]; $message = $rule["message"] ?? "%3\$T wurde geändert zu '%4\$t'"; $arguments = [ /* 1 */ $ctrlClass::getSingular(), /* 2 */ $originHID, /* 3 */ $column, /* 4 */ $changed[ $column ], ...(array)($rule["arguments"] ?? []) ]; if( preg_match( '/_hid$/', $column ) ) $targetHIDs[] = $changed[ $column ]; if( isset( $rule["class"] ) ) $targetHIDs[] = $rule["class"]::get( $changed[ $column ] )->hashid; $targetHIDs = array_unique( $targetHIDs ); $targetHIDs = array_filter( $targetHIDs ); if( isset( $rule["options"][ $value ]["label"] ) ) $arguments[3] = $rule["options"][ $value ]["label"]; // show( $column, $message, $targetHIDs, $arguments, $rule ); Logs\Model::save([ // show([ "source_hid" => $originHID, "target_hids" => $targetHIDs, "created_by" => Users\Model::get()->hashid, "action" => "{$action}::{$hook}->{$column}", "message" => __( $message, ...$arguments ), // ], FALSE ); ]); } return $result; /** Datei: plugins/logs/hooks/model/created.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @hook model::created * @param mixed $result save result * @param string $table Current Database Table Name * @param object $query Database\QueryBuilder Object * @param string $hook Hook type/name * @param array $changed changed Data * @param string $class Current static class * * @since 1.0.0 File is created */ use ARUNOX\Core\Hooks; use ARUNOX\Plugins\Logs; use ARUNOX\Plugins\Users; if( $result === FALSE ) return $result; if( is_string( $result ) ) $originHID = $result; elseif( is_numeric( $result ) ) $originHID = $class::getHashID( $result ); /* ### LOAD CLASSES ################################################# # */ $modelClass = ARUNOX\Plugins\Logs\Model::resolveTable( $table ); $ctrlClass = $modelClass::getControllerClass(); if( $modelClass ) $rules = $modelClass::getLogRulesCreated( $result ); /* ### FILTER RULES ################################################# # */ $changed = array_merge( $changed, [ "__self" => TRUE ] ); $rules = Hooks::filter("logs.rules::{$hook}->{$table}", $rules ?? [], $hook, $table, $result ); $rules = array_intersect_key( $rules, $changed ); // show( $modelClass, $hook, $rules, $changed ); if( !$rules || !$ctrlClass ) return $result; $action = explode( "_", $table ); $action = implode(".", $action ); $action = strtolower( $action ); // show( $hook, $rules, $changed ); /* ### CREATE LOGS ################################################## # */ foreach( $rules as $column => $rule ) { if( is_string( $rule ) ) $rule = [ "message" => $rule ]; $originHID = $rule["origin_hid"] ?? $originHID; $targetHIDs = (array)( $rule["target_hids"] ?? [] ); $value = $changed[ $column ]; $message = $rule["message"] ?? "%1\$t wurde erstellt"; $arguments = [ /* 1 */ $ctrlClass::getSingular(), /* 2 */ $originHID, /* 3 */ $column, /* 4 */ $changed[ $column ], ...(array)($rule["arguments"] ?? []) ]; if( preg_match( '/_hid$/', $column ) ) $targetHIDs[] = $changed[ $column ]; if( isset( $rule["class"] ) ) $targetHIDs[] = $rule["class"]::get( $changed[ $column ] )->hashid; $targetHIDs = array_unique( $targetHIDs ); $targetHIDs = array_filter( $targetHIDs ); // show( $column, $message, $targetHIDs, $arguments, $rule ); Logs\Model::save([ "source_hid" => $originHID, "target_hids" => $targetHIDs, "created_by" => Users\Model::get()->hashid, "action" => "{$action}::{$hook}", "message" => __( $message, ...$arguments ), ]); } return $result; /** Datei: plugins/logs/config.php **/ * @copyright 2025 ARUNOX * @version 1.0.0 * * @preload TRUE * @system-need ALL * @dependencies users * * @since 1.0.0 Plugin initial erstellt */ /** Datei: plugins/logs/config/schema/v1.0.0.php **/ [ 'columns' => [ 'id' => 'INT NOT NULL AUTO_INCREMENT', 'hashid' => 'VARCHAR(32) NOT NULL', 'date_create' => 'DATETIME NOT NULL', 'created_by' => 'VARCHAR(32) NOT NULL', 'action' => 'VARCHAR(64) NOT NULL', 'message' => 'TEXT NOT NULL', 'target_id' => 'VARCHAR(32) DEFAULT NULL', 'context_data' => 'TEXT DEFAULT NULL', ], 'primary' => ['id'], 'unique' => ['hashid'], 'indexes' => ['created_by', 'action', 'target_id'], 'engine' => 'InnoDB', 'charset' => 'utf8mb3', ] ];