diff --git a/admin/settings/appearance.php b/admin/settings/appearance.php index 28081638b3f6f..dc2ba27ca4304 100644 --- a/admin/settings/appearance.php +++ b/admin/settings/appearance.php @@ -18,6 +18,8 @@ $temp->add(new admin_setting_configcheckbox('allowuserblockhiding', get_string('allowuserblockhiding', 'admin'), get_string('configallowuserblockhiding', 'admin'), 1)); $temp->add(new admin_setting_configcheckbox('allowblockstodock', get_string('allowblockstodock', 'admin'), get_string('configallowblockstodock', 'admin'), 1)); $temp->add(new admin_setting_configtextarea('custommenuitems', get_string('custommenuitems', 'admin'), get_string('configcustommenuitems', 'admin'), '', PARAM_TEXT, '50', '10')); + $temp->add(new admin_setting_configcheckbox('enabledevicedetection', get_string('enabledevicedetection', 'admin'), get_string('configenabledevicedetection', 'admin'), 1)); + $temp->add(new admin_setting_devicedetectregex('devicedetectregex', get_string('devicedetectregex', 'admin'), get_string('devicedetectregex_desc', 'admin'), '')); $ADMIN->add('themes', $temp); $ADMIN->add('themes', new admin_externalpage('themeselector', get_string('themeselector','admin'), $CFG->wwwroot . '/theme/index.php')); diff --git a/lang/en/admin.php b/lang/en/admin.php index 09817efec35e9..c0847d141ea45 100644 --- a/lang/en/admin.php +++ b/lang/en/admin.php @@ -187,6 +187,7 @@ $string['configdeleteincompleteusers'] = 'After this period, old not fully setup accounts are deleted.'; $string['configdeleteunconfirmed'] = 'If you are using email authentication, this is the period within which a response will be accepted from users. After this period, old unconfirmed accounts are deleted.'; $string['configdenyemailaddresses'] = 'To deny email addresses from particular domains list them here in the same way. All other domains will be accepted. To deny subdomains add the domain with a preceding \'.\'. eg hotmail.com yahoo.co.uk .live.com'; +$string['configenabledevicedetection'] = 'Enables detection of mobiles, smartphones, tablets or default devices (desktop PCs, laptops, etc) for the application of themes and other features.'; $string['configdigestmailtime'] = 'People who choose to have emails sent to them in digest form will be emailed the digest daily. This setting controls which time of day the daily mail will be sent (the next cron that runs after this hour will send it).'; $string['configdisableuserimages'] = 'Disable the ability for users to change user profile images.'; $string['configdisplayloginfailures'] = 'This will display information to selected users about previous failed logins.'; @@ -450,6 +451,12 @@ $string['density'] = 'Density'; $string['denyemailaddresses'] = 'Denied email domains'; $string['development'] = 'Development'; +$string['devicedetectregex'] = 'Device detection regular expressions'; +$string['devicedetectregex_desc'] = '
By default, Moodle can detect devices of the type default (desktop PCs, laptops, etc), mobile (phones and small hand held devices), tablet (iPads, Android tablets) and legacy (Internet Explorer 6 users). The theme selector can be used to apply separate themes to all of these. This setting allows regular expressions that allow the detection of extra device types (these take precedence over the default types).
+For example, you could enter the regular expression \'/(MIDP-1.0|Maemo|Windows CE)/\' to detect some commonly used feasture phones add the return value \'featurephone\'. This adds \'featurephone\' on the theme selector that would allow you to add a theme that would be used on these devices. Other phones would still use the theme selected for the mobile device type.
'; +$string['devicedetectregexexpression'] = 'Regular expression'; +$string['devicedetectregexvalue'] = 'Return value'; +$string['devicetype'] = 'Device type'; $string['digestmailtime'] = 'Hour to send digest emails'; $string['disableuserimages'] = 'Disable user profile images'; $string['displayerrorswarning'] = 'Enabling the PHP setting display_errors is not recommended on production sites because some error messages may reveal sensitive information about your server.'; @@ -491,6 +498,7 @@ $string['enablecourseajax'] = 'Enable AJAX course editing'; $string['enablecourseajax_desc'] = 'Allow AJAX when editing main course pages. Note that the course format and the theme must support AJAX editing and the user has to enable AJAX in their profiles, too.'; $string['enablecourserequests'] = 'Enable course requests'; +$string['enabledevicedetection'] = 'Enable device detection'; $string['enableglobalsearch'] = 'Enable global search'; $string['enablegroupmembersonly'] = 'Enable group members only'; $string['enablehtmlpurifier'] = 'Enable HTML Purifier'; @@ -993,7 +1001,9 @@ $string['tabselectedtofronttext'] = 'Bring selected tab row to front'; $string['themedesignermode'] = 'Theme designer mode'; $string['themelist'] = 'Theme list'; +$string['themenoselected'] = 'No theme selected'; $string['themeresetcaches'] = 'Clear theme caches'; +$string['themeselect'] = 'Select theme'; $string['themeselector'] = 'Theme selector'; $string['themesettings'] = 'Theme settings'; $string['therewereerrors'] = 'There were errors in your data'; diff --git a/lang/en/moodle.php b/lang/en/moodle.php index 0d6215b3841a0..8e3fbc93f3c0e 100644 --- a/lang/en/moodle.php +++ b/lang/en/moodle.php @@ -906,7 +906,6 @@ $string['layouttable'] = 'Layout table'; $string['leavetokeep'] = 'Leave blank to keep current password'; $string['legacythemeinuse'] = 'This site is being displayed to you in compatibility mode because your browser is too old.'; -$string['legacythemesaved'] = 'New legacy theme saved'; $string['license'] = 'Licence'; $string['licenses'] = 'Licences'; $string['liketologin'] = 'Would you like to log in now with a full user account?'; @@ -1603,6 +1602,8 @@ $string['summary_help'] = 'The idea of a summary is a short text to prepare students for the activities within the topic or week. The text is shown on the course page under the section name.'; $string['summaryof'] = 'Summary of {$a}'; $string['supplyinfo'] = 'More details'; +$string['switchdevicedefault'] = 'Switch to the standard theme'; +$string['switchdevicerecommended'] = 'Switch to the recommended theme for your device'; $string['switchrolereturn'] = 'Return to my normal role'; $string['switchroleto'] = 'Switch role to...'; $string['tag'] = 'Tag'; @@ -1692,8 +1693,6 @@ $string['url'] = 'URL'; $string['used'] = 'Used'; $string['usedinnplaces'] = 'Used in {$a} places'; -$string['useformaintheme'] = 'Use for modern browsers'; -$string['useforlegacytheme'] = 'Use for old browsers'; $string['usemessageform'] = 'or use the form below to send a message to the selected students'; $string['user'] = 'User'; $string['userconfirmed'] = 'Confirmed {$a}'; @@ -1723,6 +1722,7 @@ $string['useruploadtype'] = 'User upload type: {$a}'; $string['userviewingsettings'] = 'Profile settings for {$a}'; $string['userzones'] = 'User zones'; +$string['usetheme'] = 'Use theme'; $string['usingexistingcourse'] = 'Using existing course'; $string['valuealreadyused'] = 'This value has already been used.'; $string['version'] = 'Version'; diff --git a/lib/adminlib.php b/lib/adminlib.php index 49289ddc1fffa..0f0e26ffd7578 100644 --- a/lib/adminlib.php +++ b/lib/adminlib.php @@ -7307,7 +7307,193 @@ public function output_html($data, $query = '') { $content .= html_writer::end_tag('div'); return format_admin_setting($this, $this->visiblename, $content, $this->description, false, '', $this->get_defaultsetting(), $query); } +} + +/** + * Administration interface for user specified regular expressions for device detection. + * + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class admin_setting_devicedetectregex extends admin_setting { + + /** + * Calls parent::__construct with specific args + */ + public function __construct($name, $visiblename, $description, $defaultsetting = '') { + global $CFG; + parent::__construct($name, $visiblename, $description, $defaultsetting); + } + + /** + * Return the current setting(s) + * + * @return array Current settings array + */ + public function get_setting() { + global $CFG; + + $config = $this->config_read($this->name); + if (is_null($config)) { + return null; + } + + return $this->prepare_form_data($config); + } + + /** + * Save selected settings + * + * @param array $data Array of settings to save + * @return bool + */ + public function write_setting($data) { + if (empty($data)) { + $data = array(); + } + + if ($this->config_write($this->name, $this->process_form_data($data))) { + return ''; // success + } else { + return get_string('errorsetting', 'admin') . $this->visiblename . html_writer::empty_tag('br'); + } + } + + /** + * Return XHTML field(s) for regexes + * + * @param array $data Array of options to set in HTML + * @return string XHTML string for the fields and wrapping div(s) + */ + public function output_html($data, $query='') { + global $OUTPUT; + $out = html_writer::start_tag('table', array('border' => 1, 'class' => 'generaltable')); + $out .= html_writer::start_tag('thead'); + $out .= html_writer::start_tag('tr'); + $out .= html_writer::tag('th', get_string('devicedetectregexexpression', 'admin')); + $out .= html_writer::tag('th', get_string('devicedetectregexvalue', 'admin')); + $out .= html_writer::end_tag('tr'); + $out .= html_writer::end_tag('thead'); + $out .= html_writer::start_tag('tbody'); + + if (empty($data)) { + $looplimit = 1; + } else { + $looplimit = (count($data)/2)+1; + } + + for ($i=0; $i<$looplimit; $i++) { + $out .= html_writer::start_tag('tr'); + + $expressionname = 'expression'.$i; + + if (!empty($data[$expressionname])){ + $expression = $data[$expressionname]; + } else { + $expression = ''; + } + + $out .= html_writer::tag('td', + html_writer::empty_tag('input', + array( + 'type' => 'text', + 'class' => 'form-text', + 'name' => $this->get_full_name().'[expression'.$i.']', + 'value' => $expression, + ) + ), array('class' => 'c'.$i) + ); + + $valuename = 'value'.$i; + + if (!empty($data[$valuename])){ + $value = $data[$valuename]; + } else { + $value= ''; + } + + $out .= html_writer::tag('td', + html_writer::empty_tag('input', + array( + 'type' => 'text', + 'class' => 'form-text', + 'name' => $this->get_full_name().'[value'.$i.']', + 'value' => $value, + ) + ), array('class' => 'c'.$i) + ); + + $out .= html_writer::end_tag('tr'); + } + + $out .= html_writer::end_tag('tbody'); + $out .= html_writer::end_tag('table'); + + return format_admin_setting($this, $this->visiblename, $out, $this->description, false, '', null, $query); + } + + /** + * Converts the string of regexes + * + * @see self::process_form_data() + * @param $regexes string of regexes + * @return array of form fields and their values + */ + protected function prepare_form_data($regexes) { + + $regexes = json_decode($regexes); + + $form = array(); + + $i = 0; + + foreach ($regexes as $value => $regex) { + $expressionname = 'expression'.$i; + $valuename = 'value'.$i; + + $form[$expressionname] = $regex; + $form[$valuename] = $value; + $i++; + } + + return $form; + } + + /** + * Converts the data from admin settings form into a string of regexes + * + * @see self::prepare_form_data() + * @param array $data array of admin form fields and values + * @return false|string of regexes + */ + protected function process_form_data(array $form) { + + $count = count($form); // number of form field values + + if ($count % 2) { + // we must get five fields per expression + return false; + } + + $regexes = array(); + for ($i = 0; $i < $count / 2; $i++) { + $expressionname = "expression".$i; + $valuename = "value".$i; + + $expression = trim($form['expression'.$i]); + $value = trim($form['value'.$i]); + + if (empty($expression)){ + continue; + } + + $regexes[$value] = $expression; + } + + $regexes = json_encode($regexes); + + return $regexes; + } } diff --git a/lib/db/upgrade.php b/lib/db/upgrade.php index 2918eb1bde429..92017e610a877 100644 --- a/lib/db/upgrade.php +++ b/lib/db/upgrade.php @@ -6112,6 +6112,12 @@ function xmldb_main_upgrade($oldversion) { upgrade_main_savepoint(true, 2011052300.02); } + //set enable theme detection to the new themes setting. + if ($oldversion < 2011052500.00) { + set_config('enabledevicedetection', 1); + + upgrade_main_savepoint(true, 2011052500.00); + } return true; } diff --git a/lib/moodlelib.php b/lib/moodlelib.php index 3dee9f948be0f..ba34b2740a97b 100644 --- a/lib/moodlelib.php +++ b/lib/moodlelib.php @@ -7603,6 +7603,181 @@ function check_browser_version($brand, $version = null) { return false; } + +/** + * Returns whether a device/browser combination is mobile, tablet, legacy, default or the result of + * an optional admin specified regular expression. If enabledevicedetection is set to no or not set + * it returns default + * + * @return string device type + */ +function get_device_type() { + global $CFG; + + if (empty($CFG->enabledevicedetection) || empty($_SERVER['HTTP_USER_AGENT'])) { + return 'default'; + } + + $useragent = $_SERVER['HTTP_USER_AGENT']; + + if (!empty($CFG->devicedetectregex)) { + $regexes = json_decode($CFG->devicedetectregex); + + foreach ($regexes as $value=>$regex) { + if (preg_match($regex, $useragent)) { + return $value; + } + } + } + + //mobile detection PHP direct copy from open source detectmobilebrowser.com + $phonesregex = '/android|avantgo|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i'; + $modelsregex = '/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|e\-|e\/|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(di|rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|xda(\-|2|g)|yas\-|your|zeto|zte\-/i'; + + if (preg_match($phonesregex,$useragent)||preg_match($modelsregex,substr($useragent,0,4))){ + return 'mobile'; + } + + $tabletregex = '/Tablet browser|iPad|iProd|GT-P1000|GT-I9000|SHW-M180S|SGH-T849|SCH-I800|Build\/ERE27|sholest/i'; + + if (preg_match($tabletregex, $useragent)) { + return 'tablet'; + } + + if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6.') !== false) { + return 'legacy'; + } + + return 'default'; +} + + +/** + * Returns a list of the device types supporting by Moodle + * @param boolean incusertypes includes types specified using the devicedetectregex admin setting + * @return array $types + */ +function get_device_type_list($incusertypes = true) { + global $CFG; + + $types = array('default', 'legacy', 'mobile', 'tablet'); + + if ($incusertypes && !empty($CFG->devicedetectregex)) { + $regexes = json_decode($CFG->devicedetectregex); + + foreach ($regexes as $value => $regex) { + $types[] = $value; + } + } + + return $types; +} + + +/** + * Returns the theme selected for a particular device or false if none selected. + * @param string $themes + * @param string $devicetype + * @return string $theme or boolean false + */ +function get_selected_theme_for_device_type($devicetype = null) { + global $CFG; + + if (empty($devicetype)) { + $devicetype = get_device_type(); + + //check if the user has switched theme, change $devicetype to default. + $switched = get_user_switched_device($devicetype); + + if ($switched) { + $devicetype = $switched; + } + } + + $themevarname = get_device_cfg_var_name($devicetype); + + if (empty($CFG->$themevarname)) { + return false; + } + + //prevent problems if a user installs themes + if (!is_dir($CFG->dirroot.'/theme/'.$CFG->$themevarname)) { + if ($devicetype == 'default') { + return 'standard'; + } else { + return false; + } + } + + return $CFG->$themevarname; +} + + +/** + * Returns the name of the device type theme var in $CFG (because there is not a standard convention to allow backwards compatability + * @param string $devicetype + */ +function get_device_cfg_var_name($devicetype = null) { + if ($devicetype == 'default' || empty($devicetype)) { + return 'theme'; + } + + return 'theme' . $devicetype; +} + + +/** + * Returns device type or false if the user has switched theme to default for a device type + * @param string $devicetype + */ +function get_user_switched_device($devicetype = null) { + global $USER; + + if (empty($USER)) { + return false; + } + + if (empty($devicetype)) { + $devicetype = get_device_type(); + } + + $switchdevice = get_user_preferences('switchdevice'.$devicetype); + + if (empty($switchdevice)) { + return false; + } + + return $switchdevice; +} + + +function switch_device($devicetype = null) { + global $USER; + + if (is_null($devicetype)) { + $devicetype = get_device_type(); + } + + $switcheddevice = get_user_preferences('switchdevice'.$devicetype); + + if (!empty($switcheddevice)) { + $switcheddevice = false; + } else { + $pref = optional_param('switchdevice', '', PARAM_TEXT); + + if (!empty($pref)) { + $switcheddevice = $pref; + } else if ($devicetype == 'default') { + $switcheddevice = 'mobile'; + } else { + $switcheddevice = 'default'; + } + } + + set_user_preference('switchdevice'.$devicetype, $switcheddevice); +} + + /** * Returns one or several CSS class names that match the user's browser. These can be put * in the body tag of the page to apply browser-specific rules without relying on CSS hacks diff --git a/lib/outputrenderers.php b/lib/outputrenderers.php index 786444f957990..92346d9be8f0f 100644 --- a/lib/outputrenderers.php +++ b/lib/outputrenderers.php @@ -212,6 +212,8 @@ class core_renderer extends renderer_base { protected $contenttype; /** @var string used by {@link redirect_message()} method to communicate with {@link header()}. */ protected $metarefreshtag = ''; + /** @var set if the theme links function has been called **/ + protected $switchlinkdisplayed; /** * Get the DOCTYPE declaration that should be used with this page. Designed to @@ -362,10 +364,13 @@ public function standard_footer_html() { // but some of the content won't be known until later, so we return a placeholder // for now. This will be replaced with the real content in {@link footer()}. $output = self::PERFORMANCE_INFO_TOKEN; - if ($this->page->legacythemeinuse) { + if ($this->page->devicetypeinuse == 'legacy'){ // The legacy theme is in use print the notification $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse')); } + + $output .= $this->theme_switch_links(); + if (!empty($CFG->debugpageinfo)) { $output .= '