5
* @version $Id: functions_module.php,v 1.59 2007/10/05 14:30:10 acydburn Exp $
6
* @copyright (c) 2005 phpBB Group
7
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
14
if (!defined('IN_PHPBB'))
20
* Class handling all types of 'plugins' (a future term)
31
var $active_module = false;
32
var $active_module_row_id = false;
33
var $acl_forum_id = false;
34
var $module_ary = array();
39
* This creates a list, stored in $this->module_ary of all available
40
* modules for the given class (ucp, mcp and acp). Additionally
41
* $this->module_y_ary is created with indentation information for
42
* displaying the module list appropriately. Only modules for which
43
* the user has access rights are included in these lists.
45
function list_modules($p_class)
47
global $auth, $db, $user, $cache;
48
global $config, $phpbb_root_path, $phpEx;
50
// Sanitise for future path use, it's escaped as appropriate for queries
51
$this->p_class = str_replace(array('.', '/', '\\'), '', basename($p_class));
54
if (($this->module_cache = $cache->get('_modules_' . $this->p_class)) === false)
58
FROM ' . MODULES_TABLE . "
59
WHERE module_class = '" . $db->sql_escape($this->p_class) . "'
60
ORDER BY left_id ASC";
61
$result = $db->sql_query($sql);
64
while ($row = $db->sql_fetchrow($result))
66
$rows[$row['module_id']] = $row;
68
$db->sql_freeresult($result);
70
$this->module_cache = array();
71
foreach ($rows as $module_id => $row)
73
$this->module_cache['modules'][] = $row;
74
$this->module_cache['parents'][$row['module_id']] = $this->get_parents($row['parent_id'], $row['left_id'], $row['right_id'], $rows);
78
$cache->put('_modules_' . $this->p_class, $this->module_cache);
81
if (empty($this->module_cache))
83
$this->module_cache = array('modules' => array(), 'parents' => array());
86
// We "could" build a true tree with this function - maybe mod authors want to use this...
87
// Functions for traversing and manipulating the tree are not available though
88
// We might re-structure the module system to use true trees in 3.2.x...
89
// $tree = $this->build_tree($this->module_cache['modules'], $this->module_cache['parents']);
91
// Clean up module cache array to only let survive modules the user can access
93
foreach ($this->module_cache['modules'] as $key => $row)
95
// Not allowed to view module?
96
if (!$this->module_auth($row['module_auth']))
98
unset($this->module_cache['modules'][$key]);
102
// Category with no members, ignore
103
if (!$row['module_basename'] && ($row['left_id'] + 1 == $row['right_id']))
105
unset($this->module_cache['modules'][$key]);
110
if ($right_id !== false)
112
if ($row['left_id'] < $right_id)
114
unset($this->module_cache['modules'][$key]);
122
if (!$row['module_enabled'])
124
// If category is disabled then disable every child too
125
unset($this->module_cache['modules'][$key]);
126
$right_id = $row['right_id'];
131
// Re-index (this is needed, else we are not able to array_slice later)
132
$this->module_cache['modules'] = array_merge($this->module_cache['modules']);
134
// Include MOD _info files for populating language entries within the menus
135
$this->add_mod_info($this->p_class);
137
// Now build the module array, but exclude completely empty categories...
141
foreach ($this->module_cache['modules'] as $key => $row)
144
if ($right_id !== false)
146
if ($row['left_id'] < $right_id)
154
// Category with no members on their way down (we have to check every level)
155
if (!$row['module_basename'])
157
$empty_category = true;
159
// We go through the branch and look for an activated module
160
foreach (array_slice($this->module_cache['modules'], $key + 1) as $temp_row)
162
if ($temp_row['left_id'] > $row['left_id'] && $temp_row['left_id'] < $row['right_id'])
165
if ($temp_row['module_basename'] && $temp_row['module_enabled'])
167
$empty_category = false;
178
$right_id = $row['right_id'];
183
$depth = sizeof($this->module_cache['parents'][$row['module_id']]);
185
// We need to prefix the functions to not create a naming conflict
187
// Function for building 'url_extra'
188
$url_func = '_module_' . $row['module_basename'] . '_url';
190
// Function for building the language name
191
$lang_func = '_module_' . $row['module_basename'] . '_lang';
193
// Custom function for calling parameters on module init (for example assigning template variables)
194
$custom_func = '_module_' . $row['module_basename'];
196
$names[$row['module_basename'] . '_' . $row['module_mode']][] = true;
201
'id' => (int) $row['module_id'],
202
'parent' => (int) $row['parent_id'],
203
'cat' => ($row['right_id'] > $row['left_id'] + 1) ? true : false,
205
'is_duplicate' => ($row['module_basename'] && sizeof($names[$row['module_basename'] . '_' . $row['module_mode']]) > 1) ? true : false,
207
'name' => (string) $row['module_basename'],
208
'mode' => (string) $row['module_mode'],
209
'display' => (int) $row['module_display'],
211
'url_extra' => (function_exists($url_func)) ? $url_func($row['module_mode'], $row) : '',
213
'lang' => ($row['module_basename'] && function_exists($lang_func)) ? $lang_func($row['module_mode'], $row['module_langname']) : ((!empty($user->lang[$row['module_langname']])) ? $user->lang[$row['module_langname']] : $row['module_langname']),
214
'langname' => $row['module_langname'],
216
'left' => $row['left_id'],
217
'right' => $row['right_id'],
220
if (function_exists($custom_func))
222
$custom_func($row['module_mode'], $module_row);
225
$this->module_ary[] = $module_row;
228
unset($this->module_cache['modules'], $names);
232
* Check if a certain main module is accessible/loaded
233
* By giving the module mode you are able to additionally check for only one mode within the main module
235
* @param string $module_basename The module base name, for example logs, reports, main (for the mcp).
236
* @param mixed $module_mode The module mode to check. If provided the mode will be checked in addition for presence.
238
* @return bool Returns true if module is loaded and accessible, else returns false
240
function loaded($module_basename, $module_mode = false)
242
if (empty($this->loaded_cache))
244
$this->loaded_cache = array();
246
foreach ($this->module_ary as $row)
253
if (!isset($this->loaded_cache[$row['name']]))
255
$this->loaded_cache[$row['name']] = array();
263
$this->loaded_cache[$row['name']][$row['mode']] = true;
267
if ($module_mode === false)
269
return (isset($this->loaded_cache[$module_basename])) ? true : false;
272
return (!empty($this->loaded_cache[$module_basename][$module_mode])) ? true : false;
276
* Check module authorisation
278
function module_auth($module_auth, $forum_id = false)
280
global $auth, $config;
282
$module_auth = trim($module_auth);
284
// Generally allowed to access module if module_auth is empty
290
// With the code below we make sure only those elements get eval'd we really want to be checked
292
"[^"\\\\]*(?:\\\\.[^"\\\\]*)*" |
293
\'[^\'\\\\]*(?:\\\\.[^\'\\\\]*)*\' |
295
[^\s(),]+)/x', $module_auth, $match);
298
for ($i = 0, $size = sizeof($tokens); $i < $size; $i++)
300
$token = &$tokens[$i];
312
if (!preg_match('#(?:acl_([a-z_]+)(,\$id)?)|(?:\$id)|(?:aclf_([a-z_]+))|(?:cfg_([a-z_]+))|(?:request_([a-z_]+))#', $token))
320
$module_auth = implode(' ', $tokens);
322
// Make sure $id seperation is working fine
323
$module_auth = str_replace(' , ', ',', $module_auth);
325
$forum_id = ($forum_id === false) ? $this->acl_forum_id : $forum_id;
328
eval('$is_auth = (int) (' . preg_replace(array('#acl_([a-z_]+)(,\$id)?#', '#\$id#', '#aclf_([a-z_]+)#', '#cfg_([a-z_]+)#', '#request_([a-z_]+)#'), array('(int) $auth->acl_get(\'\\1\'\\2)', '(int) $forum_id', '(int) $auth->acl_getf_global(\'\\1\')', '(int) $config[\'\\1\']', '!empty($_REQUEST[\'\\1\'])'), $module_auth) . ');');
336
function set_active($id = false, $mode = false)
339
$this->active_module = false;
341
if (request_var('icat', ''))
344
$id = request_var('icat', '');
348
foreach ($this->module_ary as $row_id => $item_ary)
350
// If this is a module and it's selected, active
351
// If this is a category and the module is the first within it, active
352
// If this is a module and no mode selected, select first mode
353
// If no category or module selected, go active for first module in first category
355
(($item_ary['name'] === $id || $item_ary['id'] === (int) $id) && (($item_ary['mode'] == $mode && !$item_ary['cat']) || ($icat && $item_ary['cat']))) ||
356
($item_ary['parent'] === $category && !$item_ary['cat'] && !$icat && $item_ary['display']) ||
357
(($item_ary['name'] === $id || $item_ary['id'] === (int) $id) && !$mode && !$item_ary['cat']) ||
358
(!$id && !$mode && !$item_ary['cat'] && $item_ary['display'])
361
if ($item_ary['cat'])
369
$this->p_id = $item_ary['id'];
370
$this->p_parent = $item_ary['parent'];
371
$this->p_name = $item_ary['name'];
372
$this->p_mode = $item_ary['mode'];
373
$this->p_left = $item_ary['left'];
374
$this->p_right = $item_ary['right'];
376
$this->module_cache['parents'] = $this->module_cache['parents'][$this->p_id];
377
$this->active_module = $item_ary['id'];
378
$this->active_module_row_id = $row_id;
382
else if (($item_ary['cat'] && $item_ary['id'] === (int) $id) || ($item_ary['parent'] === $category && $item_ary['cat']))
384
$category = $item_ary['id'];
390
* Loads currently active module
392
* This method loads a given module, passing it the relevant id and mode.
394
function load_active($mode = false, $module_url = false, $execute_module = true)
396
global $phpbb_root_path, $phpbb_admin_path, $phpEx, $user;
398
$module_path = $phpbb_root_path . 'includes/' . $this->p_class;
399
$icat = request_var('icat', '');
401
if ($this->active_module === false)
403
trigger_error('Module not accessible', E_USER_ERROR);
406
if (!class_exists("{$this->p_class}_$this->p_name"))
408
if (!file_exists("$module_path/{$this->p_class}_$this->p_name.$phpEx"))
410
trigger_error("Cannot find module $module_path/{$this->p_class}_$this->p_name.$phpEx", E_USER_ERROR);
413
include("$module_path/{$this->p_class}_$this->p_name.$phpEx");
415
if (!class_exists("{$this->p_class}_$this->p_name"))
417
trigger_error("Module file $module_path/{$this->p_class}_$this->p_name.$phpEx does not contain correct class [{$this->p_class}_$this->p_name]", E_USER_ERROR);
422
$this->p_mode = $mode;
425
// Create a new instance of the desired module ... if it has a
426
// constructor it will of course be executed
427
$instance = "{$this->p_class}_$this->p_name";
429
$this->module = new $instance($this);
431
// We pre-define the action parameter we are using all over the place
432
if (defined('IN_ADMIN'))
434
// Is first module automatically enabled a duplicate and the category not passed yet?
435
if (!$icat && $this->module_ary[$this->active_module_row_id]['is_duplicate'])
437
$icat = $this->module_ary[$this->active_module_row_id]['parent'];
440
// Not being able to overwrite ;)
441
$this->module->u_action = append_sid("{$phpbb_admin_path}index.$phpEx", "i={$this->p_name}") . (($icat) ? '&icat=' . $icat : '') . "&mode={$this->p_mode}";
445
// If user specified the module url we will use it...
446
if ($module_url !== false)
448
$this->module->u_action = $module_url;
452
$this->module->u_action = $phpbb_root_path . (($user->page['page_dir']) ? $user->page['page_dir'] . '/' : '') . $user->page['page_name'];
455
$this->module->u_action = append_sid($this->module->u_action, "i={$this->p_name}") . (($icat) ? '&icat=' . $icat : '') . "&mode={$this->p_mode}";
458
// Add url_extra parameter to u_action url
459
if (!empty($this->module_ary) && $this->active_module !== false && $this->module_ary[$this->active_module_row_id]['url_extra'])
461
$this->module->u_action .= $this->module_ary[$this->active_module_row_id]['url_extra'];
464
// Assign the module path for re-usage
465
$this->module->module_path = $module_path . '/';
467
// Execute the main method for the new instance, we send the module id and mode as parameters
468
// Users are able to call the main method after this function to be able to assign additional parameters manually
471
$this->module->main($this->p_name, $this->p_mode);
479
* Appending url parameter to the currently active module.
481
* This function is called for adding specific url parameters while executing the current module.
482
* It is doing the same as the _module_{name}_url() function, apart from being able to be called after
483
* having dynamically parsed specific parameters. This allows more freedom in choosing additional parameters.
484
* One example can be seen in /includes/mcp/mcp_notes.php - $this->p_master->adjust_url() call.
486
* @param string $url_extra Extra url parameters, e.g.: &u=$user_id
489
function adjust_url($url_extra)
491
if (empty($this->module_ary[$this->active_module_row_id]))
496
$row = &$this->module_ary[$this->active_module_row_id];
498
// We check for the same url_extra in $row['url_extra'] to overcome doubled additions...
499
if (strpos($row['url_extra'], $url_extra) === false)
501
$row['url_extra'] .= $url_extra;
506
* Check if a module is active
508
function is_active($id, $mode = false)
510
// If we find a name by this id and being enabled we have our active one...
511
foreach ($this->module_ary as $row_id => $item_ary)
513
if (($item_ary['name'] === $id || $item_ary['id'] === (int) $id) && $item_ary['display'])
515
if ($mode === false || $mode === $item_ary['mode'])
528
function get_parents($parent_id, $left_id, $right_id, &$all_parents)
536
foreach ($all_parents as $module_id => $row)
538
if ($row['left_id'] < $left_id && $row['right_id'] > $right_id)
540
$parents[$module_id] = $row['parent_id'];
543
if ($row['left_id'] > $left_id)
556
function get_branch($left_id, $right_id, $remaining)
560
foreach ($remaining as $key => $row)
562
if ($row['left_id'] > $left_id && $row['left_id'] < $right_id)
574
* Build true binary tree from given array
577
function build_tree(&$modules, &$parents)
581
foreach ($modules as $row)
585
if ($row['parent_id'])
587
// Go through the tree to find our branch
588
$parent_tree = $parents[$row['module_id']];
590
foreach ($parent_tree as $id => $value)
592
if (!isset($branch[$id]) && isset($branch['child']))
594
$branch = &$branch['child'];
596
$branch = &$branch[$id];
598
$branch = &$branch['child'];
601
$branch[$row['module_id']] = $row;
602
if (!isset($branch[$row['module_id']]['child']))
604
$branch[$row['module_id']]['child'] = array();
612
* Build navigation structure
614
function assign_tpl_vars($module_url)
618
$current_id = $right_id = false;
620
// Make sure the module_url has a question mark set, effectively determining the delimiter to use
621
$delim = (strpos($module_url, '?') === false) ? '?' : '&';
623
$current_padding = $current_depth = 0;
624
$linear_offset = 'l_block1';
625
$tabular_offset = 't_block2';
627
// Generate the list of modules, we'll do this in two ways ...
628
// 1) In a linear fashion
629
// 2) In a combined tabbed + linear fashion ... tabs for the categories
630
// and a linear list for subcategories/items
631
foreach ($this->module_ary as $row_id => $item_ary)
633
// Skip hidden modules
634
if (!$item_ary['display'])
640
if ($right_id !== false)
642
if ($item_ary['left'] < $right_id)
650
// Category with no members on their way down (we have to check every level)
651
if (!$item_ary['name'])
653
$empty_category = true;
655
// We go through the branch and look for an activated module
656
foreach (array_slice($this->module_ary, $row_id + 1) as $temp_row)
658
if ($temp_row['left'] > $item_ary['left'] && $temp_row['left'] < $item_ary['right'])
660
// Module there and displayed?
661
if ($temp_row['name'] && $temp_row['display'])
663
$empty_category = false;
674
$right_id = $item_ary['right'];
679
// Select first id we can get
680
if (!$current_id && (in_array($item_ary['id'], array_keys($this->module_cache['parents'])) || $item_ary['id'] == $this->p_id))
682
$current_id = $item_ary['id'];
685
$depth = $item_ary['depth'];
687
if ($depth > $current_depth)
689
$linear_offset = $linear_offset . '.l_block' . ($depth + 1);
690
$tabular_offset = ($depth + 1 > 2) ? $tabular_offset . '.t_block' . ($depth + 1) : $tabular_offset;
692
else if ($depth < $current_depth)
694
for ($i = $current_depth - $depth; $i > 0; $i--)
696
$linear_offset = substr($linear_offset, 0, strrpos($linear_offset, '.'));
697
$tabular_offset = ($i + $depth > 1) ? substr($tabular_offset, 0, strrpos($tabular_offset, '.')) : $tabular_offset;
701
$u_title = $module_url . $delim . 'i=' . (($item_ary['cat']) ? $item_ary['id'] : $item_ary['name'] . (($item_ary['is_duplicate']) ? '&icat=' . $current_id : '') . '&mode=' . $item_ary['mode']);
703
// Was not allowed in categories before - /*!$item_ary['cat'] && */
704
$u_title .= (isset($item_ary['url_extra'])) ? $item_ary['url_extra'] : '';
706
// Only output a categories items if it's currently selected
707
if (!$depth || ($depth && (in_array($item_ary['parent'], array_values($this->module_cache['parents'])) || $item_ary['parent'] == $this->p_parent)))
709
$use_tabular_offset = (!$depth) ? 't_block1' : $tabular_offset;
712
'L_TITLE' => $item_ary['lang'],
713
'S_SELECTED' => (in_array($item_ary['id'], array_keys($this->module_cache['parents'])) || $item_ary['id'] == $this->p_id) ? true : false,
714
'U_TITLE' => $u_title
717
$template->assign_block_vars($use_tabular_offset, array_merge($tpl_ary, array_change_key_case($item_ary, CASE_UPPER)));
721
'L_TITLE' => $item_ary['lang'],
722
'S_SELECTED' => (in_array($item_ary['id'], array_keys($this->module_cache['parents'])) || $item_ary['id'] == $this->p_id) ? true : false,
723
'U_TITLE' => $u_title
726
$template->assign_block_vars($linear_offset, array_merge($tpl_ary, array_change_key_case($item_ary, CASE_UPPER)));
728
$current_depth = $depth;
733
* Returns desired template name
735
function get_tpl_name()
737
return $this->module->tpl_name . '.html';
741
* Returns the desired page title
743
function get_page_title()
747
if (!isset($this->module->page_title))
752
return (isset($user->lang[$this->module->page_title])) ? $user->lang[$this->module->page_title] : $this->module->page_title;
756
* Load module as the current active one without the need for registering it
758
function load($class, $name, $mode = false)
760
$this->p_class = $class;
761
$this->p_name = $name;
763
// Set active module to true instead of using the id
764
$this->active_module = true;
766
$this->load_active($mode);
772
function display($page_title, $display_online_list = true)
774
global $template, $user;
777
if (defined('IN_ADMIN') && isset($user->data['session_admin']) && $user->data['session_admin'])
779
adm_page_header($page_title);
783
page_header($page_title, $display_online_list);
786
$template->set_filenames(array(
787
'body' => $this->get_tpl_name())
790
if (defined('IN_ADMIN') && isset($user->data['session_admin']) && $user->data['session_admin'])
801
* Toggle whether this module will be displayed or not
803
function set_display($id, $mode = false, $display = true)
805
foreach ($this->module_ary as $row_id => $item_ary)
807
if (($item_ary['name'] === $id || $item_ary['id'] === (int) $id) && (!$mode || $item_ary['mode'] === $mode))
809
$this->module_ary[$row_id]['display'] = (int) $display;
815
* Add custom MOD info language file
817
function add_mod_info($module_class)
819
global $user, $phpEx;
821
if (file_exists($user->lang_path . 'mods'))
823
$add_files = array();
825
$dir = @opendir($user->lang_path . 'mods');
829
while (($entry = readdir($dir)) !== false)
831
if (strpos($entry, 'info_' . strtolower($module_class) . '_') === 0 && substr(strrchr($entry, '.'), 1) == $phpEx)
833
$add_files[] = 'mods/' . substr(basename($entry), 0, -(strlen($phpEx) + 1));
839
if (sizeof($add_files))
841
$user->add_lang($add_files);
b'\\ No newline at end of file'
added
removed
www/php/phpBB3/includes/functions_module.php
