MDL-25394 Tidied up several things in order to get this integrated
[moodle.git] / theme / index.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This page prvides the Administration -> ... -> Theme selector UI.
20  */
22 require_once(dirname(__FILE__) . '/../config.php');
23 require_once($CFG->libdir . '/adminlib.php');
25 $choose = optional_param('choose', '', PARAM_SAFEDIR);
26 $reset  = optional_param('reset', 0, PARAM_BOOL);
27 $device = optional_param('device', '', PARAM_TEXT);
29 admin_externalpage_setup('themeselector');
31 if (!empty($device)) {
32     // Make sure the device requested is valid
33     $devices = get_device_type_list();
34     if (!in_array($device, $devices)) {
35         // The provided device isn't a valid device throw an error
36         print_error('invaliddevicetype');
37     }
38 }
40 unset($SESSION->theme);
42 if ($reset and confirm_sesskey()) {
43     theme_reset_all_caches();
45 } else if ($choose && $device && confirm_sesskey()) {
46  
47     // Load the theme to make sure it is valid.
48     $theme = theme_config::load($choose);
49     // Get the config argument for the chosen device.
50     $themename = get_device_cfg_var_name($device);
51     set_config($themename, $theme->name);
53     // Create a new page for the display of the themes readme.
54     // This ensures that the readme page is shown using the new theme.
55     $confirmpage = new moodle_page();
56     $confirmpage->set_context($PAGE->context);
57     $confirmpage->set_url($PAGE->url);
58     $confirmpage->set_pagelayout($PAGE->pagelayout);
59     $confirmpage->set_pagetype($PAGE->pagetype);
60     $confirmpage->set_title($PAGE->title);
61     $confirmpage->set_heading($PAGE->heading);
63     // Get the core renderer for the new theme.
64     $output = $confirmpage->get_renderer('core');
66     echo $output->header();
67     echo $output->heading(get_string('themesaved'));
68     echo $output->box_start();
69     echo format_text(get_string('choosereadme', 'theme_'.$theme->name), FORMAT_MOODLE);
70     echo $output->box_end();
71     echo $output->continue_button($CFG->wwwroot . '/' . $CFG->admin . '/index.php');
72     echo $output->footer();
73     exit;
74 }
76 // Otherwise, show either a list of devices, or is enabledevicedetection set to no or a
77 // device is specified show a list of themes.
79 echo $OUTPUT->header('themeselector');
80 echo $OUTPUT->heading(get_string('themes'));
82 echo $OUTPUT->single_button(new moodle_url('index.php', array('sesskey' => sesskey(), 'reset' => 1)), get_string('themeresetcaches', 'admin'));
84 $table = new html_table();
85 $table->data = array();
86 if ($CFG->enabledevicedetection && empty($device)) {
87     // Display a list of devices that a user can select a theme for.
89     $strthemenotselected = get_string('themenoselected', 'admin');
90     $strthemeselect = get_string('themeselect', 'admin');
92     // Display the device selection screen
93     $table->id = 'admindeviceselector';
94     $table->head = array(get_string('devicetype', 'admin'), get_string('theme'), get_string('info'));
96     $devices = get_device_type_list();
97     foreach ($devices as $device) {
99         $themename = get_selected_theme_for_device_type($device);
100         if (!$themename && $device == 'default') {
101             $themename = theme_config::DEFAULT_THEME;
102         }
104         $screenshotcell = $strthemenotselected;
105         if ($themename) {
106             // Check the theme exists
107             $themename = clean_param($themename, PARAM_THEME);
108             if (empty($themename)) {
109                 // Likely the theme has been deleted
110                 unset_config(get_device_cfg_var_name($device));
111             } else {
112                 $strthemename = get_string('pluginname', 'theme_'.$themename);
113                 // link to the screenshot, now mandatory - the image path is hardcoded because we need image from other themes, not the current one
114                 $screenshoturl = new moodle_url('/theme/image.php', array('theme' => $themename, 'image' => 'screenshot', 'component' => 'theme'));
115                 // Contents of the screenshot/preview cell.
116                 $screenshotcell = html_writer::empty_tag('img', array('src' => $screenshoturl, 'alt' => $strthemename));
117             }
118         }
120         $deviceurl = new moodle_url('/theme/index.php', array('device' => $device, 'sesskey' => sesskey()));
121         $select = new single_button($deviceurl, $strthemeselect, 'get');
123         $table->data[] = array(
124             $device,
125             $screenshotcell,
126             $OUTPUT->render($select)
127         );
128     }
129 } else {
130     // Either a device has been selected of $CFG->enabledevicedetection is off so display a list
131     // of themes to select.
133     if (empty($device)) {
134         // if $CFG->enabledevicedetection is off this will return 'default'
135         $device = get_device_type();
136     }
138     $table->id = 'adminthemeselector';
139     $table->head = array(get_string('theme'), get_string('info'));
141     $themes = get_plugin_list('theme');
143     foreach ($themes as $themename => $themedir) {
145         // Load the theme config.
146         try {
147             $theme = theme_config::load($themename);
148         } catch (Exception $e) {
149             // Bad theme, just skip it for now.
150             continue;
151         }
152         if ($themename !== $theme->name) {
153             //obsoleted or broken theme, just skip for now
154             continue;
155         }
156         if (!$CFG->themedesignermode && $theme->hidefromselector) {
157             // The theme doesn't want to be shown in the theme selector and as theme
158             // designer mode is switched off we will respect that decision.
159             continue;
160         }
161         $strthemename = get_string('pluginname', 'theme_'.$themename);
163         // Build the table row, and also a list of items to go in the second cell.
164         $row = array();
165         $infoitems = array();
166         $rowclasses = array();
168         // Set up bools whether this theme is chosen either main or legacy
169         $ischosentheme = ($themename == get_selected_theme_for_device_type($device));
171         if ($ischosentheme) {
172             // Is the chosen main theme
173             $rowclasses[] = 'selectedtheme';
174         }
176         // link to the screenshot, now mandatory - the image path is hardcoded because we need image from other themes, not the current one
177         $screenshotpath = new moodle_url('/theme/image.php', array('theme'=>$themename, 'image'=>'screenshot', 'component'=>'theme'));
178         // Contents of the first screenshot/preview cell.
179         $row[] = html_writer::empty_tag('img', array('src'=>$screenshotpath, 'alt'=>$strthemename));
180         // Contents of the second cell.
181         $infocell = $OUTPUT->heading($strthemename, 3);
183         // Button to choose this as the main theme
184         $maintheme = new single_button(new moodle_url('/theme/index.php', array('device' => $device, 'choose' => $themename, 'sesskey' => sesskey())), get_string('usetheme'), 'get');
185         $maintheme->disabled = $ischosentheme;
186         $infocell .= $OUTPUT->render($maintheme);
188         $row[] = $infocell;
190         $table->data[$themename] = $row;
191         $table->rowclasses[$themename] = join(' ', $rowclasses);
192     }
195 echo html_writer::table($table);
197 echo $OUTPUT->footer();