Add the search bots into the database This code should be used in execute_last if the source database did not have bots If you are converting bots this function should not be called

Todo:

We might want to look at sharing the bot list between the install code and this code for consistancy

Add any of the pre-defined "special" groups which are missing from the database

Adds a user to the specified group and optionally makes them a group leader This function does not create the group if it does not exist and so should only be called after the groups have been created

For replacing {L_*} strings with preg_replace_callback

Generate a key value based on existing values

Parameters:

pad - Amount to add to the maximum value

Returns:

Key value

Determine if we are able to load a specified PHP module and do so if possible

Used to test whether we are able to connect to the database the user has specified and identify any problems (eg there are already tables with the names we want to use

Parameters:

dbms - should be of the format of an element of the array returned by {@link get_available_dbms get_available_dbms()} necessary extensions should be loaded already

Convert a value from days to seconds

Generate the drop down of available database options

Reverse the encoding of wild-carded bans

Convert an IP address from the hexadecimal notation to normal dotted-quad notation

Extract the variables defined in a configuration file

Todo:

As noted by Xore we need to look at this from a security perspective

Ensure that all users have a default group specified and update related information such as their colour

Generate the email hash stored in the users table

Note: Deprecated, calls should directly go to phpbb_email_hash()

Returns an array of available DBMS with some data, if a DBMS is specified it will only return data for that DBMS and will load its extension if necessary.

Obtain the height of the specified avatar

Obtain the width of the specified avatar

Return the bitfield calculated by the previous function

Retrieves configuration information from the source forum and caches it as an array Both database and file driven configuration formats can be handled (the type used is specified in $config_schema, see convert_phpbb20.php for more details)

Get old config value

Obtain the size of the specified gallery avatar (using the cache if possible) and cache the value

Return the group_id for a given group name

Calculate the size of the specified image Called from the following functions for calculating the size of specific image types

Obtain the size of the specified remote avatar (using the cache if possible) and cache the value Whilst it's unlikely that remote avatars will be duplicated, it is possible so caching seems the best option This should only be called from a post processing step due to the possibility of network timeouts

Obtain the size of the specified smilie (using the cache if possible) and cache the value

Obtain the height of the specified smilie

Obtain the width of the specified smilie

Get tables of a database

Obtain the size of the specified uploaded avatar (using the cache if possible) and cache the value

Return the next value

Function to mimic php's empty() function (it is the same)

Convert a boolean into the appropriate phpBB constant indicating whether the item is locked

Return whether the value is positive

Convert a boolean into the appropriate phpBB constant indicating whether the topic is locked

Determine whether a user is anonymous and return the appropriate new user_id

Generate a bbcode_uid value

Index messages on the fly as we convert them

Todo:

naderman, can you check that this works with the new search plugins as it's use is currently disabled (and thus untested)function search_indexing($message = ''){ global $fulltext_search, $convert_row; if (!isset($convert_row['post_id'])) { return; } if (!$message) { if (!isset($convert_row['message'])) { return; } $message = $convert_row['message']; } $title = (isset($convert_row['title'])) ? $convert_row['title'] : ''; $fulltext_search->index('post', $convert_row['post_id'], $message, $title, $convert_row['poster_id'], $convert_row['forum_id']);}

Grant permissions to a specified user or group

Parameters:

ug_type - user|group|user_role|group_role

forum_id - forum ids (array|int|0) -> 0 == all forums

ug_id - [int] user_id|group_id : [string] usergroup name

acl_list - [string] acl entry : [array] acl entries : [string] role entry

setting - ACL_YES|ACL_NO|ACL_NEVER

Determine the MIME-type of a specified filename This does not actually inspect the file, but simply uses the file extension

Convert a value from minutes to hours

Boolean inverse of the value

Convert nulls to empty strings for fields which allowed a NULL value in the source but not the destination

Convert nulls to zeros for fields which allowed a NULL value in the source but not the destination

Convert the attachment category constants This is only used if the Attachment MOD was installed

Obtain list of forums in which different attachment categories can be used

Convert the avatar type constants

Convert authentication user, group and forum table has to be filled in order to work

Convert the group name, making sure to avoid conflicts with 3.0 special groups

Convert the group type constants

Convert the topic type constants

Copy thumbnails of uploaded images from the 2.0.x forum This is only used if the Attachment MOD was installed

Checks whether there are any usernames on the old board that would map to the same username_clean on phpBB3. Prints out a list if any exist and exits.

Adjust 2.0.x disallowed names to 3.0.x format

Set forum flags - only prune old polls by default

Find out about the avatar's dimensions

Find out about the avatar's dimensions

Convert Birthday from Birthday MOD to phpBB Format

Obtain the path to uploaded files on the 2.0.x forum This is only used if the Attachment MOD was installed

Obtain the folder_id for the custom folder created to replace the savebox from 2.0.x (used to store saved private messages)

Transfer attachment specific configuration options These were not stored in the main config table on 2.0.x This is only used if the Attachment MOD was installed

Transfer avatars, copying the image if it was uploaded

Calculate the reason a user became inactive We can't actually tell the difference between a manual deactivation and one for profile changes from the data available to assume the latter

Calculate the date a user became inactive

Insert/Convert forums

Calculate whether a private message was new using the bitfield

Determine the last user to edit a post In practice we only tracked edits by the original poster in 2.0.x so this will only be set if they had edited their own post

Reparse the message stripping out the bbcode_uid values and adding new ones and setting the bitfield

Todo:

What do we want to do about HTML in messages - currently it gets converted to the entities, but there may be some objections to this

Calculate the correct to_address field for private messages

Same as phpbb_set_encoding, but forcing boards default language

Function for recoding text with the default language

Parameters:

text - text to recode to utf8

grab_user_lang - if set to true the function tries to use $convert_row['user_lang'] (and falls back to $convert_row['poster_id']) instead of the boards default language

Set primary group. Really simple and only based on user_level (remaining groups will be assigned later)

Just undos the replacing of '<' and '>'

Calculate whether a private message was unread using the bitfield

Return correct user id value Everyone's id will be one higher to allow the guest/anonymous user to have a positive id as well

Obtain the dimensions of all remotely hosted avatars This should only be called from execute_last There can be significant network overhead if there are a large number of remote avatars

Todo:

Look at the option of allowing the user to decide whether this is called or to force the dimensions

Cleanly remove invalid user entries after converting the users table...

remove_remarks will strip the sql comment lines out of an uploaded sql file

Transfers the relevant configuration information from the source forum The mapping of fields is specified in $config_schema, see convert_phpbb20.php for more details

Convert a boolean into the appropriate phpBB constant indicating whether the user is active

split_sql_file will split an uploaded sql file into single sql statements. Note: expects trim() to have already been run on $sql.

Convert a textual value to it's equivalent boolean value

Parameters:

str - String to convert (converts yes, on, y, 1 and true to boolean true)

Returns:

The equivalent value

Convert the name of a user's primary group to the appropriate equivalent phpBB group id

Parameters:

status - The name of the group

Returns:

The group_id corresponding to the equivalent group

Sync post count. We might need to do this in batches.

Update any dynamic configuration variables after the conversion is finished

Todo:

Confirm that this updates all relevant values since it has not necessarily been kept in sync with all changes

Update the count of PM's in custom folders for all users

Updates topics_posted entries

Update the count of unread private messages for all users

Add users to the pre-defined "special" groups

Parameters:

group - The name of the special group to add to

select_query - An SQL query to retrieve the user(s) to add to the group

Ignore.

A wrapper function for the normalizer which takes care of including the class if required and modifies the passed strings to be in NFC (Normalization Form Composition).

Parameters:

strings - a string or an array of strings to normalize

Returns:

the normalized content, preserving array keys if array given.

Validate a website address