Merge branch 'MDL-61076-master' of https://github.com/sammarshallou/moodle

admin/searchareas.php

@@ -35,10 +35,7 @@ try {
     // Continue, we return an error later depending on the requested action.
 }
 
-echo $OUTPUT->header();
-
 if ($action) {
-    require_sesskey();
 
     if ($areaid) {
         // We need to check that the area exists.
@@ -48,45 +45,76 @@ if ($action) {
         }
     }
 
-    // All actions but enable/disable need the search engine to be ready.
     if ($action !== 'enable' && $action !== 'disable') {
+        // All actions but enable/disable need the search engine to be ready.
         if (!empty($searchmanagererror)) {
             throw $searchmanagererror;
         }
+
+        // Show confirm prompt for all these actions as they may be inadvisable, or may cause
+        // an interruption in search functionality, on production systems.
+        if (!optional_param('confirm', 0, PARAM_INT)) {
+            // Display confirmation prompt.
+            $a = null;
+            if ($areaid) {
+                $a = html_writer::tag('strong', $area->get_visible_name());
+            }
+
+            $actionparams = ['sesskey' => sesskey(), 'action' => $action, 'confirm' => 1];
+            if ($areaid) {
+                $actionparams['areaid'] = $areaid;
+            }
+            $actionurl = new moodle_url('/admin/searchareas.php', $actionparams);
+            $cancelurl = new moodle_url('/admin/searchareas.php');
+            echo $OUTPUT->header();
+            echo $OUTPUT->confirm(get_string('confirm_' . $action, 'search', $a),
+                    new single_button($actionurl, get_string('continue'), 'post', true),
+                    new single_button($cancelurl, get_string('cancel'), 'get'));
+            echo $OUTPUT->footer();
+            exit;
+        }
     }
 
+    // We are now taking an actual action, so require sesskey.
+    require_sesskey();
+
     switch ($action) {
         case 'enable':
             $area->set_enabled(true);
-            echo $OUTPUT->notification(get_string('searchareaenabled', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
+            \core\notification::add(get_string('searchareaenabled', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
             break;
         case 'disable':
             $area->set_enabled(false);
-            echo $OUTPUT->notification(get_string('searchareadisabled', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
+            \core\notification::add(get_string('searchareadisabled', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
             break;
         case 'delete':
             $search = \core_search\manager::instance();
             $search->delete_index($areaid);
-            echo $OUTPUT->notification(get_string('searchindexdeleted', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
+            \core\notification::add(get_string('searchindexdeleted', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
             break;
         case 'indexall':
             $searchmanager->index();
-            echo $OUTPUT->notification(get_string('searchindexupdated', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
+            \core\notification::add(get_string('searchindexupdated', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
             break;
         case 'reindexall':
             $searchmanager->index(true);
-            echo $OUTPUT->notification(get_string('searchreindexed', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
+            \core\notification::add(get_string('searchreindexed', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
             break;
         case 'deleteall':
             $searchmanager->delete_index();
-            echo $OUTPUT->notification(get_string('searchalldeleted', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
+            \core\notification::add(get_string('searchalldeleted', 'admin'), \core\output\notification::NOTIFY_SUCCESS);
             break;
         default:
             throw new moodle_exception('invalidaction');
             break;
     }
+
+    // Redirect back to the main page after taking action.
+    redirect(new moodle_url('/admin/searchareas.php'));
 }
 
+echo $OUTPUT->header();
+
 $searchareas = \core_search\manager::get_search_areas_list();
 if (empty($searchmanagererror)) {
     $areasconfig = $searchmanager->get_areas_config($searchareas);
@@ -192,9 +220,12 @@ echo $OUTPUT->footer();
  * @return moodle_url
  */
 function admin_searcharea_action_url($action, $areaid = false) {
-    $params = array('action' => $action, 'sesskey' => sesskey());
+    $params = array('action' => $action);
     if ($areaid) {
         $params['areaid'] = $areaid;
     }
+    if ($action === 'disable' || $action === 'enable') {
+        $params['sesskey'] = sesskey();
+    }
     return new moodle_url('/admin/searchareas.php', $params);
 }

admin/tests/behat/search_areas.feature

@@ -0,0 +1,21 @@
+@core @core_admin
+Feature: Use the search areas admin screen
+  In order to control search indexing
+  As an admin
+  I need to use the search areas admin screen
+
+  Background:
+    Given I log in as "admin"
+    And I navigate to "Plugins > Search > Search areas" in site administration
+
+  Scenario: Disable and enable a search area
+    When I click on "Disable" "link" in the "Book - resource information" "table_row"
+    Then I should see "Search area disabled" in the ".alert-success" "css_element"
+    And I should see "Search area disabled" in the "Book - resource information" "table_row"
+
+    When I click on "Enable" "link" in the "Book - resource information" "table_row"
+    Then I should see "Search area enabled" in the ".alert-success" "css_element"
+    And I should not see "Search area disabled" in the "Book - resource information" "table_row"
+
+  # Note: Other scenarios are not currently easy to implement in Behat because there is no mock
+  # search engine - we could add testing once Moodle has an internal database search engine.

lang/en/search.php

@@ -31,6 +31,10 @@ $string['authorname'] = 'Author name';
 $string['back'] = 'Back';
 $string['beadmin'] = 'You need to be an admin user to use this page.';
 $string['commenton'] = 'Comment on';
+$string['confirm_delete'] = 'Are you sure you want to delete the index for {$a}? Until the search area is indexed, users will not get search results from this area.';
+$string['confirm_indexall'] = 'Are you sure you want to update indexed contents now? If a large amount of content needs indexing, this can take a long time. For live servers, you should normally leave indexing to the \'Global search indexing\' scheduled task.';
+$string['confirm_reindexall'] = 'Are you sure you want to reindex all site contents now? If your site contains a large amount of content, this will take a long time, and users may not get full search results until it completes.';
+$string['confirm_deleteall'] = 'Are you sure you want to delete all indexed contents now? Until the site is indexed again, users will not get search results.';
 $string['createanindex'] = 'create an index';
 $string['createdon'] = 'Created on';
 $string['database'] = 'Database';