mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-30 21:40:43 +02:00
Code Issues Releases Wiki Activity

Merge remote-tracking branch 'github-prototech/ticket/11508' into develop-ascraeus

Browse Source 
* github-prototech/ticket/11508:
  [ticket/11508] Fix build_url test.
  [ticket/11508] Add functional test for jumpbox.
  [ticket/11508] Use $phpbb_path_helper.
  [ticket/11508] Allow equal sign in parameter value.
  [ticket/11508] Remove unnecessary implode.
  [ticket/11508] Remove unnecessary isset check.
  [ticket/11508] Fix build_url test.
  [ticket/11508] Curly brace should be on its own line...
  [ticket/11508] The question mark is expected even if there are no parameters.
  [ticket/11508] Add tests.
  [ticket/11508] Do not add the '?' unless there are parameters.
  [ticket/11508] Change separator parameter to a simple true|false $is_amp.
  [ticket/11508] Move helper functions to path_helper class.
  [ticket/11508] Move the stripping param code to separate function as well.
  [ticket/11508] Build the jumpbox hidden fields using the _form action_
  [ticket/11508] Split parts of build_url() into reusable functions.
This commit is contained in:
Nils Adermann
2014-05-02 16:40:01 +02:00
parent a9ae1f83c7 e9b00071dd
commit e65c51e3cd
6 changed files with 393 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
phpBB/includes/functions.php
View File

@@ -2326,8 +2326,9 @@ function reapply_sid($url)
*/
function build_url($strip_vars = false)
{
global $config, $user, $phpEx, $phpbb_root_path;
global $config, $user, $phpbb_path_helper;
$php_ext = $phpbb_path_helper->get_php_ext();
$page = $user->page['page'];
// We need to be cautious here.
@@ -2340,71 +2341,23 @@ function build_url($strip_vars = false)
if ($url_parts === false || empty($url_parts['scheme']) || empty($url_parts['host']))
{
// Remove 'app.php/' from the page, when rewrite is enabled
if ($config['enable_mod_rewrite'] && strpos($page, 'app.' . $phpEx . '/') === 0)
if ($config['enable_mod_rewrite'] && strpos($page, 'app.' . $php_ext . '/') === 0)
{
$page = substr($page, strlen('app.' . $phpEx . '/'));
$page = substr($page, strlen('app.' . $php_ext . '/'));
}
$page = $phpbb_root_path . $page;
$page = $phpbb_path_helper->get_phpbb_root_path() . $page;
}
// Append SID
$redirect = append_sid($page, false, false);
// Add delimiter if not there...
if (strpos($redirect, '?') === false)
if ($strip_vars !== false)
{
$redirect .= '?';
$redirect = $phpbb_path_helper->strip_url_params($redirect, $strip_vars, false);
}
// Strip vars...
if ($strip_vars !== false && strpos($redirect, '?') !== false)
{
if (!is_array($strip_vars))
{
$strip_vars = array($strip_vars);
}
$query = $_query = array();
$args = substr($redirect, strpos($redirect, '?') + 1);
$args = ($args) ? explode('&', $args) : array();
$redirect = substr($redirect, 0, strpos($redirect, '?'));
foreach ($args as $argument)
{
$arguments = explode('=', $argument);
$key = $arguments[0];
unset($arguments[0]);
if ($key === '')
{
continue;
}
$query[$key] = implode('=', $arguments);
}
// Strip the vars off
foreach ($strip_vars as $strip)
{
if (isset($query[$strip]))
{
unset($query[$strip]);
}
}
// Glue the remaining parts together... already urlencoded
foreach ($query as $key => $value)
{
$_query[] = $key . '=' . $value;
}
$query = implode('&', $_query);
$redirect .= ($query) ? '?' . $query : '';
}
return str_replace('&', '&', $redirect);
return $redirect . ((strpos($redirect, '?') === false) ? '?' : '');
}
/**
@@ -4902,7 +4855,6 @@ function page_header($page_title = '', $display_online_list = false, $item_id =
}
}
$hidden_fields_for_jumpbox = phpbb_build_hidden_fields_for_query_params($request, array('f'));
$notification_mark_hash = generate_link_hash('mark_all_notifications_read');
// The following assigns all _common_ variables that may be used at any point in a template.
@@ -4919,7 +4871,6 @@ function page_header($page_title = '', $display_online_list = false, $item_id =
'LOGGED_IN_USER_LIST' => $online_userlist,
'RECORD_USERS' => $l_online_record,
'PRIVATE_MESSAGE_COUNT' => (!empty($user->data['user_unread_privmsg'])) ? $user->data['user_unread_privmsg'] : 0,
'HIDDEN_FIELDS_FOR_JUMPBOX' => $hidden_fields_for_jumpbox,
'UNREAD_NOTIFICATIONS_COUNT' => ($notifications !== false) ? $notifications['unread_count'] : '',
'NOTIFICATIONS_COUNT' => ($notifications !== false) ? $notifications['unread_count'] : '',

11
phpBB/includes/functions_content.php
View File

@@ -110,7 +110,7 @@ function gen_sort_selects(&$limit_days, &$sort_by_text, &$sort_days, &$sort_key,
*/
function make_jumpbox($action, $forum_id = false, $select_all = false, $acl_list = false, $force_display = false)
{
global $config, $auth, $template, $user, $db;
global $config, $auth, $template, $user, $db, $phpbb_path_helper;
// We only return if the jumpbox is not forced to be displayed (in case it is needed for functionality)
if (!$config['load_jumpbox'] && $force_display === false)
@@ -196,10 +196,13 @@ function make_jumpbox($action, $forum_id = false, $select_all = false, $acl_list
$db->sql_freeresult($result);
unset($padding_store);
$url_parts = $phpbb_path_helper->get_url_parts($action);
$template->assign_vars(array(
'S_DISPLAY_JUMPBOX' => $display_jumpbox,
'S_JUMPBOX_ACTION' => $action)
);
'S_DISPLAY_JUMPBOX' => $display_jumpbox,
'S_JUMPBOX_ACTION' => $action,
'HIDDEN_FIELDS_FOR_JUMPBOX' => build_hidden_fields($url_parts['params']),
));
return;
}

116
phpBB/phpbb/path_helper.php
View File

@@ -216,4 +216,120 @@ class path_helper
return $scheme . $this->filesystem->clean_path($path);
}
/**
* Glue URL parameters together
*
* @param array $params URL parameters in the form of array(name => value)
* @return string Returns the glued string, e.g. name1=value1&name2=value2
*/
public function glue_url_params($params)
{
$_params = array();
foreach ($params as $key => $value)
{
$_params[] = $key . '=' . $value;
}
return implode('&', $_params);
}
/**
* Get the base and parameters of a URL
*
* @param string $url URL to break apart
* @param bool $is_amp Is the parameter separator &. Defaults to true.
* @return array Returns the base and parameters in the form of array('base' => string, 'params' => array(name => value))
*/
public function get_url_parts($url, $is_amp = true)
{
$separator = ($is_amp) ? '&' : '&';
$params = array();
if (strpos($url, '?') !== false)
{
$base = substr($url, 0, strpos($url, '?'));
$args = substr($url, strlen($base) + 1);
$args = ($args) ? explode($separator, $args) : array();
foreach ($args as $argument)
{
if (empty($argument))
{
continue;
}
list($key, $value) = explode('=', $argument, 2);
if ($key === '')
{
continue;
}
$params[$key] = $value;
}
}
else
{
$base = $url;
}
return array(
'base' => $base,
'params' => $params,
);
}
/**
* Strip parameters from an already built URL.
*
* @param string $url URL to strip parameters from
* @param array|string $strip Parameters to strip.
* @param bool $is_amp Is the parameter separator &. Defaults to true.
* @return string Returns the new URL.
*/
public function strip_url_params($url, $strip, $is_amp = true)
{
$url_parts = $this->get_url_parts($url, $is_amp);
$params = $url_parts['params'];
if (!is_array($strip))
{
$strip = array($strip);
}
if (!empty($params))
{
// Strip the parameters off
foreach ($strip as $param)
{
unset($params[$param]);
}
}
return $url_parts['base'] . (($params) ? '?' . $this->glue_url_params($params) : '');
}
/**
* Append parameters to an already built URL.
*
* @param string $url URL to append parameters to
* @param array $new_params Parameters to add in the form of array(name => value)
* @param string $is_amp Is the parameter separator &. Defaults to true.
* @return string Returns the new URL.
*/
public function append_url_params($url, $new_params, $is_amp = true)
{
$url_parts = $this->get_url_parts($url, $is_amp);
$params = array_merge($url_parts['params'], $new_params);
// Move the sid to the end if it's set
if (isset($params['sid']))
{
$sid = $params['sid'];
unset($params['sid']);
$params['sid'] = $sid;
}
return $url_parts['base'] . (($params) ? '?' . $this->glue_url_params($params) : '');
}
}