Little helper for the build_hidden_fields function

The crypt function/replacement

Encode hash

Generate salt for hash generation

Add a secret token to the form (requires the S_FORM_TOKEN template variable)

Parameters:

form_name - The name of the form; has to match the name used in check_form_key, otherwise no restrictions apply

Add log event

Append session id to url. This function supports hooks.

Parameters:

url - The url the session id needs to be appended to (can have params)

params - String or array of additional url parameters

is_amp - Is url using & (true) or & (false)

session_id - Possibility to use a custom session id instead of the global one Examples: append_sid("{$phpbb_root_path}viewtopic.$phpEx?t=1&f=2"); append_sid("{$phpbb_root_path}viewtopic.$phpEx", 't=1&f=2'); append_sid("{$phpbb_root_path}viewtopic.$phpEx", 't=1&f=2', false); append_sid("{$phpbb_root_path}viewtopic.$phpEx", array('t' => 1, 'f' => 2));

A wrapper for the PHP5 function array_combine()

Parameters:

keys - contains keys for the resulting array

values - contains values for the resulting array

Returns:

an array by using the values from the keys array as keys and the values from the values array as the corresponding values. Returns false if the number of elements for each array isn't equal or if the arrays are empty.

Remove avatar

Avatar Gallery

Tries to (re-)establish avatar dimensions

Uploading/Changing user avatar

Remote avatar linkage

Remove avatar also for users not having the group as default

Avatar upload using the upload class

custom version of nl2br which takes custom BBCodes into account

Build simple hidden fields from array

Parameters:

field_ary - an array of values to build the hidden field from

specialchar - if true, keys and values get specialchared

stripslashes - if true, keys and values get stripslashed

Returns:

the hidden fields

Returns url from the session/current page with an re-appended SID with optionally stripping vars from the url

Bump Topic Check - used by posting and viewtopic

Censoring

Check the form key. Required for all altering actions not secured by confirm_box

Parameters:

form_name - The name of the form; has to match the name used in add_form_key, otherwise no restrictions apply

timespan - The maximum acceptable age for a submitted form in seconds. Defaults to the config setting.

return_page - The address for the return link

trigger - If true, the function will triger an error when encountering an invalid form

checks a link hash - for GET requests

Parameters:

token - the submitted token

link_name - The name of the link

Returns:

true if all is fine

Check Rule against Message Information

Delete Messages From Sentbox we are doing this here because this saves us a bunch of checks and queries

Build Confirm box

Parameters:

check - True for checking if confirmed (without any additional parameters) and false for displaying the confirm box

title - Title/Message used for confirm box. message text is _CONFIRM appended to title. If title cannot be found in user->lang a default one is displayed If title_CONFIRM cannot be found in user->lang the text given is used.

hidden - Hidden variables

html_body - Template used for confirm box

u_action - Custom form action

Create Thumbnail

Decode text whereby text is coming from the db and expected to be pre-parsed content We are placing this outside of the message parser because we are often in need of it...

Delete PM(s)

Delete Post

Assign/Build custom bbcodes for display in screens supporting using of bbcodes The custom bbcodes buttons will be placed within the template block 'custom_codes'

Display Forums

Display reasons

Display user activity (action forum/topic)

Check if downloading item is allowed

Handler for exit calls in phpBB. This function supports hooks.

Note: This function is called after the template has been outputted.

Check if extension is allowed to be posted.

Parameters:

forum_id - The forum id to check or false if private message

extension - The extension to check, for example zip.

&$extensions - The extension array holding the information from the cache (will be obtained if empty)

Returns:

False if the extension is not allowed to be posted, else true.

Generate ISO 8601 date string (RFC 3339)

Generate text content

Closing the cache object and the database Cool function name, eh? We might want to add operations to it later

User authorisation levels output

Parameters:

mode - Can be forum or topic. Not in use at the moment.

forum_id - The current forum the user is in.

forum_status - The forums status bit.

Generates an alphanumeric random string of given length

Generates a user-friendly alphanumeric random string of given length We remove 0 and O so users cannot confuse those in passwords etc.

Generate sort selection fields

Generate board url (example: http://www.example.com/phpBB)

Parameters:

without_script_path - if set to true the script path gets not appended (example: http://www.example.com)

Returns:

the generated board url

Create forum navigation links for given forum, create parent list if currently null, assign basic forum info to template

Create forum rules for given forum

Add a secret hash for use in links/GET requests

Parameters:

link_name - The name of the link; has to match the name used in check_link_hash, otherwise no restrictions apply

Returns:

the hash

Pagination routine, generates page number sequence tpl_prefix is for using different pagination blocks at one page

Fill smiley templates (or just the variables) with smilies, either in a window or inline

For display of custom parsed text on user-facing pages Expects $text to be the value directly from the database (stored value)

For decoding custom parsed text for edits as well as extracting the flags Expects $text to be the value directly from the database (pre-parsed content)

For parsing custom parsed text to be stored within the database. This function additionally returns the uid and bitfield that needs to be stored. Expects $text to be the value directly from request_var() and in it's non-parsed form

Generates avatar filename from the database entry

Return a nicely formatted backtrace (parts from the php manual by diz at ysagoon dot com)

Generate regexp for naughty words censoring Depends on whether installed PHP version supports unicode properties

Parameters:

word - word template to be replaced

use_unicode - whether or not to take advantage of PCRE supporting unicode

Returns:

$preg_expr regex to use with word censor

Get topic tracking info from db (for cookie based tracking only this function is used)

Generates a text with approx. the specified length which contains the specified words and their context

Parameters:

text - The full text from which context shall be extracted

words - An array of words which should be contained in the result, has to be a valid part of a PCRE pattern (escape with preg_quote!)

length - The desired length of the resulting text, however the result might be shorter or longer than this value

Returns:

Context of the specified words separated by "..."

Get folder status

Return formatted string for filesizes

Parameters:

value - filesize in bytes

string_only - true if language string should be returned

allowed_units - only allow these units (data array indexes)

Returns:

data array if $string_only is false

Author:

bantu

Returns forum parents as an array. Get them from forum_data if available, or update the database otherwise

Get group name

Calculate the needed size for Thumbnail

Obtain list of moderators of each forum

This function returns a regular expression pattern for commonly used expressions Use with / as delimiter for email mode and # for url modes mode can be: email|bbcode_htm|url|url_inline|www_url|www_url_inline|relative_url|relative_url_inline|ipv4|ipv6

Generates an array of coloured recipient names from a list of PMs - (groups & users)

Parameters:

pm_by_id - An array of rows from PRIVMSGS_TABLE, keys are the msg_ids.

Returns:

2D Array: array(msg_id => array('username or group string', ...), ...) Usernames are generated with {@link get_username_string get_username_string} Groups are coloured and have a link to the membership page

Return supported image types

Get topic tracking info by using already fetched info

Get list of unread topics

Parameters:

user_id - User ID (or false for current user)

sql_extra - Extra WHERE SQL statement

sql_sort - ORDER BY SQL sorting statement

sql_limit - Limits the size of unread topics list, 0 for unlimited query

sql_limit_offset - Sets the offset of the first row to search, 0 to search from the start

Returns:

Topic ids as keys, mark_time of topic as value

Get user avatar

Parameters:

avatar - Users assigned avatar name

avatar_type - Type of avatar

avatar_width - Width of users avatar

avatar_height - Height of users avatar

alt - Optional language string for alt tag within image, can be a language key or text

ignore_config - Ignores the config-setting, to be still able to view the avatar in the UCP

Returns:

Avatar image

Get user rank title and image

Parameters:

user_rank - the current stored users rank id

user_posts - the users number of posts

&$rank_title - the rank title will be stored here after execution

&$rank_img - the rank image as full img tag is stored here after execution

&$rank_img_src - the rank image source is stored here after execution Note: since we do not want to break backwards-compatibility, this function will only properly assign ranks to guests if you call it for them with user_posts == false

Get username details for placing into templates. This function caches all modes on first call, except for no_profile and anonymous user - determined by $user_id.

Parameters:

mode - Can be profile (for getting an url to the profile), username (for obtaining the username), colour (for obtaining the user colour), full (for obtaining a html string representing a coloured link to the users profile) or no_profile (the same as full but forcing no profile link)

user_id - The users id

username - The users name

username_colour - The users colour

guest_username - optional parameter to specify the guest username. It will be used in favor of the GUEST language variable then.

custom_profile_url - optional parameter to specify a profile url. The user id get appended to this url as &u={user_id}

Returns:

A string consisting of what is wanted based on $mode.

Author:

BartVB, Acyd Burn

Changes a group avatar's filename to conform to the naming scheme

Add or edit a group. If we're editing a group we only update user parameters such as rank, etc. if they are changed

Group Delete

Obtain either the members of a specified group, the groups the specified user is subscribed to or checking if a specified user is in a specified group. This function does not return pending memberships.

Note: Never use this more than once... first group your users/groups

Re-cache moderators and foes if group has a_ or m_ permissions

Add user(s) to group

Returns:

false if no errors occurred, else the user lang string for the relevant error, for example 'NO_USER'

This is used to promote (to leader), demote or set as default a member/s

Remove a user/s from a given group. When we remove users we update their default group_id. We do this by examining which "special" groups they belong to. The selection is made based on a reasonable priority system

Returns:

if no errors occurred, else the user lang string for the relevant error, for example 'NO_USER'

A small version of validate_username to check for a group name's existence. To be called directly.

Handle all actions possible with marked messages

Do the various checks required for removing posts as well as removing it

Get a browser friendly UTF-8 encoded filename

A wrapper for htmlspecialchars_decode

Ignore.

Checks if a path ($path) is absolute or relative

Parameters:

path - Path to check absoluteness of

Pick a language, any language ...

Load Drafts

Generate login box or verify password

Generate forum login box

Encodes the given string for proper display in UTF-8.

This version is using base64 encoded data. The downside of this is if the mail client does not understand this encoding the user is basically doomed with an unreadable subject.

Please note that this version fully supports RFC 2045 section 6.8.

Parameters:

eol - End of line we are using (optional to be backwards compatible)

make_clickable function

Replace magic urls of form http://xxx.xxx., www.xxx. and xxx@xxx.xxx. Cuts down displayed size of link if over 50 chars, turns absolute links into relative versions when the server/script path matches the link

A subroutine of make_clickable used with preg_replace It places correct HTML around an url, shortens the displayed text and makes sure no entities are inside URLs

Generate Jumpbox

Marks a topic/forum as read Marks a topic as posted to

Parameters:

user_id - can only be used with $mode == 'post'

Display Message History

Meta refresh assignment Adds META template variable with meta http tag.

Parameters:

time - Time in seconds for meta refresh tag

url - URL to redirect to. The url will go through redirect() first before the template variable is assigned

disable_cd_check - If true, meta_refresh() will redirect to an external domain. If false, the redirect point to the boards url if it does not match the current domain. Default is false.

Move PM from one to another folder

Error and message handler, call with trigger_error if reqd

Queries the session table to get information about online guests

Parameters:

item_id - Limits the search to the item with this id

item - The name of the item which is stored in the session table as session_{$item}_id

Returns:

The number of active distinct guest sessions

Queries the session table to get information about online users

Parameters:

item_id - Limits the search to the item with this id

item - The name of the item which is stored in the session table as session_{$item}_id

Returns:

An array containing the ids of online, hidden and visible users, as well as statistical info

Uses the result of obtain_users_online to generate a localized, readable representation.

Parameters:

online_users - result of obtain_users_online - array with user_id lists for total, hidden and visible users, and statistics

item_id - Indicate that the data is limited to one item and not global

item - The name of the item which is stored in the session table as session_{$item}_id

Returns:

An array containing the string for output to the template

Return current page (pagination)

Generate page footer

Generate page header

General attachment parsing

Parameters:

forum_id - The forum id the attachments are displayed in (false if in private message)

&$message - The post/private message

&$attachments - The attachments to parse for (inline) display. The attachments array will hold templated data after parsing.

&$update_count - The attachment counts to be updated - will be filled

preview - If set to true the attachments are parsed for preview. Within preview mode the comments are fetched from the given $attachments array and not fetched from the database.

Parse cfg file

Handle topic bumping

Parameters:

forum_id - The ID of the forum the topic is being bumped belongs to

topic_id - The ID of the topic is being bumping

post_data - Passes some topic parameters: - 'topic_title' - 'topic_last_post_id' - 'topic_last_poster_id' - 'topic_last_post_subject' - 'topic_last_poster_name' - 'topic_last_poster_colour'

bump_time - The time at which topic was bumped, usually it is a current time as obtained via time().

Returns:

An URL to the bumped topic, example: ./viewtopic.php?forum_id=1&topic_id=2&p=3#p3

Check for correct password

Parameters:

password - The password in plain text

hash - The stored password hash

Returns:

Returns true if the password is correct, false if not.

Wrapper for php's checkdnsrr function.

Parameters:

host - Fully-Qualified Domain Name

type - Resource record type to lookup Supported types are: MX (default), A, AAAA, NS, TXT, CNAME Other types may work or may not work

Returns:

true if entry found, false if entry not found, null if this function is not supported by this environment Since null can also be returned, you probably want to compare the result with === true or === false,

Author:

bantu

Global function for chmodding directories and files for internal use

This function determines owner and group whom the file belongs to and user and group of PHP and then set safest possible file permissions. The function determines owner and group from common.php file and sets the same to the provided file. The function uses bit fields to build the permissions. The function sets the appropiate execute bit on directories.

Supported constants representing bit fields are:

CHMOD_ALL - all permissions (7) CHMOD_READ - read permission (4) CHMOD_WRITE - write permission (2) CHMOD_EXECUTE - execute permission (1)

NOTE: The function uses POSIX extension and fileowner()/filegroup() functions. If any of them is disabled, this function tries to build proper permissions, by calling is_readable() and is_writable() functions.

Parameters:

filename - The file/directory to be chmodded

perms - Permissions to set

Returns:

true on success, otherwise false

Author:

faw, phpBB Group

Hashes an email address to a big integer

Parameters:

email - Email address

Returns:

Unsigned Big Integer

Version:

Version 0.1 / slightly modified for phpBB 3.0.x (using $H$ as hash type identifier) Portable PHP password hashing framework. Written by Solar Designer in 2004-2006 and placed in the public domain. There's absolutely no warranty. The homepage URL for this framework is: http://www.openwall.com/phpass/ Please be sure to update the Version line if you edit this file in any way. It is suggested that you leave the main version number intact, but indicate your project name (after the slash) and add your own revision information. Please do not change the "private" password hashing method implemented in here, thereby making your hashes incompatible. However, if you must, please change the hash type identifier (the "$P$") to something different. Obviously, since this code is in the public domain, the above are not requirements (there can be none), but merely suggestions. Hash the password

Login using http authenticate.

Parameters:

param - Parameter array, see $param_defaults array.

Test if a file/directory is writable

This function calls the native is_writable() when not running under Windows and it is not disabled.

Parameters:

file - Path to perform write test on

Returns:

True when the path is writable, otherwise false.

Wrapper for sending out emails with the PHP's mail function

Wrapper for mt_rand() which allows swapping $min and $max parameters.

PHP does not allow us to swap the order of the arguments for mt_rand() anymore. (since PHP 5.3.4, see http://bugs.php.net/46587)

Parameters:

min - Lowest value to be returned

max - Highest value to be returned

Returns:

Random integer between $min and $max (or $max and $min)

Get option bitfield from custom data

Parameters:

bit - The bit/value to get

data - Current bitfield to check

Returns:

Returns true if value of constant is set in bitfield, else false

Set option bitfield

Parameters:

bit - The bit/value to set/unset

set - True if option should be set, false if option should be unset.

data - Current bitfield to change

Returns:

The new bitfield

Author:

Chris Smith

Copyright:

2006 Project Minerva Team

Parameters:

path - The path which we should attempt to resolve.

A wrapper for realpath

Handler for init calls in phpBB. This function is called in user::setup(); This function supports hooks.

Place new messages into appropriate folder

PM Notification

Generate inline attachment entry

Assign Inline attachments (build option fields)

Generate Topic Icons for display

Build topic types able to be selected

Re-Apply session id after page reloads

Rebuild message header

Redirects the user to another page then exits the script nicely This function is intended for urls within the board. It's not meant to redirect to cross-domains.

Parameters:

url - The url to redirect to

return - If true, do not redirect but return the sanitized URL. Default is no return.

disable_cd_check - If true, redirect() will redirect to an external domain. If false, the redirect point to the boards url if it does not match the current domain. Default is false.

Removes the group avatar of the default group from the users in user_ids who have that group as default.

Removes the group rank of the default group from the users in user_ids who have that group as default.

Funtion to make a user leave the NEWLY_REGISTERED system group.

Parameters:

The - id of the user to remove from the group

request_var

Used to get passed variable

Send file to browser

Outputs correct status line header.

Depending on php sapi one of the two following forms is used:

Status: 404 Not Found

HTTP/1.x 404 Not Found

HTTP version is taken from HTTP_VERSION environment variable, and defaults to 1.0.

Sample usage:

send_status_line(404, 'Not Found');

Parameters:

code - HTTP status code

message - Message for the status code

Set config value. Creates missing config entry.

Set dynamic config value with arithmetic operation.

Check if the browser has the file already and set the appropriate headers-

Returns:

false if a resend is in order.

Set correct users max messages in PM folder. If several group memberships define different amount of messages, the highest will be chosen.

Returns the first block of the specified IPv6 address and as many additional ones as specified in the length paramater. If length is zero, then an empty string is returned. If length is greater than 3 the complete IP will be returned

Smiley processing

Replacement or substitute for PHP's mail command

Determine whether we are approaching the maximum execution time. Should be called once at the beginning of the script in which it's used.

Returns:

Either true if the maximum execution time is nearly reached, or false if some time is still left.

A wrapper for the PHP5 function str_split()

Parameters:

string - contains the string to be converted

split_length - contains the length of each chunk

Returns:

a string to an array. If the optional split_length parameter is specified, the returned array will be broken down into chunks with each being split_length in length, otherwise each chunk will be one character in length. FALSE is returned if split_length is less than 1. If the split_length length exceeds the length of string, the entire string is returned as the first (and only) array element.

Strips all bbcode from a text and returns the plain content

A wrapper for the PHP5 function stripos Find position of first occurrence of a case-insensitive string

Parameters:

haystack - is the string to search in

needle - is the string to search for

Returns:

Returns the numeric position of the first occurrence of needle in the haystack string. Unlike strpos(), stripos() is case-insensitive. Note that the needle may be a string of one or more characters. If needle is not found, stripos() will return boolean FALSE.

Pick a template/theme combo,

Submit PM

Submit Post

Todo:

Split up and create lightweight, simple API for this.

Generate topic pagination

Topic Review

Generate topic status

Transform an array into a serialized format

Transform a serialized array into an actual array

Truncates string while retaining special characters if going over the max length The default max length is 60 at the moment The maximum storage length is there to fit the string within the given length. The string may be further truncated due to html entities. For example: string given is 'a "quote"' (length: 9), would be a stored as 'a "quote"' (length: 19)

Parameters:

string - The text to truncate to the given length. String is specialchared.

max_length - Maximum length of string (multibyte character count as 1 char / Html entity count as 1 char)

max_store_length - Maximum character length of string (multibyte character count as 1 char / Html entity count as entity chars).

allow_reply - Allow Re: in front of string NOTE: This parameter can cause undesired behavior (returning strings longer than $max_store_legnth) and is deprecated.

append - String to be appended

Pick a timezone

Return unique id

Parameters:

extra - additional entropy

Check for read forums and update topic tracking info accordingly

Parameters:

forum_id - the forum id to check

forum_last_post_time - the forums last post time

f_mark_time - the forums last mark time if user is registered and load_db_lastread enabled

mark_time_forum - false if the mark time needs to be obtained, else the last users forum mark time

Returns:

if complete forum got marked read, else false.

Get latest registered username and update database to reflect it

Update user PM count

Update last post information Should be used instead of sync() if only the last post information are out of sync... faster

Parameters:

type - Can be forum|topic

ids - topic/forum ids

return_update_sql - true: SQL query shall be returned, false: execute SQL

Update unread message status

Upload Attachment - filedata is generated here Uses upload class

Flips user_type from active to inactive and vice versa, handles group membership updates

Parameters:

mode - can be flip for flipping from active/inactive, activate or deactivate

Adds an user

Parameters:

user_row - An array containing the following keys (and the appropriate values): username, group_id (the group to place the user in), user_email and the user_type(usually 0). Additional entries not overridden by defaults will be forwarded.

cp_data - custom profile fields, see custom_profile::build_insert_sql_array

Returns:

new user's ID.

Add a ban or ban exclusion to the banlist. Bans either a user, an IP or an email address

Parameters:

mode - Type of ban. One of the following: user, ip, email

ban - Banned entity. Either string or array with usernames, ips or email addresses

ban_len - Ban length in minutes

ban_len_other - Ban length as a date (YYYY-MM-DD)

ban_exclude - Exclude these entities from banning?

ban_reason - String describing the reason for this ban

Remove User

Obtain user_ids from usernames or vice versa. Returns false on success else the error string

Parameters:

&$user_id_ary - The user ids to check or empty if usernames used

&$username_ary - The usernames to check or empty if user ids used

user_type - Array of user types to check, false if not restricting by user type

Internet Protocol Address Whois RFC3912: WHOIS Protocol Specification

Parameters:

ip - Ip address, either IPv4 or IPv6.

Returns:

Empty string if not a valid ip address. Otherwise make_clickable()'ed whois result.

User Notification

Unban User

Updates a username across all relevant tables/fields

Parameters:

old_name - the old/current username

new_name - the new username

Data validation ... used primarily but not exclusively by ucp modules

"Master" function for validating a range of data types

Validate Date

Parameters:

string - a date in the dd-mm-yyyy format

Check to see if email address is banned or already present in the DB

Parameters:

email - The email to check

allowed_email - An allowed email, default being $user->data['user_email']

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Validate jabber address Taken from the jabber class within flyspray (see author notes)

Author:

flyspray.org

Validate Language Pack ISO Name

Tests whether a language name is valid and installed

Parameters:

lang_iso - The language string to test

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Validate Match

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Validate Number

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Check to see if the password meets the complexity settings

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Validate String

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Check to see if the username has been taken, or if it is disallowed. Also checks if it includes the " character, which we don't allow in usernames. Used for registering, changing names, and posting anonymously with a username

Parameters:

username - The username to check

allowed_username - An allowed username, default being $user->data['username']

Returns:

Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

Topic and forum watching common code

Wraps an url into a simple html page. Used to display attachments in IE. this is a workaround for now; might be moved to template system later direct any complaints to 1 Microsoft Way, Redmond

Print out/assign recipient information