[5.3][com_actionlogs] exclude self from mail notification (#44640)

Author: alikon

administrator/components/com_actionlogs/src/Model/ActionlogModel.php

@@ -126,7 +126,7 @@ protected function sendNotificationEmails($messages, $username, $context)
         $query = $db->getQuery(true);
 
         $query
-            ->select($db->quoteName(['u.email', 'l.extensions']))
+            ->select($db->quoteName(['u.email', 'u.username', 'l.extensions', 'l.exclude_self']))
             ->from($db->quoteName('#__users', 'u'))
             ->where($db->quoteName('u.block') . ' = 0')
             ->join(
@@ -142,6 +142,10 @@ protected function sendNotificationEmails($messages, $username, $context)
         $recipients = [];
 
         foreach ($users as $user) {
+            if ($user->username === $this->getCurrentUser()->username && $user->exclude_self) {
+                continue;
+            }
+
             $extensions = json_decode($user->extensions, true);
 
             if ($extensions && \in_array(strtok($context, '.'), $extensions)) {

administrator/components/com_admin/sql/updates/mysql/5.3.0-2024-12-19.sql

@@ -0,0 +1 @@
+ALTER TABLE `#__action_logs_users` ADD COLUMN `exclude_self` tinyint NOT NULL DEFAULT 0;

administrator/components/com_admin/sql/updates/postgresql/5.3.0-2024-12-19.sql

@@ -0,0 +1 @@
+ALTER TABLE "#__action_logs_users" ADD COLUMN "exclude_self" integer DEFAULT 0 NOT NULL;

administrator/language/en-GB/plg_system_actionlogs.ini

@@ -10,6 +10,7 @@ PLG_SYSTEM_ACTIONLOGS_INFO_LABEL="Information"
 PLG_SYSTEM_ACTIONLOGS_JOOMLA_ACTIONLOG_DISABLED="Action Log - Joomla"
 PLG_SYSTEM_ACTIONLOGS_JOOMLA_ACTIONLOG_DISABLED_REDIRECT="The %s plugin is disabled."
 PLG_SYSTEM_ACTIONLOGS_NOTIFICATIONS="Email Notifications"
+PLG_SYSTEM_ACTIONLOGS_NOTIFICATIONS_EXCLUDE="Exclude Self"
 PLG_SYSTEM_ACTIONLOGS_OPTIONS="User Actions Log Options"
 PLG_SYSTEM_ACTIONLOGS_XML_DESCRIPTION="Records the actions of users on the site so they can be reviewed if required."
 ; Common content type log messages

installation/sql/mysql/extensions.sql

@@ -887,6 +887,7 @@ CREATE TABLE IF NOT EXISTS `#__action_logs_users` (
   `user_id` int UNSIGNED NOT NULL,
   `notify` tinyint UNSIGNED NOT NULL,
   `extensions` text NOT NULL,
+  `exclude_self` tinyint UNSIGNED NOT NULL DEFAULT 0,
   PRIMARY KEY (`user_id`),
   KEY `idx_notify` (`notify`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 DEFAULT COLLATE=utf8mb4_unicode_ci;

installation/sql/postgresql/extensions.sql

@@ -848,6 +848,7 @@ CREATE TABLE "#__action_logs_users" (
   "user_id" integer NOT NULL,
   "notify" integer NOT NULL,
   "extensions" text NOT NULL,
+  "exclude_self" integer NOT NULL DEFAULT 0,
   PRIMARY KEY ("user_id")
 );
 

plugins/system/actionlogs/forms/actionlogs.xml

@@ -24,6 +24,18 @@
 				showon="actionlogsNotify:1"
 				default="com_content"
 			/>
+			<field
+				name="actionlogsExcludeSelf"
+				type="radio"
+				label="PLG_SYSTEM_ACTIONLOGS_NOTIFICATIONS_EXCLUDE"
+				layout="joomla.form.field.radio.switcher"
+				showon="actionlogsNotify:1"
+				default="0"
+				filter="integer"
+				>
+				<option value="0">JNO</option>
+				<option value="1">JYES</option>
+			</field>
 		</fields>
 	</fieldset>
 </form>

plugins/system/actionlogs/src/Extension/ActionLogs.php

@@ -151,7 +151,7 @@ public function onContentPrepareData($context, $data)
         $id = (int) $data->id;
 
         $query = $db->getQuery(true)
-            ->select($db->quoteName(['notify', 'extensions']))
+            ->select($db->quoteName(['notify', 'extensions', 'exclude_self']))
             ->from($db->quoteName('#__action_logs_users'))
             ->where($db->quoteName('user_id') . ' = :userid')
             ->bind(':userid', $id, ParameterType::INTEGER);
@@ -169,9 +169,10 @@ public function onContentPrepareData($context, $data)
         // Load plugin language files.
         $this->loadLanguage();
 
-        $data->actionlogs                       = new \stdClass();
-        $data->actionlogs->actionlogsNotify     = $values->notify;
-        $data->actionlogs->actionlogsExtensions = $values->extensions;
+        $data->actionlogs                        = new \stdClass();
+        $data->actionlogs->actionlogsNotify      = $values->notify;
+        $data->actionlogs->actionlogsExtensions  = $values->extensions;
+        $data->actionlogs->actionlogsExcludeSelf = $values->exclude_self;
 
         if (!HTMLHelper::isRegistered('users.actionlogsNotify')) {
             HTMLHelper::register('users.actionlogsNotify', [__CLASS__, 'renderActionlogsNotify']);
@@ -181,6 +182,10 @@ public function onContentPrepareData($context, $data)
             HTMLHelper::register('users.actionlogsExtensions', [__CLASS__, 'renderActionlogsExtensions']);
         }
 
+        if (!HTMLHelper::isRegistered('users.actionlogsExcludeSelf')) {
+            HTMLHelper::register('users.actionlogsExcludeSelf', [__CLASS__, 'renderActionlogsExcludeSelf']);
+        }
+
         return true;
     }
 
@@ -227,9 +232,10 @@ public function onUserAfterSave($user, $isNew, $success, $msg): void
         // If preferences don't exist, insert.
         if (!$exists && $authorised && isset($user['actionlogs'])) {
             $notify  = (int) $user['actionlogs']['actionlogsNotify'];
-            $values  = [':userid', ':notify'];
-            $bind    = [$userid, $notify];
-            $columns = ['user_id', 'notify'];
+            $exclude = (int) $user['actionlogs']['actionlogsExcludeSelf'];
+            $values  = [':userid', ':notify', ':exclude'];
+            $bind    = [$userid, $notify, $exclude];
+            $columns = ['user_id', 'notify', 'exclude_self'];
 
             $query->bind($values, $bind, ParameterType::INTEGER);
 
@@ -250,6 +256,11 @@ public function onUserAfterSave($user, $isNew, $success, $msg): void
 
             $query->bind(':notify', $notify, ParameterType::INTEGER);
 
+            $exclude  = (int) $user['actionlogs']['actionlogsExcludeSelf'];
+            $values[] = $db->quoteName('exclude_self') . ' = :exclude';
+
+            $query->bind(':exclude', $exclude, ParameterType::INTEGER);
+
             if (isset($user['actionlogs']['actionlogsExtensions'])) {
                 $values[]  = $db->quoteName('extensions') . ' = :extension';
                 $extension = json_encode($user['actionlogs']['actionlogsExtensions']);
@@ -324,6 +335,20 @@ public static function renderActionlogsNotify($value)
         return Text::_($value ? 'JYES' : 'JNO');
     }
 
+    /**
+     * Method to render a value.
+     *
+     * @param   integer|string  $value  The value (0 or 1).
+     *
+     * @return  string  The rendered value.
+     *
+     * @since   __DEPLOY_VERSION_
+     */
+    public static function renderActionlogsExcludeSelf($value)
+    {
+        return Text::_($value ? 'JYES' : 'JNO');
+    }
+
     /**
      * Method to render a list of extensions.
      *
@@ -373,7 +398,7 @@ public function onExtensionAfterSave($context, $table, $isNew): void
         $db = $this->getDatabase();
 
         $query = $db->getQuery(true)
-            ->select($db->quoteName(['user_id', 'notify', 'extensions']))
+            ->select($db->quoteName(['user_id', 'notify', 'extensions', 'exclude_self']))
             ->from($db->quoteName('#__action_logs_users'));
 
         try {