[RC] HTTP Guest Cache

A place for MOD Authors to post and receive feedback on MODs still in development. No MODs within this forum should be used within a live environment!
Get Involved
Haravikk
Registered User
Posts: 261
Joined: Sat Nov 02, 2002 4:42 pm

[RC] HTTP Guest Cache

Post by Haravikk » Sat Feb 09, 2013 6:54 pm

Modification Name: HTTP Guest Cache
Author: Haravikk

Modification Description:: This mod enables pages viewed by guests to be cached via HTTP, resulting in reduced repeat page generations not just for individual users, but also for multiple users when using intermediary caches.
Modification Version:: 0.2.1

Requirements: phpBB 3.0.11 (may work with earlier versions)

Compatibility:
There is currently a bug affecting this mod when used in combination with the Artodia mobile style mods for phpBB which can result in a redirection loop. I'll produce a fix at the earliest opportunity, but in the mean time these mods are not compatible until I can figure out why this happens.

In addition, any mods that add changing content to guest pages, without altering their URL in any way (e.g - adding parameters) may not be truly compatible with this mod, as caches will not recognise the difference, potentially resulting in a change in the loaded page. As usual for mods still in development; there may other incompatibilities that I am still unaware of, please let me know if you find any not listed here!

Features:
  • Detects when most common page views are in fact cacheable (user is guest with no ability to change the page, e.g - by posting/replying).
  • Automatically sanitises URLs and adds a parameter to better support caching of only guest pages (logged in users are unaffected). Parameter can also be used to override behaviour for guests that require the latest version of a page. Some pages (currently only the view online page) may override this with a shorter time if appropriate.
  • Sets HTTP headers with adjustable expiration time to tailor how up to date cached pages will be for end users.
  • Optionally uses Javascript to provide "correct" timestamps, as opposed to potentially out-of-date ones produced when the cached file was updated.
Modification Download: Download from DropBox

Additional Notes:
This mod is AutoMOD compatible, and uses a UMIL installer to activate its Administration Control Panel module; this is optional if you prefer to add the module yourself.

Although the mod can operate with guest marking of topics turned on, it is strongly recommended that this is disabled, which you can easily do from this mod's module. If marking for guests is turned on then caching will be limited to the FAQ, member list, view online pages and user control panel pages; that is, those of which are accessible to guests anyway! To gain the maximum utility from this mod it is recommended to run a board without posting privileges for guest accounts, or for these permissions to be restricted to only certain areas of the board such as a new-members forum; this way the majority of the board should be cacheable.

Also, I don't currently know if I've set up the .xsl file properly, since none of the browsers I've tried it in display it properly, but the same is true for other mods that I've downloaded as well.

Changelog:
0.2.1:
  • Cron-jobs are permitted to execute if headers have not been sent, in which case HTTP caching headers are removed.
  • Added X-Mod-Http-Cache-Expired header if the DEBUG constant is enabled in config.php, allowing for easier inspection of expiration dates from caches that perform modification to headers.
  • Mod now uses the $_EXTRA_URL feature of append_sid() to remove the need for more complex code in append_sid(). This greatly simplifies changes to append_sid(), which now only has code for ensuring cache parameters are removed from URLs if found to be set.
  • Added compatibility option to strip no-cache="set-cookie" header from cacheable pages. Although not recommended, it may be necessary to do this on HTTP caches (currently including CloudFlare) that do not process the contents of the no-cache directive and simply treat the file as uncacheable.
0.2.0:
  • Added (optional) caching to search.php.
  • Replaced "isset($config['foo']) && $config['foo']" statements with "!empty($config['foo'])" for improved readability.
  • Extracted HTTP header setting into a separate set_header() method, to make mod compatibility a bit easier, and to simplify the changes to includes/functions.php.
  • Topics and forums that are locked are now cacheable even if guests would otherwise be allowed to post/reply to them.
  • Simplified UMIL installer files, tidied up some edits for global $foo calls.
  • Suppressed inclusion of cron-tasks for cacheable requests, otherwise calls to cron.php may be stored within cached page(s), and be triggered all users that recall them.
  • Add more robust steps to find actions for complex files such as functions.php.
  • Removed support for ucp.php to prevent login issues when cookies don't work.
0.1.1:
  • Renamed to "HTTP Guest Cache" to be more descriptive.
  • Extracted session clearing to a custom function to avoid calling session_kill(), for greater compatibility.
0.1.0:
  • Initial Release
Upgrade Instructions (v0.1.0 to v0.1.1)
To upgrade from v0.1.0 to v0.1.1 you will need to first uninstall using the UMIL installer, before uninstalling using AutoMOD or by following the install instructions in reverse to do this manually. If you need to re-download v0.1.0 then you can do so here.

You may then install v0.1.1 (and later) as normal.

Adding Mod Compatibility
If you want to make pages added by your mod(s) compatible with this one then you will need to edit the files manually (this is an unsupported action, recommended for mod authors only).

To mark your page as cacheable in a mod-agnostic way (won't fail if this mod isn't installed) you can add the following code to your page script(s):

Code: Select all

/* BEGIN mod_http_guest_cache */
if (!empty($config['mod_http_guest_cache']))
{
	include_once "$phpbb_root_path/includes/mod_http_guest_cache.$phpEx";
	if ($mod_http_guest_cache->is_guest())
	{
		$mod_http_guest_cache->set_cacheable(true);
	}
}
/* END mod_http_guest_cache */
This code should be added anywhere in the file after the line $auth->acl($user->data), but before any call to page_header(). Basically the code should be added at the earliest location that you know for sure that it's okay for the page to be cached. The code is safe to include in mods even when HTTP guest cache is not installed at all, so support is encouraged ;)

If the cacheability of the page is dependent on some condition then add a test for this condition to the call to set_cacheable() instead of simply passing true. For example you might do something like:

Code: Select all

		$mod_http_guest_cache->set_cacheable(!$auth->acl_gets('f_post', 'f_reply', $forum_id));
In which case the page will only be cacheable if if the user is able to post in the current forum.

CloudFlare Support
By default CloudFlare does not cache PHP pages, however it is possible to add this support with Page Rules.

Your page-rule should look something like this:

URL Pattern: example.org/forum/*?*cache=1*
Custom Caching: Cache Everything

Substituting the correct domain, forum root path and cache parameter into your pattern. You can verify that the rule is working because all valid page-views should include the Cf-Cache-Status header. It can take a while for caching to begin (the header value with be "MISS") but if your site is generating enough cacheable traffic then CloudFlare will begin serving up cached guest pages.

In order to cache your pages properly in CloudFlare you will need to enable the option to omit the no-cache="set-cookie" directive in the mod's admin panel. This option was added in v0.2.1, and will allow CloudFlare to cache pages as expected; omitting this directive is not recommended on other caching providers unless you know that they strip cookies from cached results, which is what CloudFlare does.

Thanks
Many thanks to Pthelovod and Kot Matroskin for feedback and testing!
Last edited by Haravikk on Sat Jul 13, 2013 4:47 pm, edited 12 times in total.

Haravikk
Registered User
Posts: 261
Joined: Sat Nov 02, 2002 4:42 pm

Re: [Beta] Guest Cache

Post by Haravikk » Sat Feb 09, 2013 7:46 pm

Sorry, I somehow missed the part where we need to use a template for in-development mods; I've edited the first post so hopefully it's okay now!

User avatar
Pthelovod
Registered User
Posts: 106
Joined: Mon Feb 22, 2010 1:32 am
Location: Россия
Name: Alexs Pthelovod
Contact:

Re: [Beta] Guest Cache

Post by Pthelovod » Sun Feb 10, 2013 8:19 am

Файл: [ROOT]/viewtopic.php
Строка: 2003 [PHP Notice]
Undefined index: is_registered

Code: Select all

	if ($config['load_cpf_viewtopic'])
	{
		$cp_row = (isset($profile_fields_cache[$poster_id])) ? $cp->generate_profile_fields_template('show', false, $profile_fields_cache[$poster_id]) : array();
	}

	$post_unread = (isset($topic_tracking_info[$topic_id]) && $row['post_time'] > $topic_tracking_info[$topic_id]) ? true : false;

	$s_first_unread = false;
	if (!$first_unread && $post_unread)
	{
		$s_first_unread = $first_unread = true;
	}

2003+	$edit_allowed = ($user->data['is_registered'] && ($auth->acl_get('m_edit', $forum_id) || (
		$user->data['user_id'] == $poster_id &&
		$auth->acl_get('f_edit', $forum_id) &&
		!$row['post_edit_locked'] &&
		($row['post_time'] > time() - ($config['edit_time'] * 60) || !$config['edit_time'])
	)));

	$delete_allowed = ($user->data['is_registered'] && ($auth->acl_get('m_delete', $forum_id) || (
		$user->data['user_id'] == $poster_id &&
		$auth->acl_get('f_delete', $forum_id) &&
		$topic_data['topic_last_post_id'] == $row['post_id'] &&
		($row['post_time'] > time() - ($config['delete_time'] * 60) || !$config['delete_time']) &&
		// we do not want to allow removal of the last post if a moderator locked it!
		!$row['post_edit_locked']
	)));
Файл: [ROOT]/viewtopic.php
Строка: 2010 [PHP Notice]
Undefined index: is_registered

Code: Select all

	if ($config['load_cpf_viewtopic'])
	{
		$cp_row = (isset($profile_fields_cache[$poster_id])) ? $cp->generate_profile_fields_template('show', false, $profile_fields_cache[$poster_id]) : array();
	}

	$post_unread = (isset($topic_tracking_info[$topic_id]) && $row['post_time'] > $topic_tracking_info[$topic_id]) ? true : false;

	$s_first_unread = false;
	if (!$first_unread && $post_unread)
	{
		$s_first_unread = $first_unread = true;
	}

	$edit_allowed = ($user->data['is_registered'] && ($auth->acl_get('m_edit', $forum_id) || (
		$user->data['user_id'] == $poster_id &&
		$auth->acl_get('f_edit', $forum_id) &&
		!$row['post_edit_locked'] &&
		($row['post_time'] > time() - ($config['edit_time'] * 60) || !$config['edit_time'])
	)));

2010+	$delete_allowed = ($user->data['is_registered'] && ($auth->acl_get('m_delete', $forum_id) || (
		$user->data['user_id'] == $poster_id &&
		$auth->acl_get('f_delete', $forum_id) &&
		$topic_data['topic_last_post_id'] == $row['post_id'] &&
		($row['post_time'] > time() - ($config['delete_time'] * 60) || !$config['delete_time']) &&
		// we do not want to allow removal of the last post if a moderator locked it!
		!$row['post_edit_locked']
	)));
Файл: [ROOT]/viewtopic.php
Строка: 2143 [PHP Notice]
Undefined index: is_registered

Code: Select all

		'U_EDIT'			=> ($edit_allowed) ? append_sid("{$phpbb_root_path}posting.$phpEx", "mode=edit&f=$forum_id&p={$row['post_id']}") : '',
		'U_QUOTE'			=> ($auth->acl_get('f_reply', $forum_id)) ? append_sid("{$phpbb_root_path}posting.$phpEx", "mode=quote&f=$forum_id&p={$row['post_id']}") : '',
		'U_INFO'			=> ($auth->acl_get('m_info', $forum_id)) ? append_sid("{$phpbb_root_path}mcp.$phpEx", "i=main&mode=post_details&f=$forum_id&p=" . $row['post_id'], true, $user->session_id) : '',
		'U_DELETE'			=> ($delete_allowed) ? append_sid("{$phpbb_root_path}posting.$phpEx", "mode=delete&f=$forum_id&p={$row['post_id']}") : '',
2143+   'U_NOMINATE'		=> $user->data['is_registered'] && $poster_id != $user->data['user_id'] && $poster_id != ANONYMOUS ? append_sid("{$phpbb_root_path}medals.$phpEx", "m=nominate&u=$poster_id&ref=" . $row['post_id']) : '',
// start change_author
		'S_CAN_CHGPOSTER'	=> $change_poster,
		'U_FIND_USERNAME'	=> ($auth->acl_get('m_chgposter', $forum_id)) ? append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=searchuser&form=mcp_chgposter'.$row['post_id'].'&field=username&select_single=true') : '',
		'S_USER_SELECT'		=> $user_select,
Файл: [ROOT]/arcade/includes/phpBBArcade.php
Строка: 331 [PHP Notice]
Undefined index: is_registered

Code: Select all

	function access($type = '', $admin = true)
	{
		global $user, $auth;
		global $arcade_config;

331+		$admin			= ($admin && $user->data['is_registered'] && $auth->acl_get('a_')) ? true : false;
		$arcade_access	= ($this->version_check() && $auth->acl_get('u_arcade') && !$this->ban_check(true) && (!$arcade_config['arcade_disable'] || $admin)) ? true : false;

		switch ($type)
		{
			case 'challenge':
				$arcade_access = ($arcade_access && $auth->acl_get('u_arcade_challenge') && (!$arcade_config['challenge_disable'] || $admin)) ? true : false;
			break;
Файл: [ROOT]/arcade/includes/phpBBArcade.php
Строка: 147 [PHP Notice]
Undefined index: is_registered

Code: Select all

	function ban_check($return = false)
	{
		global $user;

147+		if ($user->data['is_registered'] && $user->data['user_type'] == USER_FOUNDER)
		{
			return false;
		}

		static $_arcade_user_ban_cache;
Файл: [ROOT]/arcade/includes/phpBBArcade.php
Строка: 770 [PHP Notice]
Undefined index: is_registered

Code: Select all

		'U_ARCADE_SCORE'				=> $arcade->url('swf=score'),
		'U_ARCADE_AJAX'					=> $arcade->url(false, 'arcade/js/ajax'),

770+		'S_ARCADE_REPORTS'				=> ($user->data['is_registered'] && $auth->acl_get('a_arcade_utilities')) ? true : false,
		'S_ARCADE_REPORTS_OPEN'			=> ($arcade_config['reports_open']) ? true : false,
Image

Help please. Protocol 2 minutes to fill pages 120-150

:oops: :oops: :oops: :oops: :oops: :oops: :oops:

User avatar
Kot Matroskin
Registered User
Posts: 126
Joined: Sat May 29, 2010 9:44 am
Location: Minsk, Belarus
Name: Vitaly Filatenko
Contact:

Re: [Beta] Guest Cache

Post by Kot Matroskin » Sun Feb 10, 2013 11:29 am

Hello Haravikk,

thank yoг for your mod! I was working on the same task latest week (related discussion topic on Russian language), and almost was ready to release alpha version... when encountered with your mod. :) Honestly, It was something confused for me, I have felt like my work is useless... Ever mod's names are same: I planned to call my mod "Cache guests pages". :twisted:

But when I've investigated your code changes, I felt relief -- we pursuit for one goal, but in different ways. ;) Could you please confirm my assumption and investigation, that your mod just performs http-protocol cache, not physical cache of guests pages (like my mod does)?

So, it works for particular one guest user, when he tries to return back to already viewed page. But when another guest will visited this page, the page have to be rendered again for him?

Haravikk
Registered User
Posts: 261
Joined: Sat Nov 02, 2002 4:42 pm

Re: [Beta] Guest Cache

Post by Haravikk » Sun Feb 10, 2013 12:30 pm

Kot Matroskin wrote:Could you please confirm my assumption and investigation, that your mod just performs http-protocol cache, not physical cache of guests pages (like my mod does)?

So, it works for particular one guest user, when he tries to return back to already viewed page. But when another guest will visited this page, the page have to be rendered again for him?
That's correct; it's a fairly simple mod that just strips SIDs from URLs and adds HTTP caching headers. While it will only work for individual guests normally , if used with an intermediary cache (such as CloudFlare) it should work for all guest traffic without touching the server at all. Since I'm already using CloudFlare on my site it's basically intended as a way to offload page requests to them as well, as I'm currently overworking my poor PHP installation with hundreds of requests ;)

I'm afraid I can't read Russian, but if/when your mod is available for download I'd love to know, as I may be able to tweak mine to work alongside it or even change its behaviour if your mod is installed! I think that I may rename mine to "HTTP Guest Cache" or similar, to make it a bit clearer what mine does.


@Pthelovod, can you give more details about what you did when this issue occurred, have you installed any other mods, was it a vanilla phpBB installation? My mod shouldn't be doing anything that affects the contents of the $user->data array that I'm aware of; all my mod does is check the $user->data['is_bot'] property for some of its tests, I can't think of any reason the $user->data['is_registered'] property would have disappeared?

User avatar
Pthelovod
Registered User
Posts: 106
Joined: Mon Feb 22, 2010 1:32 am
Location: Россия
Name: Alexs Pthelovod
Contact:

Re: [Beta] Guest Cache

Post by Pthelovod » Sun Feb 10, 2013 1:22 pm

Haravikk
What do you provide for the analysis of errors? I did not write in English. This mod works perfectly already at three conferences. Load is reduced and weak servers happy. And in one forum does not want. Forum strongly modified (almost 500 models). Errors appear immediately when you turn in the administration panel. Is an error in the protocol debugger. I can not understand myself.
Changes to the file

Code: Select all

styles/prosilver/template/index_body.html
until you make.
I have several of these codes

Code: Select all

{CURRENT_TIME}
in files overall_header.html and index_body.html .
Add files.

index_body.html

Code: Select all

<!-- INCLUDE overall_header.html -->

<p class="{S_CONTENT_FLOW_END}<!-- IF S_USER_LOGGED_IN --> rightside<!-- ENDIF -->"><!-- IF S_USER_LOGGED_IN -->{LAST_VISIT_DATE}<!-- ELSE -->{CURRENT_TIME}<!-- ENDIF --></p>
<!-- IF U_MCP --><p>{CURRENT_TIME} <br />[&nbsp;<a href="{U_MCP}">{L_MCP}</a>&nbsp;]</p><!-- ELSEIF S_USER_LOGGED_IN --><p>{CURRENT_TIME}</p><!-- ENDIF -->

<!-- IF RECENT_TOPICS_DISPLAY -->
<!-- INCLUDE recent_topics_body.html -->
<!-- ENDIF -->

<!-- INCLUDE forumlist_body.html -->

<!-- INCLUDE chat_body.html -->

<!-- IF RECENT_TOPICS_FULL_DISPLAY -->
<!-- INCLUDE recent_topics_full_body.html -->
<!-- ENDIF -->

<!-- IF U_VIEWONLINE -->
<!-- INCLUDE featured_topics.html -->  
<!-- ENDIF -->

<!-- INCLUDE top_five_body.html -->

<!-- IF S_HAS_POLL -->
<!-- INCLUDE poll_block.html -->
<!-- ENDIF -->

<!-- INCLUDE blok_five_body3.html -->

<!-- INCLUDE gallery/recent_body.html -->

<!-- INCLUDE last_x_att_on_forum.html -->

<!-- INCLUDE blok_five_body2.html -->

<!-- INCLUDE last_x_hsimg_on_forum.html -->

<center>
   	<font size="5" color="blue" face="Cursive" >{L_ARCADE_NEWS}</font>
</center>

<!-- IF S_ARCADE_PLUGIN_TOP -->
	<!-- DEFINE $S_ARCADE_PLUGIN_POSITION = 'top' -->
	<!-- INCLUDE arcade/plugins.html -->
<!-- ENDIF -->

<!-- IF S_ARCADE_PLUGIN_BOTTOM -->
	<!-- DEFINE $S_ARCADE_PLUGIN_POSITION = 'bottom' -->
	<!-- INCLUDE arcade/plugins.html -->
<!-- ENDIF -->

<!-- IF S_ARCADE_PLUGIN_STAT -->
     <!-- DEFINE $S_ARCADE_PLUGIN_POSITION = 'stat' -->
     <!-- INCLUDE arcade/plugins.html -->
<!-- ENDIF -->		

<!-- IF RSI_ENABLED -->
<!-- IF U_ACP --><!-- INCLUDE search_index.html --><!-- ENDIF -->
<!-- ENDIF -->

<!-- INCLUDE blok_five_body5.html -->

<!-- INCLUDE overall_footer.html -->
overall_header.html

Code: Select all

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" dir="{S_CONTENT_DIRECTION}" lang="{S_USER_LANG}" xml:lang="{S_USER_LANG}">

<head>
<meta http-equiv="content-type" content="text/html; charset={S_CONTENT_ENCODING}" />
<meta http-equiv="content-style-type" content="text/css" />
<meta http-equiv="content-language" content="{S_USER_LANG}" />
<meta http-equiv="imagetoolbar" content="no" />
<meta name="resource-type" content="document" />
<meta name="distribution" content="global" />
<meta name="keywords" content="<!-- IF SEO_KEY -->{SEO_KEY}<!-- ENDIF -->" />
<meta name="description" content="<!-- IF SEO_DESC -->{SEO_DESC}<!-- ENDIF -->" />
{META}
<title><!-- IF TOPIC_SEO_TITLE -->{TOPIC_SEO_TITLE}<!-- ELSE -->{PAGE_TITLE} &bull; <!-- IF S_IN_MCP -->{L_MCP} &bull; <!-- ELSEIF S_IN_UCP -->{L_UCP} &bull; <!-- ENDIF -->{SITENAME}<!-- ENDIF --></title>
<link rel="shortcut icon" href="http://fotovideoforum.ru/favicon.ico" type="image/x-icon" />

<!-- IF S_FEEDS --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {SITENAME}" href="{U_RSS}" />
<!-- IF U_FEEDS_NEWS --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_RSS_NEWS}" href="{U_FEEDS_NEWS}" /><!-- ENDIF -->
<!-- IF U_FEEDS_NEWPOST --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_RSS_NEWPOST}" href="{U_FEEDS_NEWPOST}" /><!-- ENDIF -->
<!-- IF U_FEEDS_FORUMS --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_ALL_FORUMS}" href="{U_FEEDS_FORUMS}" /><!-- ENDIF -->
<!-- IF U_FEEDS_THREADS --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_ALL_TOPICS}" href="{U_FEEDS_THREADS}" /><!-- ENDIF -->
<!-- IF U_FEEDS_POSTS --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_ALL_POSTS}" href="{U_FEEDS_POSTS}" /><!-- ENDIF -->
<!-- IF U_FEEDS_ATTACH --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_RSS_ATTACH}" href="{U_FEEDS_ATTACH}" /><!-- ENDIF -->
<!-- IF U_FEEDS_EGOSEARCH --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_YOUR_POSTS}" href="{U_FEEDS_EGOSEARCH}" /><!-- ENDIF -->
<!-- IF U_FEEDS_FORUM --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_FORUM} {FORUM_NAME}" href="{U_FEEDS_FORUM}" /><!-- ENDIF -->
<!-- IF U_FEEDS_THREAD --><link rel="alternate" type="application/rss+xml" title="{L_RSS_FEEDS} - {L_TOPIC} {TOPIC_TITLE}" href="{U_FEEDS_THREAD}" /><!-- ENDIF --><!-- ENDIF -->

<!-- IF S_USER_UNREAD_PRIVMSG > 0 -->
<script type='text/javascript'>
	var newTxt="<<<! {L_YOU_NEW_PM} !>>>";
var oldTxt=document.title;

function migalka(){
    if(document.title==oldTxt){
        document.title=newTxt;
    }else{
        document.title=oldTxt;
    }
}

var timer = setInterval(migalka,1000);
</script>
<!-- ENDIF -->

<script type="text/javascript">
// <![CDATA[
	var jump_page = '{LA_JUMP_PAGE}:';
	var on_page = '{ON_PAGE}';
	var per_page = '{PER_PAGE}';
	var base_url = '{A_BASE_URL}';
	var style_cookie = 'phpBBstyle';
	var onload_functions = new Array();
	var onunload_functions = new Array();

	/**
	* Find a member
	*/
	function find_username(url)
	{
		popup(url, 1100, 400, '_usersearch');
		return false;
	}

	/**
	* New function for handling multiple calls to window.onload and window.unload by pentapenguin
	*/
	window.onload = function()
	{
		for (var i = 0; i < onload_functions.length; i++)
		{
			eval(onload_functions[i]);
		}
	};

	window.onunload = function()
	{
		for (var i = 0; i < onunload_functions.length; i++)
		{
			eval(onunload_functions[i]);
		}
	};
// ]]>
</script>
	
<script type="text/javascript">
// <![CDATA[
// start change_author
	function doOpenChangePoster(id)
	{
		var b = document.getElementById(id);
		if (b.style.display=='none')
		{
			b.style.display='';
		} 
		else 
		{
			b.style.display='none';
		} 
	return false;
	}
// end change_author
// ]]>
</script>

<script type="text/javascript">
// <![CDATA[
    function doCollapseExpand(id,img){
    var b = document.getElementById(id);
      if (b.style.display=='none')
	  {
      b.style.display='';
   document.images[img].src='{ROOT_PATH}images/dopinfo_up.gif'; 
      } 
	  else 
	  {
      b.style.display='none';
   document.images[img].src='{ROOT_PATH}images/dopinfo_down.gif';
      } 
	  return false; 
	}

// ]]>
</script>

<script type="text/javascript">
// <![CDATA[
	window.onload = resizeimg;
	function resizeimg()
	{
		if (document.getElementsByTagName)
		{
			var resClass = document.getElementsByTagName('span');
			for (var i = 0; i < resClass.length; i++)
			{
				if (resClass[i].className == "image-resize")
				{
					var img = resClass[i].getElementsByTagName("img");
					if (img[0].width > 650)
					{
						resClass[i].innerHTML = '<a href="' + img[0].src + '" class="highslide" onclick="return hs.expand(this)"><img src="' + img[0].src + '" width="650" alt=""></a>';
					}
				}
			}
		}
	}
// ]]>
</script>

<!-- IF S_DATEPICKER_NEEDED -->
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/datepicker/datetimepicker_css.js"></script>
<script type="text/javascript">
// <![CDATA[
var MonthName={MONTH_NAME};
var WeekDayName1={WEEK_DAY_NAME_1};
var WeekDayName2={WEEK_DAY_NAME_2};
var img_path="{T_SUPER_TEMPLATE_PATH}/datepicker/images";
// ]]>
</script>
<!-- ENDIF -->

<!-- IF S_SNOW_ENABLED and S_SNOW_UCP_ENABLED -->
<script type="text/javascript" src="{ROOT_PATH}js/snowstorm.js"></script>
<!-- ENDIF -->

<!-- IF U_PROFILE_PICTURE -->
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/lpp/lpp.js"></script>
<link rel="stylesheet" href="{T_THEME_PATH}/x_custom.css" type="text/css" />
<!-- ENDIF -->

<!-- IF SCRIPT_NAME == "viewforum" -->
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/tooltip.js"></script>
<!-- ENDIF -->

<!-- IF VIDEO_INSTRUK -->
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/jwplayer.js"></script>
<!-- ENDIF -->

<!-- IF S_NEED_TIMER -->
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/block_urls.js"></script>
<script type="text/javascript">
/* <![CDATA[ */
	var time = new Date();
	var timeout = time.getTime()+{S_NEED_TIMER}*60*1000;
	<!-- IF CAPTCHA_TEMPLATE and S_CONFIRM_REFRESH -->
	onload_functions.push('apply_onkeypress_event()');
	<!-- ENDIF -->
/* ]]> */
</script>
<!-- ENDIF -->

<!-- IF S_ALLOW_LIGHT_VIEWTOPIC and (S_VIEWFORUM or S_VIEWTOPIC) -->
<script type="text/javascript">
// <![CDATA[
	var cur_state = {S_LIGHT_VIEWTOPIC_TYPE};
	function light_viewtopic_type()
	{
		var as = document.getElementsByTagName("a");
		for (var i = 0; i <  as.length; i++)
		{
			if (as[i].href.indexOf('viewtopic.php', 0) != -1)
			{
				var pos = as[i].href.indexOf('&lv=', 0);
				cur_state = (pos == -1) ? 1 : ((as[i].href.substring(pos+4, pos+5) == '1') ? 0 : 1);
				if (as[i].href.indexOf('&lv', 0) == -1)
				{
					if (as[i].href.indexOf('#p', 0) == -1)
					{
						as[i].href = as[i].href.concat('&lv=', cur_state);
					}
					else
					{
						as[i].href = as[i].href.substring(0, as[i].href.indexOf('#p', 0)) + '&lv=' + cur_state + as[i].href.substr(as[i].href.indexOf('#p', 0));
					}
				}
				else				
				{
					as[i].href = as[i].href.replace(/&lv=[0-9]/g, '&lv=' + cur_state);
				}
			}
		}
		var spans = document.getElementsByName("light-viewtopic-span");
		for (var i = 0; i <  spans.length; i++)
		{
			spans[i].style.backgroundPosition = (cur_state == 0) ? '' : "0 100%";
		}
	}
// ]]>
</script>
<!-- ENDIF -->

<!-- IF S_ALLOW_LIGHT_VIEWTOPIC and S_VIEWTOPIC-->
<script type="text/javascript">
// <![CDATA[
	function light_viewtopic()
	{
		var divs = document.getElementsByName("postprofile_div");
		for (var i = 0; i <  divs.length; i++)
		{
			cur_state = (divs[i].style.display == '') ? 1 : 0;
			divs[i].style.display = (cur_state == 0) ? '' : 'none';
		}
		var divs = document.getElementsByTagName("div");
		for (var i = 0; i <  divs.length-1; i++)
		{
			if (divs[i].className == "postbody")
			{
				divs[i].style.width = (cur_state == 0) ? '' :  "99%";
			}	
		}

		light_viewtopic_type();
	}
// ]]>
</script>
<!-- ENDIF -->

<link href="{T_THEME_PATH}/print.css" rel="stylesheet" type="text/css" media="print" title="printonly" />
<link href="{T_STYLESHEET_LINK}" rel="stylesheet" type="text/css" media="screen, projection" />
<link href="{T_THEME_PATH}/normal.css" rel="stylesheet" type="text/css" title="A" />
<link href="{T_THEME_PATH}/medium.css" rel="alternate stylesheet" type="text/css" title="A+" />
<link href="{T_THEME_PATH}/large.css" rel="alternate stylesheet" type="text/css" title="A++" />
<link href="{T_THEME_PATH}/chat.css" rel="stylesheet" type="text/css" />
<link href="{T_THEME_PATH}/last_x_att_style.css" rel="stylesheet" type="text/css" />
<link href="{T_THEME_PATH}/last_x_hsimg_style.css" rel="stylesheet" type="text/css" />
<link href="{T_THEME_PATH}/quickmod/stylesheet.css" rel="stylesheet" type="text/css" />

<!-- IF S_CONTENT_DIRECTION eq 'rtl' -->
<link href="{T_THEME_PATH}/bidi.css" rel="stylesheet" type="text/css" media="screen, projection" />
<!-- ENDIF -->

<!-- IF GUEST_HIDE_BBCODE_MOD -->
<link href="{T_THEME_PATH}/guest_hide_bbcode_mod.css" rel="stylesheet" type="text/css" />
<!-- ENDIF -->

<!-- IF S_VIEWFORUM or S_SHOW_TOPICS or S_VIEWTOPIC -->
<script type="text/javascript">
	if (window.jQuery === undefined) {
		document.write(unescape('%3Cscript src="{ROOT_PATH}script/jquery-latest.min.js" type="text/javascript"%3E%3C/script%3E'));
	}
</script>
<!-- ENDIF -->

<!-- IF SITE_BG_IMG -->
<style type="text/css">
<!--
.headerbar {background:url("{SITE_BG_IMG}") repeat;}
-->
</style>
<!-- ENDIF -->

<!-- INCLUDE arcade/script_body.html -->

<!-- INCLUDE prime_show_deleted_post.html -->

<!-- IF S_VIEWTOPIC -->
<!-- INCLUDE quickedit/quickedit_header.html -->
<!-- ENDIF -->

<!-- INCLUDE gallery/plugins_header.html -->

<!-- INCLUDE ./../../abbcode/abbcode_header.html -->

<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/styleswitcher.js"></script>
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/forum_fn.js"></script>
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/crawl.js"></script>
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/jqueryui.js"></script>
<script type="text/javascript" src="{T_SUPER_TEMPLATE_PATH}/jquery.timers.js"></script>

</head>

<body id="phpbb" class="section-{SCRIPT_NAME} {S_CONTENT_DIRECTION}">

<div id="wrap">
<a id="top" name="top" accesskey="t"></a>
<div id="page-header">
	<div class="headerbar">
			<div class="inner"><span class="corners-top"><span></span></span>

			<div id="site-description">
				<a href="{U_INDEX}" title="{L_INDEX}" id="logo">{SITE_LOGO_IMG}</a>
				<p style="display: none;"><a href="#start_here">{L_SKIP}</a></p>
			</div>

		<span class="corners-bottom"><span></span></span></div>
    </div>
	
<center>
<div id="welcomeuser" style="display: inline-block; font-weight: bold; padding-bottom: 8px; line-height: 0.8em">{L_BABU}</div>	
</center>

<!-- INCLUDE blok_five_body.html -->

<div class="navbar">
<div class="inner"><span class="corners-top"><span></span></span>

		<!-- IF S_DISPLAY_SEARCH and not S_IN_SEARCH -->
		<div id="search-box" style="float: right">
				<form action="{U_SEARCH}" method="post" id="search">
				<fieldset>
				<input name="keywords" id="keywords" type="text" maxlength="128" title="{L_SEARCH_KEYWORDS}" class="inputbox search" value="<!-- IF SEARCH_WORDS -->{SEARCH_WORDS}<!-- ELSE -->{L_SEARCH_MINI}<!-- ENDIF -->" onclick="if(this.value=='{LA_SEARCH_MINI}')this.value='';" onblur="if(this.value=='')this.value='{LA_SEARCH_MINI}';" /> 
					<input class="button2" value="{L_SEARCH}" type="submit" /><br />
				{S_SEARCH_HIDDEN_FIELDS}
				</fieldset>
				</form>
			</div>
		<!-- ENDIF -->
		
	<!-- IF S_AUTHORIZED --><form style="float: right" id="purge_cache" method="post" action="#"><fieldset><input type="hidden" name="purge_cache" value="1" /><input class="button2" style="overflow: visible" type="submit" value="{L_PURGE_CACHE}" /> &nbsp;</fieldset></form><!-- ENDIF -->
	<!-- IF U_ACP --><div style="float: right; font-size: 1.1em; font-weight: bold; line-height: 1.5em"><a href="{U_ACP}">{L_ACP}</a>&nbsp; </div><!-- ENDIF -->
	<div id="welcomeuser" style="display: inline-block; font-weight: bold; padding-bottom: 12px; line-height: 0.8em">{L_WELCOME_USER}</div>

	<ul class="linklist navlinks">
		<li class="icon-home">
		     <a href="{U_INDEX}" accesskey="h">{L_INDEX}</a> <!-- BEGIN navlinks --> <strong>&#8249;</strong> <a href="{navlinks.U_VIEW_FORUM}">{navlinks.FORUM_NAME}</a><!-- END navlinks -->
		</li>
      	<!-- IF S_DISPLAY_SEARCH or (S_USER_LOGGED_IN and not S_IS_BOT) -->
			<!-- IF U_PRINT_TOPIC --><li class="rightside"><a href="{U_PRINT_TOPIC}" title="{L_PRINT_TOPIC}" accesskey="p" class="print">{L_PRINT_TOPIC}</a></li><!-- ENDIF -->
		    <!-- IF U_PRINT_PM --><li class="rightside"><a href="{U_PRINT_PM}" title="{L_PRINT_PM}" accesskey="p" class="print">{L_PRINT_PM}</a></li><!-- ENDIF -->
        	<!-- IF U_ACP --><li class="rightside"><a href="{U_ACP}"><img src="{T_THEME_PATH}/images/icon_acp.gif" title="{L_ACP}" alt="{L_ACP}" style="vertical-align: -2px" /></a></li><!-- ENDIF -->
	        <!-- IF U_MCP --><li class="rightside"><a href="{U_MCP}"><img src="{T_THEME_PATH}/images/icon_mcp.gif" title="{L_MCP}" alt="{L_MCP}" style="vertical-align: -2px" /></a></li><!-- ENDIF -->
    	<!-- ENDIF -->
	</ul>

	<ul class="linklist leftside" style="float: none; margin: 0; padding: 0 0 3px; border-bottom: 1px solid black;">
	<!-- IF S_DISPLAY_SEARCH or (S_USER_LOGGED_IN and not S_IS_BOT) -->
    	<!-- IF S_DISPLAY_SEARCH -->
			<li class="icon-search">
				<a href="#" style="display: block">{L_SEARCH_VIEW}</a>
				<div id="menu-1">
					<a href="{U_SEARCH_OWN}">{L_SEARCH_OWN}</a>
					<a href="{U_SEARCH_SELF}">{L_SEARCH_SELF}</a>
					<a href="{U_SEARCH_NEW}">{L_SEARCH_NEW}: {TOTAL}</a>
					<a href="{U_SEARCH_UNREAD}">{L_SEARCH_UNREAD}</a>
					<a href="{U_SEARCH_UNANSWERED}">{L_SEARCH_UNANSWERED}</a>
					<a href="{U_SEARCH_ACTIVE_TOPICS}">{L_SEARCH_ACTIVE_TOPICS}</a>              
				</div>
				</li>
		<!-- ENDIF -->
			
			<li class="icon-ucp"><a href="{U_PROFILE}" title="{L_PROFILE}" accesskey="e">{L_PROFILE}</a>
			<!-- IF S_DISPLAY_PM --><!-- IF S_USER_NEW_PRIVMSG --> &bull; (<a href="{U_PRIVATEMSGS}" style="color:#FF0000;">{PRIVATE_MESSAGE_INFO}</a>)<!-- ELSE -->(<a href="{U_PRIVATEMSGS}">{PRIVATE_MESSAGE_INFO}</a>)<!-- ENDIF --><!-- ENDIF --></li>
			<!-- IF U_RESTORE_PERMISSIONS --> &bull; <a href="{U_RESTORE_PERMISSIONS}">{L_RESTORE_PERMISSIONS}</a><!-- ENDIF -->
			<!-- IF S_USER_LOGGED_IN --><!-- IF SIMPLE_COMMENT_ENABLED --><li class="icon-ucp"><a href="{U_COMMENTS}">({L_TOTAL_COMMENT})</a></li><!-- ENDIF --><!-- ENDIF -->
    		
	<!-- ENDIF -->
	        <li class="icon-faq"><a href="{U_FAQ}" title="{L_FAQ_EXPLAIN}">{L_FAQ}</a></li>
			<li class="icon-rules"><a href="{U_RULES}" title="{L_BOARD_RULES_HDR}">{L_BOARD_RULES}</a></li>
			<li class="icon-faq"><a href="{U_UFAQ}" title="{L_UFAQ_ADD_ANSWERS}">{L_UFAQ_ADD_ANSWERS}</a></li>
			<li class="icon-navigator"><a href="{U_NAVIGATOR}" title="{L_BOARD_NAVIGATOR_HDR}">{L_BOARD_NAVIGATOR}</a></li>
			<li class="icon-members"><a href="{U_APPLICATION_FORM}" title="{L_APPLICATION_FORM_EXPLAIN}">{L_APPLICATION_FORM}</a></li>
		    <li class="icon-contact"><a href="{U_CONTACT}" title="{L_CONTACT_BOARD_ADMIN}">{L_CONTACT_BOARD_ADMIN_SHORT}</a></li>            
    </ul>

	<ul class="linklist rightside" style="margin-bottom: -3px;">
	        <!-- IF S_USER_LOGGED_IN --><li class="icon-search"><a href="{U_SEARCH}">{L_SEARCH_BIG}</a></li><!-- ENDIF -->
	        <!-- SIMPLE AUDIO PLAYER MOD BEGIN --><!-- IF S_USER_LOGGED_IN --><li class="icon-sap"> <a href="{U_SIMPLE_AUDIO_PLAYER_MOD_LINK}" onclick="window.open('{U_SIMPLE_AUDIO_PLAYER_MOD_LINK}','','toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=yes, resizable=yes, width=340, height=350, left=20, top=10'); return false;">{L_SIMPLE_AUDIO_PLAYER_MOD_LINK}</a></li><!-- ENDIF --><!-- SIMPLE AUDIO PLAYER MOD END -->
			<!-- IF S_DISPLAY_ARCADE --><!-- IF S_DISPLAY_ARCADE_CHALLENGE --><li class="icon-arcade-challenge"><a href="{U_ARCADE_CHALLENGE}" title="{L_ARCADE_CHALLENGE_EXPLAIN}">{L_ARCADE_CHALLENGE}</a></li><!-- ENDIF --><!-- ENDIF -->			
            <!-- IF S_USER_LOGGED_IN --><li class="icon-members"><a href="{U_CHAT}" title="{L_CHAT_EXPLAIN}" >{L_CHAT}</a></li><!-- ENDIF -->
			<!-- IF S_TOPICLIST --><li class="icon-search"><a href="{U_TOPICLIST}">{L_TOPICLIST_FX}</a></li><!-- ENDIF -->
        	<!-- IF S_USER_LOGGED_IN --><li class="icon-search"><a href="{U_NEWS}" title="{L_NEWS}">{L_NEWS}</a></li><!-- ENDIF -->
			<!-- IF not S_IS_BOT -->
			<!-- IF S_DISPLAY_MEMBERLIST --><li class="icon-members"><a href="{U_MEMBERLIST}" title="{L_MEMBERLIST_EXPLAIN}">{L_MEMBERLIST}</a></li><!-- ENDIF -->
			<!-- IF S_DISPLAY_MEMBERLIST --><li class="icon-members"><a href="{U_ALL_MEMBERS_LIST}" title="{L_ALL_MEMBERS_LIST_EXPLAIN}">{L_ALL_MEMBERS_LIST}</a></li><!-- ENDIF -->
            <!-- IF S_DISPLAY_TOPLIST --><li class="icon-thanks_toplist"><a href="{U_REPUT_TOPLIST}" title="{L_REPUT_TOPLIST}">{L_REPUT_TOPLIST}</a></li><!-- ENDIF -->
			<!-- IF not S_USER_LOGGED_IN and S_REGISTER_ENABLED --><li class="icon-register"><a href="{U_REGISTER}">{L_REGISTER}</a></li><!-- ENDIF -->
			<li class="icon-logout"><a href="{U_LOGIN_LOGOUT}" accesskey="x"<!-- IF not S_USER_LOGGED_IN and not S_DISPLAY_FULL_LOGIN --> onmouseover="delay1 = setTimeout('document.getElementById(\'quick-login\').style.zIndex=\'2\'', 500);" onmouseout="clearTimeout(delay1)"<!-- ENDIF -->>{L_LOGIN_LOGOUT}</a></li>							
			<!-- ENDIF -->			
	</ul>
<span class="corners-bottom"><span></span></span></div>
</div>
</div>

<!-- IF not S_USER_LOGGED_IN and not S_IS_BOT and not S_DISPLAY_FULL_LOGIN -->
	<form method="post" action="{S_LOGIN_ACTION}" id="quick-login" onmouseout="delay2 = setTimeout('document.getElementById(\'quick-login\').style.zIndex=\'-2\'', 1500);" onmouseover="if (typeof delay2 !== 'undefined') clearTimeout(delay2)">
		<fieldset>
			{L_USERNAME}:<br />
			<input type="text" name="username" size="10" class="inputbox" title="{L_USERNAME}" /><br />
			{L_PASSWORD}:<br />
			<input type="password" name="password" size="10" class="inputbox" title="{L_PASSWORD}" style="margin-bottom: 7px" /><br />
			<!-- IF S_AUTOLOGIN_ENABLED -->
				<label>{L_LOG_ME_IN_SHORT} <input type="checkbox" name="autologin" /></label><br />
			<!-- ENDIF -->
			<input type="button" value="{L_CANCEL}" class="button2" onclick="document.getElementById('quick-login').style.zIndex='-2';" />
			<input type="submit" name="login" value="{L_LOGIN}" class="button2" />
			{S_LOGIN_REDIRECT}
		</fieldset>
	</form>
<!-- ENDIF -->

<a name="start_here"></a>
	<div id="page-body">
	<!-- IF S_BOARD_DISABLED and S_USER_LOGGED_IN and (U_MCP or U_ACP) -->
		<div id="message" class="rules">
			<div class="inner"><span class="corners-top"><span></span></span>
				<strong>{L_INFORMATION}:</strong> {L_BOARD_DISABLED}
			<span class="corners-bottom"><span></span></span></div>
		</div>
	<!-- ENDIF -->

<!-- IF S_USER_PM_POPUP and S_NEW_PM -->
<div id="newpm" align="right">
<div id="hidden" class="newpm" align="center" valign="middle">
		<table width="300" cellspacing="0" border="0" align="center">
		<tr><td colspan="2" align="center"><br /><b style="font-size: 1.3em; color: #376B79;">{L_YOU_NEW_PM}</b><br />&nbsp;</td></tr>
		<tr><td align="right"><b>{L_AUTHOR}:&nbsp;</b></td><td align="left"><b>&nbsp;{S_PM_SENDER}</b></td></tr>
		<tr><td align="right"><b>{L_SUBJECT}:&nbsp;</b></td><td align="left"><b>&nbsp;{S_PM_SUBJECT}</b></td></tr>
		<tr><td align="right"><b>{L_TIME}:&nbsp;</b></td><td align="left"><b>&nbsp;{S_PM_DATE}</b></td></tr>
		<tr><td colspan="2" align="center"><br /><a style="color: #376B79; font-size: 1.2em;" href="{U_PRIVATEMSGS}">{L_VIEWING_PRIVATE_MESSAGES}</a></td></tr>
		<tr><td colspan="2" align="center"><a style="color: #0516B7; font-size: 1.2em;" href='' onclick="dE('hidden');return false;">{L_CLOSE_WINDOW}</a></td></tr>
		</table>
		</div>
</div>
<!-- ENDIF -->

<!-- IF INV_ENABLED -->
    <!-- IF not S_IS_BOT -->
    <!-- IF not S_USER_LOGGED_IN and not (S_SHOW_COPPA or S_REGISTRATION) -->
        <div class="reybar">
        <div class="inner"><span class="corners-top"><span></span></span>
        <p>{CURRENT_TIME}</p><div style="text-align:center;"><img src="{T_THEME_PATH}/images/ciaomamma.gif"/><br /> <span style="font-weight: bold"><span style="font-size: 150%; line-height: 116%;"><span style="color: #000060">{L_INVITATION} {SITENAME}, {L_GUEST}! {L_INVITAT} &nbsp; <img src="{T_THEME_PATH}/images/register.png" width="40" height="40"/>&nbsp; <a href="{U_REGISTER}" class="button1">{L_REGISTER}</a>&nbsp; {L_JOIN} &nbsp;<a href="{U_LOGIN_LOGOUT}" class="button1">{L_LOGIN}</a></span></span></span> &nbsp; <img src="{T_THEME_PATH}/images/login.png" width="40" height="40"/>&nbsp;</div>
        <span class="corners-bottom"><span></span></span></div>
        </div><!-- ENDIF --><!-- ENDIF -->
<!-- ENDIF -->

<div id="timedown" class="timedown"></div>	

<div class="rules">
	<div class="inner"><span class="corners-top"><span></span></span>
		<center>
            <!-- IF S_USER_LOGGED_IN -->
            	<p>&bull;&nbsp;{LAST_VISIT_DATE}&nbsp;&bull;
            	<!-- IF U_MCP -->&nbsp;<a href="{U_MCP}">{L_MCP}</a>&nbsp;&bull;<!-- ENDIF -->
            	<!-- IF U_ACP -->&nbsp;<a href="{U_ACP}">{L_ACP}</a>&nbsp;<!-- ENDIF -->
            	<!-- IF S_DISPLAY_SEARCH and not S_IS_BOT and U_MARK_FORUMS -->
	         	&bull;&nbsp;<a href="{U_MARK_FORUMS}" accesskey="m">{L_MARK_FORUMS_READ}</a>&nbsp;
            	<!-- ENDIF -->
            <!-- ENDIF -->
                &bull;&nbsp;{CURRENT_TIME}&nbsp;&bull;</p>
 		</center>
	<span class="corners-bottom"><span></span></span></div>
</div>

<!-- INCLUDE arcade/info_body.html -->
<!-- INCLUDE phpbb_debug.html -->
<!-- INCLUDE announcement_centre.html -->			
I think that the changes in these files can not make. Error is without edits to those files.

Haravikk
Registered User
Posts: 261
Joined: Sat Nov 02, 2002 4:42 pm

Re: [Beta] Guest Cache

Post by Haravikk » Sun Feb 10, 2013 1:40 pm

You should only need to the modify the first instance of {CURRENT_TIME} in each case; those edits are also only required if you want to enable the Javascript time function. If you do want to do the changes then the line you want for prosilver's index_body.html is (just replace the {CURRENT_TIME} part as normal:

Code: Select all

<p class="{S_CONTENT_FLOW_END}<!-- IF S_USER_LOGGED_IN --> rightside<!-- ENDIF -->"><!-- IF S_USER_LOGGED_IN -->{LAST_VISIT_DATE}<!-- ELSE -->{CURRENT_TIME}<!-- ENDIF --></p>
And for subsilver2's overall_header.html, I think it's been too heavily modified for me to really know where the change should be. I'd hazard a guess at here:

Code: Select all

<div class="rules">
   <div class="inner"><span class="corners-top"><span></span></span>
      <center>
            <!-- IF S_USER_LOGGED_IN -->
               <p>&bull;&nbsp;{LAST_VISIT_DATE}&nbsp;&bull;
               <!-- IF U_MCP -->&nbsp;<a href="{U_MCP}">{L_MCP}</a>&nbsp;&bull;<!-- ENDIF -->
               <!-- IF U_ACP -->&nbsp;<a href="{U_ACP}">{L_ACP}</a>&nbsp;<!-- ENDIF -->
               <!-- IF S_DISPLAY_SEARCH and not S_IS_BOT and U_MARK_FORUMS -->
               &bull;&nbsp;<a href="{U_MARK_FORUMS}" accesskey="m">{L_MARK_FORUMS_READ}</a>&nbsp;
               <!-- ENDIF -->
            <!-- ENDIF -->
                &bull;&nbsp;{CURRENT_TIME}&nbsp;&bull;</p>
       </center>
   <span class="corners-bottom"><span></span></span></div>
</div>
But I'm not sure to be honest.


Like I say though, these edits are only required if you want to enable the Javascript time feature, it should have no impact on the mod otherwise, and definitely shouldn't be causing errors on your pages.


I really have no idea what would cause those errors though, you're saying that they stop when you turn off guest caching? I'm not sure what could cause the problem as my mod shouldn't have any impact on $user->data at all. One thing that it does do however is that it destroys the user's session if a page is cacheable, by calling $user->session_kill(false), however in a vanilla phpBB installation this doesn't discard $user->data, it just clears things like session IDs. Could you post the code for the session_kill() function in includes/session.php? It sounds like one of the other mods must have changed how that function operates so that when my mod calls it it's doing something to $user->data that I didn't expect.

It means that the fix though will require me to re-implement the parts of session_kill() that I need somewhere else.

User avatar
Pthelovod
Registered User
Posts: 106
Joined: Mon Feb 22, 2010 1:32 am
Location: Россия
Name: Alexs Pthelovod
Contact:

Re: [Beta] Guest Cache

Post by Pthelovod » Sun Feb 10, 2013 2:05 pm

I really have no idea what would cause those errors though, you're saying that they stop when you turn off guest caching?
Yes. After turning off the errors disappear.

Show the whole file includes/session.php. Can it help me?
I am not a professional in phpBB.
I wrote the code offline heavily modified.
I'm sorry that I bring anxiety.

Code: Select all

<?php
/**
*
* @package phpBB3
* @version $Id$
* @copyright (c) 2005 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/

/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
	exit;
}

/**
* Session class
* @package phpBB3
*/
class session
{
	var $cookie_data = array();
	var $page = array();
	var $data = array();
	var $browser = '';
	var $forwarded_for = '';
	var $host = '';
	var $session_id = '';
	var $ip = '';
	var $load = 0;
	var $time_now = 0;
	var $update_session_page = true;

	/**
	* Extract current session page
	*
	* @param string $root_path current root path (phpbb_root_path)
	*/
	function extract_current_page($root_path)
	{
		$page_array = array();

		// First of all, get the request uri...
		$script_name = (!empty($_SERVER['PHP_SELF'])) ? $_SERVER['PHP_SELF'] : getenv('PHP_SELF');
		$args = (!empty($_SERVER['QUERY_STRING'])) ? explode('&', $_SERVER['QUERY_STRING']) : explode('&', getenv('QUERY_STRING'));

		// If we are unable to get the script name we use REQUEST_URI as a failover and note it within the page array for easier support...
		if (!$script_name)
		{
			$script_name = (!empty($_SERVER['REQUEST_URI'])) ? $_SERVER['REQUEST_URI'] : getenv('REQUEST_URI');
			$script_name = (($pos = strpos($script_name, '?')) !== false) ? substr($script_name, 0, $pos) : $script_name;
			$page_array['failover'] = 1;
		}

		// Replace backslashes and doubled slashes (could happen on some proxy setups)
		$script_name = str_replace(array('\\', '//'), '/', $script_name);

		// Now, remove the sid and let us get a clean query string...
		$use_args = array();

		// Since some browser do not encode correctly we need to do this with some "special" characters...
		// " -> %22, ' => %27, < -> %3C, > -> %3E
		$find = array('"', "'", '<', '>');
		$replace = array('%22', '%27', '%3C', '%3E');

		foreach ($args as $key => $argument)
		{
			if (strpos($argument, 'sid=') === 0)
			{
				continue;
			}

			$use_args[] = str_replace($find, $replace, $argument);
		}
		unset($args);

		// The following examples given are for an request uri of {path to the phpbb directory}/adm/index.php?i=10&b=2

		// The current query string
		$query_string = trim(implode('&', $use_args));

		// basenamed page name (for example: index.php)
		$page_name = (substr($script_name, -1, 1) == '/') ? '' : basename($script_name);
		$page_name = urlencode(htmlspecialchars($page_name));

		// current directory within the phpBB root (for example: adm)
		$root_dirs = explode('/', str_replace('\\', '/', phpbb_realpath($root_path)));
		$page_dirs = explode('/', str_replace('\\', '/', phpbb_realpath('./')));
		$intersection = array_intersect_assoc($root_dirs, $page_dirs);

		$root_dirs = array_diff_assoc($root_dirs, $intersection);
		$page_dirs = array_diff_assoc($page_dirs, $intersection);

		$page_dir = str_repeat('../', sizeof($root_dirs)) . implode('/', $page_dirs);

		if ($page_dir && substr($page_dir, -1, 1) == '/')
		{
			$page_dir = substr($page_dir, 0, -1);
		}

		// Current page from phpBB root (for example: adm/index.php?i=10&b=2)
		$page = (($page_dir) ? $page_dir . '/' : '') . $page_name . (($query_string) ? "?$query_string" : '');

		// The script path from the webroot to the current directory (for example: /phpBB3/adm/) : always prefixed with / and ends in /
		$script_path = trim(str_replace('\\', '/', dirname($script_name)));

		// The script path from the webroot to the phpBB root (for example: /phpBB3/)
		$script_dirs = explode('/', $script_path);
		array_splice($script_dirs, -sizeof($page_dirs));
		$root_script_path = implode('/', $script_dirs) . (sizeof($root_dirs) ? '/' . implode('/', $root_dirs) : '');

		// We are on the base level (phpBB root == webroot), lets adjust the variables a bit...
		if (!$root_script_path)
		{
			$root_script_path = ($page_dir) ? str_replace($page_dir, '', $script_path) : $script_path;
		}

		$script_path .= (substr($script_path, -1, 1) == '/') ? '' : '/';
		$root_script_path .= (substr($root_script_path, -1, 1) == '/') ? '' : '/';

		$page_array += array(
			'page_name'			=> $page_name,
			'page_dir'			=> $page_dir,

			'query_string'		=> $query_string,
			'script_path'		=> str_replace(' ', '%20', htmlspecialchars($script_path)),
			'root_script_path'	=> str_replace(' ', '%20', htmlspecialchars($root_script_path)),

			'page'				=> $page,
			'forum'				=> (isset($_REQUEST['f']) && $_REQUEST['f'] > 0) ? (int) $_REQUEST['f'] : 0,
            'album'				=> (isset($_REQUEST['album_id']) && $_REQUEST['album_id'] > 0) ? (int) $_REQUEST['album_id'] : 0,
		);
		if ($page_array['forum'] > 0)
		{
			global $db;

			$sql = 'SELECT forum_ranon_flags FROM ' . FORUMS_TABLE . ' WHERE forum_id = ' . (int)$page_array['forum'];
			$result = $db->sql_query($sql);
			$forum_ranon_flags = (int)$db->sql_fetchfield('forum_ranon_flags');
			$db->sql_freeresult($result);
			if (!empty($forum_ranon_flags) && $forum_ranon_flags && ($forum_ranon_flags & FORUM_RANON_FLAG_ENABLE))
			{				
				$page_array['forum'] = 0;
				
				$page_array['forum_ranon_flags'] = $forum_ranon_flags;
			}
		}
		return $page_array;
	}

	/**
	* Get valid hostname/port. HTTP_HOST is used, SERVER_NAME if HTTP_HOST not present.
	*/
	function extract_current_hostname()
	{
		global $config;

		// Get hostname
		$host = (!empty($_SERVER['HTTP_HOST'])) ? $_SERVER['HTTP_HOST'] : ((!empty($_SERVER['SERVER_NAME'])) ? $_SERVER['SERVER_NAME'] : getenv('SERVER_NAME'));

		// Should be a string and lowered
		$host = (string) strtolower($host);

		// If host is equal the cookie domain or the server name (if config is set), then we assume it is valid
		if ((isset($config['cookie_domain']) && $host === $config['cookie_domain']) || (isset($config['server_name']) && $host === $config['server_name']))
		{
			return $host;
		}

		// Is the host actually a IP? If so, we use the IP... (IPv4)
		if (long2ip(ip2long($host)) === $host)
		{
			return $host;
		}

		// Now return the hostname (this also removes any port definition). The http:// is prepended to construct a valid URL, hosts never have a scheme assigned
		$host = @parse_url('http://' . $host);
		$host = (!empty($host['host'])) ? $host['host'] : '';

		// Remove any portions not removed by parse_url (#)
		$host = str_replace('#', '', $host);

		// If, by any means, the host is now empty, we will use a "best approach" way to guess one
		if (empty($host))
		{
			if (!empty($config['server_name']))
			{
				$host = $config['server_name'];
			}
			else if (!empty($config['cookie_domain']))
			{
				$host = (strpos($config['cookie_domain'], '.') === 0) ? substr($config['cookie_domain'], 1) : $config['cookie_domain'];
			}
			else
			{
				// Set to OS hostname or localhost
				$host = (function_exists('php_uname')) ? php_uname('n') : 'localhost';
			}
		}

		// It may be still no valid host, but for sure only a hostname (we may further expand on the cookie domain... if set)
		return $host;
	}

	/**
	* Start session management
	*
	* This is where all session activity begins. We gather various pieces of
	* information from the client and server. We test to see if a session already
	* exists. If it does, fine and dandy. If it doesn't we'll go on to create a
	* new one ... pretty logical heh? We also examine the system load (if we're
	* running on a system which makes such information readily available) and
	* halt if it's above an admin definable limit.
	*
	* @param bool $update_session_page if true the session page gets updated.
	*			This can be set to circumvent certain scripts to update the users last visited page.
	*/
	function session_begin($update_session_page = true)
	{
		global $phpEx, $SID, $_SID, $_EXTRA_URL, $db, $config, $phpbb_root_path;

		// Give us some basic information
		$this->time_now				= time();
		$this->cookie_data			= array('u' => 0, 'k' => '');
		$this->update_session_page	= $update_session_page;
		$this->browser				= (!empty($_SERVER['HTTP_USER_AGENT'])) ? htmlspecialchars((string) $_SERVER['HTTP_USER_AGENT']) : '';
		$this->referer				= (!empty($_SERVER['HTTP_REFERER'])) ? htmlspecialchars((string) $_SERVER['HTTP_REFERER']) : '';
		$this->forwarded_for		= (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) ? htmlspecialchars((string) $_SERVER['HTTP_X_FORWARDED_FOR']) : '';

		$this->host					= $this->extract_current_hostname();
		$this->page					= $this->extract_current_page($phpbb_root_path);
		if (!empty($this->page['forum_ranon_flags']) && $this->page['forum_ranon_flags'] & FORUM_RANON_FLAG_ENABLE)
		{
			$this->update_session_page = $update_session_page = false;
		}
		// if the forwarded for header shall be checked we have to validate its contents
		if ($config['forwarded_for_check'])
		{
			$this->forwarded_for = preg_replace('# {2,}#', ' ', str_replace(',', ' ', $this->forwarded_for));

			// split the list of IPs
			$ips = explode(' ', $this->forwarded_for);
			foreach ($ips as $ip)
			{
				// check IPv4 first, the IPv6 is hopefully only going to be used very seldomly
				if (!empty($ip) && !preg_match(get_preg_expression('ipv4'), $ip) && !preg_match(get_preg_expression('ipv6'), $ip))
				{
					// contains invalid data, don't use the forwarded for header
					$this->forwarded_for = '';
					break;
				}
			}
		}
		else
		{
			$this->forwarded_for = '';
		}

		if (isset($_COOKIE[$config['cookie_name'] . '_sid']) || isset($_COOKIE[$config['cookie_name'] . '_u']))
		{
			$this->cookie_data['u'] = request_var($config['cookie_name'] . '_u', 0, false, true);
			$this->cookie_data['k'] = request_var($config['cookie_name'] . '_k', '', false, true);
			$this->session_id 		= request_var($config['cookie_name'] . '_sid', '', false, true);

			$SID = (defined('NEED_SID')) ? '?sid=' . $this->session_id : '?sid=';
			$_SID = (defined('NEED_SID')) ? $this->session_id : '';

			if (empty($this->session_id))
			{
				$this->session_id = $_SID = request_var('sid', '');
				$SID = '?sid=' . $this->session_id;
				$this->cookie_data = array('u' => 0, 'k' => '');
			}
		}
		else
		{
			$this->session_id = $_SID = request_var('sid', '');
			$SID = '?sid=' . $this->session_id;
		}

		$_EXTRA_URL = array();

		// Why no forwarded_for et al? Well, too easily spoofed. With the results of my recent requests
		// it's pretty clear that in the majority of cases you'll at least be left with a proxy/cache ip.
		$this->ip = (!empty($_SERVER['HTTP_X_REAL_IP'])) ? (string) $_SERVER['HTTP_X_REAL_IP'] : '';
		$this->ip = preg_replace('# {2,}#', ' ', str_replace(',', ' ', $this->ip));

		// split the list of IPs
		$ips = explode(' ', trim($this->ip));

		// Default IP if REMOTE_ADDR is invalid
		$this->ip = '127.0.0.1';

		foreach ($ips as $ip)
		{
			if (preg_match(get_preg_expression('ipv4'), $ip))
			{
				$this->ip = $ip;
			}
			else if (preg_match(get_preg_expression('ipv6'), $ip))
			{
			// Quick check for IPv4-mapped address in IPv6
			if (stripos($ip, '::ffff:') === 0)
			{
				$ipv4 = substr($ip, 7);

				if (preg_match(get_preg_expression('ipv4'), $ipv4))
				{
					$ip = $ipv4;
				}
			}

			$this->ip = $ip;
			}
			else
			{
				// We want to use the last valid address in the chain
				// Leave foreach loop when address is invalid
				break;
			}
		}

		$this->load = false;

		// Load limit check (if applicable)
		if ($config['limit_load'] || $config['limit_search_load'])
		{
			if ((function_exists('sys_getloadavg') && $load = sys_getloadavg()) || ($load = explode(' ', @file_get_contents('/proc/loadavg'))))
			{
				$this->load = array_slice($load, 0, 1);
				$this->load = floatval($this->load[0]);
			}
			else
			{
				set_config('limit_load', '0');
				set_config('limit_search_load', '0');
			}
		}

 		// if no session id is set, redirect to index.php
 		if (defined('NEED_SID') && (!isset($_GET['sid']) || $this->session_id !== $_GET['sid']))
 		{
 			send_status_line(401, 'Not authorized');
 			redirect(append_sid("{$phpbb_root_path}index.$phpEx"));
 		}
 
 		// if session id is set
 		if (!empty($this->session_id))
		{
			$sql = 'SELECT u.*, s.*
				FROM ' . SESSIONS_TABLE . ' s, ' . USERS_TABLE . " u
				WHERE s.session_id = '" . $db->sql_escape($this->session_id) . "'
					AND u.user_id = s.session_user_id";
			$result = $db->sql_query($sql);
			$this->data = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);

			// Did the session exist in the DB?
			if (isset($this->data['user_id']))
			{
				// Validate IP length according to admin ... enforces an IP
				// check on bots if admin requires this
//				$quadcheck = ($config['ip_check_bot'] && $this->data['user_type'] & USER_BOT) ? 4 : $config['ip_check'];

				if (strpos($this->ip, ':') !== false && strpos($this->data['session_ip'], ':') !== false)
				{
					$s_ip = short_ipv6($this->data['session_ip'], $config['ip_check']);
					$u_ip = short_ipv6($this->ip, $config['ip_check']);
				}
				else
				{
					$s_ip = implode('.', array_slice(explode('.', $this->data['session_ip']), 0, $config['ip_check']));
					$u_ip = implode('.', array_slice(explode('.', $this->ip), 0, $config['ip_check']));
				}

				$s_browser = ($config['browser_check']) ? trim(strtolower(substr($this->data['session_browser'], 0, 149))) : '';
				$u_browser = ($config['browser_check']) ? trim(strtolower(substr($this->browser, 0, 149))) : '';

				$s_forwarded_for = ($config['forwarded_for_check']) ? substr($this->data['session_forwarded_for'], 0, 254) : '';
				$u_forwarded_for = ($config['forwarded_for_check']) ? substr($this->forwarded_for, 0, 254) : '';

				// referer checks
				// The @ before $config['referer_validation'] suppresses notices present while running the updater
				$check_referer_path = (@$config['referer_validation'] == REFERER_VALIDATE_PATH);
				$referer_valid = true;

				// we assume HEAD and TRACE to be foul play and thus only whitelist GET
				if (@$config['referer_validation'] && isset($_SERVER['REQUEST_METHOD']) && strtolower($_SERVER['REQUEST_METHOD']) !== 'get')
				{
					$referer_valid = $this->validate_referer($check_referer_path);
				}

				if ($u_ip === $s_ip && $s_browser === $u_browser && $s_forwarded_for === $u_forwarded_for && $referer_valid)
				{
					$session_expired = false;

					// Check whether the session is still valid if we have one
					$method = basename(trim($config['auth_method']));
					include_once($phpbb_root_path . 'includes/auth/auth_' . $method . '.' . $phpEx);

					$method = 'validate_session_' . $method;
					if (function_exists($method))
					{
						if (!$method($this->data))
						{
							$session_expired = true;
						}
					}

					if (!$session_expired)
					{
						// Check the session length timeframe if autologin is not enabled.
						// Else check the autologin length... and also removing those having autologin enabled but no longer allowed board-wide.
						if (!$this->data['session_autologin'])
						{
							if ($this->data['session_time'] < $this->time_now - ($config['session_length'] + 60))
							{
								$session_expired = true;
							}
						}
						else if (!$config['allow_autologin'] || ($config['max_autologin_time'] && $this->data['session_time'] < $this->time_now - (86400 * (int) $config['max_autologin_time']) + 60))
						{
							$session_expired = true;
						}
					}

					if (!$session_expired)
					{
						// Only update session DB a minute or so after last update or if page changes
						if ($this->time_now - $this->data['session_time'] > 60 || ($this->update_session_page && $this->data['session_page'] != $this->page['page']))
						{
							$sql_ary = array('session_time' => $this->time_now);

							if ($this->update_session_page)
							{
								$sql_ary['session_page'] = substr($this->page['page'], 0, 199);
								$sql_ary['session_forum_id'] = $this->page['forum'];
                                $sql_ary['session_album_id'] = $this->page['album'];
							}

							$db->sql_return_on_error(true);

							$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $db->sql_build_array('UPDATE', $sql_ary) . "
								WHERE session_id = '" . $db->sql_escape($this->session_id) . "'";
							$result = $db->sql_query($sql);

							$db->sql_return_on_error(false);

							if ($result === false)
							{
								unset($sql_ary['session_album_id']);
								$db->sql_return_on_error(true);

								$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $db->sql_build_array('UPDATE', $sql_ary) . "
									WHERE session_id = '" . $db->sql_escape($this->session_id) . "'";
								$result = $db->sql_query($sql);

								$db->sql_return_on_error(false);
							}

							// If the database is not yet updated, there will be an error due to the session_forum_id
							// @todo REMOVE for 3.0.2
							if ($result === false)
							{
								unset($sql_ary['session_forum_id']);

								$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $db->sql_build_array('UPDATE', $sql_ary) . "
									WHERE session_id = '" . $db->sql_escape($this->session_id) . "'";
								$db->sql_query($sql);
							}

							if ($this->data['user_id'] != ANONYMOUS && !empty($config['new_member_post_limit']) && $this->data['user_new'] && $config['new_member_post_limit'] <= $this->data['user_posts'])
							{
								$this->leave_newly_registered();
							}
						}

						$this->data['is_registered'] = ($this->data['user_id'] != ANONYMOUS && ($this->data['user_type'] == USER_NORMAL || $this->data['user_type'] == USER_FOUNDER)) ? true : false;
						$this->data['is_bot'] = (!$this->data['is_registered'] && $this->data['user_id'] != ANONYMOUS) ? true : false;
						$this->data['user_lang'] = basename($this->data['user_lang']);

						return true;
					}
				}
				else
				{
					// Added logging temporarly to help debug bugs...
					if (defined('DEBUG_EXTRA') && $this->data['user_id'] != ANONYMOUS)
					{
						if ($referer_valid)
						{
							add_log('critical', 'LOG_IP_BROWSER_FORWARDED_CHECK', $u_ip, $s_ip, $u_browser, $s_browser, htmlspecialchars($u_forwarded_for), htmlspecialchars($s_forwarded_for));
						}
						else
						{
							add_log('critical', 'LOG_REFERER_INVALID', $this->referer);
						}
					}
				}
			}
		}

		// If we reach here then no (valid) session exists. So we'll create a new one
		return $this->session_create();
	}

	/**
	* Create a new session
	*
	* If upon trying to start a session we discover there is nothing existing we
	* jump here. Additionally this method is called directly during login to regenerate
	* the session for the specific user. In this method we carry out a number of tasks;
	* garbage collection, (search)bot checking, banned user comparison. Basically
	* though this method will result in a new session for a specific user.
	*/
	function session_create($user_id = false, $set_admin = false, $persist_login = false, $viewonline = true)
	{
		global $SID, $_SID, $db, $config, $cache, $phpbb_root_path, $phpEx;

		$this->data = array();

		/* Garbage collection ... remove old sessions updating user information
		// if necessary. It means (potentially) 11 queries but only infrequently
		if ($this->time_now > $config['session_last_gc'] + $config['session_gc'])
		{
			$this->session_gc();
		}*/

		// Do we allow autologin on this board? No? Then override anything
		// that may be requested here
		if (!$config['allow_autologin'])
		{
			$this->cookie_data['k'] = $persist_login = false;
		}

		/**
		* Here we do a bot check, oh er saucy! No, not that kind of bot
		* check. We loop through the list of bots defined by the admin and
		* see if we have any useragent and/or IP matches. If we do, this is a
		* bot, act accordingly
		*/
		$bot = false;
		$active_bots = $cache->obtain_bots();

		foreach ($active_bots as $row)
		{
			if ($row['bot_agent'] && preg_match('#' . str_replace('\*', '.*?', preg_quote($row['bot_agent'], '#')) . '#i', $this->browser))
			{
				$bot = $row['user_id'];
			}

			// If ip is supplied, we will make sure the ip is matching too...
			if ($row['bot_ip'] && ($bot || !$row['bot_agent']))
			{
				// Set bot to false, then we only have to set it to true if it is matching
				$bot = false;

				foreach (explode(',', $row['bot_ip']) as $bot_ip)
				{
					$bot_ip = trim($bot_ip);

					if (!$bot_ip)
					{
						continue;
					}

					if (strpos($this->ip, $bot_ip) === 0)
					{
						$bot = (int) $row['user_id'];
						break;
					}
				}
			}

			if ($bot)
			{
				break;
			}
		}

		$method = basename(trim($config['auth_method']));
		include_once($phpbb_root_path . 'includes/auth/auth_' . $method . '.' . $phpEx);

		$method = 'autologin_' . $method;
		if (function_exists($method))
		{
			$this->data = $method();

			if (sizeof($this->data))
			{
				$this->cookie_data['k'] = '';
				$this->cookie_data['u'] = $this->data['user_id'];
			}
		}

		// If we're presented with an autologin key we'll join against it.
		// Else if we've been passed a user_id we'll grab data based on that
		if (isset($this->cookie_data['k']) && $this->cookie_data['k'] && $this->cookie_data['u'] && !sizeof($this->data))
		{
			$sql = 'SELECT u.*
				FROM ' . USERS_TABLE . ' u, ' . SESSIONS_KEYS_TABLE . ' k
				WHERE u.user_id = ' . (int) $this->cookie_data['u'] . '
					AND u.user_type IN (' . USER_NORMAL . ', ' . USER_FOUNDER . ")
					AND k.user_id = u.user_id
					AND k.key_id = '" . $db->sql_escape(md5($this->cookie_data['k'])) . "'";
			$result = $db->sql_query($sql);
			$this->data = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);
			$bot = false;
		}
		else if ($user_id !== false && !sizeof($this->data))
		{
			$this->cookie_data['k'] = '';
			$this->cookie_data['u'] = $user_id;

			$sql = 'SELECT *
				FROM ' . USERS_TABLE . '
				WHERE user_id = ' . (int) $this->cookie_data['u'] . '
					AND user_type IN (' . USER_NORMAL . ', ' . USER_FOUNDER . ')';
			$result = $db->sql_query($sql);
			$this->data = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);
			$bot = false;
		}

		// Bot user, if they have a SID in the Request URI we need to get rid of it
		// otherwise they'll index this page with the SID, duplicate content oh my!
		if ($bot && isset($_GET['sid']))
		{
			send_status_line(301, 'Moved Permanently');
			redirect(build_url(array('sid')));
		}

		// If no data was returned one or more of the following occurred:
		// Key didn't match one in the DB
		// User does not exist
		// User is inactive
		// User is bot
		if (!sizeof($this->data) || !is_array($this->data))
		{
			$this->cookie_data['k'] = '';
			$this->cookie_data['u'] = ($bot) ? $bot : ANONYMOUS;

			if (!$bot)
			{
				$sql = 'SELECT *
					FROM ' . USERS_TABLE . '
					WHERE user_id = ' . (int) $this->cookie_data['u'];
			}
			else
			{
				// We give bots always the same session if it is not yet expired.
				$sql = 'SELECT u.*, s.*
					FROM ' . USERS_TABLE . ' u
					LEFT JOIN ' . SESSIONS_TABLE . ' s ON (s.session_user_id = u.user_id)
					WHERE u.user_id = ' . (int) $bot;
			}

			$result = $db->sql_query($sql);
			$this->data = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);
		}

		if ($this->data['user_id'] != ANONYMOUS && !$bot)
		{
			$this->data['session_last_visit'] = (isset($this->data['session_time']) && $this->data['session_time']) ? $this->data['session_time'] : (($this->data['user_lastvisit']) ? $this->data['user_lastvisit'] : time());
		}
		else
		{
			$this->data['session_last_visit'] = $this->time_now;
		}

		// Force user id to be integer...
		$this->data['user_id'] = (int) $this->data['user_id'];

		// At this stage we should have a filled data array, defined cookie u and k data.
		// data array should contain recent session info if we're a real user and a recent
		// session exists in which case session_id will also be set
//-- mod: Prime Ban to Group -----------------------------------------------//
		// Delete stale bans
		global $phpbb_root_path, $phpEx;
		include "$phpbb_root_path/includes/prime_ban_to_group.$phpEx";
		$prime_ban_to_group = new prime_ban_to_group(null, 'unban');
//-- end: Prime Ban to Group -----------------------------------------------//
		// Is user banned? Are they excluded? Won't return on ban, exists within method
		if ($this->data['user_type'] != USER_FOUNDER)
		{
			if (!$config['forwarded_for_check'])
			{
				$this->check_ban($this->data['user_id'], $this->ip);
			}
			else
			{
				$ips = explode(' ', $this->forwarded_for);
				$ips[] = $this->ip;
				$this->check_ban($this->data['user_id'], $ips);
			}
		}

		$this->data['is_registered'] = (!$bot && $this->data['user_id'] != ANONYMOUS && ($this->data['user_type'] == USER_NORMAL || $this->data['user_type'] == USER_FOUNDER)) ? true : false;
		$this->data['is_bot'] = ($bot) ? true : false;

		// If our friend is a bot, we re-assign a previously assigned session
		if ($this->data['is_bot'] && $bot == $this->data['user_id'] && $this->data['session_id'])
		{
			// Only assign the current session if the ip, browser and forwarded_for match...
			if (strpos($this->ip, ':') !== false && strpos($this->data['session_ip'], ':') !== false)
			{
				$s_ip = short_ipv6($this->data['session_ip'], $config['ip_check']);
				$u_ip = short_ipv6($this->ip, $config['ip_check']);
			}
			else
			{
				$s_ip = implode('.', array_slice(explode('.', $this->data['session_ip']), 0, $config['ip_check']));
				$u_ip = implode('.', array_slice(explode('.', $this->ip), 0, $config['ip_check']));
			}

			$s_browser = ($config['browser_check']) ? trim(strtolower(substr($this->data['session_browser'], 0, 149))) : '';
			$u_browser = ($config['browser_check']) ? trim(strtolower(substr($this->browser, 0, 149))) : '';

			$s_forwarded_for = ($config['forwarded_for_check']) ? substr($this->data['session_forwarded_for'], 0, 254) : '';
			$u_forwarded_for = ($config['forwarded_for_check']) ? substr($this->forwarded_for, 0, 254) : '';

			if ($u_ip === $s_ip && $s_browser === $u_browser && $s_forwarded_for === $u_forwarded_for)
			{
				$this->session_id = $this->data['session_id'];

				// Only update session DB a minute or so after last update or if page changes
				if ($this->time_now - $this->data['session_time'] > 60 || ($this->update_session_page && $this->data['session_page'] != $this->page['page']))
				{
					$this->data['session_time'] = $this->data['session_last_visit'] = $this->time_now;

					$sql_ary = array('session_time' => $this->time_now, 'session_last_visit' => $this->time_now, 'session_admin' => 0);

					if ($this->update_session_page)
					{
						$sql_ary['session_page'] = substr($this->page['page'], 0, 199);
						$sql_ary['session_forum_id'] = $this->page['forum'];
                        $sql_ary['session_album_id'] = $this->page['album'];		
					}

					$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $db->sql_build_array('UPDATE', $sql_ary) . "
						WHERE session_id = '" . $db->sql_escape($this->session_id) . "'";
					$db->sql_query($sql);

					// Update the last visit time
					$sql = 'UPDATE ' . USERS_TABLE . '
						SET user_lastvisit = ' . (int) $this->data['session_time'] . '
						WHERE user_id = ' . (int) $this->data['user_id'];
					$db->sql_query($sql);
				}

				$SID = '?sid=';
				$_SID = '';
				return true;
			}
			else
			{
				// If the ip and browser does not match make sure we only have one bot assigned to one session
				$db->sql_query('DELETE FROM ' . SESSIONS_TABLE . ' WHERE session_user_id = ' . $this->data['user_id']);
			}
		}

		$session_autologin = (($this->cookie_data['k'] || $persist_login) && $this->data['is_registered']) ? true : false;
		$set_admin = ($set_admin && $this->data['is_registered']) ? true : false;

		// Create or update the session
		$sql_ary = array(
			'session_user_id'		=> (int) $this->data['user_id'],
			'session_start'			=> (int) $this->time_now,
			'session_last_visit'	=> (int) $this->data['session_last_visit'],
			'session_time'			=> (int) $this->time_now,
			'session_browser'		=> (string) trim(substr($this->browser, 0, 149)),
			'session_forwarded_for'	=> (string) $this->forwarded_for,
			'session_ip'			=> (string) $this->ip,
			'session_autologin'		=> ($session_autologin) ? 1 : 0,
			'session_admin'			=> ($set_admin) ? 1 : 0,
			'session_viewonline'	=> ($viewonline) ? 1 : 0,
		);

		if ($this->update_session_page)
		{
			$sql_ary['session_page'] = (string) substr($this->page['page'], 0, 199);
			$sql_ary['session_forum_id'] = $this->page['forum'];
            $sql_ary['session_album_id'] = $this->page['album'];
		}

		$db->sql_return_on_error(true);

		$sql = 'DELETE
			FROM ' . SESSIONS_TABLE . '
			WHERE session_id = \'' . $db->sql_escape($this->session_id) . '\'
				AND session_user_id = ' . ANONYMOUS;

		if (!defined('IN_ERROR_HANDLER') && (!$this->session_id || !$db->sql_query($sql) || !$db->sql_affectedrows()))
		{
			// Limit new sessions in 1 minute period (if required)
			if (empty($this->data['session_time']) && $config['active_sessions'])
			{
//				$db->sql_return_on_error(false);

				$sql = 'SELECT COUNT(session_id) AS sessions
					FROM ' . SESSIONS_TABLE . '
					WHERE session_time >= ' . ($this->time_now - 60);
				$result = $db->sql_query($sql);
				$row = $db->sql_fetchrow($result);
				$db->sql_freeresult($result);

				if ((int) $row['sessions'] > (int) $config['active_sessions'])
				{
					send_status_line(503, 'Service Unavailable');
					trigger_error('BOARD_UNAVAILABLE');
				}
			}
		}

		// Since we re-create the session id here, the inserted row must be unique. Therefore, we display potential errors.
		// Commented out because it will not allow forums to update correctly
//		$db->sql_return_on_error(false);

		// Something quite important: session_page always holds the *last* page visited, except for the *first* visit.
		// We are not able to simply have an empty session_page btw, therefore we need to tell phpBB how to detect this special case.
		// If the session id is empty, we have a completely new one and will set an "identifier" here. This identifier is able to be checked later.
		if (empty($this->data['session_id']))
		{
			// This is a temporary variable, only set for the very first visit
			$this->data['session_created'] = true;
		}

		$this->session_id = $this->data['session_id'] = md5(unique_id());

		$sql_ary['session_id'] = (string) $this->session_id;
		$sql_ary['session_page'] = (string) substr($this->page['page'], 0, 199);
		$sql_ary['session_forum_id'] = $this->page['forum'];
        $sql_ary['session_album_id'] = $this->page['album'];

		$sql = 'INSERT INTO ' . SESSIONS_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary);
		$db->sql_query($sql);

		$db->sql_return_on_error(false);

		// Regenerate autologin/persistent login key
		if ($session_autologin)
		{
			$this->set_login_key();
		}

		// refresh data
		$SID = '?sid=' . $this->session_id;
		$_SID = $this->session_id;
		$this->data = array_merge($this->data, $sql_ary);

		if (!$bot)
		{
			$cookie_expire = $this->time_now + (($config['max_autologin_time']) ? 86400 * (int) $config['max_autologin_time'] : 31536000);

			$this->set_cookie('u', $this->cookie_data['u'], $cookie_expire);
			$this->set_cookie('k', $this->cookie_data['k'], $cookie_expire);
			$this->set_cookie('sid', $this->session_id, $cookie_expire);

			unset($cookie_expire);

			$sql = 'SELECT COUNT(session_id) AS sessions
					FROM ' . SESSIONS_TABLE . '
					WHERE session_user_id = ' . (int) $this->data['user_id'] . '
					AND session_time >= ' . (int) ($this->time_now - (max($config['session_length'], $config['form_token_lifetime'])));
			$result = $db->sql_query($sql);
			$row = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);

			if ((int) $row['sessions'] <= 1 || empty($this->data['user_form_salt']))
			{
				$this->data['user_form_salt'] = unique_id();
				// Update the form key
				$sql = 'UPDATE ' . USERS_TABLE . '
					SET user_form_salt = \'' . $db->sql_escape($this->data['user_form_salt']) . '\'
					WHERE user_id = ' . (int) $this->data['user_id'];
				$db->sql_query($sql);
			}
		}
		else
		{
			$this->data['session_time'] = $this->data['session_last_visit'] = $this->time_now;

			// Update the last visit time
			$sql = 'UPDATE ' . USERS_TABLE . '
				SET user_lastvisit = ' . (int) $this->data['session_time'] . '
				WHERE user_id = ' . (int) $this->data['user_id'];
			$db->sql_query($sql);

			$SID = '?sid=';
			$_SID = '';
		}

		return true;
	}

	/**
	* Kills a session
	*
	* This method does what it says on the tin. It will delete a pre-existing session.
	* It resets cookie information (destroying any autologin key within that cookie data)
	* and update the users information from the relevant session data. It will then
	* grab guest user information.
	*/
	function session_kill($new_session = true)
	{
		global $SID, $_SID, $db, $config, $phpbb_root_path, $phpEx;

		$sql = 'DELETE FROM ' . SESSIONS_TABLE . "
			WHERE session_id = '" . $db->sql_escape($this->session_id) . "'
				AND session_user_id = " . (int) $this->data['user_id'];
		$db->sql_query($sql);

		// Allow connecting logout with external auth method logout
		$method = basename(trim($config['auth_method']));
		include_once($phpbb_root_path . 'includes/auth/auth_' . $method . '.' . $phpEx);

		$method = 'logout_' . $method;
		if (function_exists($method))
		{
			$method($this->data, $new_session);
		}

		if ($this->data['user_id'] != ANONYMOUS)
		{
			// Delete existing session, update last visit info first!
			if (!isset($this->data['session_time']))
			{
				$this->data['session_time'] = time();
			}

			$sql = 'UPDATE ' . USERS_TABLE . '
				SET user_lastvisit = ' . (int) $this->data['session_time'] . '
				WHERE user_id = ' . (int) $this->data['user_id'];
			$db->sql_query($sql);

			if ($this->cookie_data['k'])
			{
				$sql = 'DELETE FROM ' . SESSIONS_KEYS_TABLE . '
					WHERE user_id = ' . (int) $this->data['user_id'] . "
						AND key_id = '" . $db->sql_escape(md5($this->cookie_data['k'])) . "'";
				$db->sql_query($sql);
			}

			// Reset the data array
			$this->data = array();

			$sql = 'SELECT *
				FROM ' . USERS_TABLE . '
				WHERE user_id = ' . ANONYMOUS;
			$result = $db->sql_query($sql);
			$this->data = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);
		}

		$cookie_expire = $this->time_now - 31536000;
		$this->set_cookie('u', '', $cookie_expire);
		$this->set_cookie('k', '', $cookie_expire);
		$this->set_cookie('sid', '', $cookie_expire);
		unset($cookie_expire);

		$SID = '?sid=';
		$this->session_id = $_SID = '';

		// To make sure a valid session is created we create one for the anonymous user
		if ($new_session)
		{
			$this->session_create(ANONYMOUS);
		}

		return true;
	}

	/**
	* Session garbage collection
	*
	* This looks a lot more complex than it really is. Effectively we are
	* deleting any sessions older than an admin definable limit. Due to the
	* way in which we maintain session data we have to ensure we update user
	* data before those sessions are destroyed. In addition this method
	* removes autologin key information that is older than an admin defined
	* limit.
	*/
	function session_gc()
	{
		global $db, $config, $phpbb_root_path, $phpEx;

		$batch_size = 10;

		if (!$this->time_now)
		{
			$this->time_now = time();
		}

		// Firstly, delete guest sessions
		$sql = 'DELETE FROM ' . SESSIONS_TABLE . '
			WHERE session_user_id = ' . ANONYMOUS . '
				AND session_time < ' . (int) ($this->time_now - 86400);
		$db->sql_query($sql);

		// Get expired sessions, only most recent for each user
		$sql = 'SELECT session_user_id, session_page, MAX(session_time) AS recent_time
			FROM ' . SESSIONS_TABLE . '
						WHERE session_time < ' . ($this->time_now - $config['session_length']) . ' AND session_user_id <> ' . ANONYMOUS . '
			GROUP BY session_user_id, session_page';
		$result = $db->sql_query_limit($sql, $batch_size);

		$del_user_id = array();
		$del_sessions = 0;

		while ($row = $db->sql_fetchrow($result))
		{
			$sql = 'UPDATE ' . USERS_TABLE . '
				SET user_lastvisit = ' . (int) $row['recent_time'] . ", user_lastpage = '" . $db->sql_escape($row['session_page']) . "'
				WHERE user_id = " . (int) $row['session_user_id'];
			$db->sql_query($sql);

			$del_user_id[] = (int) $row['session_user_id'];
			$del_sessions++;
		}
		$db->sql_freeresult($result);

		if (sizeof($del_user_id))
		{
			// Delete expired sessions
			$sql = 'DELETE FROM ' . SESSIONS_TABLE . '
				WHERE ' . $db->sql_in_set('session_user_id', $del_user_id) . '
					AND session_time < ' . ($this->time_now - $config['session_length']);
			$db->sql_query($sql);
		}

		if ($del_sessions < $batch_size)
		{

    		// Less than 10 users, update gc timer ... else we want gc
			// called again to delete other sessions
			set_config('session_last_gc', $this->time_now, true);

			if ($config['max_autologin_time'])
			{
				$sql = 'DELETE FROM ' . SESSIONS_KEYS_TABLE . '
					WHERE last_login < ' . (time() - (86400 * (int) $config['max_autologin_time']));
				$db->sql_query($sql);
			}

			// only called from CRON; should be a safe workaround until the infrastructure gets going
			if (!class_exists('phpbb_captcha_factory'))
			{
				include($phpbb_root_path . "includes/captcha/captcha_factory." . $phpEx);
			}
			phpbb_captcha_factory::garbage_collect($config['captcha_plugin']);

			$sql = 'DELETE FROM ' . LOGIN_ATTEMPT_TABLE . '
				WHERE attempt_time < ' . (time() - (int) $config['ip_login_limit_time']);
			$db->sql_query($sql);
		}

		return;
	}

	/**
	* Sets a cookie
	*
	* Sets a cookie of the given name with the specified data for the given length of time. If no time is specified, a session cookie will be set.
	*
	* @param string $name		Name of the cookie, will be automatically prefixed with the phpBB cookie name. track becomes [cookie_name]_track then.
	* @param string $cookiedata	The data to hold within the cookie
	* @param int $cookietime	The expiration time as UNIX timestamp. If 0 is provided, a session cookie is set.
	*/
	function set_cookie($name, $cookiedata, $cookietime)
	{
		global $config;

		$name_data = rawurlencode($config['cookie_name'] . '_' . $name) . '=' . rawurlencode($cookiedata);
		$expire = gmdate('D, d-M-Y H:i:s \\G\\M\\T', $cookietime);
		$domain = (!$config['cookie_domain'] || $config['cookie_domain'] == 'localhost' || $config['cookie_domain'] == '127.0.0.1') ? '' : '; domain=' . $config['cookie_domain'];

		header('Set-Cookie: ' . $name_data . (($cookietime) ? '; expires=' . $expire : '') . '; path=' . $config['cookie_path'] . $domain . ((!$config['cookie_secure']) ? '' : '; secure') . '; HttpOnly', false);
	}

	/**
	* Check for banned user
	*
	* Checks whether the supplied user is banned by id, ip or email. If no parameters
	* are passed to the method pre-existing session data is used. If $return is false
	* this routine does not return on finding a banned user, it outputs a relevant
	* message and stops execution.
	*
	* @param string|array	$user_ips	Can contain a string with one IP or an array of multiple IPs
	*/
	function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false)
	{
		global $config, $db;

		if (defined('IN_CHECK_BAN'))
		{
			return;
		}

		$banned = false;
		$cache_ttl = 3600;
		$where_sql = array();

		$sql = 'SELECT ban_ip, ban_userid, ban_email, ban_exclude, ban_give_reason, ban_end
			FROM ' . BANLIST_TABLE . '
			WHERE ';

		// Determine which entries to check, only return those
		if ($user_email === false)
		{
			$where_sql[] = "ban_email = ''";
		}

		if ($user_ips === false)
		{
			$where_sql[] = "(ban_ip = '' OR ban_exclude = 1)";
		}

		if ($user_id === false)
		{
			$where_sql[] = '(ban_userid = 0 OR ban_exclude = 1)';
		}
		else
		{
			$cache_ttl = ($user_id == ANONYMOUS) ? 3600 : 0;
			$_sql = '(ban_userid = ' . $user_id;

			if ($user_email !== false)
			{
				$_sql .= " OR ban_email <> ''";
			}

			if ($user_ips !== false)
			{
				$_sql .= " OR ban_ip <> ''";
			}

			$_sql .= ')';

			$where_sql[] = $_sql;
		}

		$sql .= (sizeof($where_sql)) ? implode(' AND ', $where_sql) : '';
		$result = $db->sql_query($sql, $cache_ttl);

		$ban_triggered_by = 'user';
		while ($row = $db->sql_fetchrow($result))
		{
			if ($row['ban_end'] && $row['ban_end'] < time())
			{
				continue;
			}

			$ip_banned = false;
			if (!empty($row['ban_ip']))
			{
				if (!is_array($user_ips))
				{
					$ip_banned = preg_match('#^' . str_replace('\*', '.*?', preg_quote($row['ban_ip'], '#')) . '$#i', $user_ips);
				}
				else
				{
					foreach ($user_ips as $user_ip)
					{
						if (preg_match('#^' . str_replace('\*', '.*?', preg_quote($row['ban_ip'], '#')) . '$#i', $user_ip))
						{
							$ip_banned = true;
							break;
						}
					}
				}
			}

			if ((!empty($row['ban_userid']) && intval($row['ban_userid']) == $user_id) ||
				$ip_banned ||
				(!empty($row['ban_email']) && preg_match('#^' . str_replace('\*', '.*?', preg_quote($row['ban_email'], '#')) . '$#i', $user_email)))
			{
				if (!empty($row['ban_exclude']))
				{
					$banned = false;
					break;
				}
				else
				{
					$banned = true;
					$ban_row = $row;

					if (!empty($row['ban_userid']) && intval($row['ban_userid']) == $user_id)
					{
						$ban_triggered_by = 'user';
					}
					else if ($ip_banned)
					{
						$ban_triggered_by = 'ip';
					}
					else
					{
						$ban_triggered_by = 'email';
					}

					// Don't break. Check if there is an exclude rule for this user
				}
			}
		}
		$db->sql_freeresult($result);

		if ($banned && !$return)
		{
			global $template;

			// If the session is empty we need to create a valid one...
			if (empty($this->session_id))
			{
				// This seems to be no longer needed? - #14971
//				$this->session_create(ANONYMOUS);
			}

			// Initiate environment ... since it won't be set at this stage
			$this->setup();

			// Logout the user, banned users are unable to use the normal 'logout' link
			if ($this->data['user_id'] != ANONYMOUS)
			{
				$this->session_kill();
			}

			// We show a login box here to allow founders accessing the board if banned by IP
			if (defined('IN_LOGIN') && $this->data['user_id'] == ANONYMOUS)
			{
				global $phpEx;

				$this->setup('ucp');
				$this->data['is_registered'] = $this->data['is_bot'] = false;

				// Set as a precaution to allow login_box() handling this case correctly as well as this function not being executed again.
				define('IN_CHECK_BAN', 1);

				login_box("index.$phpEx");

				// The false here is needed, else the user is able to circumvent the ban.
				$this->session_kill(false);
			}

			// Ok, we catch the case of an empty session id for the anonymous user...
			// This can happen if the user is logging in, banned by username and the login_box() being called "again".
			if (empty($this->session_id) && defined('IN_CHECK_BAN'))
			{
				$this->session_create(ANONYMOUS);
			}


			// Determine which message to output
			$till_date = ($ban_row['ban_end']) ? $this->format_date($ban_row['ban_end']) : '';
			$message = ($ban_row['ban_end']) ? 'BOARD_BAN_TIME' : 'BOARD_BAN_PERM';

			$message = sprintf($this->lang[$message], $till_date, '<a href="mailto:' . $config['board_contact'] . '">', '</a>');
			$message .= ($ban_row['ban_give_reason']) ? '<br /><br />' . sprintf($this->lang['BOARD_BAN_REASON'], $ban_row['ban_give_reason']) : '';
			$message .= '<br /><br /><em>' . $this->lang['BAN_TRIGGERED_BY_' . strtoupper($ban_triggered_by)] . '</em>';

			// To circumvent session_begin returning a valid value and the check_ban() not called on second page view, we kill the session again
			$this->session_kill(false);

			// A very special case... we are within the cron script which is not supposed to print out the ban message... show blank page
			if (defined('IN_CRON'))
			{
				garbage_collection();
				exit_handler();
				exit;
			}

			trigger_error($message);
		}

		return ($banned && $ban_row['ban_give_reason']) ? $ban_row['ban_give_reason'] : $banned;
	}

	/**
	* Check if ip is blacklisted
	* This should be called only where absolutly necessary
	*
	* Only IPv4 (rbldns does not support AAAA records/IPv6 lookups)
	*
	* @author satmd (from the php manual)
	* @param string $mode register/post - spamcop for example is ommitted for posting
	* @return false if ip is not blacklisted, else an array([checked server], [lookup])
	*/
	function check_dnsbl($mode, $ip = false)
	{
		if ($ip === false)
		{
			$ip = $this->ip;
		}

		// Neither Spamhaus nor Spamcop supports IPv6 addresses.
		if (strpos($ip, ':') !== false)
		{
			return false;
		}

		$dnsbl_check = array(
			'sbl.spamhaus.org'	=> 'http://www.spamhaus.org/query/bl?ip=',
		);

		if ($mode == 'register')
		{
			$dnsbl_check['bl.spamcop.net'] = 'http://spamcop.net/bl.shtml?';
		}

		if ($ip)
		{
			$quads = explode('.', $ip);
			$reverse_ip = $quads[3] . '.' . $quads[2] . '.' . $quads[1] . '.' . $quads[0];

			// Need to be listed on all servers...
			$listed = true;
			$info = array();

			foreach ($dnsbl_check as $dnsbl => $lookup)
			{
				if (phpbb_checkdnsrr($reverse_ip . '.' . $dnsbl . '.', 'A') === true)
				{
					$info = array($dnsbl, $lookup . $ip);
				}
				else
				{
					$listed = false;
				}
			}

			if ($listed)
			{
				return $info;
			}
		}

		return false;
	}

	/**
	* Check if URI is blacklisted
	* This should be called only where absolutly necessary, for example on the submitted website field
	* This function is not in use at the moment and is only included for testing purposes, it may not work at all!
	* This means it is untested at the moment and therefore commented out
	*
	* @param string $uri URI to check
	* @return true if uri is on blacklist, else false. Only blacklist is checked (~zero FP), no grey lists
	function check_uribl($uri)
	{
		// Normally parse_url() is not intended to parse uris
		// We need to get the top-level domain name anyway... change.
		$uri = parse_url($uri);

		if ($uri === false || empty($uri['host']))
		{
			return false;
		}

		$uri = trim($uri['host']);

		if ($uri)
		{
			// One problem here... the return parameter for the "windows" method is different from what
			// we expect... this may render this check useless...
			if (phpbb_checkdnsrr($uri . '.multi.uribl.com.', 'A') === true)
			{
				return true;
			}
		}

		return false;
	}
	*/

	/**
	* Set/Update a persistent login key
	*
	* This method creates or updates a persistent session key. When a user makes
	* use of persistent (formerly auto-) logins a key is generated and stored in the
	* DB. When they revisit with the same key it's automatically updated in both the
	* DB and cookie. Multiple keys may exist for each user representing different
	* browsers or locations. As with _any_ non-secure-socket no passphrase login this
	* remains vulnerable to exploit.
	*/
	function set_login_key($user_id = false, $key = false, $user_ip = false)
	{
		global $config, $db;

		$user_id = ($user_id === false) ? $this->data['user_id'] : $user_id;
		$user_ip = ($user_ip === false) ? $this->ip : $user_ip;
		$key = ($key === false) ? (($this->cookie_data['k']) ? $this->cookie_data['k'] : false) : $key;

		$key_id = unique_id(hexdec(substr($this->session_id, 0, 8)));

		$sql_ary = array(
			'key_id'		=> (string) md5($key_id),
			'last_ip'		=> (string) $this->ip,
			'last_login'	=> (int) time()
		);

		if (!$key)
		{
			$sql_ary += array(
				'user_id'	=> (int) $user_id
			);
		}

		if ($key)
		{
			$sql = 'UPDATE ' . SESSIONS_KEYS_TABLE . '
				SET ' . $db->sql_build_array('UPDATE', $sql_ary) . '
				WHERE user_id = ' . (int) $user_id . "
					AND key_id = '" . $db->sql_escape(md5($key)) . "'";
		}
		else
		{
			$sql = 'INSERT INTO ' . SESSIONS_KEYS_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary);
		}
		$db->sql_query($sql);

		$this->cookie_data['k'] = $key_id;

		return false;
	}

	/**
	* Reset all login keys for the specified user
	*
	* This method removes all current login keys for a specified (or the current)
	* user. It will be called on password change to render old keys unusable
	*/
	function reset_login_keys($user_id = false)
	{
		global $config, $db;

		$user_id = ($user_id === false) ? (int) $this->data['user_id'] : (int) $user_id;

		$sql = 'DELETE FROM ' . SESSIONS_KEYS_TABLE . '
			WHERE user_id = ' . (int) $user_id;
		$db->sql_query($sql);

		// If the user is logged in, update last visit info first before deleting sessions
		$sql = 'SELECT session_time, session_page
			FROM ' . SESSIONS_TABLE . '
			WHERE session_user_id = ' . (int) $user_id . '
			ORDER BY session_time DESC';
		$result = $db->sql_query_limit($sql, 1);
		$row = $db->sql_fetchrow($result);
		$db->sql_freeresult($result);

		if ($row)
		{
			$sql = 'UPDATE ' . USERS_TABLE . '
				SET user_lastvisit = ' . (int) $row['session_time'] . ", user_lastpage = '" . $db->sql_escape($row['session_page']) . "'
				WHERE user_id = " . (int) $user_id;
			$db->sql_query($sql);
		}

		// Let's also clear any current sessions for the specified user_id
		// If it's the current user then we'll leave this session intact
		$sql_where = 'session_user_id = ' . (int) $user_id;
		$sql_where .= ($user_id === (int) $this->data['user_id']) ? " AND session_id <> '" . $db->sql_escape($this->session_id) . "'" : '';

		$sql = 'DELETE FROM ' . SESSIONS_TABLE . "
			WHERE $sql_where";
		$db->sql_query($sql);

		// We're changing the password of the current user and they have a key
		// Lets regenerate it to be safe
		if ($user_id === (int) $this->data['user_id'] && $this->cookie_data['k'])
		{
			$this->set_login_key($user_id);
		}
	}


	/**
	* Check if the request originated from the same page.
	* @param bool $check_script_path If true, the path will be checked as well
	*/
	function validate_referer($check_script_path = false)
	{
		global $config;

		// no referer - nothing to validate, user's fault for turning it off (we only check on POST; so meta can't be the reason)
		if (empty($this->referer) || empty($this->host))
		{
			return true;
		}

		$host = htmlspecialchars($this->host);
		$ref = substr($this->referer, strpos($this->referer, '://') + 3);

		if (!(stripos($ref, $host) === 0) && (!$config['force_server_vars'] || !(stripos($ref, $config['server_name']) === 0)))
		{
			return false;
		}
		else if ($check_script_path && rtrim($this->page['root_script_path'], '/') !== '')
		{
			$ref = substr($ref, strlen($host));
			$server_port = (!empty($_SERVER['SERVER_PORT'])) ? (int) $_SERVER['SERVER_PORT'] : (int) getenv('SERVER_PORT');

			if ($server_port !== 80 && $server_port !== 443 && stripos($ref, ":$server_port") === 0)
			{
				$ref = substr($ref, strlen(":$server_port"));
			}

			if (!(stripos(rtrim($ref, '/'), rtrim($this->page['root_script_path'], '/')) === 0))
			{
				return false;
			}
		}

		return true;
	}


	function unset_admin()
	{
		global $db;
		$sql = 'UPDATE ' . SESSIONS_TABLE . '
			SET session_admin = 0
			WHERE session_id = \'' . $db->sql_escape($this->session_id) . '\'';
		$db->sql_query($sql);
	}
}


/**
* Base user class
*
* This is the overarching class which contains (through session extend)
* all methods utilised for user functionality during a session.
*
* @package phpBB3
*/
class user extends session
{
	var $lang = array();
	var $help = array();
	var $theme = array();
	var $date_format;
	var $timezone;
	var $dst;

	var $lang_name = false;
	var $lang_id = false;
	var $lang_path;
	var $img_lang;
	var $img_array = array();

	// Able to add new options (up to id 31)
	var $keyoptions = array('viewimg' => 0, 'viewflash' => 1, 'viewsmilies' => 2, 'viewsigs' => 3, 'viewavatars' => 4, 'viewcensors' => 5, 'attachsig' => 6, 'bbcode' => 8, 'smilies' => 9, 'popuppm' => 10, 'viewquickreply' => 11, 'viewquickpost' => 12, 'sig_bbcode' => 15, 'sig_smilies' => 16, 'sig_links' => 17);

	/**
	* Constructor to set the lang path
	*/
	function user()
	{
		global $phpbb_root_path;

		$this->lang_path = $phpbb_root_path . 'language/';
	}

	/**
	* Function to set custom language path (able to use directory outside of phpBB)
	*
	* @param string $lang_path New language path used.
	* @access public
	*/
	function set_custom_lang_path($lang_path)
	{
		$this->lang_path = $lang_path;

		if (substr($this->lang_path, -1) != '/')
		{
			$this->lang_path .= '/';
		}
	}

	/**
	* Setup basic user-specific items (style, language, ...)
	*/
	function setup($lang_set = false, $style = false)
	{
		global $db, $template, $config, $auth, $phpEx, $phpbb_root_path, $cache;

		if ($this->data['user_id'] != ANONYMOUS)
		{
			$this->lang_name = (file_exists($this->lang_path . $this->data['user_lang'] . "/common.$phpEx")) ? $this->data['user_lang'] : basename($config['default_lang']);

			$this->date_format = $this->data['user_dateformat'];
			$this->timezone = $this->data['user_timezone'] * 3600;
			$this->dst = $this->data['user_dst'] * 3600;
		}
		else
		{
			$this->lang_name = basename($config['default_lang']);
			$this->date_format = $config['default_dateformat'];
			$this->timezone = $config['board_timezone'] * 3600;
			$this->dst = $config['board_dst'] * 3600;

			/**
			* If a guest user is surfing, we try to guess his/her language first by obtaining the browser language
			* If re-enabled we need to make sure only those languages installed are checked
			* Commented out so we do not loose the code.

			if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE']))
			{
				$accept_lang_ary = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);

				foreach ($accept_lang_ary as $accept_lang)
				{
					// Set correct format ... guess full xx_YY form
					$accept_lang = substr($accept_lang, 0, 2) . '_' . strtoupper(substr($accept_lang, 3, 2));
					$accept_lang = basename($accept_lang);

					if (file_exists($this->lang_path . $accept_lang . "/common.$phpEx"))
					{
						$this->lang_name = $config['default_lang'] = $accept_lang;
						break;
					}
					else
					{
						// No match on xx_YY so try xx
						$accept_lang = substr($accept_lang, 0, 2);
						$accept_lang = basename($accept_lang);

						if (file_exists($this->lang_path . $accept_lang . "/common.$phpEx"))
						{
							$this->lang_name = $config['default_lang'] = $accept_lang;
							break;
						}
					}
				}
			}
			*/
		}

		// We include common language file here to not load it every time a custom language file is included
		$lang = &$this->lang;

		// Do not suppress error if in DEBUG_EXTRA mode
		$include_result = (defined('DEBUG_EXTRA')) ? (include $this->lang_path . $this->lang_name . "/common.$phpEx") : (@include $this->lang_path . $this->lang_name . "/common.$phpEx");

		if ($include_result === false)
		{
			die('Language file ' . $this->lang_path . $this->lang_name . "/common.$phpEx" . " couldn't be opened.");
		}

		$this->add_lang($lang_set);
		unset($lang_set);

		if (!empty($_GET['style']) && $auth->acl_get('a_styles') && !defined('ADMIN_START'))
		{
			global $SID, $_EXTRA_URL;

			$style = request_var('style', 0);
			$SID .= '&style=' . $style;
			$_EXTRA_URL = array('style=' . $style);
		}
		else
		{
			// Set up style
			$style = ($style) ? $style : ((!$config['override_user_style']) ? $this->data['user_style'] : $config['default_style']);
		}

		$sql = 'SELECT s.style_id, t.template_storedb, t.template_path, t.template_id, t.bbcode_bitfield, t.template_inherits_id, t.template_inherit_path, c.theme_path, c.theme_name, c.theme_storedb, c.theme_id, i.imageset_path, i.imageset_id, i.imageset_name
			FROM ' . STYLES_TABLE . ' s, ' . STYLES_TEMPLATE_TABLE . ' t, ' . STYLES_THEME_TABLE . ' c, ' . STYLES_IMAGESET_TABLE . " i
			WHERE s.style_id = $style
				AND t.template_id = s.template_id
				AND c.theme_id = s.theme_id
				AND i.imageset_id = s.imageset_id";
		$result = $db->sql_query($sql, 3600);
		$this->theme = $db->sql_fetchrow($result);
		$db->sql_freeresult($result);

		// User has wrong style
		if (!$this->theme && $style == $this->data['user_style'])
		{
			$style = $this->data['user_style'] = $config['default_style'];

			$sql = 'UPDATE ' . USERS_TABLE . "
				SET user_style = $style
				WHERE user_id = {$this->data['user_id']}";
			$db->sql_query($sql);

			$sql = 'SELECT s.style_id, t.template_storedb, t.template_path, t.template_id, t.bbcode_bitfield, c.theme_path, c.theme_name, c.theme_storedb, c.theme_id, i.imageset_path, i.imageset_id, i.imageset_name
				FROM ' . STYLES_TABLE . ' s, ' . STYLES_TEMPLATE_TABLE . ' t, ' . STYLES_THEME_TABLE . ' c, ' . STYLES_IMAGESET_TABLE . " i
				WHERE s.style_id = $style
					AND t.template_id = s.template_id
					AND c.theme_id = s.theme_id
					AND i.imageset_id = s.imageset_id";
			$result = $db->sql_query($sql, 3600);
			$this->theme = $db->sql_fetchrow($result);
			$db->sql_freeresult($result);
		}

		if (!$this->theme)
		{
			trigger_error('Could not get style data', E_USER_ERROR);
		}

		// Now parse the cfg file and cache it
		$parsed_items = $cache->obtain_cfg_items($this->theme);

		// We are only interested in the theme configuration for now
		$parsed_items = $parsed_items['theme'];

		$check_for = array(
			'parse_css_file'	=> (int) 0,
			'pagination_sep'	=> (string) ', '
		);

		foreach ($check_for as $key => $default_value)
		{
			$this->theme[$key] = (isset($parsed_items[$key])) ? $parsed_items[$key] : $default_value;
			settype($this->theme[$key], gettype($default_value));

			if (is_string($default_value))
			{
				$this->theme[$key] = htmlspecialchars($this->theme[$key]);
			}
		}

		// If the style author specified the theme needs to be cached
		// (because of the used paths and variables) than make sure it is the case.
		// For example, if the theme uses language-specific images it needs to be stored in db.
		if (!$this->theme['theme_storedb'] && $this->theme['parse_css_file'])
		{
			$this->theme['theme_storedb'] = 1;

			$stylesheet = file_get_contents("{$phpbb_root_path}styles/{$this->theme['theme_path']}/theme/stylesheet.css");
			// Match CSS imports
			$matches = array();
			preg_match_all('/@import url\(["\'](.*)["\']\);/i', $stylesheet, $matches);

			if (sizeof($matches))
			{
				$content = '';
				foreach ($matches[0] as $idx => $match)
				{
					if ($content = @file_get_contents("{$phpbb_root_path}styles/{$this->theme['theme_path']}/theme/" . $matches[1][$idx]))
					{
						$content = trim($content);
					}
					else
					{
						$content = '';
					}
					$stylesheet = str_replace($match, $content, $stylesheet);
				}
				unset($content);
			}

			$stylesheet = str_replace('./', 'styles/' . $this->theme['theme_path'] . '/theme/', $stylesheet);

			$sql_ary = array(
				'theme_data'	=> $stylesheet,
				'theme_mtime'	=> time(),
				'theme_storedb'	=> 1
			);

			$sql = 'UPDATE ' . STYLES_THEME_TABLE . '
				SET ' . $db->sql_build_array('UPDATE', $sql_ary) . '
				WHERE theme_id = ' . $this->theme['theme_id'];
			$db->sql_query($sql);

			unset($sql_ary);
		}

		$template->set_template();

		$this->img_lang = (file_exists($phpbb_root_path . 'styles/' . $this->theme['imageset_path'] . '/imageset/' . $this->lang_name)) ? $this->lang_name : $config['default_lang'];

		// Same query in style.php
		$sql = 'SELECT *
			FROM ' . STYLES_IMAGESET_DATA_TABLE . '
			WHERE imageset_id = ' . $this->theme['imageset_id'] . "
			AND image_filename <> ''
			AND image_lang IN ('" . $db->sql_escape($this->img_lang) . "', '')";
		$result = $db->sql_query($sql, 3600);

		$localised_images = false;
		while ($row = $db->sql_fetchrow($result))
		{
			if ($row['image_lang'])
			{
				$localised_images = true;
			}

			$row['image_filename'] = rawurlencode($row['image_filename']);
			$this->img_array[$row['image_name']] = $row;
		}
		$db->sql_freeresult($result);

		// there were no localised images, try to refresh the localised imageset for the user's language
		if (!$localised_images)
		{
			// Attention: this code ignores the image definition list from acp_styles and just takes everything
			// that the config file contains
			$sql_ary = array();

			$db->sql_transaction('begin');

			$sql = 'DELETE FROM ' . STYLES_IMAGESET_DATA_TABLE . '
				WHERE imageset_id = ' . $this->theme['imageset_id'] . '
					AND image_lang = \'' . $db->sql_escape($this->img_lang) . '\'';
			$result = $db->sql_query($sql);

			if (@file_exists("{$phpbb_root_path}styles/{$this->theme['imageset_path']}/imageset/{$this->img_lang}/imageset.cfg"))
			{
				$cfg_data_imageset_data = parse_cfg_file("{$phpbb_root_path}styles/{$this->theme['imageset_path']}/imageset/{$this->img_lang}/imageset.cfg");
				foreach ($cfg_data_imageset_data as $image_name => $value)
				{
					if (strpos($value, '*') !== false)
					{
						if (substr($value, -1, 1) === '*')
						{
							list($image_filename, $image_height) = explode('*', $value);
							$image_width = 0;
						}
						else
						{
							list($image_filename, $image_height, $image_width) = explode('*', $value);
						}
					}
					else
					{
						$image_filename = $value;
						$image_height = $image_width = 0;
					}

					if (strpos($image_name, 'img_') === 0 && $image_filename)
					{
						$image_name = substr($image_name, 4);
						$sql_ary[] = array(
							'image_name'		=> (string) $image_name,
							'image_filename'	=> (string) $image_filename,
							'image_height'		=> (int) $image_height,
							'image_width'		=> (int) $image_width,
							'imageset_id'		=> (int) $this->theme['imageset_id'],
							'image_lang'		=> (string) $this->img_lang,
						);
					}
				}
			}

			if (sizeof($sql_ary))
			{
				$db->sql_multi_insert(STYLES_IMAGESET_DATA_TABLE, $sql_ary);
				$db->sql_transaction('commit');
				$cache->destroy('sql', STYLES_IMAGESET_DATA_TABLE);

				add_log('admin', 'LOG_IMAGESET_LANG_REFRESHED', $this->theme['imageset_name'], $this->img_lang);
			}
			else
			{
				$db->sql_transaction('commit');
				add_log('admin', 'LOG_IMAGESET_LANG_MISSING', $this->theme['imageset_name'], $this->img_lang);
			}
		}

		// Call phpbb_user_session_handler() in case external application want to "bend" some variables or replace classes...
		// After calling it we continue script execution...
		phpbb_user_session_handler();

		// If this function got called from the error handler we are finished here.
		if (defined('IN_ERROR_HANDLER'))
		{
			return;
		}

		// Disable board if the install/ directory is still present
		// For the brave development army we do not care about this, else we need to comment out this everytime we develop locally
		if (!defined('DEBUG_EXTRA') && !defined('ADMIN_START') && !defined('IN_INSTALL') && !defined('IN_LOGIN') && file_exists($phpbb_root_path . 'install') && !is_file($phpbb_root_path . 'install'))
		{
			// Adjust the message slightly according to the permissions
			if ($auth->acl_gets('a_', 'm_') || $auth->acl_getf_global('m_'))
			{
				$message = 'REMOVE_INSTALL';
			}
			else
			{
				$message = (!empty($config['board_disable_msg'])) ? $config['board_disable_msg'] : 'BOARD_DISABLE';
			}
			trigger_error($message);
		}

		// Is board disabled and user not an admin or moderator?
		if ($config['board_disable'] && !defined('IN_LOGIN') && !$auth->acl_gets('a_', 'm_') && !$auth->acl_getf_global('m_'))
		{
			if ($this->data['is_bot'])
			{
				send_status_line(503, 'Service Unavailable');
			}

			$message = (!empty($config['board_disable_msg'])) ? $config['board_disable_msg'] : 'BOARD_DISABLE';
			trigger_error($message);
		}

		// Is load exceeded?
		if ($config['limit_load'] && $this->load !== false)
		{
			if ($this->load > floatval($config['limit_load']) && !defined('IN_LOGIN') && !defined('IN_ADMIN'))
			{
				// Set board disabled to true to let the admins/mods get the proper notification
				$config['board_disable'] = '1';

				if (!$auth->acl_gets('a_', 'm_') && !$auth->acl_getf_global('m_'))
				{
					if ($this->data['is_bot'])
					{
						send_status_line(503, 'Service Unavailable');
					}
					trigger_error('BOARD_UNAVAILABLE');
				}
			}
		}

		if (isset($this->data['session_viewonline']))
		{
			// Make sure the user is able to hide his session
			if (!$this->data['session_viewonline'])
			{
				// Reset online status if not allowed to hide the session...
				if (!$auth->acl_get('u_hideonline'))
				{
					$sql = 'UPDATE ' . SESSIONS_TABLE . '
						SET session_viewonline = 1
						WHERE session_user_id = ' . $this->data['user_id'];
					$db->sql_query($sql);
					$this->data['session_viewonline'] = 1;
				}
			}
			else if (!$this->data['user_allow_viewonline'])
			{
				// the user wants to hide and is allowed to  -> cloaking device on.
				if ($auth->acl_get('u_hideonline'))
				{
					$sql = 'UPDATE ' . SESSIONS_TABLE . '
						SET session_viewonline = 0
						WHERE session_user_id = ' . $this->data['user_id'];
					$db->sql_query($sql);
					$this->data['session_viewonline'] = 0;
				}
			}
		}
//-- mod: Prime Ban to Group -----------------------------------------------//
		$this->add_lang('mods/prime_ban_to_group');
//-- end: Prime Ban to Group -----------------------------------------------//
		// Does the user need to change their password? If so, redirect to the
		// ucp profile reg_details page ... of course do not redirect if we're already in the ucp
		if (!defined('IN_ADMIN') && !defined('ADMIN_START') && $config['chg_passforce'] && !empty($this->data['is_registered']) && $auth->acl_get('u_chgpasswd') && $this->data['user_passchg'] < time() - ($config['chg_passforce'] * 86400))
		{
			if (strpos($this->page['query_string'], 'mode=reg_details') === false && $this->page['page_name'] != "ucp.$phpEx")
			{
				redirect(append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=profile&mode=reg_details'));
			}
		}

		return;
	}

	/**
	* More advanced language substitution
	* Function to mimic sprintf() with the possibility of using phpBB's language system to substitute nullar/singular/plural forms.
	* Params are the language key and the parameters to be substituted.
	* This function/functionality is inspired by SHS` and Ashe.
	*
	* Example call: <samp>$user->lang('NUM_POSTS_IN_QUEUE', 1);</samp>
	*/
	function lang()
	{
		$args = func_get_args();
		$key = $args[0];

		if (is_array($key))
		{
			$lang = &$this->lang[array_shift($key)];

			foreach ($key as $_key)
			{
				$lang = &$lang[$_key];
			}
		}
		else
		{
			$lang = &$this->lang[$key];
		}

		// Return if language string does not exist
		if (!isset($lang) || (!is_string($lang) && !is_array($lang)))
		{
			return $key;
		}

		// If the language entry is a string, we simply mimic sprintf() behaviour
		if (is_string($lang))
		{
			if (sizeof($args) == 1)
			{
				return $lang;
			}

			// Replace key with language entry and simply pass along...
			$args[0] = $lang;
			return call_user_func_array('sprintf', $args);
		}

		// It is an array... now handle different nullar/singular/plural forms
		$key_found = false;

		// We now get the first number passed and will select the key based upon this number
		for ($i = 1, $num_args = sizeof($args); $i < $num_args; $i++)
		{
			if (is_int($args[$i]))
			{
				$numbers = array_keys($lang);

				foreach ($numbers as $num)
				{
					if ($num > $args[$i])
					{
						break;
					}

					$key_found = $num;
				}
				break;
			}
		}

		// Ok, let's check if the key was found, else use the last entry (because it is mostly the plural form)
		if ($key_found === false)
		{
			$numbers = array_keys($lang);
			$key_found = end($numbers);
		}

		// Use the language string we determined and pass it to sprintf()
		$args[0] = $lang[$key_found];
		return call_user_func_array('sprintf', $args);
	}

	/**
	* Add Language Items - use_db and use_help are assigned where needed (only use them to force inclusion)
	*
	* @param mixed $lang_set specifies the language entries to include
	* @param bool $use_db internal variable for recursion, do not use
	* @param bool $use_help internal variable for recursion, do not use
	*
	* Examples:
	* <code>
	* $lang_set = array('posting', 'help' => 'faq');
	* $lang_set = array('posting', 'viewtopic', 'help' => array('bbcode', 'faq'))
	* $lang_set = array(array('posting', 'viewtopic'), 'help' => array('bbcode', 'faq'))
	* $lang_set = 'posting'
	* $lang_set = array('help' => 'faq', 'db' => array('help:faq', 'posting'))
	* </code>
	*/
	function add_lang($lang_set, $use_db = false, $use_help = false)
	{
		global $phpEx;

		if (is_array($lang_set))
		{
			foreach ($lang_set as $key => $lang_file)
			{
				// Please do not delete this line.
				// We have to force the type here, else [array] language inclusion will not work
				$key = (string) $key;

				if ($key == 'db')
				{
					$this->add_lang($lang_file, true, $use_help);
				}
				else if ($key == 'help')
				{
					$this->add_lang($lang_file, $use_db, true);
				}
				else if (!is_array($lang_file))
				{
					$this->set_lang($this->lang, $this->help, $lang_file, $use_db, $use_help);
				}
				else
				{
					$this->add_lang($lang_file, $use_db, $use_help);
				}
			}
			unset($lang_set);
		}
		else if ($lang_set)
		{
			$this->set_lang($this->lang, $this->help, $lang_set, $use_db, $use_help);
		}
	}

	/**
	* Set language entry (called by add_lang)
	* @access private
	*/
	function set_lang(&$lang, &$help, $lang_file, $use_db = false, $use_help = false)
	{
		global $phpEx;

		// Make sure the language name is set (if the user setup did not happen it is not set)
		if (!$this->lang_name)
		{
			global $config;
			$this->lang_name = basename($config['default_lang']);
		}

		// $lang == $this->lang
		// $help == $this->help
		// - add appropriate variables here, name them as they are used within the language file...
		if (!$use_db)
		{
			if ($use_help && strpos($lang_file, '/') !== false)
			{
				$language_filename = $this->lang_path . $this->lang_name . '/' . substr($lang_file, 0, stripos($lang_file, '/') + 1) . 'help_' . substr($lang_file, stripos($lang_file, '/') + 1) . '.' . $phpEx;
			}
			else
			{
				$language_filename = $this->lang_path . $this->lang_name . '/' . (($use_help) ? 'help_' : '') . $lang_file . '.' . $phpEx;
			}

			if (!file_exists($language_filename))
			{
				global $config;

				if ($this->lang_name == 'en')
				{
					// The user's selected language is missing the file, the board default's language is missing the file, and the file doesn't exist in /en.
					$language_filename = str_replace($this->lang_path . 'en', $this->lang_path . $this->data['user_lang'], $language_filename);
					trigger_error('Language file ' . $language_filename . ' couldn\'t be opened.', E_USER_ERROR);
				}
				else if ($this->lang_name == basename($config['default_lang']))
				{
					// Fall back to the English Language
					$this->lang_name = 'en';
					$this->set_lang($lang, $help, $lang_file, $use_db, $use_help);
				}
				else if ($this->lang_name == $this->data['user_lang'])
				{
					// Fall back to the board default language
					$this->lang_name = basename($config['default_lang']);
					$this->set_lang($lang, $help, $lang_file, $use_db, $use_help);
				}

				// Reset the lang name
				$this->lang_name = (file_exists($this->lang_path . $this->data['user_lang'] . "/common.$phpEx")) ? $this->data['user_lang'] : basename($config['default_lang']);
				return;
			}

			// Do not suppress error if in DEBUG_EXTRA mode
			$include_result = (defined('DEBUG_EXTRA')) ? (include $language_filename) : (@include $language_filename);

			if ($include_result === false)
			{
				trigger_error('Language file ' . $language_filename . ' couldn\'t be opened.', E_USER_ERROR);
			}
		}
		else if ($use_db)
		{
			// Get Database Language Strings
			// Put them into $lang if nothing is prefixed, put them into $help if help: is prefixed
			// For example: help:faq, posting
		}
	}
	/**
	* Format user date for the Upcoming Birthday Mod
	* Note: this function is used as we already added timezones, etc
	*/
	function format_dateucb($date, $format = false)
	{

	  $lang_dates = $this->lang['datetime'];
	  $format = (!$format) ? $this->date_format : $format;

	  // Short representation of month in format
	  if ((strpos($format, '\M') === false && strpos($format, 'M') !== false) || (strpos($format, '\r') === false && strpos($format, 'r') !== false))
	  {
		 $lang_dates['May'] = $lang_dates['May_short'];
	  }

	  unset($lang_dates['May_short']);


	  return strtr(@date(str_replace('|', '', $format), $date), $lang_dates);
	}
	/**
	* Format user date
	*
	* @param int $gmepoch unix timestamp
	* @param string $format date format in date() notation. | used to indicate relative dates, for example |d m Y|, h:i is translated to Today, h:i.
	* @param bool $forcedate force non-relative date format.
	*
	* @return mixed translated date
	*/
	function format_date($gmepoch, $format = false, $forcedate = false)
	{
		static $midnight;
		static $date_cache;

		$format = (!$format) ? $this->date_format : $format;
		$now = time();
		$delta = $now - $gmepoch;

		if (!isset($date_cache[$format]))
		{
			// Is the user requesting a friendly date format (i.e. 'Today 12:42')?
			$date_cache[$format] = array(
				'is_short'		=> strpos($format, '|'),
				'format_short'	=> substr($format, 0, strpos($format, '|')) . '||' . substr(strrchr($format, '|'), 1),
				'format_long'	=> str_replace('|', '', $format),
				'lang'			=> $this->lang['datetime'],
			);

			// Short representation of month in format? Some languages use different terms for the long and short format of May
			if ((strpos($format, '\M') === false && strpos($format, 'M') !== false) || (strpos($format, '\r') === false && strpos($format, 'r') !== false))
			{
				$date_cache[$format]['lang']['May'] = $this->lang['datetime']['May_short'];
			}
		}

		// Zone offset
		$zone_offset = $this->timezone + $this->dst;

		// Show date <= 1 hour ago as 'xx min ago' but not greater than 60 seconds in the future
		// A small tolerence is given for times in the future but in the same minute are displayed as '< than a minute ago'
		if ($delta <= 3600 && $delta > -60 && ($delta >= -5 || (($now / 60) % 60) == (($gmepoch / 60) % 60)) && $date_cache[$format]['is_short'] !== false && !$forcedate && isset($this->lang['datetime']['AGO']))
		{
			return $this->lang(array('datetime', 'AGO'), max(0, (int) floor($delta / 60)));
		}

		if (!$midnight)
		{
			list($d, $m, $y) = explode(' ', gmdate('j n Y', time() + $zone_offset));
			$midnight = gmmktime(0, 0, 0, $m, $d, $y) - $zone_offset;
		}

		if ($date_cache[$format]['is_short'] !== false && !$forcedate && !($gmepoch < $midnight - 86400 || $gmepoch > $midnight + 172800))
		{
			$day = false;

			if ($gmepoch > $midnight + 86400)
			{
				$day = 'TOMORROW';
			}
			else if ($gmepoch > $midnight)
			{
				$day = 'TODAY';
			}
			else if ($gmepoch > $midnight - 86400)
			{
				$day = 'YESTERDAY';
			}

			if ($day !== false)
			{
				return str_replace('||', $this->lang['datetime'][$day], strtr(@gmdate($date_cache[$format]['format_short'], $gmepoch + $zone_offset), $date_cache[$format]['lang']));
			}
		}

		return strtr(@gmdate($date_cache[$format]['format_long'], $gmepoch + $zone_offset), $date_cache[$format]['lang']);
	}



	/**
	* Get language id currently used by the user
	*/
	function get_iso_lang_id()
	{
		global $config, $db;

		if (!empty($this->lang_id))
		{
			return $this->lang_id;
		}

		if (!$this->lang_name)
		{
			$this->lang_name = $config['default_lang'];
		}

		$sql = 'SELECT lang_id
			FROM ' . LANG_TABLE . "
			WHERE lang_iso = '" . $db->sql_escape($this->lang_name) . "'";
		$result = $db->sql_query($sql);
		$this->lang_id = (int) $db->sql_fetchfield('lang_id');
		$db->sql_freeresult($result);

		return $this->lang_id;
	}

	/**
	* Get users profile fields
	*/
	function get_profile_fields($user_id)
	{
		global $db;

		if (isset($this->profile_fields))
		{
			return;
		}

		$sql = 'SELECT *
			FROM ' . PROFILE_FIELDS_DATA_TABLE . "
			WHERE user_id = $user_id";
		$result = $db->sql_query_limit($sql, 1);
		$this->profile_fields = (!($row = $db->sql_fetchrow($result))) ? array() : $row;
		$db->sql_freeresult($result);
	}

	/**
	* Specify/Get image
	* $suffix is no longer used - we know it. ;) It is there for backward compatibility.
	*/
	function img($img, $alt = '', $width = false, $suffix = '', $type = 'full_tag')
	{
		static $imgs;
		global $phpbb_root_path;

		$img_data = &$imgs[$img];

		if (empty($img_data))
		{
			if (!isset($this->img_array[$img]))
			{
				// Do not fill the image to let designers decide what to do if the image is empty
				$img_data = '';
				return $img_data;
			}

			// Use URL if told so
			$root_path = (defined('PHPBB_USE_BOARD_URL_PATH') && PHPBB_USE_BOARD_URL_PATH) ? generate_board_url() . '/' : $phpbb_root_path;

			$path = 'styles/' . rawurlencode($this->theme['imageset_path']) . '/imageset/' . ($this->img_array[$img]['image_lang'] ? $this->img_array[$img]['image_lang'] .'/' : '') . $this->img_array[$img]['image_filename'];

			$img_data['src'] = $root_path . $path;
			$img_data['width'] = $this->img_array[$img]['image_width'];
			$img_data['height'] = $this->img_array[$img]['image_height'];

			// We overwrite the width and height to the phpbb logo's width
			// and height here if the contents of the site_logo file are
			// really equal to the phpbb_logo
			// This allows us to change the dimensions of the phpbb_logo without
			// modifying the imageset.cfg and causing a conflict for everyone
			// who modified it for their custom logo on updating
			if ($img == 'site_logo' && file_exists($phpbb_root_path . $path))
			{
				global $cache;

				$img_file_hashes = $cache->get('imageset_site_logo_md5');

				if ($img_file_hashes === false)
				{
					$img_file_hashes = array();
				}

				$key = $this->theme['imageset_path'] . '::' . $this->img_array[$img]['image_lang'];
				if (!isset($img_file_hashes[$key]))
				{
					$img_file_hashes[$key] = md5(file_get_contents($phpbb_root_path . $path));
					$cache->put('imageset_site_logo_md5', $img_file_hashes);
				}

				$phpbb_logo_hash = '0c461a32cd3621643105f0d02a772c10';

				if ($phpbb_logo_hash == $img_file_hashes[$key])
				{
					$img_data['width'] = '149';
					$img_data['height'] = '52';
				}
			}
		}

		$alt = (!empty($this->lang[$alt])) ? $this->lang[$alt] : $alt;

		switch ($type)
		{
			case 'src':
				return $img_data['src'];
			break;

			case 'width':
				return ($width === false) ? $img_data['width'] : $width;
			break;

			case 'height':
				return $img_data['height'];
			break;

			default:
				$use_width = ($width === false) ? $img_data['width'] : $width;

				return '<img src="' . $img_data['src'] . '"' . (($use_width) ? ' width="' . $use_width . '"' : '') . (($img_data['height']) ? ' height="' . $img_data['height'] . '"' : '') . ' alt="' . $alt . '" title="' . $alt . '" />';
			break;
		}
	}

	/**
 	* Get option bit field from user options.
 	*
 	* @param int $key option key, as defined in $keyoptions property.
 	* @param int $data bit field value to use, or false to use $this->data['user_options']
 	* @return bool true if the option is set in the bit field, false otherwise
	*/
	function optionget($key, $data = false)
	{
 		$var = ($data !== false) ? $data : $this->data['user_options'];
 		return phpbb_optionget($this->keyoptions[$key], $var);
	}

	/**
 	* Set option bit field for user options.
 	*
 	* @param int $key Option key, as defined in $keyoptions property.
 	* @param bool $value True to set the option, false to clear the option.
 	* @param int $data Current bit field value, or false to use $this->data['user_options']
 	* @return int|bool If $data is false, the bit field is modified and
 	*                  written back to $this->data['user_options'], and
 	*                  return value is true if the bit field changed and
 	*                  false otherwise. If $data is not false, the new
 	*                  bitfield value is returned.
	*/
	function optionset($key, $value, $data = false)
	{
		$var = ($data !== false) ? $data : $this->data['user_options'];

        $new_var = phpbb_optionset($this->keyoptions[$key], $value, $var);

		if ($data === false)
		{
 			if ($new_var != $var)
 			{
 				$this->data['user_options'] = $new_var;
 				return true;
 			}
 			else
 			{
 				return false;
 			}
		}
		else
		{
			return $new_var;
		}
	}

	/**
	* Funtion to make the user leave the NEWLY_REGISTERED system group.
	* @access public
	*/
	function leave_newly_registered()
	{
		global $db;

		if (empty($this->data['user_new']))
		{
			return false;
		}

		if (!function_exists('remove_newly_registered'))
		{
			global $phpbb_root_path, $phpEx;

			include($phpbb_root_path . 'includes/functions_user.' . $phpEx);
		}
		if ($group = remove_newly_registered($this->data['user_id'], $this->data))
		{
			$this->data['group_id'] = $group;

		}
		$this->data['user_permissions'] = '';
		$this->data['user_new'] = 0;

		return true;
	}
 
 	/**
 	* Returns all password protected forum ids the user is currently NOT authenticated for.
 	*
 	* @return array		Array of forum ids
 	* @access public
 	*/
 	function get_passworded_forums()
 	{
 		global $db;
 
 		$sql = 'SELECT f.forum_id, fa.user_id
 			FROM ' . FORUMS_TABLE . ' f
 			LEFT JOIN ' . FORUMS_ACCESS_TABLE . " fa
 				ON (fa.forum_id = f.forum_id
 					AND fa.session_id = '" . $db->sql_escape($this->session_id) . "')
 			WHERE f.forum_password <> ''";
 		$result = $db->sql_query($sql);
 
 		$forum_ids = array();
 		while ($row = $db->sql_fetchrow($result))
 		{
 			$forum_id = (int) $row['forum_id'];
 
 			if ($row['user_id'] != $this->data['user_id'])
 			{
 				$forum_ids[$forum_id] = $forum_id;
 			}
 		}
 		$db->sql_freeresult($result);
 
 		return $forum_ids;
 	}
}

?>

User avatar
Kot Matroskin
Registered User
Posts: 126
Joined: Sat May 29, 2010 9:44 am
Location: Minsk, Belarus
Name: Vitaly Filatenko
Contact:

Re: [Beta] Guest Cache

Post by Kot Matroskin » Sun Feb 10, 2013 2:09 pm

Haravikk wrote:I'm afraid I can't read Russian, but if/when your mod is available for download I'd love to know, as I may be able to tweak mine to work alongside it or even change its behaviour if your mod is installed! I think that I may rename mine to "HTTP Guest Cache" or similar, to make it a bit clearer what mine does.
I'll keep you in mind, and let you know asap when my results will be ready for public access and use.

Haravikk
Registered User
Posts: 261
Joined: Sat Nov 02, 2002 4:42 pm

Re: [Beta] Guest Cache

Post by Haravikk » Sun Feb 10, 2013 3:38 pm

Pthelovod wrote:I'm sorry that I bring anxiety.
Not a problem! I posted my mod here for this reason, so I could track down any issues or incompatibilities it might have, as I can only test so much myself!

This problem looks to be a bug that is a side-effect of my mod using session::session_kill(), so what I've done is re-implement the parts that I actually need into my own "safe" function that should eliminate the incompatibility. I'm going to package this change up into a new version shortly, but for you I think it might be easier to just edit the two small parts I've changed as follows:

Open includes/mod_guest_cache.php
Find:

Code: Select all

			$user->session_kill(false);
Replace-With:

Code: Select all

			$this->clear_session();
Find:

Code: Select all

		return $mod_guest_cache_jstime;
	}
After-Add:

Code: Select all

	function clear_session() {
		global $SID, $_SID, $user;

		$cookie_expire = $user->time_now - 31536000;
		$user->set_cookie('u', '', $cookie_expire);
		$user->set_cookie('k', '', $cookie_expire);
		$user->set_cookie('sid', '', $cookie_expire);

		$SID = '?sid=';
		$user->session_id = $_SID = '';
	}
Open includes/functions.php
Find:

Code: Select all

		$user->session_kill(false);
Replace-With:

Code: Select all

		if ($_SID)
		{
			$mod_guest_cache->clear_session();
		}
This should correct the issue for you, as the new clear_session() method only discards the session ID related stuff, hopefully avoiding any incompatibilities with other mods that use session_kill() or that don't quite match the flow that my mod assumed for user data.

If you want you can do this for any other boards you've added the mod to, though it's not really necessary.

User avatar
Pthelovod
Registered User
Posts: 106
Joined: Mon Feb 22, 2010 1:32 am
Location: Россия
Name: Alexs Pthelovod
Contact:

Re: [Beta] HTTP Guest Cache

Post by Pthelovod » Mon Feb 11, 2013 1:38 am

Oh! It worked! You are great help. I'll make your edit to other forums to avoid errors arising from the installation of new mods. I admire your work. Weak servers for small index decreased load. This is evident from the information about the load on the processor. On a large forum is not seen nothing, but monitoring will be carried out. I accomplish your goal. Thank you so much! I like it when everything works fine with no errors. Sorry for bad English through a robot translator. I'm ashamed ...

Image

no errors

User avatar
Kot Matroskin
Registered User
Posts: 126
Joined: Sat May 29, 2010 9:44 am
Location: Minsk, Belarus
Name: Vitaly Filatenko
Contact:

Re: [Beta] HTTP Guest Cache

Post by Kot Matroskin » Wed Feb 13, 2013 12:38 am


Haravikk
Registered User
Posts: 261
Joined: Sat Nov 02, 2002 4:42 pm

Re: [Beta] HTTP Guest Cache

Post by Haravikk » Wed Feb 13, 2013 11:03 am

Pthelovod wrote:Weak servers for small index decreased load. This is evident from the information about the load on the processor. On a large forum is not seen nothing, but monitoring will be carried out.
Glad to hear it's working! Your results sound about right as larger forums may not notice a big difference from HTTP caching alone, since it will depend on how often each individual guest views the same page. However, the biggest improvements should be seen if the site(s) use intermediary caches such as CloudFlare, or if there are HTTP caches between your server and your users.

A lot of ISPs do use HTTP caches to reduce external bandwidth and improve speed, so users of bigger ISPs may see the largest benefit. Some web-hosts also use HTTP caches to keep complex load off their actual hosting servers. So yeah, mileage may vary, but the mod shouldn't add much load at all to registered users while helping with guests, every little helps I think!
Kot Matroskin wrote:as I promised -- link to similar mod which provides physical caching of guests pages content.
Great to see this! I'll have a go at installing it later on to see if there are any conflicts with my mod, as I think that the two combined should make a big difference to forums with high numbers of guest page-views.


On another note, I'm preparing a v0.2.0 of my mod, which simplifies some of the code (more from a maintenance point of view, I don't think it affects speed), as well as adding HTTP caching to search pages which I believe to be safe to cache.

I'm curious actually whether people interested in this mod think that search pages should have their own separate expiration time, or if it's okay to just use the same time that the rest of the mod uses. Search traffic can be very costly so I think it's an important one to add to this mod, but currently the only choice my mod offers is to turn search caching on or off; I'm thinking something in between might allow a better balance between responsive searches and up to date ones.

User avatar
Pthelovod
Registered User
Posts: 106
Joined: Mon Feb 22, 2010 1:32 am
Location: Россия
Name: Alexs Pthelovod
Contact:

Re: [Beta] HTTP Guest Cache

Post by Pthelovod » Wed Feb 13, 2013 11:25 am

every little helps I think!
I realized, maestro! Thank you again ...

User avatar
Kot Matroskin
Registered User
Posts: 126
Joined: Sat May 29, 2010 9:44 am
Location: Minsk, Belarus
Name: Vitaly Filatenko
Contact:

Re: [Beta] HTTP Guest Cache

Post by Kot Matroskin » Wed Feb 13, 2013 11:35 am

Haravikk wrote:Great to see this! I'll have a go at installing it later on to see if there are any conflicts with my mod, as I think that the two combined should make a big difference to forums with high numbers of guest page-views.
To be honest, I didn't tested it together.

Your mod looks very useful... but I have one significant objection regarding to -- I'd like to get guests ability to post messages on my forum. :) So, your mod required to switch off this ability (or says every user "don't worry, you'll see your message after cache expiration time" ;)).

In my mod I used write-through caching: when new post arrived, all related caches are cleared: topic, forum, parent forums, index, etc.

Anyway, both mods contains some concessions.

Original phpBB: all data are realtime.

Cache Guests Pages: posts and topics are realtime, additional information (like topic views, count of users posts, user signatures) is delayed.

HTTP Guest Cache: all information is delayed, but delay time is smaller than in the mod above (default 15 mins vs default 12 hours).

Best performance combination is using both mods with enabled caching proxy (like mentioned CloudFlare).

Locked

Return to “[3.0.x] MODs in Development”