last-login: Add abstracted way to update custom fields

Author: slusarz

data/settings.js

@@ -2600,7 +2600,7 @@ last_login {
 		plugin: 'last-login',
 		values: setting_types.STRING,
 		text: `
-The key that is updated in the dictionary with the last login information.`
+The key that is updated in the dictionary with the last login timestamp.`
 	},
 
 	last_login_precision: {
@@ -2611,6 +2611,18 @@ The key that is updated in the dictionary with the last login information.`
 		text: `Precision for last login timestamp.`
 	},
 
+	last_login_dict_fields: {
+		default: '',
+		added: {
+			settings_last_login_dict_fields_added: false
+		},
+		plugin: 'last-login',
+		values: setting_types.STRLIST,
+		text: `
+List of additional key/value pairs to be updated in the
+dictionary. Both keys and values support variable expansion.`
+	},
+
 	/* lazy-expunge plugin */
 
 	lazy_expunge_mailbox: {

data/updates.js

@@ -156,6 +156,7 @@ export const updates = {
 	settings_imapc_ssl_verify_removed: '2.4.0',
 	settings_inet_listener_type_added: '2.4.0',
 	settings_lazy_expunge_only_last_instance_changed: '2.4.3',
+	settings_last_login_dict_fields_added: '2.4.X',
 	settings_login_socket_path_added: '2.4.0',
 	settings_lmtp_user_concurrency_limit_changed: '2.4.1',
 	settings_mail_access_groups_changed: '2.4.3',

docs/core/plugins/last_login.md

@@ -60,7 +60,9 @@ to include `%{service}`.
 
 ### MySQL Example
 
-This includes the service and remote IP address as well.
+This includes the service and remote IP address as well. Using
+`last_login_dict_fields` ensures that both the timestamp and the IP address are
+updated if a login record for that user/service already exists.
 
 ::: code-group
 
@@ -69,7 +71,10 @@ last_login {
   dict proxy {
     name = sql
   }
-  key = last-login/%{service}/%{user}/%{remote_ip}
+  key = last-login/%{service}/%{user}/access
+  last_login_dict_fields {
+    ip = %{remote_ip}
+  }
   precision = ms
 }
 
@@ -82,7 +87,7 @@ dict_server {
       password = pass
     }
 
-    dict_map shared/last-login/$service/$user/$remote_ip {
+    dict_map shared/last-login/$service/$user/access {
       sql_table = last_login
       value_field last_access {
         type = uint
@@ -94,8 +99,18 @@ dict_server {
       key_field service {
         value = $service
       }
-      key_field last_ip {
-        value = $remote_ip
+    }
+
+    dict_map shared/last-login/$service/$user/ip {
+      sql_table = last_login
+      value_field last_ip {
+      }
+
+      key_field userid {
+        value = $user
+      }
+      key_field service {
+        value = $service
       }
     }
   }
@@ -125,7 +140,10 @@ last_login {
     name = cassandra
     socket_path = dict-async
   }
-  key = last-login/%{service}/%{user}/%{remote_ip}
+  key = last-login/%{service}/%{user}/access
+  last_login_dict_fields {
+    ip = %{remote_ip}
+  }
   precision = ms
 }
 
@@ -140,7 +158,7 @@ dict_server {
       password = pass
     }
 
-    dict_map shared/last-login/$service/$user/$remote_ip {
+    dict_map shared/last-login/$service/$user/access {
       sql_table = last_login
       value_field last_access {
         type = uint
@@ -152,8 +170,18 @@ dict_server {
       key_field service {
         value = $service
       }
-      key_field last_ip {
-        value = $remote_ip
+    }
+
+    dict_map shared/last-login/$service/$user/ip {
+      sql_table = last_login
+      value_field last_ip {
+      }
+
+      key_field userid {
+        value = $user
+      }
+      key_field service {
+        value = $service
       }
     }
   }