AUBBC
Advanced Universal Bulletin Board Code Tags used to create formatting effects in HTML or XHTML.
The advantage of using this Bulletin Board Code tags is to restrict the usage of HTML/XHTML elements and to make formating of posts easy to people that have no HTML/XHTML skill. Most sites that use these tags show a list of them and/or easy way to insert the tags to the form field by the user.
This module addresses many security issues the UBBC tags may have mainly cross site script also known as XSS. Each message is escaped before it gets returned if script_escape is Enabled and checked for many types of security problems before that tag converts to HTML/XHTML. The script_escape setting and method also converts the ' sign so the text can be stored in a SQL back-end. Most of the free web portals use the | sign as the delimiter for the flat file database, the script_escape setting and method also converts that sign so the structure of the database is retained.
Allows easy conversion to HTML and XHTML, existing tags will convert to the HTML type set.
If there isn't a popular tag available this module provides a method to "Build your own tags" custom tags can help link to parts of the current web page, other web pages and add other HTML elements.
This is a list of Default settings and the method to change them when needed.
$aubbc->settings(
aubbc => 1,
utf => 1,
smileys => 1,
highlight => 1,
no_bypass => 0,
for_links => 0,
aubbc_escape => 1,
icon_image => 1,
image_hight => 60,
image_width => 90,
image_border => 0,
image_wrap => 1,
href_target => 0,
images_url => '',
html_type => 'html',
code_class => '',
code_extra => '',
href_class => '',
quote_class => '',
quote_extra => '',
script_escape => 1,
protect_email => 1,
email_message => 'Contact Email',
highlight_class1 => '',
highlight_class2 => '',
highlight_class3 => '',
highlight_class4 => '',
highlight_class5 => '',
highlight_class6 => '',
highlight_class7 => '',
);
Enable or Disable Main AUBBC Tags Default 1 is Enabled, 0 is Disable.
Enable or Disable UFT Tags Default 1 is Enabled, 0 is Disable.
Enable or Disable Smiley Tags Default 1 is Enabled, 0 is Disable.
Enable or Disable Code Highlight Default 1 is Enabled, 0 is Disable.
Enable or Disable User Tags for Bypassing Tags Default 0 is Disable, 1 is Enabled.
Tags must at the very beginning of the message. Bypass Tags: #none #noaubbc #nobuild #noutf #nosmileys
Enable or Disable Use Tags for Links Default 0 is Disable, 1 is Enabled. Some AUBBC Tags are not good to use in a link like other links. If Enabled will only use the UTF and Smiley tags.
Enable or Disable AUBBC Tag Escape Default 1 is Enabled, 0 is Disable.
Escaping a Tag:
[b]Stuff[/b] # Normal Tag Bold
[b]]Stuff[/b]] # Escaped Tag Bold
[[b]Stuff[[/b] # Escaped Tag Bold
[[b]]Stuff[[/b]] # Escaped Tag Bold
[b}}Stuff[/b}} # Escaped Tag Bold
{{b]Stuff{{/b] # Escaped Tag Bold
{{b}}Stuff{{/b}} # Escaped Tag Bold
Bugs if Enabled:
Any use of }} will equal ] and any {{ will equal [
Any use of ]] will equal ] and any [[ will equal [
Enable or Disable Custom Image Size Default 1 is Enabled, 0 is Disable. If enabled will use the values from image_hight and image_width in all Image Tags [img]/images/large_pic.gif[/img]
The Default Image hight is 60px. Only used when icon_image is Enabled.
The Default Image width is 90px. Only used when icon_image is Enabled.
Enable or Disable Image Border Default 0 is Disable, 1 is Enabled.
Enable or Disable Image wrap Default 1 is Enabled, 0 is Disable. Enabled will add a space after each image & smiley's.
Enable or Disable href target Default 0 is Disable, 1 is Enabled. Enabled will add target="_blank" to all href's.
Default is blank. This is the link to your images folder and is only used for Smilies. For the smileis to work you must provide a URL. example: smilies must be in /smilies folder the images_url link must have the /smilies folder in it and not point directly to /smilies.
Default is 'html' and the only other support is 'xhtml'
Default is '' and this allows a custom class, style and/or javascript to be used in any of the [code] [c] tags. must have a space before the text. example: code_class => ' class="quote"', code_class => ' class="quote" onclick="....."',
Default is '' and this is for a custom message, code, image, est.. to be used after the [code] [c] tags.
example: code_extra => 'Codes may not reflect what is in the current version.', code_extra => '<div style="clear: left"> </div>',
Default is '' and this allows a custom class, style and/or javascript to be used in the [url] tags.
must have a space before the text. example: href_class => ' class="url"', href_class => ' class="url" onclick="....."',
Default is '' and this allows a custom class, style and/or javascript to be used in the [quote] tags.
must have a space before the text. example: quote_class => ' class="quote"', quote_class => ' class="quote" onclick="....."',
Default is '' and this is for a custom message, code, image, est.. to be used after a [quote] tags.
example:
quote_extra => 'QUOTES AND SAYINGS DISPLAYED ON THIS BLOG ARE NOT WRITTEN BY THE AUTHOR OF THE BLOG.', quote_extra => '<div style="clear: left"> </div>',
This will turn on or off the sanitizer/escape security for the hole message.
Default is 1 on and 0 for Disable.
Notes: 1)The code highlighter works best with an escaped character format like the script_escape => 1 setting can provide.
2) If this setting is disabled and a character escaping method or security filter is not used can result is a security compromise of the AUBBC tags.
3) if Disabled the method "$message = $aubbc->script_escape($message);" can be used on the message as needed before do_all_ubbc() is called.
Default is 1 and other possible values are (0, 2, 3, 4).
Can add a protection to hide emails in the [email] tag from email harvesters.
Not 100% fool proof.
0 - has no type of protection.
1 - uses unicode type protection.
2 - Javascript and unicode type protection.
3 - Javascript and unicode type protection.
4 - Javascript encryption
When the protect_email setting is 2, 3 or 4 it will display this message as the link.
Default message is 'Contact Email' and that say's 'Contact Email'
This is for using your own class or font color for the code highlighter.
example:
highlight_class1 => ' class="highlightclass1"',
highlight_class1 = String quote
highlight_class2 = Comment's
highlight_class3 = String quote
highlight_class4 = String quote
highlight_class5 = Number's
highlight_class6 = Operator, Function and other Name's
highlight_class7 = Variables
These are the settings for using custom smilies.
Note: There are no Built-in smilies.
This is one of the two ways to import your custom smilies hash.
example:
use AUBBC; my $aubbc = new AUBBC; my %smiley = (lol => 'lol.gif'); $aubbc->smiley_hash(%smiley);
The way you use this smiley is [lol]
Must have the images_url set to the proper location.
images_url/smilies/lol.gif
This is one of the two ways to import your custom smiley hash.
example:
my %smiley = (lol => 'lol.gif'); use AUBBC; %AUBBC::SMILEYS = %smiley; my $aubbc = new AUBBC;
The way you use this smiley is [lol]
Must have the images_url set to the proper location.
images_url/smileis/lol.gif
These are the settings and methods for using custom tags.
name - will be the tags name
pattern - limited to 'all' or 'l,n,-,:,_,s'
'all' = 'a-z\d\:\-\s\_\/\.\;\&\=\?\-\+\#\%\~\,\|'
'l' = 'a-z'
'n' = '0-9'
's' = ' '
'-' = '-'
':' = ':'
'_' = '_'
type - 1 is style [name://pattern], 2 is style [name]pattern[/name] and 3 is style [name]
function - a pre-defined subroutine that receives the matched pattern, tag name and returns what you want,
Note: if the function returns undefined, '' or 0 the tag will not be changed.
Usage:
package My_Message;
use AUBBC;
my $aubbc = new AUBBC;
$aubbc->add_build_tag(
name => 'ok',
pattern => 'l,s',
type => 1,
function => 'My_Message::check_ok_tag',
);
$aubbc->add_build_tag(
name => 'ip',
pattern => '',
type => 3,
function => 'My_Message::get_some_tag',
);
$aubbc->add_build_tag(
name => 'agent',
pattern => '',
type => 3,
function => 'My_Message::get_some_tag',
);
my $message = '[ok://test me] [ok://test other] [ok://n0 w00rk] [ip] [agent]';
$message = $aubbc->do_all_ubbc($message);
print $message;
sub check_ok_tag {
my ($tag_name, $text_from_AUBBC) = @_;
if ($text_from_AUBBC eq 'test me') {
return 'Works Good 1';
}
else {
return 'Works Good 2';
}
}
sub get_some_tag {
my ($tag_name, $text_from_AUBBC) = @_;
$tag_name = lc($tag_name);
$text_from_AUBBC = $ENV{'REMOTE_ADDR'} if ($tag_name eq 'ip');
$text_from_AUBBC = $ENV{'HTTP_USER_AGENT'} if ($tag_name eq 'agent');
return $text_from_AUBBC;
}
1;
There are two ways to use this.
1) Remove a single built tag: $aubbc->remove_build_tag($name);
2) Remove all built tags: $aubbc->remove_build_tag('', 1);
Default message is 'Error', this message is used when the code finds bad characters in [email] or [img] tags.
Usage of this setting: use AUBBC; $AUBBC::BAD_MESSAGE = 'Unauthorized use of characters or pattern in this tag.'; # est...
The Debug setting will send a lot of messages to warn and is not recommended to leave on all the time.
Default is '' off, and Enabled is 1. Usage of this setting: use AUBBC; $AUBBC::DEBUG_AUBBC = 1; # est...
Returns the current version of the module.
Usage: use AUBBC; my $aubbc = new AUBBC; my $Current_Version = $aubbc->version(); print $Current_Version;
v2.0 - 10/07/2008 13:52:11
Fixed single tag [name] for build tags
Changed the regex in plain URL's
Removed bad patter setting and now using a more standard way to detect bad image tags
Fixed dynamic view in XHTML for the protect email method.
Added js_print method which will print out the javascript needed for the new protect email method
Added values for the code highlighter so it can support CSS classes
Added highlighting of variables and changed 2 quote regex to allow multi line quotes
and a few other things that make this 2.0
v1.30 - 09/08/2008 14:12:10
Fixed the function check in add_build_tag(), when the 1.20 changes where made this check was neglected
Edited add_build_tag() Error messages, hopefully they make more sence.
Now add_build_tag() name allows - and _ in it.
v1.20 - 09/07/2008 09:23:09
Fixed bug that bypassed utf tag converter if square bracket wasn't detected
Fixed Makefile.PL
v1.10 - 09/02/2008 09:49:46
Added two more tags [big]..[/big] and [small]..[/small].
Removed utf tag style [ux23] and [u://0931] to make more tag names available.
Changed add_build_tag() to use hash variable, see "Build your own tags" for the new style.
Changed the way functions should work for built tags, the custom function for built tags will receive the tag name and data of the tag. This is so one function can handle many tags.
Removed other site tags and setting other_sites_pattern, an example of them are in "Build your own tags"
Removed [time] tag, example in "Build your own tags".
Email now allows names with & sign
Now every message that is passed to do_all_ubbc() gets escaped before being returned if script_escape is Enabled.
All tags in %AUBBC_TAGS will only convert if lowercase.
"new" now uses the most standard referenced object method.
Removed DOS_prevent() method, since the script has been tested more and was causing a timing problem.
Removed [cd]#code[/cd] code tag, which had no code_class or code_extra.
Commented bad_pattern check for [email] tags, this security check is not needed because the next line will take care of all email tag security.
Added missing $AUBBC{image_border}, $AUBBC{html_type} and $AUBBC{image_wrap} to the none icon image.
Changed names of left and right align images to [left_img]..[/img] and [right_img]..[/img], also updated examples to show tags.
Added missing $AUBBC{html_type} to quote, code tags and code_highlight function.
v1.0 01/20/2008 08:46:08
Released.
AUBBC.pm, v2.0 10/07/2008 13:52:11 By: N.K.A Advanced Universal Bulletin Board Code Tags. Note: This code has a lot of settings and works good with most default settings.
