Added AbuseIPDB support, including settings management and error handling.

Author: Grandi0z

modules/core/handler_modules.php

@@ -1017,20 +1017,58 @@ public function process() {
 class Hm_Handler_process_spam_report_settings extends Hm_Handler_Module {
     public function process() {
         list($success, $form) = $this->process_form(array('save_settings'));
-        if (!$success || !array_key_exists('spamcop_settings', $this->request->post)) {
+        if (!$success) {
             return;
         }
 
         $new_settings = $this->get('new_user_settings', array());
-        $spamcop = $this->request->post['spamcop_settings'];
 
-        $set_email_setting = function($key, $value) use (&$new_settings) {
-            $new_settings[$key] = (!empty($value) && filter_var($value, FILTER_VALIDATE_EMAIL)) ? $value : '';
+        // Helper function for validation
+        $set_setting = function($key, $value, $validator = null) use (&$new_settings) {
+            if ($validator && !$validator($value)) {
+                $new_settings[$key] = '';
+            } else {
+                $new_settings[$key] = $value;
+            }
         };
 
-        $new_settings['spamcop_enabled_setting'] = isset($spamcop['enabled']);
-        $set_email_setting('spamcop_submission_email_setting', $spamcop['submission_email'] ?? '');
-        $set_email_setting('spamcop_from_email_setting', $spamcop['from_email'] ?? '');
+        // Process SpamCop settings
+        if (array_key_exists('spamcop_settings', $this->request->post)) {
+            $spamcop = $this->request->post['spamcop_settings'];
+            $new_settings['spamcop_enabled_setting'] = isset($spamcop['enabled']);
+            $set_setting('spamcop_submission_email_setting', $spamcop['submission_email'] ?? '', function($v) {
+                return filter_var($v, FILTER_VALIDATE_EMAIL);
+            });
+            $set_setting('spamcop_from_email_setting', $spamcop['from_email'] ?? '', function($v) {
+                return filter_var($v, FILTER_VALIDATE_EMAIL);
+            });
+        }
+
+        // Process AbuseIPDB settings
+        if (array_key_exists('abuseipdb_settings', $this->request->post)) {
+            $abuseipdb = $this->request->post['abuseipdb_settings'];
+            $new_settings['abuseipdb_enabled_setting'] = isset($abuseipdb['enabled']);
+            
+            // Handle API key: if field is empty but api_key_set flag is present, preserve original key
+            $api_key = $abuseipdb['api_key'] ?? '';
+            $api_key_was_set = isset($abuseipdb['api_key_set']) && $abuseipdb['api_key_set'] == '1';
+            
+            if (empty($api_key) && $api_key_was_set) {
+                // User left field empty but key was originally set - preserve the original key
+                $original_key = $this->user_config->get('abuseipdb_api_key_setting', '');
+                if (!empty($original_key)) {
+                    $new_settings['abuseipdb_api_key_setting'] = $original_key;
+                } else {
+                    $new_settings['abuseipdb_api_key_setting'] = '';
+                }
+            } else {
+                // User entered a new value (or cleared it) - validate and set it
+                $set_setting('abuseipdb_api_key_setting', $api_key, function($v) {
+                    // API key validation: non-empty string, reasonable length (10-200 chars)
+                    return !empty($v) && strlen($v) >= 10 && strlen($v) <= 200;
+                });
+            }
+        }
 
         $this->out('new_user_settings', $new_settings, false);
     }

modules/core/output_modules.php

@@ -2379,6 +2379,56 @@ protected function output() {
     }
 }
 
+/**
+ * Option to enable/disable AbuseIPDB reporting
+ * @subpackage core/output
+ */
+class Hm_Output_abuseipdb_enabled_setting extends Hm_Output_Module {
+    protected function output() {
+        $settings = $this->get('user_settings', array());
+        $enabled = get_setting_value($settings, 'abuseipdb_enabled', false);
+        $checked = $enabled ? ' checked="checked"' : '';
+        $reset = $enabled ? '<span class="tooltip_restore" restore_aria_label="Restore default value"><i class="bi bi-arrow-counterclockwise refresh_list reset_default_value_checkbox"></i></span>' : '';
+        
+        return '<tr class="report_spam_setting"><td><label class="form-check-label" for="abuseipdb_enabled">'.
+            $this->trans('Enable AbuseIPDB reporting').'</label></td>'.
+            '<td><input class="form-check-input" type="checkbox" '.$checked.' id="abuseipdb_enabled" name="abuseipdb_settings[enabled]" data-default-value="false" value="1" />'.$reset.'</td></tr>';
+    }
+}
+
+/**
+ * Option for AbuseIPDB API key
+ * @subpackage core/output
+ */
+class Hm_Output_abuseipdb_api_key_setting extends Hm_Output_Module {
+    protected function output() {
+        $settings = $this->get('user_settings', array());
+        $api_key = get_setting_value($settings, 'abuseipdb_api_key', '');
+        
+        // Mask API key if it exists - show empty field with indicator
+        // The handler will preserve the original key if empty value is submitted
+        $display_value = '';
+        $placeholder = $this->trans('Your AbuseIPDB API key');
+        
+        if (!empty($api_key)) {
+            // Show empty field but indicate key is set via placeholder
+            // User must enter new value to change it, or leave empty to keep current
+            $placeholder = $this->trans('API key is set (••••••••) - enter new value to change');
+        }
+        
+        $reset = !empty($api_key) ? '<span class="tooltip_restore" restore_aria_label="Restore default value"><i class="bi bi-arrow-counterclockwise refresh_list reset_default_value_input"></i></span>' : '';
+        
+        // Add a hidden field to track if API key was originally set
+        // This helps the handler know to preserve the key if field is left empty
+        $hidden_field = !empty($api_key) ? '<input type="hidden" name="abuseipdb_settings[api_key_set]" value="1" />' : '';
+        
+        return '<tr class="report_spam_setting"><td><label for="abuseipdb_api_key">'.
+            $this->trans('AbuseIPDB API Key').'</label></td>'.
+            '<td class="d-flex">'.$hidden_field.
+            '<input class="form-control form-control-sm" type="password" id="abuseipdb_api_key" name="abuseipdb_settings[api_key]" value="'.$this->html_safe($display_value).'" placeholder="'.$placeholder.'" autocomplete="off" />'.$reset.'</td></tr>';
+    }
+}
+
 /**
  * Option to warn user when he has unsaved changes.
  * @subpackage imap/output

modules/core/setup.php

@@ -106,7 +106,9 @@
 add_output('settings', 'spamcop_enabled_setting', true, 'core', 'start_report_spam_settings', 'after');
 add_output('settings', 'spamcop_submission_email_setting', true, 'core', 'spamcop_enabled_setting', 'after');
 add_output('settings', 'spamcop_from_email_setting', true, 'core', 'spamcop_submission_email_setting', 'after');
-add_output('settings', 'start_everything_settings', true, 'core', 'spamcop_from_email_setting', 'after');
+add_output('settings', 'abuseipdb_enabled_setting', true, 'core', 'spamcop_from_email_setting', 'after');
+add_output('settings', 'abuseipdb_api_key_setting', true, 'core', 'abuseipdb_enabled_setting', 'after');
+add_output('settings', 'start_everything_settings', true, 'core', 'abuseipdb_api_key_setting', 'after');
 add_output('settings', 'all_since_setting', true, 'core', 'start_everything_settings', 'after');
 add_output('settings', 'all_source_max_setting', true, 'core', 'all_since_setting', 'after');
 add_output('settings', 'start_all_email_settings', true, 'core', 'all_source_max_setting', 'after');
@@ -366,5 +368,6 @@
         'images_whitelist' => FILTER_UNSAFE_RAW,
         'update' => FILTER_VALIDATE_BOOLEAN,
         'spamcop_settings' => array('filter' => FILTER_UNSAFE_RAW, 'flags' => FILTER_FORCE_ARRAY),
+        'abuseipdb_settings' => array('filter' => FILTER_UNSAFE_RAW, 'flags' => FILTER_FORCE_ARRAY),
     )
 );