MDL-32009 messaging: Add message processor uninstall functionality

admin/message.php

@@ -34,6 +34,10 @@ require_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM));
 // Get the submitted params
 $disable    = optional_param('disable', 0, PARAM_INT);
 $enable     = optional_param('enable', 0, PARAM_INT);
+$uninstall  = optional_param('uninstall', 0, PARAM_INT);
+$confirm  = optional_param('confirm', false, PARAM_BOOL);
+
+$headingtitle = get_string('managemessageoutputs', 'message');
 
 if (!empty($disable) && confirm_sesskey()) {
     if (!$processor = $DB->get_record('message_processors', array('id'=>$disable))) {
@@ -42,14 +46,37 @@ if (!empty($disable) && confirm_sesskey()) {
     $DB->set_field('message_processors', 'enabled', '0', array('id'=>$processor->id));      // Disable output
 }
 
-if (!empty($enable) && confirm_sesskey() ) {
+if (!empty($enable) && confirm_sesskey()) {
     if (!$processor = $DB->get_record('message_processors', array('id'=>$enable))) {
         print_error('outputdoesnotexist', 'message');
     }
     $DB->set_field('message_processors', 'enabled', '1', array('id'=>$processor->id));      // Enable output
 }
 
-if ($disable || $enable) {
+if (!empty($uninstall) && confirm_sesskey()) {
+    echo $OUTPUT->header();
+    echo $OUTPUT->heading($headingtitle);
+
+    if (!$processor = $DB->get_record('message_processors', array('id'=>$uninstall))) {
+        print_error('outputdoesnotexist', 'message');
+    }
+
+    $processorname = get_string('pluginname', 'message_'.$processor->name);
+
+    if (!$confirm) {
+        echo $OUTPUT->confirm(get_string('processordeleteconfirm', 'message', $processorname), 'message.php?uninstall='.$processor->id.'&confirm=1', 'message.php');
+        echo $OUTPUT->footer();
+        exit;
+
+    } else {
+        message_processor_uninstall($processor->name);
+        $a->processor = $processorname;
+        $a->directory = $CFG->dirroot.'/message/output/'.$processor->name;
+        notice(get_string('processordeletefiles', 'message', $a), 'message.php');
+    }
+}
+
+if ($disable || $enable || $uninstall) {
     $url = new moodle_url('message.php');
     redirect($url);
 }
@@ -65,6 +92,6 @@ $messageoutputs = $renderer->manage_messageoutputs($processors);
 
 // Display the page
 echo $OUTPUT->header();
-echo $OUTPUT->heading(get_string('managemessageoutputs', 'message'));
+echo $OUTPUT->heading($headingtitle);
 echo $messageoutputs;
 echo $OUTPUT->footer();

lang/en/message.php

@@ -108,6 +108,8 @@ $string['permitted'] = 'Permitted';
 $string['page-message-x'] = 'Any message pages';
 $string['private_config'] = 'Popup message window';
 $string['processortag'] = 'Destination';
+$string['processordeleteconfirm'] = 'You are about to completely delete message processor \'{$a}\'.  This will completely delete everything in the database associated with this processor. Are you SURE you want to continue?';
+$string['processordeletefiles'] = 'All data associated with the processor \'{$a->processor}\' has been deleted from the database.  To complete the deletion (and prevent the processor re-installing itself), you should now delete this directory from your server: {$a->directory}';
 $string['providers_config'] = 'Configure notification methods for incoming messages';
 $string['providerstag'] = 'Source';
 $string['recent'] = 'Recent';

lib/messagelib.php

@@ -480,6 +480,7 @@ function message_processor_uninstall($name) {
 
     $transaction = $DB->start_delegated_transaction();
     $DB->delete_records('message_processors', array('name' => $name));
+    $DB->delete_records_select('config_plugins', "plugin = ?", array("message_{$name}"));
     // delete permission preferences only, we do not care about loggedin/loggedoff
     // defaults, they will be removed on the next attempt to update the preferences
     $DB->delete_records_select('config_plugins', "plugin = 'message' AND ".$DB->sql_like('name', '?', false), array("{$name}_provider_%"));

lib/pluginlib.php

@@ -2309,6 +2309,18 @@ class plugininfo_message extends plugininfo_base {
             return parent::is_enabled();
         }
     }
+
+    /**
+     * @see plugintype_interface::get_uninstall_url()
+     */
+    public function get_uninstall_url() {
+        $processors = get_message_processors();
+        if (isset($processors[$this->name])) {
+            return new moodle_url('message.php', array('uninstall' => $processors[$this->name]->id, 'sesskey' => sesskey()));
+        } else {
+            return parent::get_uninstall_url();
+        }
+    }
 }