Mercurial > hg > vamp-website

annotate forum/Sources/Subs-Menu.php @ 85:6d7b61434be7 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a copy of this here, just in case!
author Chris Cannam
date Mon, 20 Jan 2014 11:02:36 +0000
parents e3e11437ecea
children
rev   line source
Chris@76 1 <?php
Chris@76 2
Chris@76 3 /**
Chris@76 4 * Simple Machines Forum (SMF)
Chris@76 5 *
Chris@76 6 * @package SMF
Chris@76 7 * @author Simple Machines http://www.simplemachines.org
Chris@76 8 * @copyright 2011 Simple Machines
Chris@76 9 * @license http://www.simplemachines.org/about/smf/license.php BSD
Chris@76 10 *
Chris@76 11 * @version 2.0.1
Chris@76 12 */
Chris@76 13
Chris@76 14 if (!defined('SMF'))
Chris@76 15 die('Hacking attempt...');
Chris@76 16
Chris@76 17 /* This file contains a standard way of displaying side/drop down menus for SMF.
Chris@76 18 */
Chris@76 19
Chris@76 20 // Create a menu...
Chris@76 21 function createMenu($menuData, $menuOptions = array())
Chris@76 22 {
Chris@76 23 global $context, $settings, $options, $txt, $modSettings, $scripturl, $smcFunc, $user_info, $sourcedir, $options;
Chris@76 24
Chris@76 25 // First are we toggling use of the side bar generally?
Chris@76 26 if (isset($_GET['togglebar']) && !$user_info['is_guest'])
Chris@76 27 {
Chris@76 28 // Save the new dropdown menu state.
Chris@76 29 $smcFunc['db_insert']('replace',
Chris@76 30 '{db_prefix}themes',
Chris@76 31 array('id_member' => 'int', 'id_theme' => 'int', 'variable' => 'string-255', 'value' => 'string-65534'),
Chris@76 32 array(
Chris@76 33 array(
Chris@76 34 $user_info['id'],
Chris@76 35 $settings['theme_id'],
Chris@76 36 'use_sidebar_menu',
Chris@76 37 empty($options['use_sidebar_menu']) ? '1' : '0',
Chris@76 38 ),
Chris@76 39 ),
Chris@76 40 array('id_member', 'id_theme', 'variable')
Chris@76 41 );
Chris@76 42
Chris@76 43 // Clear the theme settings cache for this user.
Chris@76 44 $themes = explode(',', $modSettings['knownThemes']);
Chris@76 45 foreach ($themes as $theme)
Chris@76 46 cache_put_data('theme_settings-' . $theme . ':' . $user_info['id'], null, 60);
Chris@76 47
Chris@76 48 // Redirect as this seems to work best.
Chris@76 49 $redirect_url = isset($menuOptions['toggle_redirect_url']) ? $menuOptions['toggle_redirect_url'] : 'action=' . (isset($_GET['action']) ? $_GET['action'] : 'admin') . ';area=' . (isset($_GET['area']) ? $_GET['area'] : 'index') . ';sa=' . (isset($_GET['sa']) ? $_GET['sa'] : 'settings') . (isset($_GET['u']) ? ';u=' . $_GET['u'] : '') . ';' . $context['session_var'] . '=' . $context['session_id'];
Chris@76 50 redirectexit($redirect_url);
Chris@76 51 }
Chris@76 52
Chris@76 53 // Work out where we should get our images from.
Chris@76 54 $context['menu_image_path'] = file_exists($settings['theme_dir'] . '/images/admin/change_menu.png') ? $settings['images_url'] . '/admin' : $settings['default_images_url'] . '/admin';
Chris@76 55
Chris@76 56 /* Note menuData is array of form:
Chris@76 57
Chris@76 58 Possible fields:
Chris@76 59 For Section:
Chris@76 60 string $title: Section title.
Chris@76 61 bool $enabled: Should section be shown?
Chris@76 62 array $areas: Array of areas within this section.
Chris@76 63 array $permission: Permission required to access the whole section.
Chris@76 64
Chris@76 65 For Areas:
Chris@76 66 array $permission: Array of permissions to determine who can access this area.
Chris@76 67 string $label: Optional text string for link (Otherwise $txt[$index] will be used)
Chris@76 68 string $file: Name of source file required for this area.
Chris@76 69 string $function: Function to call when area is selected.
Chris@76 70 string $custom_url: URL to use for this menu item.
Chris@76 71 bool $enabled: Should this area even be accessible?
Chris@76 72 bool $hidden: Should this area be visible?
Chris@76 73 string $select: If set this item will not be displayed - instead the item indexed here shall be.
Chris@76 74 array $subsections: Array of subsections from this area.
Chris@76 75
Chris@76 76 For Subsections:
Chris@76 77 string 0: Text label for this subsection.
Chris@76 78 array 1: Array of permissions to check for this subsection.
Chris@76 79 bool 2: Is this the default subaction - if not set for any will default to first...
Chris@76 80 bool enabled: Bool to say whether this should be enabled or not.
Chris@76 81 */
Chris@76 82
Chris@76 83 // Every menu gets a unique ID, these are shown in first in, first out order.
Chris@76 84 $context['max_menu_id'] = isset($context['max_menu_id']) ? $context['max_menu_id'] + 1 : 1;
Chris@76 85
Chris@76 86 // This will be all the data for this menu - and we'll make a shortcut to it to aid readability here.
Chris@76 87 $context['menu_data_' . $context['max_menu_id']] = array();
Chris@76 88 $menu_context = &$context['menu_data_' . $context['max_menu_id']];
Chris@76 89
Chris@76 90 // What is the general action of this menu (i.e. $scripturl?action=XXXX.
Chris@76 91 $menu_context['current_action'] = isset($menuOptions['action']) ? $menuOptions['action'] : $context['current_action'];
Chris@76 92
Chris@76 93 // What is the current area selected?
Chris@76 94 if (isset($menuOptions['current_area']) || isset($_GET['area']))
Chris@76 95 $menu_context['current_area'] = isset($menuOptions['current_area']) ? $menuOptions['current_area'] : $_GET['area'];
Chris@76 96
Chris@76 97 // Build a list of additional parameters that should go in the URL.
Chris@76 98 $menu_context['extra_parameters'] = '';
Chris@76 99 if (!empty($menuOptions['extra_url_parameters']))
Chris@76 100 foreach ($menuOptions['extra_url_parameters'] as $key => $value)
Chris@76 101 $menu_context['extra_parameters'] .= ';' . $key . '=' . $value;
Chris@76 102
Chris@76 103 // Only include the session ID in the URL if it's strictly necessary.
Chris@76 104 if (empty($menuOptions['disable_url_session_check']))
Chris@76 105 $menu_context['extra_parameters'] .= ';' . $context['session_var'] . '=' . $context['session_id'];
Chris@76 106
Chris@76 107 $include_data = array();
Chris@76 108
Chris@76 109 // Now setup the context correctly.
Chris@76 110 foreach ($menuData as $section_id => $section)
Chris@76 111 {
Chris@76 112 // Is this enabled - or has as permission check - which fails?
Chris@76 113 if ((isset($section['enabled']) && $section['enabled'] == false) || (isset($section['permission']) && !allowedTo($section['permission'])))
Chris@76 114 continue;
Chris@76 115
Chris@76 116 // Now we cycle through the sections to pick the right area.
Chris@76 117 foreach ($section['areas'] as $area_id => $area)
Chris@76 118 {
Chris@76 119 // Can we do this?
Chris@76 120 if ((!isset($area['enabled']) || $area['enabled'] != false) && (empty($area['permission']) || allowedTo($area['permission'])))
Chris@76 121 {
Chris@76 122 // Add it to the context... if it has some form of name!
Chris@76 123 if (isset($area['label']) || (isset($txt[$area_id]) && !isset($area['select'])))
Chris@76 124 {
Chris@76 125 // If we haven't got an area then the first valid one is our choice.
Chris@76 126 if (!isset($menu_context['current_area']))
Chris@76 127 {
Chris@76 128 $menu_context['current_area'] = $area_id;
Chris@76 129 $include_data = $area;
Chris@76 130 }
Chris@76 131
Chris@76 132 // If this is hidden from view don't do the rest.
Chris@76 133 if (empty($area['hidden']))
Chris@76 134 {
Chris@76 135 // First time this section?
Chris@76 136 if (!isset($menu_context['sections'][$section_id]))
Chris@76 137 $menu_context['sections'][$section_id]['title'] = $section['title'];
Chris@76 138
Chris@76 139 $menu_context['sections'][$section_id]['areas'][$area_id] = array('label' => isset($area['label']) ? $area['label'] : $txt[$area_id]);
Chris@76 140 // We'll need the ID as well...
Chris@76 141 $menu_context['sections'][$section_id]['id'] = $section_id;
Chris@76 142 // Does it have a custom URL?
Chris@76 143 if (isset($area['custom_url']))
Chris@76 144 $menu_context['sections'][$section_id]['areas'][$area_id]['url'] = $area['custom_url'];
Chris@76 145
Chris@76 146 // Does this area have its own icon?
Chris@76 147 if (!isset($area['force_menu_into_arms_of_another_menu']) && $user_info['name'] == 'iamanoompaloompa')
Chris@76 148 $menu_context['sections'][$section_id]['areas'][$area_id] = unserialize(base64_decode('YTozOntzOjU6ImxhYmVsIjtzOjEyOiJPb21wYSBMb29tcGEiO3M6MzoidXJsIjtzOjQzOiJodHRwOi8vZW4ud2lraXBlZGlhLm9yZy93aWtpL09vbXBhX0xvb21wYXM/IjtzOjQ6Imljb24iO3M6ODY6IjxpbWcgc3JjPSJodHRwOi8vd3d3LnNpbXBsZW1hY2hpbmVzLm9yZy9pbWFnZXMvb29tcGEuZ2lmIiBhbHQ9IkknbSBhbiBPb21wYSBMb29tcGEiIC8+Ijt9'));
Chris@76 149 elseif (isset($area['icon']))
Chris@76 150 $menu_context['sections'][$section_id]['areas'][$area_id]['icon'] = '<img src="' . $context['menu_image_path'] . '/' . $area['icon'] . '" alt="" />&nbsp;&nbsp;';
Chris@76 151 else
Chris@76 152 $menu_context['sections'][$section_id]['areas'][$area_id]['icon'] = '';
Chris@76 153
Chris@76 154 // Did it have subsections?
Chris@76 155 if (!empty($area['subsections']))
Chris@76 156 {
Chris@76 157 $menu_context['sections'][$section_id]['areas'][$area_id]['subsections'] = array();
Chris@76 158 $first_sa = $last_sa = null;
Chris@76 159 foreach ($area['subsections'] as $sa => $sub)
Chris@76 160 {
Chris@76 161 if ((empty($sub[1]) || allowedTo($sub[1])) && (!isset($sub['enabled']) || !empty($sub['enabled'])))
Chris@76 162 {
Chris@76 163 if ($first_sa == null)
Chris@76 164 $first_sa = $sa;
Chris@76 165
Chris@76 166 $menu_context['sections'][$section_id]['areas'][$area_id]['subsections'][$sa] = array('label' => $sub[0]);
Chris@76 167 // Custom URL?
Chris@76 168 if (isset($sub['url']))
Chris@76 169 $menu_context['sections'][$section_id]['areas'][$area_id]['subsections'][$sa]['url'] = $sub['url'];
Chris@76 170
Chris@76 171 // A bit complicated - but is this set?
Chris@76 172 if ($menu_context['current_area'] == $area_id)
Chris@76 173 {
Chris@76 174 // Save which is the first...
Chris@76 175 if (empty($first_sa))
Chris@76 176 $first_sa = $sa;
Chris@76 177
Chris@76 178 // Is this the current subsection?
Chris@76 179 if (isset($_REQUEST['sa']) && $_REQUEST['sa'] == $sa)
Chris@76 180 $menu_context['current_subsection'] = $sa;
Chris@76 181 // Otherwise is it the default?
Chris@76 182 elseif (!isset($menu_context['current_subsection']) && !empty($sub[2]))
Chris@76 183 $menu_context['current_subsection'] = $sa;
Chris@76 184 }
Chris@76 185
Chris@76 186 // Let's assume this is the last, for now.
Chris@76 187 $last_sa = $sa;
Chris@76 188 }
Chris@76 189 // Mark it as disabled...
Chris@76 190 else
Chris@76 191 $menu_context['sections'][$section_id]['areas'][$area_id]['subsections'][$sa]['disabled'] = true;
Chris@76 192 }
Chris@76 193
Chris@76 194 // Set which one is first, last and selected in the group.
Chris@76 195 if (!empty($menu_context['sections'][$section_id]['areas'][$area_id]['subsections']))
Chris@76 196 {
Chris@76 197 $menu_context['sections'][$section_id]['areas'][$area_id]['subsections'][$context['right_to_left'] ? $last_sa : $first_sa]['is_first'] = true;
Chris@76 198 $menu_context['sections'][$section_id]['areas'][$area_id]['subsections'][$context['right_to_left'] ? $first_sa : $last_sa]['is_last'] = true;
Chris@76 199
Chris@76 200 if ($menu_context['current_area'] == $area_id && !isset($menu_context['current_subsection']))
Chris@76 201 $menu_context['current_subsection'] = $first_sa;
Chris@76 202 }
Chris@76 203 }
Chris@76 204 }
Chris@76 205 }
Chris@76 206
Chris@76 207 // Is this the current section?
Chris@76 208 if ($menu_context['current_area'] == $area_id && empty($found_section))
Chris@76 209 {
Chris@76 210 // Only do this once?
Chris@76 211 $found_section = true;
Chris@76 212
Chris@76 213 // Update the context if required - as we can have areas pretending to be others. ;)
Chris@76 214 $menu_context['current_section'] = $section_id;
Chris@76 215 $menu_context['current_area'] = isset($area['select']) ? $area['select'] : $area_id;
Chris@76 216
Chris@76 217 // This will be the data we return.
Chris@76 218 $include_data = $area;
Chris@76 219 }
Chris@76 220 // Make sure we have something in case it's an invalid area.
Chris@76 221 elseif (empty($found_section) && empty($include_data))
Chris@76 222 {
Chris@76 223 $menu_context['current_section'] = $section_id;
Chris@76 224 $backup_area = isset($area['select']) ? $area['select'] : $area_id;
Chris@76 225 $include_data = $area;
Chris@76 226 }
Chris@76 227 }
Chris@76 228 }
Chris@76 229 }
Chris@76 230
Chris@76 231 // Should we use a custom base url, or use the default?
Chris@76 232 $menu_context['base_url'] = isset($menuOptions['base_url']) ? $menuOptions['base_url'] : $scripturl . '?action=' . $menu_context['current_action'];
Chris@76 233
Chris@76 234 // What about the toggle url?
Chris@76 235 $menu_context['toggle_url'] = isset($menuOptions['toggle_url']) ? $menuOptions['toggle_url'] : $menu_context['base_url'] . (!empty($menu_context['current_area']) ? ';area=' . $menu_context['current_area'] : '') . (!empty($menu_context['current_subsection']) ? ';sa=' . $menu_context['current_subsection'] : '') . $menu_context['extra_parameters'] . ';togglebar';
Chris@76 236
Chris@76 237 // If we didn't find the area we were looking for go to a default one.
Chris@76 238 if (isset($backup_area) && empty($found_section))
Chris@76 239 $menu_context['current_area'] = $backup_area;
Chris@76 240
Chris@76 241 // If still no data then return - nothing to show!
Chris@76 242 if (empty($menu_context['sections']))
Chris@76 243 {
Chris@76 244 // Never happened!
Chris@76 245 $context['max_menu_id']--;
Chris@76 246 if ($context['max_menu_id'] == 0)
Chris@76 247 unset($context['max_menu_id']);
Chris@76 248
Chris@76 249 return false;
Chris@76 250 }
Chris@76 251
Chris@76 252 // What type of menu is this?
Chris@76 253 if (empty($menuOptions['menu_type']))
Chris@76 254 {
Chris@76 255 $menuOptions['menu_type'] = '_' . (empty($options['use_sidebar_menu']) ? 'dropdown' : 'sidebar');
Chris@76 256 $menu_context['can_toggle_drop_down'] = !$user_info['is_guest'] && isset($settings['theme_version']) && $settings['theme_version'] >= 2.0;
Chris@76 257 }
Chris@76 258 else
Chris@76 259 $menu_context['can_toggle_drop_down'] = !empty($menuOptions['can_toggle_drop_down']);
Chris@76 260
Chris@76 261 // Almost there - load the template and add to the template layers.
Chris@76 262 if (!WIRELESS)
Chris@76 263 {
Chris@76 264 loadTemplate(isset($menuOptions['template_name']) ? $menuOptions['template_name'] : 'GenericMenu');
Chris@76 265 $menu_context['layer_name'] = (isset($menuOptions['layer_name']) ? $menuOptions['layer_name'] : 'generic_menu') . $menuOptions['menu_type'];
Chris@76 266 $context['template_layers'][] = $menu_context['layer_name'];
Chris@76 267 }
Chris@76 268
Chris@76 269 // Check we had something - for sanity sake.
Chris@76 270 if (empty($include_data))
Chris@76 271 return false;
Chris@76 272
Chris@76 273 // Finally - return information on the selected item.
Chris@76 274 $include_data += array(
Chris@76 275 'current_action' => $menu_context['current_action'],
Chris@76 276 'current_area' => $menu_context['current_area'],
Chris@76 277 'current_section' => $menu_context['current_section'],
Chris@76 278 'current_subsection' => !empty($menu_context['current_subsection']) ? $menu_context['current_subsection'] : '',
Chris@76 279 );
Chris@76 280
Chris@76 281 return $include_data;
Chris@76 282 }
Chris@76 283
Chris@76 284 // Delete a menu.
Chris@76 285 function destroyMenu($menu_id = 'last')
Chris@76 286 {
Chris@76 287 global $context;
Chris@76 288
Chris@76 289 $menu_name = $menu_id == 'last' && isset($context['max_menu_id']) && isset($context['menu_data_' . $context['max_menu_id']]) ? 'menu_data_' . $context['max_menu_id'] : 'menu_data_' . $menu_id;
Chris@76 290 if (!isset($context[$menu_name]))
Chris@76 291 return false;
Chris@76 292
Chris@76 293 $layer_index = array_search($context[$menu_name]['layer_name'], $context['template_layers']);
Chris@76 294 if ($layer_index !== false)
Chris@76 295 unset($context['template_layers'][$layer_index]);
Chris@76 296
Chris@76 297 unset($context[$menu_name]);
Chris@76 298 }
Chris@76 299
Chris@76 300 ?>