No namespace

Class browser_detector This class is an experiment for the job of correctly detecting browsers and settings needed for them. - Detects the following browsers - Opera, Webkit, Firefox, Web_tv, Konqueror, IE, Gecko - Webkit variants: Chrome, iphone, blackberry, android, safari, ipad, ipod - Opera Versions: 6, 7, 8 ... 10 ... and mobile mini and mobi - Firefox Versions: 1, 2, 3 .... 11 ... - Chrome Versions: 1 ... 18 ... - IE Versions: 4, 5, 5.5, 6, 7, 8, 9, 10 ... mobile and Mac - MS Edge - Nokia

Class curl_fetch_web_data Simple cURL class to fetch a web page Properly redirects even with safe mode and basedir restrictions Can provide simple post options to a page

Used for the "custom search index" option Class custom_search

Class ftp_connection Simple FTP protocol implementation.

Class fulltext_search Used for fulltext index searching

This really is a pseudo class, I couldn't justify having instance of it while mentioning so I just made every method static

Class xmlArray Represents an XML array

Safe serialize() replacement. Recursive - output a strict subset of PHP's native serialized representation - does not serialize objects

Safe unserialize() replacement - accepts a strict subset of PHP's native serialized representation - does not unserialize objects

Add a function for integration hook. does nothing if the function is already added.

Adds an array of data into an existing table. if there are no existing tables, will create one with default attributes. if custom_table isn't specified, it will use the last table created, if it is specified and doesn't exist the function will return false. if a set of keys have been specified, the function will check each required key is present in the incoming data. If this data is missing the current tables default value will be used. if any key in the incoming data begins with '#sep#', the function will add a separator across the table at this point. once the incoming data has been sanitized, it is added to the table.

Add a Javascript variable for output later (for feeding text strings and similar to JS) Cleaner and easier (for modders) than to use the function below.

This function handles adding a membergroup and setting some initial properties. Called by ?action=admin;area=membergroups;sa=add. It requires the manage_membergroups permission. Allows to use a predefined permission profile or copy one from another group. Redirects to action=admin;area=membergroups;sa=edit;group=x.

This function handles the approval, rejection, activation or deletion of members. Called by ?action=admin;area=viewmembers;sa=approve. Requires the moderate_forum permission. Redirects to ?action=admin;area=viewmembers;sa=browse with the same parameters as the calling page.

Recount many forum totals that can be recounted automatically without harm. it requires the admin_forum permission. It shows the maintain_forum admin area.

The main administration section. It prepares all the data necessary for the administration front page. It uses the Admin template along with the admin sub template. It requires the moderate_forum, manage_membergroups, manage_bans, admin_forum, manage_permissions, manage_attachments, manage_smileys, manage_boards, edit_news, or send_mail permission. It uses the index administrative area. It can be found by going to ?action=admin.

Question the verity of the admin by asking for his or her password. - loads Login.template.php and uses the admin_login sub template. - sends data to template so the admin is sent on to the page they wanted if their password is correct, otherwise they can try again.

Used by the adminLogin() function. if 'value' is an array, the function is called recursively.

The main admin handling function.
It initialises all the basic context required for the admin center.
It passes execution onto the relevant admin section.
If the passed section is not found it shows the admin home page.

This simple function gets a list of all administrators and sends them an email to let them know a new member has joined. Called by registerMember() function in Subs-Members.php. Email is sent to all groups that have the moderate_forum permission. The language set by each member is being used (if available).

This function allows the admin to register a new member by hand. It also allows assigning a primary group to the member being registered. Accessed by ?action=admin;area=regcenter;sa=register Requires the moderate_forum permission.

All this does is pass through to manage members. ViewMembers()

Counts how many alerts a user has - either unread or all depending on $unread We can't use db_num_rows here, as we have to determine what boards the user can see Possibly in future versions as database support for json is mainstream, we can simplify this.

Check the user's permissions. checks whether the user is allowed to do permission. (ie. post_new.) If boards is specified, checks those boards instead of the current one. If any is true, will return true if the user has the permission on any of the specified boards Always returns true if the user is an administrator.

Checks the status of an attachment directory and returns an array of the status key, if that status key signifies an error, and the file count.

Performs various checks on an uploaded file. - Requires that $_SESSION['temp_attachments'][$attachID] be properly populated.

Called when a directory space limit is reached. Creates a new directory and increments the directory suffix number.

Check if the current directory is still valid or not. If not creates the new directory

Ban center. The main entrance point for all ban center functions. It is accesssed by ?action=admin;area=ban. It choses a function based on the 'sa' parameter, like many others. The default sub-action is BanList(). It requires the ban_members permission. It initializes the admin tabs.

This handles the screen for showing the banned entities It is accessed by ?action=admin;area=ban;sa=browse It uses sub-tabs for browsing by IP, hostname, email or username.

This function is behind the screen for adding new bans and modifying existing ones. Adding new bans: - is accessed by ?action=admin;area=ban;sa=add. - uses the ban_edit sub template of the ManageBans template. Modifying existing bans: - is accessed by ?action=admin;area=ban;sa=edit;bg=x - uses the ban_edit sub template of the ManageBans template. - shows a list of ban triggers for the specified ban.

This function handles the ins and outs of the screen for adding new ban triggers or modifying existing ones. Adding new ban triggers: - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x - uses the ban_edit_trigger sub template of ManageBans. Editing existing ban triggers: - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x;bi=y - uses the ban_edit_trigger sub template of ManageBans.

Shows a list of bans currently set. It is accessed by ?action=admin;area=ban;sa=list. It removes expired bans. It allows sorting on different criteria. It also handles removal of selected ban items.

This handles the listing of ban log entries, and allows their deletion. Shows a list of logged access attempts by banned users. It is accessed by ?action=admin;area=ban;sa=log. How it works: - allows sorting of several columns. - also handles deletion of (a selection of) log entries.

Fix permissions according to ban status. Applies any states of banning by removing permissions the user cannot have.

As of SMF 2.1, this is unused. But it is available if any mod wants to use it. Convert only the BBC that can be edited in HTML mode for the (old) editor.

This function shows the board index. It uses the BoardIndex template, and main sub template. It updates the most online statistics. It is accessed by ?action=boardindex.

Turn off/on notification for a particular board. Must be called with a board specified in the URL. Only uses the template if no sub action is used. (on/off) Redirects the user back to the board after it is done. Accessed via ?action=notifyboard.

Generate a report on the current permissions by board and membergroup. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Standard report about what settings the boards have. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Return the boards a user has a certain (board) permission on. (array(0) if all.) - returns a list of boards on which the user is allowed to do the specified permission. - returns an array with only a 0 in it if the user has permission to do this on every board. - returns an empty array if he or she cannot do this on any board. If check_access is true will also make sure the group has proper access to that board.

Show a list of attachment or avatar files. Called by ?action=admin;area=manageattachments;sa=browse for attachments and ?action=admin;area=manageattachments;sa=browse;avatars for avatars. Allows sorting by name, date, size and member. Paginates results.

This simple function adds/removes the passed user from the current users buddy list. Requires profile_identity_own permission. Called by ?action=buddy;u=x;session_id=y. Redirects to ?action=profile;u=x.

Gets the value from the cache specified by key, so long as it is not older than ttl seconds. - It may often "miss", so shouldn't be depended on. - It supports the same as cache_put_data().

Retrieve all events for the given days, independently of the users offset. cache callback function used to retrieve the birthdays, holidays, and events between now and now + days_to_index. widens the search range by an extra 24 hours to support time offset shifts. used by the cache_getRecentEvents function to get the information needed to calculate the events taking the users time offset into account.

cache callback function used to retrieve the upcoming birthdays, holidays, and events within the given period, taking into account the users time offset. Called from the BoardIndex to display the current day's events on the board index used by the board index and SSI to show the upcoming events.

Show the calendar. It loads the specified month's events, holidays, and birthdays. It requires the calendar_view permission. It depends on the cal_enabled setting, and many of the other cal_ settings. It uses the calendar_start_day theme option. (Monday/Sunday) It uses the main sub template in the Calendar template. It goes to the month and year passed in 'month' and 'year' by get or post. It is accessed through ?action=calendar.

Receives a string and tries to figure it out if its a method or a function. If a method is found, it looks for a "#" which indicates SMF should create a new instance of the given class. Checks the string/array for is_callable() and return false/fatal_lang_error is the given value results in a non callable string/array. Prepare and returns a callable depending on the type of method/function found.

Process functions of an integration hook. calls all functions of the given hook. supports static class method calls.

Does permission checks to see if an event can be linked to a board/topic. checks if the current user can link the current topic to the calendar, permissions et al. this requires the calendar_post permission, a forum moderator, or a topic starter. expects the $topic and $board variables to be set. if the user doesn't have proper permissions, an error will be shown.

Ensures supplied data is properly encapsulated in cdata xml tags Called from getXmlProfile in News.php

Replace all vulgar words with respective proper words. (substring or whole words..) What this function does: - it censors the passed string. - if the theme setting allow_no_censored is on, and the theme option show_no_censored is enabled, does not censor, unless force is also set. - it caches the list of censored words to reduce parsing.

Checks whether a given IP range already exists in the trigger list. If yes, it returns an error message. Otherwise, it returns an array optimized for the database.

Sets a global $gd2 variable needed by some functions to determine whether the GD2 library is present.

Searches through the file to see if there's potentially harmful non-binary content. - if extensiveCheck is true, searches for asp/php short tags as well.

Make sure the user's correct session was passed, and they came from here. Checks the current session, verifying that the person is who he or she should be. Also checks the referrer to make sure they didn't get sent here. Depends on the disableCheckUA setting, which is usually missing. Will check GET, POST, or REQUEST depending on the passed type. Also optionally checks the referring action if passed. (note that the referring action must be by GET.)

Check whether a form has been submitted twice. Registers a sequence number for a form. Checks whether a submitted sequence number is registered in the current session. Depending on the value of is_fatal shows an error or returns true or false. Frees a sequence number from the stack after it's been checked. Frees a sequence number without checking if action == 'free'.

Removes old unused tokens from session defaults to 3 hours before a token is considered expired if $complete = true will remove all tokens

Clean up the XML to make sure it doesn't contain invalid characters. What it does: - removes invalid XML characters to assure the input string being - parsed properly.

• Formats a number.
• uses the format of number_format to decide how to format the number. for example, it might display "1 234,50".
• caches the formatting data from the setting for optimization.

Compares two versions and determines if one is newer, older or the same, returns - (-1) if version1 is lower than version2 - (0) if version1 is equal to version2 - (1) if version1 is higher than version2

Shows a form to edit a forum mailing and its recipients. Called by ?action=admin;area=news;sa=mailingcompose. Requires the send_mail permission. Form is submitted to ?action=admin;area=news;sa=mailingsend.

Converts HTML-entities to their UTF-8 character equivalents. This requires the admin_forum permission. Pre-condition: UTF-8 has been set as database and global character set.

Convert the column "body" of the table {db_prefix}messages from TEXT to MEDIUMTEXT and vice versa. It requires the admin_forum permission. This is needed only for MySQL. During the conversion from MEDIUMTEXT to TEXT it check if any of the posts exceed the TEXT length and if so it aborts. This action is linked from the maintenance screen (if it's applicable). Accessed by ?action=admin;area=maintain;sa=database;activity=convertmsgbody.

Copies one directory structure over to another. requires the destination to be writable.

Create an attachment, with the given array of parameters. - Adds any additional or missing parameters to $attachmentOptions. - Renames the temporary file. - Creates a thumbnail if the file is an image and the option enabled.

Create a new board and set its properties and position. Allows (almost) the same options as the modifyBoard() function. With the option inherit_permissions set, the parent board permissions will be inherited.

Create a new category. general function to create a new category and set its position. allows (almost) the same options as the modifyCat() function. returns the ID of the newly created category.

Create a custom search index for the messages table. Called by ?action=admin;area=managesearch;sa=createmsgindex. Linked from the EditSearchMethod screen. Requires the admin_forum permission. Depending on the size of the message table, the process is divided in steps.

Create a post, either as new topic (id_topic = 0) or in an existing one. The input parameters of this function assume: - Strings have been escaped. - Integers have been cast to integer. - Mandatory parameters are set.

Create a salvage area for repair purposes, if one doesn't already exist. Uses the forum's default language, and checks based on that name.

Creates a wave file that spells the letters of $word. Tries the user's language first, and defaults to english. Used by VerificationCode() (Register.php).

Get an array of previously defined files and adds them to our main minified files. Sets a one day cache to avoid re-creating a file on every request.

Remove one or more boards. Allows to move the children of the board before deleting it if moveChildrenTo is set to null, the child boards will be deleted. Deletes: - all topics that are on the given boards; - all information that's associated with the given boards; updates the statistics to reflect the new situation.

Remove one or more categories. general function to delete one or more categories. allows to move all boards in the categories to a different category before deleting them. if moveChildrenTo is set to null, all boards inside the given categories will be deleted. deletes all information that's associated with the given categories. updates the statistics to reflect the new situation.

Deletes one or many drafts from the DB Validates the drafts are from the user is supplied an array of drafts will attempt to remove all of them

Delete all or some of the errors in the error log. It applies any necessary filters to deletion. This should only be called by ViewErrorLog(). It attempts to TRUNCATE the table to reset the auto_increment. Redirects back to the error log when done.

Deleting a membergroup by URL (not implemented). Called by ?action=admin;area=membergroups;sa=delete;group=x;session_var=y. Requires the manage_membergroups permission. Redirects to ?action=admin;area=membergroups.

Delete one of more membergroups. Requires the manage_membergroups permission. Returns true on success or false on failure. Has protection against deletion of protected membergroups. Deletes the permissions linked to the membergroup. Takes members out of the deleted membergroups.

Delete one or more members. Requires profile_remove_own or profile_remove_any permission for respectively removing your own account or any account. Non-admins cannot delete admins. The function: - changes author of messages, topics and polls to guest authors. - removes all log entries concerning the deleted members, except the error logs, ban logs and moderation logs. - removes these members' personal messages (only the inbox), avatars, ban entries, theme settings, moderator positions, poll and votes. - updates member statistics afterwards.

Remove just a single post. On completion redirect to the topic or to the board.

Deletes a directory, and all the files and direcories inside it. requires access to delete these files.

Loads information about what browser the user is viewing with and places it in $context - uses the class from Class-BrowserDetect.php

Checks if the message table already has a fulltext index created and returns the key name Determines if a db is capable of creating a fulltext index

The central part of the board - topic display. This function loads the posts in a topic up so they can be displayed. It uses the main sub template of the Display template. It requires a topic, and can go to the previous or next topic from it. It jumps to the correct post depending on a number/time/IS_MSG passed. It depends on the messages_per_page, defaultMaxMessages and enableAllMessages settings. It is accessed by ?topic=id_topic.START.

Show an error message for the connection problems. It shows a complete page independent of language files or themes. It is used only if there's no way to connect to the database. It stops further execution of the script.

Show an error message for load average blocking problems. It shows a complete page independent of language files or themes. It is used only if the load averages are too high to continue execution. It stops further execution of the script.

Show a message for the (full block) maintenance mode. It shows a complete page independent of language files or themes. It is used only if $maintenance = 2 in Settings.php. It stops further execution of the script.

This function shows the debug information tracked when $db_show_debug = true in Settings.php

Once upon a time, this function handled downloading attachments. Now it's just an alias retained for the sake of backwards compatibility.

downloads a file from a url and stores it locally for avatar use by id_member. - supports GIF, JPG, PNG, BMP and WBMP formats. - detects if GD2 is available. - uses resizeImageFile() to resize to max_width by max_height, and saves the result to a file. - updates the database info for the member's avatar. - returns whether the download and resize was successful.

Download a language file from the Simple Machines website. Requires a valid download ID ("did") in the URL. Also handles installing language files. Attempts to chmod things as needed. Uses a standard list to display information about all the files and where they'll be put.

Formats data retrieved in other functions into xml format. Additionally formats data based on the specific format passed. This function is recursively called to handle sub arrays of data.

Allows the administrator to edit the registration agreement, and choose whether it should be shown or not. It writes and saves the agreement to the agreement.txt file. Accessed by ?action=admin;area=regcenter;sa=agreement. Requires the admin_forum permission.

Modify a specific board... screen for editing and repositioning a board. called by ?action=admin;area=manageboards;sa=board uses the modify_board sub-template of the ManageBoards template. requires manage_boards permission. also used to show the confirm deletion of category screen (sub-template confirm_board_delete).

Make changes to/delete a board. (function for handling a submitted form saving the board.) It also handles deletion of a board. Called by ?action=admin;area=manageboards;sa=board2 Redirects to ?action=admin;area=manageboards. It requires manage_boards permission.

Modify a specific category. (screen for editing and repositioning a category.) Also used to show the confirm deletion of category screen (sub-template confirm_category_delete). Called by ?action=admin;area=manageboards;sa=cat Requires manage_boards permission.

Function for handling a submitted form saving the category. (complete the modifications to a specific category.) It also handles deletion of a category. It requires manage_boards permission. Called by ?action=admin;area=manageboards;sa=cat2 Redirects to ?action=admin;area=manageboards.

Shows a textarea for editing a moderator comment. Handles the edited comment and stores it on the DB.

Editing a membergroup. Screen to edit a specific membergroup. Called by ?action=admin;area=membergroups;sa=edit;group=x. It requires the manage_membergroups permission. Also handles the delete button of the edit form. Redirects to ?action=admin;area=membergroups.

Let the administrator(s) edit the news items for the forum. It writes an entry into the moderation log. This function uses the edit_news administration area. Called by ?action=admin;area=news. Requires the edit_news permission. Can be accessed with ?action=admin;sa=editnews.

Display screen for editing or adding a poll. Must be called with a topic specified in the URL. If the user is adding a poll to a topic, must contain the variable 'add' in the url. User must have poll_edit_any/poll_add_any permission for the relevant action, otherwise must be poll starter with poll_edit_own permission for editing, or be topic starter with poll_add_any permission for adding. Accessed via ?action=editpoll.

Update the settings for a poll, or add a new one. Must be called with a topic specified in the URL. The user must have poll_edit_any/poll_add_any permission for the relevant action. Otherwise they must be poll starter with poll_edit_own permission for editing, or be topic starter with poll_add_any permission for adding. In the case of an error, this function will redirect back to EditPoll and display the relevant error message. Upon successful completion of action will direct user back to topic. Accessed via ?action=editpoll2.

Edit the search method and search index used. Calculates the size of the current search indexes in use. Allows to create and delete a fulltext index on the messages table. Allows to delete a custom index (that CreateMessageIndex() created). Called by ?action=admin;area=managesearch;sa=method. Requires the admin_forum permission.

Edit some general settings related to the search function. Called by ?action=admin;area=managesearch;sa=settings. Requires the admin_forum permission.

Shows an interface for editing the templates. - uses the Themes template and edit_template/edit_style sub template. - accessed via ?action=admin;area=theme;sa=edit

Edit the relative weight of the search factors. Called by ?action=admin;area=managesearch;sa=weights. Requires the admin_forum permission.

Send all the administrators a lovely email. - loads all users who are admins or have the admin forum permission. - uses the email template and replacements passed in the parameters. - sends them an email.

Adds slashes to the array/variable. What it does: - returns the var, as an array or string, with escapes as required. - importantly escapes all keys and values! - calls itself recursively if necessary.

An irrecoverable error. This function stops execution and displays an error message. It logs the error message if $log is specified.

Checks for errors in steps, until 5 seconds have passed. It keeps track of the errors it did find, so that the actual repair won't have to recheck everything.

Finds members by email address, username, or real name. - searches for members whose username, display name, or e-mail address match the given pattern of array names. - searches only buddies if buddies_only is set.

This does the necessary count of table data before displaying them. is (unfortunately) required to create some useful variables for templates. foreach data table created, it will count the number of rows and columns in the table. will also create a max_width variable for the table, to give an estimate width for the whole table * * if it can.

Called from dumpTags to convert data to xml Finds urls for local site and sanitizes them

Converts html entities to utf8 equivalents special db wrapper for mysql based on the limitation of mysql/mb3

Fixes the children of a board by setting their child_levels to new values. Used when a board is deleted or moved, to affect its children.

Fix a specific class of tag - ie. url with =. Used by fixTags, fixes a specific tag's links.

Fix any URLs posted - ie. remove 'javascript:'. Used by preparsecode, fixes links in message and returns nothing.

Return a Gravatar URL based on - the supplied email address, - the global maximum rating, - the global default fallback, - maximum sizes as set in the admin panel.

Simply returns the total count of integration hooks Used by the integration hooks list function (list_integration_hooks)

Callback function for the integration hooks list (list_integration_hooks) Gets all of the hooks in the system and their status

Get all birthdays within the given time range. finds all the birthdays in the specified range of days. works with birthdays set for no year, or any other year, and respects month and year boundaries.

Fetches a list of boards and (optional) categories including statistical information, child boards and moderators. - Used by both the board index (main data) and the message index (child boards). - Depending on the include_categories setting returns an associative array with categories->boards->child_boards or an associative array with boards->child_boards.

Generates the query to determine the list of available boards for a user Executes the query and returns the list

Get all parent boards (requires first parent as parameter) It finds all the parents of id_parent, and that board itself. Additionally, it detects the moderators of said boards.

Load a lot of useful information regarding the boards and categories. The information retrieved is stored in globals: $boards properties of each board. $boardList a list of boards grouped by category ID. $cat_tree properties of each category.

Gets specific details about a moderator comment. It also adds a permission for editing/deleting the comment, by default only admins and the author of the comment can edit/delete it.

Loads the statistics on a daily basis in $context. called by DisplayStats().

Search through source, theme and language files to determine their version. Get detailed version information about the physical SMF files on the server.

Attempt to reload our known languages. It will try to choose only utf8 or non-utf8 languages.

Retrieve a list and several other statistics of the users currently online. Used by the board index and SSI. Also returns the membergroups of the users that are currently online. (optionally) hides members that chose to hide their online presence.

Retrieves a list of message icons. - Based on the settings, the array will either contain a list of default message icons or a list of custom message icons retrieved from the database. - The board_id is needed for the custom message icons (which can be set for each board individually).

Fetches the list of preferences (or a single/subset of preferences) for notifications for one or more users.

Loads a package's information and returns a representative array. - expects the file to be a package in Packages/. - returns a error string if the package-info is invalid. - otherwise returns a basic array of id, version, filename, and similar information. - an xmlArray is available in 'xml'.

Returns date information about 'today' relative to the users time offset. returns an array with the current date, day, month, and year. takes the users time offset into account.

Tries to load up the entire board order and category very very quickly Returns an array with two elements, cats and boards

Retrieve the list of members from database. The array will be generated to match the format.

Get the latest topics information from a specific board, to display later. The returned array will be generated to match the xml_format.

Get the profile information for member into an array, which will be generated to match the xml_format.

Get the recent topics to display. The returned array will be generated to match the xml_format.

Show the large variety of group permissions assigned to each membergroup. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Entry point function, permission checks, admin bars, etc. It allows moderators and users to access the group showing functions. It handles permission checks, and puts the moderation bar on as required.

Retrieves a list of membergroups that are allowed to do the given permission. (on the given board) If board_id is not null, a board permission is assumed. The function takes different permission settings into account.

Converts HTML to BBC As of SMF 2.1, only used by ManageBoards.php (and possibly mods)

Adds html entities to the array/variable. Uses two underscores to guard against overloading. What it does: - adds entities (", <, >) to the array or string var. - importantly, does not effect keys, only values. - calls itself recursively if necessary.

Trim a string including the HTML space, character 160. Uses two underscores to guard against overloading. What it does: - trims a string or an the var array using html characters as well. - does not effect keys, only values. - may call itself recursively if needed.

Copy image. Used when imagecopyresample() is not available.

It is set only if it doesn't already exist (for forwards compatiblity.) It only supports uncompressed bitmaps.

Display a message about the forum being in maintenance mode. - display a login screen with sub template 'maintenance'. - sends a 503 header, so search engines don't bother indexing while we're in maintenance mode.

Creates a new ban group If the group is successfully created the ID is returned On error the error code is returned or false

Consolidating the various INSERT statements into this function. Inserts the passed event information into the calendar table. Allows to either set a time span (in days) or an end_date. Does not check any permissions of any sort.

Convert a single IP to a ranged IP. internal function used to convert a user-readable format to a format suitable for the database.

Do banning related stuff. (ie. disallow access....) Checks if the user is banned, and if so dies with an error. Caches this information for optimization purposes.

Require a user who is logged in. (not a guest.) Checks if the user is currently a guest, and if so asks them to login with a message telling them why. Message is what to tell them when asking them to login.

Fatal error if they cannot. Uses allowedTo() to check if the user is allowed to do permission. Checks the passed boards or current board for the permission. If $any is true, the user only needs permission on at least one of the boards to pass If they are not, it loads the Errors language file and shows an error using $txt['cannot_' . $permission]. If they are a guest and cannot do it, this calls is_not_guest().

Checks if a given email address might be banned. Check if a given email is banned. Performs an immediate ban if the turns turns out positive.

Check if a name is in the reserved words list. (name, current member id, name/username?.) - checks if name is a reserved name or username. - if is_name is false, the name is assumed to be a username. - the id_member variable is used to ignore duplicate matches with the current member.

Check the given String if he is a valid IPv4 or IPv6 return true or false

Used to edit the body or subject of a message inline called from action=jsmodify from script and topic js

Nifty function to calculate the number of days ago a given date was. Requires a unix timestamp as input, returns an integer. Named in honour of Jeff Lewis, the original creator of...this function.

Called by index.php?action=findmember. - is used as a popup for searching members. - uses sub template find_members of the Help template. - also used to add members for PM's sent using wap2/imode protocol.

Throws guests out to the login screen when guest access is off. - sets $_SESSION['login_url'] to $_SERVER['REQUEST_URL']. - uses the 'kick_guest' sub template found in Login.template.php.

Load a list of ban log entries from the database. (no permissions check). Callback for $listOptions['get_items'] in BanLog()

Returns the list of attachments files (avatars or not), recorded in the database, per the parameters received.

Fetch the actual language information. Callback for $listOptions['get_items']['function'] in ManageLanguageSettings. Determines which languages are available by looking for the "index.{language}.php" file. Also figures out how many users are using a particular language.

Gets a list of available languages from the mother ship Will return a subset if searching, otherwise all avaialble

This function grabs the mail queue items from the database, according to the params given. Callback for $listOptions['get_items'] in BrowseMailQueue()

Returns the total count of items in the mail queue. Callback for $listOptions['get_count'] in BrowseMailQueue

Gets the moderation log entries that match the specified parameters. Callback for createList() in ViewModlog().

Get the number of mod log entries. Callback for createList() in ViewModlog().

Return the number of files of the specified type recorded in the database. (the specified type being attachments or avatars).

How many languages? Callback for the list in ManageLanguageSettings().

Callback function for createList() Get the number of spider stat rows from the log spider stats table

Callback function for UnapprovedAttachments count all the attachments waiting for approval that this approver can approve

Callback function for createList() Get a list of spider stats from the log_spider table

Callback function for UnapprovedAttachments retrieve all the attachments waiting for approval the approver can approve

Generates a list of integration hooks for display Accessed through ?action=admin;area=maintain;sa=hooks; Allows for removal or disabling of selected hooks

Gets the members of a supplied membergroup Returns them as a link for display

Receives a string and tries to figure it out if it contains info to load a file. Checks for a | (pipe) symbol and tries to load a file with the info given. The string should be format as follows File.php|. You can use the following wildcards: $boarddir, $sourcedir and if available at the moment of execution, $themedir.

This loads an attachment's contextual data including, most importantly, its size if it is an image. It requires the view_attachments permission to calculate image size. It attempts to keep the "aspect ratio" of the posted image in line, even if it has to be resized by the max_image_width and max_image_height settings.

Check for moderators and see if they have access to the board. What it does: - sets up the $board_info array for current board information. - if cache is enabled, the $board_info array is stored in cache. - redirects to appropriate post if only message id is requested. - is only used when inside a topic or board. - determines the local moderators for the board. - adds group id 3 if the user is a local moderator for the board they are in. - prevents access if user is not in proper group nor a local moderator of the board.

Loads a list of membergroups who cannot be granted the bbc_html permission. Stores the groups in $context['permissions_excluded']['bbc_html'].

Loads the permissions that can not be given to guests. Stores the permissions in $context['non_guest_permissions']. Also populates $context['permissions_excluded'] with the info.

Load all the payment gateways. Checks the Sources directory for any files fitting the format of a payment gateway, loads each file to check it's valid, includes each file and returns the function name and whether it should work with this version of SMF.

Get the installed Search API implementations. This function checks for patterns in comments on top of the Search-API files! In addition to filenames pattern. It loads the search API classes if identified. This function is used by EditSearchMethod to list all installed API implementations.

Load a sub-template. What it does: - loads the sub template specified by sub_template_name, which must be in an already-loaded template. - if ?debug is in the query string, shows administrators a marker after every sub template for debugging purposes.

Load a template - if the theme doesn't include it, use the default. What this function does: - loads a template file with the name template_name from the current, default, or base theme. - detects a wrong default theme directory and tries to work around it.

Load all the important user information. What it does: - sets up the $user_info array - assigns $user_info['query_wanna_see_board'] for what boards the user can see. - first checks for cookie or integration validation. - uses the current session if no integration function or cookie is found. - checks password length, if member is activated and the login span isn't over. - if validation fails for the user, $id_member is set to 0. - updates the last visit time when needed.

Locks a topic... either by way of a moderator or the topic starter. What this does: - locks a topic, toggles between locked/unlocked/admin locked. - only admins can unlock topics locked by other admins. - requires the lock_own or lock_any permission. - logs the action to the moderator log. - returns to the topic after it is done. - it is accessed via ?action=lock.

Lock the voting for a poll. Must be called with a topic specified in the URL. An admin always has over riding permission to lock a poll. If not an admin must have poll_lock_any permission, otherwise must be poll starter with poll_lock_own permission. Upon successful completion of action will direct user back to topic. Accessed via ?action=lockvoting.

Log a ban in the database. Log the current user in the ban logs. Increment the hit counters for the specified ban ID's (if any.)

Log an error, if the error logging is enabled. filename and line should be FILE and LINE, respectively. Example use: die(log_error($msg));

Small utility function for fatal error pages. Used by fatal_error(), fatal_lang_error()

This function logs an action in the respective log. (database log) You should use logActions() instead.

Log changes to the forum, such as moderation events or administrative changes. This behaves just like logAction() in SMF 2.0, except that it is designed to log multiple actions at once.

Ask them for their login information. (shows a page for the user to type in their username and password.) It caches the referring URL in $_SESSION['login_url']. It is accessed from ?action=login.

Actually logs you in. What it does: - checks credentials and checks that login was successful. - it employs protection against a specific IP or user trying to brute force a login to an account. - upgrades password encryption on login, if necessary. - after successful login, redirects you to $_SESSION['login_url']. - accessed from ?action=login2, by forms. On error, uses the same templates Login() uses.

Logs the last database error into a file. Attempts to use the backup file first, to store the last database error and only update db_last_error.php if the first was successful.

Logs the current user out of their account. It requires that the session hash is sent as well, to prevent automatic logouts by images or javascript. It redirects back to $_SESSION['logout_url'], if it exists. It is accessed via ?action=logout;session_var=...

Wipes the whole cache directory. This only applies to SMF's own cache directory, though.

Show several file maintenance options. Called by ?action=admin;area=manageattachments;sa=maintain. Calculates file statistics (total file size, number of attachments, number of avatars, attachment space available).

Recalculate all members post counts it requires the admin_forum permission.

The main 'Attachments and Avatars' management function. This function is the entry point for index.php?action=admin;area=manageattachments and it calls a function based on the sub-action. It requires the manage_attachments permission.

Allows to show/change attachment settings. This is the default sub-action of the 'Attachments and Avatars' center. Called by index.php?action=admin;area=manageattachments;sa=attachments.

This allows to show/change avatar settings. Called by index.php?action=admin;area=manageattachments;sa=avatars. Show/set permissions for permissions: 'profile_server_avatar', 'profile_upload_avatar' and 'profile_remote_avatar'.

The main dispatcher; doesn't do anything, just delegates. This is the main entry point for all the manageboards admin screens. Called by ?action=admin;area=manageboards. It checks the permissions, based on the sub-action, and calls a function based on the sub-action.

The main control panel thing, the screen showing all boards and categories. Called by ?action=admin;area=manageboards or ?action=admin;area=manageboards;sa=move. Requires manage_boards permission. It also handles the interface for moving boards.

The main controlling function doesn't have much to do... yet. Just check permissions and delegate to the rest.

This is the main function for the languages area. It dispatches the requests. Loads the ManageLanguages template. (sub-actions will use it)

Main dispatcher, the maintenance access point. This, as usual, checks permissions, loads language files, and forwards to the actual workers.

The news dispatcher; doesn't do anything, just delegates. This is the entrance point for all News and Newsletter screens. Called by ?action=admin;area=news. It does the permission checks, and calls the appropriate function based on the requested sub-action.

The main entrance point for the 'Paid Subscription' screen, calling the right function based on the given sub-action. It defaults to sub-action 'view'. Accessed from ?action=admin;area=paidsubscribe. It requires admin_forum permission for admin based actions.

The main entrance point for the 'Posts and topics' screen. Like all others, it checks permissions, then forwards to the right function based on the given sub-action. Defaults to sub-action 'posts'. Accessed from ?action=admin;area=postsettings. Requires (and checks for) the admin_forum permission.

Scheduled tasks management dispatcher. This function checks permissions and delegates to the appropriate function based on the sub-action. Everything here requires admin_forum permission.

Main entry point for the admin search settings screen. It checks permissions, and it forwards to the appropriate function based on the given sub-action. Defaults to sub-action 'settings'. Called by ?action=admin;area=managesearch. Requires the admin_forum permission.

Checks if version matches any of the versions in versions. - supports comma separated version numbers, with or without whitespace. - supports lower and upper bounds. (1.0-1.2) - returns true if the version matched.

Detect if a IP is in a CIDR address - returns true or false

Checks if the forum version matches any of the available versions from the package install xml. - supports comma separated version numbers, with or without whitespace. - supports lower and upper bounds. (1.0-1.2) - returns true if the version matched.

Shows an overview of the current membergroups. Called by ?action=admin;area=membergroups. Requires the manage_membergroups permission. Splits the membergroups in regular ones and post count based groups. It also counts the number of members part of each membergroup.

Display members of a group, and allow adding of members to a group. Silly function name though ;) It can be called from ManageMembergroups if it needs templating within the admin environment. It shows a list of members that are part of a given membergroup. It is called by ?action=moderate;area=viewgroups;sa=members;group=x It requires the manage_membergroups permission. It allows to add and remove members from the selected membergroup. It allows sorting on several columns. It redirects to itself.

Show what the membergroups are made of. functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Shows a listing of registered members. - If a subaction is not specified, lists all registered members. - It allows searching for members with the 'search' sub action. - It calls MLAll or MLSearch depending on the sub action. - Requires the view_mlist permission. - Accessed via ?action=mlist.

Retrieves a list of members that have a given permission (on a given board). If board_id is not null, a board permission is assumed. Takes different permission settings into account. Takes possible moderators (on board 'board_id') into account.

List all members who are awaiting approval / activation, sortable on different columns. It allows instant approval or activation of (a selection of) members. Called by ?action=admin;area=viewmembers;sa=browse;type=approve or ?action=admin;area=viewmembers;sa=browse;type=activate. The form submits to ?action=admin;area=viewmembers;sa=approve. Requires the moderate_forum permission.

Shows a 'merge completed' screen. is accessed with ?action=mergetopics;sa=done. uses 'merge_done' sub template of the SplitTopics template.

allows to pick a topic to merge the current topic with. is accessed with ?action=mergetopics;sa=index default sub action for ?action=mergetopics. uses 'merge' sub template of the MoveTopic template. allows to set a different target board.

merges two or more topics into one topic. delegates to the other functions (based on the URL parameter sa). loads the SplitTopics template. requires the merge_any permission. is accessed with ?action=mergetopics.

Prepare text strings for sending as email body or header. In case there are higher ASCII characters in the given string, this function will attempt the transport method 'quoted-printable'. Otherwise the transport method '7bit' is used.

Creates the specified tree structure with the mode specified. creates every directory in path until it finds one that already exists.

List all members, page by page, with sorting. Called from MemberList(). Can be passed a sort parameter, to order the display of members. Calls printMemberListRows to retrieve the results of the query.

Search for members, or display search results. - Called by MemberList(). - If variable 'search' is empty displays search dialog box, using the search sub template. - Calls printMemberListRows to retrieve the results of the query.

Config array for changing the basic forum settings Accessed from ?action=admin;area=featuresettings;sa=basic;

Set a few Bulletin Board Code settings. It loads a list of Bulletin Board Code tags to allow disabling tags. Requires the admin_forum permission. Accessed from ?action=admin;area=featuresettings;sa=bbc.

Modify the settings and position of a board. Used by ManageBoards.php to change the settings of a board.

Edit the position and properties of a category. general function to modify the settings and position of a category. used by ManageBoards.php to change the settings of a category.

Modify any setting related to drafts. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=drafts

modifies an event. allows to either set a time span (in days) or an end_date. does not check any permissions of any sort.

General forum settings - forum name, maintenance mode, etc. Practically, this shows an interface for the settings in Settings.php to be changed.

Allows modifying the global layout settings in the forum Accessed through ?action=admin;area=featuresettings;sa=layout;

Config array for changing like settings Accessed from ?action=admin;area=featuresettings;sa=likes;

Main dispatcher, the entrance point for all 'Manage Membergroup' actions. It forwards to a function based on the given subaction, default being subaction 'index', or, without manage_membergroup permissions, then 'settings'. Called by ?action=admin;area=membergroups. Requires the manage_membergroups or the admin_forum permission.

Set some general membergroup settings and permissions. Called by ?action=admin;area=membergroups;sa=settings Requires the admin_forum permission (and manage_permissions for changing permissions) Redirects to itself.

Config array for changing like settings Accessed from ?action=admin;area=featuresettings;sa=mentions;

Set general news and newsletter settings and permissions. Called by ?action=admin;area=news;sa=settings. Requires the forum_admin permission.

Dispatches to the right function based on the given subaction. Checks the permissions, based on the sub-action. Called by ?action=managepermissions.

Modify any setting related to posts and posting. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=posts.

This function handles registration settings, and provides a few pretty stats too while it's at it. General registration settings and Coppa compliance settings. Accessed by ?action=admin;area=regcenter;sa=settings. Requires the admin_forum permission.

This is the main dispatcher. Sets up all the available sub-actions, all the tabs and selects the appropriate one based on the sub-action.

Adding, editing and deleting subscriptions. Accessed from ?action=admin;area=paidsubscribe;sa=modify.

Set any setting related to paid subscriptions, i.e. modify which payment methods are to be used. It requires the moderate_forum permission Accessed from ?action=admin;area=paidsubscribe;sa=settings.

Modify any setting related to topics. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=topics.

Edit or add a user subscription. Accessed from ?action=admin;area=paidsubscribe;sa=modifyuser.

This function allows to move a topic, making sure to ask the moderator to give reason for topic move. It must be called with a topic specified. (that is, global $topic must be set... @todo fix this thing.) If the member is the topic starter requires the move_own permission, otherwise the move_any permission. Accessed via ?action=movetopic.

Execute the move of a topic. It is called on the submit of MoveTopic. This function logs that topics have been moved in the moderation log. If the member is the topic starter requires the move_own permission, otherwise requires the move_any permission. Upon successful completion redirects to message index. Accessed via ?action=movetopic2.

Moves one or more topics to a specific board. (doesn't check permissions.) Determines the source boards for the supplied topics Handles the moving of mark_read data Updates the posts count of the affected boards

This function creates a new table of data, most functions will only use it once. The core of this file, it creates a new, but empty, table of data in context, ready for filling using addData(). Fills the context variable current_table with the ID of the table created. Keeps track of the current table count using context variable table_count.

Rewrite URLs to include the session ID. What it does: - rewrites the URLs outputted to have the session ID, if the user is not accepting cookies and is using a standard web browser. - handles rewriting URLs for the queryless URLs option. - can be turned off entirely by setting $scripturl to an empty string, ''. (it wouldn't work well like that anyway.) - because of bugs in certain builds of PHP, does not function in versions lower than 4.3.0 - please upgrade if this hurts you.

Optimizes all tables in the database and lists how much was saved. It requires the admin_forum permission. It shows as the maintain_forum admin area. It is accessed from ?action=admin;area=maintain;sa=database;activity=optimize. It also updates the optimize scheduled task such that the tables are not automatically optimized again too soon.

Writes data to a file, almost exactly like the file_put_contents() function. uses FTP to create/chmod the file when necessary and available. uses text mode for text mode file extensions. returns the number of bytes written.

Get information about the password hash. Returns an array of the information that was used to generate the password hash.

Hash the password using the specified algorithm Limits the maximum length of password to 72, if a longer string is supplied the first 72 characters are used

Function called in-between each round of attachments and avatar repairs. Called by repairAttachments(). If repairAttachments() has more steps added, this function needs updated!

Show the not_done template to avoid CGI timeouts and similar. Called when 3 or more seconds have passed while searching for errors. If max_substep is set, $_GET['substep'] / $max_substep is the percent done this step is.

Sets up the permissions by membergroup index page. Called by ?action=managepermissions Creates an array of all the groups with the number of members and permissions.

Calculates all the possible permutations (orders) of array. should not be called on huge arrays (bigger than like 10 elements.) returns an array containing each permutation.

Choose a theme from a list. allows a user to pick a new theme with an interface. - uses the Themes template. (pick sub template.) - accessed with ?action=theme;sa=pick.

Ask the user what they want to search for. What it does: - shows the screen to search forum posts (action=search) - uses the main sub template of the Search template. - uses the Search language file. - requires the search_posts permission. - decodes and loads search parameters given in the URL (if any). - the form redirects to index.php?action=search2.

Gather the results and show them. What it does: - checks user input and searches the messages table for messages matching the query. - requires the search_posts permission. - uses the results sub template of the Search template. - uses the Search language file. - stores the results into the search cache. - show the results of the search query.

Callback for the message display. It actually gets and prepares the message context. This function will start over from the beginning if reset is set to true, which is useful for showing an index before or after the posts.

Prepare subject and message of an email for the preview box Used in ComposeMailing and RetrievePreview (Xml.php)

Helper function, it sets up the context for the manage server settings. - The basic usage of the six numbered key fields are - array (0 ,1, 2, 3, 4, 5 0 variable name - the name of the saved variable 1 label - the text to show on the settings page 2 saveto - file or db, where to save the variable name - value pair 3 type - type of data to save, int, float, text, check 4 size - false or field size 5 help - '' or helptxt variable name )

Takes a message and parses it, returning nothing. Cleans up links (javascript, etc.) and code/quote sections. Won't convert \n's and a few other things if previewing is true.

Retrieves results of the request passed to it Puts results of request into the context for the sub template.

Format a topic to be printer friendly. Must be called with a topic specified. Accessed via ?action=printpage.

Load all the languages for the profile .

Loads a post an inserts it into the current editing text box. uses the Post language file. uses special (sadly browser dependent) javascript to parse entities for internationalization reasons. accessed with ?action=quotefast.

Convert a range of given IP number into a single string. It's practically the reverse function of ip2range().

Reads a .tar.gz file, filename, in and extracts file(s) from it. essentially just a shortcut for read_tgz_data().

Reads a draft in from the user_drafts table Validates that the draft is the user''s draft Optionally loads the draft in to context or superglobal for loading in to the form

This function is used to reassociate members with relevant posts. Reattribute guest posts to a specified member. Does not check for any permissions. If add_to_post_count is set, the member's post count is increased.

Quickly find out what moderation authority this user has - builds the moderator, group and board level querys for the user - stores the information on the current users moderation powers in $user_info['mod_cache'] and $_SESSION['mc']

Recursively get a list of boards. Used by getBoardTree

Make sure the browser doesn't come back and repost the form data. Should be used whenever anything is posted.

Used to re-econodes an image to a specified image format - creates a copy of the file at the same location as fileName. - the file would have the format preferred_format if possible, otherwise the default format is jpeg. - the function makes sure that all non-essential image contents are disposed.

Entrance point for the registration center, it checks permissions and forwards to the right function based on the subaction. Accessed by ?action=admin;area=regcenter. Requires either the moderate_forum or the admin_forum permission.

Registers a member to the forum. Allows two types of interface: 'guest' and 'admin'. The first includes hammering protection, the latter can perform the registration silently. The strings used in the options array are assumed to be escaped. Allows to perform several checks on the input, e.g. reserved names. The function will adjust member statistics. If an error is detected will fatal error on all errors unless return_errors is true.

Registers the site with the Simple Machines Stat collection. This function purposely does not use updateSettings.php as it will be called shortly after this process completes by the saveSettings() function.

Remove an integration hook function. Removes the given function from the given hook. Does nothing if the function is not available.

Removes all attachments in a single click Called from the maintenance screen by ?action=admin;area=manageattachments;sa=removeall.

Remove a selection of attachments or avatars. Called from the browse screen as submitted form by ?action=admin;area=manageattachments;sa=remove

Remove attachments older than a given age. Called from the maintenance screen by ?action=admin;area=manageattachments;sa=byAge. It optionally adds a certain text to the messages the attachments were removed from.

Remove attachments larger than a given size. Called from the maintenance screen by ?action=admin;area=manageattachments;sa=bySize. Optionally adds a certain text to the messages the attachments were removed from.

This function removes a bunch of ban groups based on ids Doesn't clean the inputs

Removes logs - by default truncate the table Doesn't clean the inputs

This function removes a bunch of triggers based on ids Doesn't clean the inputs

Remove an event removes an event. does no permission checks.

Remove one or more members from one or more membergroups. Requires the manage_membergroups permission. Function includes a protection against removing from implicit groups. Non-admins are not able to remove members from the admin group.

Remove a specific message (including permission checks). - normally, local and global should be the localCookies and globalCookies settings, respectively. - uses boardurl to determine these two things.

So long as you are sure... all old posts will be gone. Used in ManageMaintenance.php to prune old topics.

Remove a poll from a topic without removing the topic. Must be called with a topic specified in the URL. Requires poll_remove_any permission, unless it's the poll starter with poll_remove_own permission. Upon successful completion of action will direct user back to topic. Accessed via ?action=removepoll.

Remove a theme from the database. - removes an installed theme. - requires an administrator. - accessed with ?action=admin;area=theme;sa=remove.

Completely remove an entire topic. Redirects to the board when completed.

Put all boards in the right order and sorts the records of the boards table. Used by modifyBoard(), deleteBoards(), modifyCategory(), and deleteCategories() functions

Finds or repairs errors in the database to fix possible problems. Requires the admin_forum permission. Calls createSalvageArea() to create a new board, if necessary. Accessed by ?action=admin;area=repairboards.

Shows detailed information about a report. such as report comments and moderator comments. Shows a list of moderation actions for the specific report.

Sets and call a function based on the given subaction. Acts as a dispatcher function. It requires the moderate_forum permission.

Handling function for generating reports. Requires the admin_forum permission. Loads the Reports template and language files. Decides which type of report to generate, if this isn't passed through the querystring it will set the report_type sub-template to force the user to choose which type. When generating a report chooses which sub_template to use. Depends on the cal_enabled setting, and many of the other cal_ settings. Will call the relevant report generation function. If generating report will call finishTables before returning. Accessed through ?action=admin;area=reports.

Report a post or profile to the moderator... ask for a comment. Gathers data from the user to report abuse to the moderator(s). Uses the ReportToModerator template, main sub template. Requires the report_any permission. Uses ReportToModerator2() if post data was sent. Accessed through ?action=reporttm.

Send the emails. Sends off emails to all the moderators. Sends to administrators and global moderators. (1 and 2) Called by ReportToModerator(), and thus has the same permission and setting requirements as it does. Accessed through ?action=reporttm when posting.

Outputs each member name on its own line. - used by javascript to find members matching the request.

Generates a random password for a user and emails it to them. - called by Profile.php when changing someone's username. - checks the validity of the new username. - generates and sets a new password for the given user. - mails the new password to the email address of the user. - if username is not set, only a new password is generated and sent.

Resizes src_img proportionally to fit within max_width and max_height limits if it is too large. If GD2 is present, it'll use it to achieve better quality. It saves the new image to destination_filename, as preferred_format if possible, default is jpeg.

Resizes an image from a remote location or a local file. Puts the resized image at the destination location. The file would have the format preferred_format if possible, otherwise the default format is jpeg.

Handles retrieving previews of news items, newsletters, signatures and warnings. Calls the appropriate function based on $_POST['item']

A wrapper for filter_var($url, FILTER_SANITIZE_URL) that can handle URLs with international characters (a.k.a. IRIs)

Microsoft uses their own character set Code Page 1252 (CP1252), which is a superset of ISO 8859-1, defining several characters between DEC 128 and 159 that are not normally displayable. This converts the popular ones that appear from a cut and paste from windows.

Saves a post draft in the user_drafts table The core draft feature must be enabled, as well as the post draft option Determines if this is a new or an existing draft Returns errors in $post_errors for display in the template

Saves a PM draft in the user_drafts table The core draft feature must be enabled, as well as the pm draft option Determines if this is a new or and update to an existing pm draft

Saves one or more ban triggers into a ban item: according to the suggestions checks the $_POST variable to verify if the trigger is present

Check for un-posted attachments is something we can do once in a while :P This function uses opendir cycling through all the attachments

Search the member list, using one or more criteria. Called by ?action=admin;area=viewmembers;sa=search. Requires the moderate_forum permission. form is submitted to action=admin;area=viewmembers;sa=query.

This function compares the length of two strings plus a little. What it does: - callback function for usort used to sort the fulltext results. - passes sorting duty to the current API.

This function allows a user to select the membergroups to send their mailing to. Called by ?action=admin;area=news;sa=mailingmembers. Requires the send_mail permission. Form is submitted to ?action=admin;area=news;mailingcompose.

This function sends an email to the specified recipient(s). It uses the mail_type settings and webmaster_email variable.

Handles the sending of the forum mailing in batches. Called by ?action=admin;area=news;sa=mailingsend Requires the send_mail permission. Redirects to itself when more batches need to be sent. Redirects to ?action=admin;area=news;sa=mailingmembers after everything has been sent.

Sends a notification to members who have elected to receive emails when things happen to a topic, such as replies are posted. The function automatically finds the subject and its board, and checks permissions for each member who is "signed up" for notifications. It will not send 'reply' notifications more than once in a row.

Sends an personal message from the specified person to the specified people ($from defaults to the user)

Implementation of sessionClose() replacing the standard close handler. It simply returns true.

Implementation of sessionGC() replacing the standard gc handler. Callback for garbage collection.

Implementation of sessionOpen() replacing the standard open handler. It simply returns true.

Small utility function for fatal error pages. Used by display_db_error(), display_loadavg_error(), display_maintenance_message()

Shows an interface to set and test censored words. It uses the censor_vulgar, censor_proper, censorWholeWord, and censorIgnoreCase settings. Requires the admin_forum permission. Accessed from ?action=admin;area=postsettings;sa=censor.

Set the start and end dates and times for a posted event for insertion into the database. Validates all date and times given to it. Makes sure events do not exceed the maximum allowed duration (if any). If passed an array that defines any time or date parameters, they will be used. Otherwise, gets the values from $_POST.

Set an option via javascript. - sets a theme option without outputting anything. - can be used with javascript, via a dummy image... (which doesn't require the page to reload.) - requires someone who is logged in. - accessed via ?action=jsoption;var=variable;val=value;session_var=sess_id. - does not log access to the Who's Online log. (in index.php..)

Sets the SMF-style login cookie and session based on the id_member and password passed. - password should be already encrypted with the cookie salt. - logs the user out if id_member is zero. - sets the cookie and session to last the number of seconds specified by cookie_length, or ends them if cookie_length is less than 0. - when logging out, if the globalCookies setting is enabled, attempts to clear the subdomain's cookie too.

Helper function to set the system memory to a needed value - If the needed memory is greater than current, will attempt to get more - if in_use is set to true, will also try to take the current memory usage in to account

Handles permission modification actions from the upper part of the permission manager index.

Set the names under which users are not allowed to register. Accessed by ?action=admin;area=regcenter;sa=reservednames. Requires the admin_forum permission.

Administrative global settings. - saves and requests global theme settings. ($settings) - loads the Admin language file. - calls ThemeAdmin() if no theme is specified. (the theme center.) - requires admin_forum permission. - accessed with ?action=admin;area=theme;sa=list&th=xx.

Sets up all of the top menu buttons Saves them in the cache if it is available and on Places the results in $context

Available since: (PHP 5) If the optional raw_output is set to TRUE, then the sha1 digest is instead returned in raw binary format with a length of 20, otherwise the returned value is a 40-character hexadecimal number.

Show some of the more detailed help to give the admin an idea... It shows a popup for administrative or user help. It uses the help parameter to decide what string to display and where to get the string from. ($helptxt or $txt?) It is accessed via ?action=helpadmin;help=?.

Downloads an avatar or attachment based on $_GET['attach'], and increments the download count. It requires the view_attachments permission. It disables the session parser, and clears any previous output. It depends on the attachmentUploadDir setting being correct. It is accessed via the query string ?action=dlattach. Views to attachments do not increase hits and are not logged in the "Who's Online" log.

Show an image containing the visual verification code for registration. Requires the GD extension. Uses a random font for each letter from default_theme_dir/fonts. Outputs a gif or a png (depending on whether gif ix supported).

Loads in a group of drafts for the user of a given type (0/posts, 1/pm's) loads a specific draft for forum use if selected. Used in the posting screens to allow draft selection Will load a draft if selected is supplied via post

Redirect to the user help ;). It loads information needed for the help section. It is accessed by ?action=help.

Show a letter for the visual verification code. Alternative function for showCodeImage() in case GD is missing. Includes an image from a random sub directory of default_theme_dir/fonts.

Show all PM drafts of the current user Uses the showpmdraft template Allows for the deleting and loading/editing of drafts

Show all drafts of a given type by the current user Uses the showdraft template Allows for the deleting and loading/editing of drafts

Shows all currently open reported posts. Handles closing multiple reports

Outputs xml data representing recent information or a profile. Can be passed 4 subactions which decide what is output: 'recent' for recent posts, 'news' for news topics, 'members' for recently registered members, 'profile' for a member's profile. To display a member's profile, a user id has to be given. (;u=1) Outputs an rss feed instead of a proprietary one if the 'type' $_GET parameter is 'rss' or 'rss2'. Accessed via ?action=.xml. Does not use any templates, sub templates, or template layers.

Handler for standard error messages, standard PHP error handler replacement. It dies with fatal_error() if the error_level matches with error_reporting.

Validates whether the resource is a valid mysqli instance. Mysqli uses objects rather than resource. https://bugs.php.net/bug.php?id=42797

The main dispatcher. This delegates to each area.

Outputs a response. It assumes the data is already a string.

This is the function which returns stats to simplemachines.org IF enabled! called by simplemachines.org. only returns anything if stats was enabled during installation. can also be accessed by the admin, to show what stats sm.org collects. does not return any data directly to sm.org, instead starts a new request for security.

This function attempts to protect from spammed messages and the like. The time taken depends on error_type - generally uses the modSetting.

Spell checks the post for typos ;). It uses the pspell or enchant library, one of which MUST be installed. It has problems with internationalization. It is accessed via ?action=spellcheck.

do the actual split. is accessed with ?action=splittopics;sa=execute. uses the main SplitTopics template. supports three ways of splitting: (1) only one message is split off. (2) all messages after and including a given message are split off. (3) select topics to split (redirects to SplitSelectTopics()). uses splitTopic function to do the actual splitting.

screen shown before the actual split. is accessed with ?action=splittopics;sa=index. default sub action for ?action=splittopics. uses 'ask' sub template of the SplitTopics template. redirects to SplitSelectTopics if the message given turns out to be the first message of a topic. shows the user three ways to split the current topic.

do the actual split of a selection of topics. is accessed with ?action=splittopics;sa=splitSelection. uses the main SplitTopics template. uses splitTopic function to do the actual splitting.

allows the user to select the messages to be split. is accessed with ?action=splittopics;sa=selectTopics. uses 'select' sub template of the SplitTopics template or (for XMLhttp) the 'split' sub template of the Xml template. supports XMLhttp for adding/removing a message to the selection. uses a session variable to store the selected topics. shows two independent page indexes for both the selected and not-selected messages (;topic=1.x;start2=y).

general function to split off a topic. creates a new topic and moves the messages with the IDs in array messagesToBeSplit to the new topic. the subject of the newly created topic is set to 'newSubject'. marks the newly created message as read for the user splitting it. updates the statistics to reflect a newly created topic. logs the action in the moderation log. a notification is sent to all users monitoring this topic.

splits a topic into two topics. delegates to the other functions (based on the URL parameter 'sa'). loads the SplitTopics template. requires the split_any permission. is accessed with ?action=splittopics.

Report for showing all the forum staff members - quite a feat! functions ending with "Report" are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Sticky a topic. Can't be done by topic starters - that would be annoying! What this does: - stickies a topic - toggles between sticky and normal. - requires the make_sticky permission. - adds an entry to the moderator log. - when done, sends the user back to the topic. - accessed via ?action=sticky.

Deletes all PHP comments from a string. Useful when analyzing input from file_get_contents, etc.

Remove slashes recursively. Uses two underscores to guard against overloading. What it does: - removes slashes, recursively, from the array or string var. - effects both keys and values of arrays. - calls itself recursively to handle arrays of arrays.