Custom HTTP Error Pages

This is a re-write of a hack I made for vBulletin 2.x.

What this hack does is use vBulletin to generate HTTP error pages (such as the 404 - Not Found error). For those of you trying to get an all-vB-based-site, this addition will help complete your quest. Also for anyone who wants a nicer looking HTTP error message than the standard blah.

Note: Your website needs to be on a server that uses a .htaccess file, a file located in your root public directory. This may only be servers using the Apache HTTP server, I'm not sure if any other HTTP server, like Microsoft IIS, uses that or not. Some more notes on this are included in the instructions.txt file.

There are no vB files to modify. There is one file to upload, and one product to install, which will install several new templates and two plugins. The plugins are for Who's Online display. The templates contain the actual messages. No existing templates are modified.

Special thanks to KirbyDE for showing me how to group templates using a plugin rather than a code modification.

This hack has now been re-written to use phrases. If you have a previous version, here's what you can do to upgrade.
1. Upload the new httperror.php file.
2. Add the product-jjr512_httperr.xml, overwriting the existing. (All old non-used templates should be removed automatically. This version uses only two templates: HTTP_ERROR and http_error_bit.)

[JJR512]

Originally Posted by KirbyDE

You are right, this edit is not necessary at all

Hook template_groups

PHP Code:

$only['http_error'] = 'HTTP Errors'; 


Another suggestion:
Use phrases for the Text, so users can easily use it with other Languages too.

Just create a new plugin with that code as the code to that hook?

Also, regarding the templates vs. phrases issue: I originally thought to use phrases. But then I discovered you can't use variables, such as $vboptions[hometitle] in phrases. Is there a way to use variables like that in phrases? If so, I can re-write the hack. But when I put in that variable in a phrase I was testing, it just came out on the page literally, dollar sign and everything.

[Andreas]

Phrase with Variable:

Hello {1}, how are you?

Template using this Phrase:

<phrase 1="$bbuserinfo[username]">$vbphrase[hello_x_how_are_you]</phrase>

Yes, just make a plugin with this Code and the Templates will be grouped.

[JJR512]

I have updated the hack to include the new plugin provided by KirbyDE. The instructions have been updated. No vBulletin file modifications are necessary. (I copied that file mod from some other hacks that group templates the same way. Now I know it's not necessary to do it like that, and I'll probably create plugins like this for other hacks I've installed and return that file to its stock form.)

Due to the small change in method, the hack is now 2.0.1. This version does not include any phrases as KirbyDE has suggested. It will take me a short while to get all that done and tested, at which point we will probably have 2.1.0.

If you have already installed 2.0.0, and are going to upgrade to 2.0.1, simply do this: Removed the modification to your adminfunctions_template.php file, and add the product again, making sure to overwrite the existing version.

[JJR512]

Originally Posted by KirbyDE

Phrase with Variable:

Hello {1}, how are you?

Template using this Phrase:

<phrase 1="$bbuserinfo[username]">$vbphrase[hello_x_how_are_you]</phrase>

Yes, just make a plugin with this Code and the Templates will be grouped.

Can you use {1} more than once in a phrase; for example, have the phrase be:

Hello, {1}! How are you today, {1}?

And the template would still be exactly the same as in your current example?

[JJR512]

Originally Posted by Dark Visor

'e' should be a TYPE_UINT.

I think this is probably going just slightly beyond what I know about. How would I make this change, and why is it important? For my education and future reference.

I have another hack I may release soon that's also going to be using a variable through the URL in the same way that $e is used here. However, in this other hack, the value of the variable, $p, will be some text, like file.php?p=something. What should I define that as and how?

[JJR512]

Wait, I think I answered my own question...

In the httperror.php file, the line

	'e'	=> TYPE_STR

should be

	'e'	=> TYPE_UINT

Is that correct?

(But in the other hack I mentioned, where $p is some text, leave it set to TYPE_STR, right?)

[Snake]

Great, thanks for the hack.

[akanevsky]

Yes, that is correct.
You might want to read my tutorial, it describes what are the clean variable types in vBulletin.

Basically, since you are passing an integer through the "e" variable, you should force the integer type on it, but it's just for security's sake

[JJR512]

Updated to 2.0.2 based on code change suggested by Dark Visor.

If you have 2.0.1, make the change as described in post# 16 above and upload the modified httperror.php file.

If you have 2.0.0, basically do what is in post# 13 above (undo the modification to adminfunctions_template.php, then re-add the product, overwriting the existing version), PLUS upload the new httperror.php file.

[Avalon111]

i have noticed that members who are not viewing a error page are listed as viewing error page in Who is online.
i have been talking with one member who has told me that.

could that be caused by this modification?