MDL-73848 administration: Fix the breadcrumbs and nav highlights

Create or update the breadcrumbs in the site administration
pages where it is required.
Highlight the corresponding site adminstration tab.
Highlight the primary nav to Site administration when user
is navigating to any of the site administration pages.

Also changed the boostnavbar so that the nodes in the secondary
navigation are not shown in the breadcrumbs when user is in site
administration page.

admin/index.php

@@ -825,6 +825,7 @@
 $SESSION->admin_critical_warning = ($insecuredataroot==INSECURE_DATAROOT_ERROR);
 
 $adminroot = admin_get_root();
+$PAGE->set_primary_active_tab('siteadminnode');
 
 // Check if there are any new admin settings which have still yet to be set
 if (any_new_admin_settings($adminroot)) {

admin/plugins.php

@@ -52,6 +52,8 @@
 
 $pluginman = core_plugin_manager::instance();
 
+$PAGE->set_primary_active_tab('siteadminnode');
+
 if ($uninstall) {
 
     if (!$confirmed) {

admin/roles/allow.php

@@ -49,6 +49,9 @@
     redirect($baseurl);
 }
 
+$PAGE->set_secondary_active_tab('users');
+$PAGE->set_primary_active_tab('siteadminnode');
+
 $controller->load_current_settings();
 
 // Display the editing form.

admin/roles/define.php

@@ -87,6 +87,10 @@
     $title = get_string('editingrolex', 'core_role', $rolenames[$roleid]->localname);
 }
 
+$PAGE->set_secondary_active_tab('users');
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->navbar->add($title, $baseurl);
+
 // Decide how to create new role.
 if ($action === 'add' and $resettype !== 'none') {
     $mform = new core_role_preset_form(null, array('action'=>'add', 'roleid'=>0, 'resettype'=>'0', 'return'=>'manage'));

admin/roles/manage.php

@@ -60,6 +60,9 @@
 $undeletableroles[$CFG->guestroleid] = 1;
 $undeletableroles[$CFG->defaultuserroleid] = 1;
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->navbar->add(get_string('defineroles', 'role'), $PAGE->url);
+
 // Process submitted data.
 $confirmed = (optional_param('confirm', false, PARAM_BOOL) && data_submitted() && confirm_sesskey());
 switch ($action) {

admin/searchareas.php

@@ -37,6 +37,8 @@
     // In action cases, we'll throw this exception below. In non-action cases, we produce a lang string error.
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+
 // Handle all the actions.
 if ($action) {
     // If dealing with an areaid, we need to check that the area exists.

admin/searchreindex.php

@@ -39,6 +39,9 @@
 }
 $areaname = $area->get_visible_name();
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('modules');
+
 // Start page output.
 $heading = get_string('gradualreindex', 'search', '');
 $PAGE->set_title($PAGE->title . ': ' . $heading);

admin/settings.php

@@ -118,6 +118,11 @@
 
     $PAGE->set_title("$SITE->shortname: " . implode(": ",$visiblepathtosection));
     $PAGE->set_heading($SITE->fullname);
+    if ($section === 'frontpagesettings') {
+        $PAGE->navbar->add(get_string('frontpage', 'admin'),
+            new moodle_url('/admin/category.php', ['category' => 'frontpage']));
+        $PAGE->navbar->add(get_string('frontpagesettings', 'admin'), $PAGE->url);
+    }
     echo $OUTPUT->header();
 
     if ($errormsg !== '') {

admin/tool/admin_presets/classes/local/action/base.php

@@ -137,6 +137,10 @@ protected function display_header(): void {
             $PAGE->navbar->add($title);
         }
 
+        if ($node = $PAGE->settingsnav->find('tool_admin_presets', \navigation_node::TYPE_SETTING)) {
+            $node->make_active();
+        }
+
         echo $OUTPUT->header();
         echo $OUTPUT->heading($title);
         if ($text) {

admin/tool/admin_presets/index.php

@@ -52,6 +52,7 @@
 $PAGE->set_url($url);
 $PAGE->set_pagelayout('admin');
 $PAGE->set_context($context);
+$PAGE->set_primary_active_tab('siteadminnode');
 
 // Executes the required action.
 $instance = new $classname();

admin/tool/analytics/classes/output/helper.php

@@ -76,10 +76,14 @@ public static function set_navbar(string $title, \moodle_url $url, ?\context $co
 
         $PAGE->set_context($context);
         $PAGE->set_url($url);
+        $PAGE->set_secondary_active_tab('siteadminnode');
+        $PAGE->set_primary_active_tab('siteadminnode');
 
         if ($siteadmin = $PAGE->settingsnav->find('root', \navigation_node::TYPE_SITE_ADMIN)) {
-            $PAGE->navbar->add($siteadmin->get_content(), $siteadmin->action());
+            $PAGE->navbar->add($siteadmin->get_content(), $siteadmin->action(),
+                \breadcrumb_navigation_node::TYPE_SITE_ADMIN, null, 'root');
         }
+
         if ($analytics = $PAGE->settingsnav->find('analytics', \navigation_node::TYPE_SETTING)) {
             $PAGE->navbar->add($analytics->get_content(), $analytics->action());
         }

admin/tool/customlang/edit.php

@@ -38,6 +38,11 @@
     array('pagelayout' => 'report')); // Hack: allows for wide page contents.
 
 $PAGE->requires->js_init_call('M.tool_customlang.init_editor', array(), true);
+$PAGE->set_context(context_system::instance());
+$PAGE->set_secondary_active_tab('siteadminnode');
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->navbar->add(get_string('editlangpack', 'tool_customlang'), $PAGE->url);
+
 
 if (empty($lng)) {
     // PARAM_LANG validation failed

admin/tool/customlang/import.php

@@ -38,6 +38,12 @@
 admin_externalpage_setup('toolcustomlang', '', null,
     new moodle_url('/admin/tool/customlang/import.php', ['lng' => $lng]));
 
+$PAGE->set_context(context_system::instance());
+
+$PAGE->set_secondary_active_tab('siteadminnode');
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->navbar->add(get_string('import', 'tool_customlang'), $PAGE->url);
+
 $output = $PAGE->get_renderer('tool_customlang');
 
 $form = new import(null, ['lng' => $lng]);

admin/tool/customlang/index.php

@@ -40,6 +40,8 @@
 admin_externalpage_setup('toolcustomlang');
 $langs = get_string_manager()->get_list_of_translations();
 
+$PAGE->set_primary_active_tab('siteadminnode');
+
 // pre-output actions
 if ($action === 'checkout') {
     require_sesskey();

admin/tool/customlang/lang/en/tool_customlang.php

@@ -50,6 +50,7 @@
 $string['customlang:view'] = 'View local translation';
 $string['export'] = 'Export custom strings';
 $string['exportfilter'] = 'Select component(s) to export';
+$string['editlangpack'] = 'Edit language pack';
 $string['filter'] = 'Filter strings';
 $string['filtercomponent'] = 'Show strings of these components';
 $string['filtercustomized'] = 'Customised only';

admin/tool/dataprivacy/classes/page_helper.php

@@ -66,6 +66,8 @@ public static function setup(moodle_url $url, $title, $attachtoparentnode = '',
         $PAGE->set_pagelayout('admin');
         $PAGE->set_title($title);
         $PAGE->set_heading($SITE->fullname);
+        $PAGE->set_secondary_active_tab('users');
+        $PAGE->set_primary_active_tab('siteadminnode');
 
         // If necessary, override the settings navigation to add this page into the breadcrumb navigation.
         if ($attachtoparentnode) {

admin/tool/filetypes/delete.php

@@ -47,6 +47,8 @@
 $PAGE->set_context($context);
 $PAGE->set_pagelayout('admin');
 $PAGE->set_title($SITE->fullname. ': ' . $title);
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('server');
 
 // Display the page.
 echo $OUTPUT->header();

admin/tool/filetypes/edit.php

@@ -100,6 +100,10 @@
 // Page settings.
 $context = context_system::instance();
 $PAGE->set_url(new \moodle_url('/admin/tool/filetypes/edit.php', array('oldextension' => $oldextension)));
+
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('server');
+
 $PAGE->navbar->add($oldextension ? s($oldextension) : $title);
 $PAGE->set_context($context);
 $PAGE->set_pagelayout('admin');

admin/tool/langimport/index.php

@@ -112,6 +112,8 @@
 }
 get_string_manager()->reset_caches();
 
+$PAGE->set_primary_active_tab('siteadminnode');
+
 echo $OUTPUT->header();
 echo $OUTPUT->heading(get_string('langimport', 'tool_langimport'));
 

admin/tool/messageinbound/index.php

@@ -32,6 +32,10 @@
 
 $pageurl = new moodle_url('/admin/tool/messageinbound/index.php');
 
+$PAGE->set_primary_active_tab('siteadminnode');
+
+$PAGE->navbar->add(get_string('message_handlers', 'tool_messageinbound'), $PAGE->url);
+
 if (empty($classname)) {
     $renderer = $PAGE->get_renderer('tool_messageinbound');
 

admin/tool/monitor/edit.php

@@ -33,6 +33,8 @@
     $context = context_system::instance();
     $coursename = format_string($SITE->fullname, true, array('context' => $context));
     $PAGE->set_context($context);
+    $PAGE->set_primary_active_tab('siteadminnode');
+    $PAGE->set_secondary_active_tab('reports');
 } else {
     $course = get_course($courseid);
     require_login($course);
@@ -65,6 +67,7 @@
 
 // Mform setup.
 if (!empty($ruleid)) {
+    $PAGE->navbar->add(get_string('editrule', 'tool_monitor'), $PAGE->url);
     $rule = \tool_monitor\rule_manager::get_rule($ruleid)->get_mform_set_data();
     $rule->minutes = $rule->timewindow / MINSECS;
     $subscriptioncount = \tool_monitor\subscription_manager::count_rule_subscriptions($ruleid);
@@ -75,6 +78,7 @@
         return $classname === $rule->eventname || !$classname::is_deprecated();
     }, ARRAY_FILTER_USE_KEY);
 } else {
+    $PAGE->navbar->add(get_string('addrule', 'tool_monitor'), $PAGE->url);
     $rule = new stdClass();
     $subscriptioncount = 0;
 

admin/tool/monitor/managerules.php

@@ -39,6 +39,7 @@
     $context = context_system::instance();
     $coursename = format_string($SITE->fullname, true, array('context' => $context));
     $PAGE->set_context($context);
+    $PAGE->set_primary_active_tab('siteadminnode');
 } else {
     $course = get_course($courseid);
     require_login($course);
@@ -56,7 +57,6 @@
 $PAGE->set_title($coursename);
 $PAGE->set_heading($coursename);
 
-
 if (!empty($action) && $action == 'changestatus') {
     require_sesskey();
     require_capability('tool/monitor:managetool', context_system::instance());
@@ -74,6 +74,9 @@
         redirect(new moodle_url('/admin/tool/monitor/managerules.php', array('courseid' => $courseid)));
     }
 
+    if ($action === 'delete') {
+        $PAGE->navbar->add(get_string('deleterule', 'tool_monitor'), $PAGE->url);
+    }
     echo $OUTPUT->header();
     $rule = \tool_monitor\rule_manager::get_rule($rule);
     switch ($action) {

admin/tool/task/scheduledtasks.php

@@ -42,6 +42,8 @@
     }
 }
 
+$PAGE->navbar->add(get_string('scheduledtasks', 'tool_task'), $PAGE->url);
+
 if ($action == 'edit') {
     $PAGE->navbar->add(get_string('edittaskschedule', 'tool_task', $task->get_name()));
 }
@@ -51,6 +53,8 @@
     $nexturl = new moodle_url($PAGE->url, ['lastchanged' => $taskname]);
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+
 $renderer = $PAGE->get_renderer('tool_task');
 
 if ($mform && ($mform->is_cancelled() || !empty($CFG->preventscheduledtaskchanges) || $task->is_overridden())) {

admin/tool/usertours/classes/manager.php

@@ -158,7 +158,9 @@ protected function setup_admin_externalpage(string $action): void {
      * @param   string  $action     The action to perform.
      */
     public function execute($action) {
+        global $PAGE;
         $this->setup_admin_externalpage($action);
+        $PAGE->set_primary_active_tab('siteadminnode');
 
         // Add the main content.
         switch($action) {

admin/user.php

@@ -42,6 +42,9 @@
 
     $returnurl = new moodle_url('/admin/user.php', array('sort' => $sort, 'dir' => $dir, 'perpage' => $perpage, 'page'=>$page));
 
+    $PAGE->set_primary_active_tab('siteadminnode');
+    $PAGE->navbar->add(get_string('userlist', 'admin'), $PAGE->url);
+
     // The $user variable is also used outside of these if statements.
     $user = null;
     if ($confirmuser and confirm_sesskey()) {

admin/user/user_bulk_confirm.php

@@ -17,6 +17,9 @@
     redirect($return);
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('users');
+
 echo $OUTPUT->header();
 
 //TODO: add support for large number of users

admin/user/user_bulk_delete.php

@@ -17,6 +17,9 @@
     redirect($return);
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('users');
+
 echo $OUTPUT->header();
 
 //TODO: add support for large number of users

admin/user/user_bulk_display.php

@@ -20,6 +20,9 @@
 
 $strnever = get_string('never');
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('users');
+
 echo $OUTPUT->header();
 
 $countries = get_string_manager()->get_list_of_countries(true);

admin/user/user_bulk_download.php

@@ -88,6 +88,9 @@
     exit;
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('users');
+
 echo $OUTPUT->header();
 echo $OUTPUT->heading(get_string('download', 'admin'));
 echo $OUTPUT->download_dataformat_selector(get_string('userbulkdownload', 'admin'), 'user_bulk_download.php');

admin/user/user_bulk_forcepasswordchange.php

@@ -18,6 +18,9 @@
     redirect($return);
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('users');
+
 echo $OUTPUT->header();
 
 if ($confirm and confirm_sesskey()) {

admin/user/user_bulk_message.php

@@ -20,6 +20,9 @@
     print_error('messagingdisable', 'error');
 }
 
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->set_secondary_active_tab('users');
+
 //TODO: add support for large number of users
 
 if ($confirm and !empty($msg) and confirm_sesskey()) {

admin/webservice/service.php

@@ -36,7 +36,11 @@
     $node->display = false;
     $newnode->make_active();
 }
-$PAGE->navbar->add(get_string('externalservice', 'webservice'));
+$PAGE->navbar->add(get_string('externalservices', 'webservice'),
+    new moodle_url('/admin/settings.php', ['section' => 'externalservices']));
+
+$PAGE->set_primary_active_tab('siteadminnode');
+
 
 //Retrieve few general parameters
 $id = required_param('id', PARAM_INT);
@@ -104,6 +108,12 @@
     redirect($returnurl);
 }
 
+if ($id == 0) {
+    $PAGE->navbar->add(get_string('addexternalservice', 'webservice'), $PAGE->url);
+} else {
+    $PAGE->navbar->add(get_string('editexternalservice', 'webservice'), $PAGE->url);
+}
+
 //OUTPUT edit/create form
 echo $OUTPUT->header();
 $mform->display();

admin/webservice/service_functions.php

@@ -41,6 +41,9 @@
 if ($node) {
     $node->make_active();
 }
+$PAGE->set_primary_active_tab('siteadminnode');
+$PAGE->navbar->add(get_string('externalservices', 'webservice'),
+   new moodle_url('/admin/settings.php', ['section' => 'externalservices']));
 $PAGE->navbar->add(get_string('functions', 'webservice'),
         new moodle_url('/' . $CFG->admin . '/webservice/service_functions.php', array('id' => $serviceid)));