==README for Profiles Checker add-on for miniBB==
Release date: March 12, 2009.
Most recent update: March 22, 2023.
miniBB version: 3.3+
Author: Paul Puzyrev (minibb.com)

The forum content consists not only of topics and messages, but also member profiles are involved. Nowadays it's important to "keep an eye" on all profiles, because graphics and textual indormation attached to the profile, may be harmful. This add-on gives an opportunity to quickly verify member profiles on the board: as soon as somebody updates any field of the profile, incl. possible photos, avatar or signature, it goes into the checking queue, and should be checked by forums administrator or moderators with the necessary action taken, if needed.

This add-on has been initially sponsored by www.latviangirls.net


==SETUP==

Modify addon_pfchecker_options.php which contains some options explained. Add-on is bundled with such profile add-ons of miniBB like Avatars, Signatures and Photo Album. If you have some of those add-ons installed, set the proper setting to TRUE to enable them showing in the queue.


==INSTALLATION==

* Add new profile field indicating the most recent profile update time, executing SQL commands from `pfchecker.sql`. The first command just adds the new field, it's required both for the freshly installed and the forums which already have the users database. The second command updates this field's value equal to the registration date - this is ONLY required for the forums which you may run already, it will update the "profile check" field, so it could appear in the queue.

* Under setup_options.php, you should properly update $dbUserSheme array, adding the aforementioned field at the end of the array and providing the proper key (use "Determine Fields" script for that). For example, it should look like this:

$dbUserSheme=array(
'username'=>array(1,'username','login'),
'user_password'=>array(3,'user_password','passwd'),

[...here follows list of other fields defined...]

'user_profileupdate'=>array(21, 'user_profileupdate', ''),
);


* At the end of your language pack (lang/eng.php or whatever) paste the code located at /lang/eng.code.txt (or another related language).

* Copy /lang/pfchecker_eng.php to the /lang/ folder of your forum (or another related language pack(s), if present).

* Edit `bb_plugins.php`, and paste the code from `bb_plugins.code_1_toplink.txt`. It's the code generating the "Check Profiles" link available to admins in the top menu of forum. This block should be pasted in the sequence of top link blocks for other add-ons like Private Messages or Premoderation you could possibly have. For example:

/* Private Messaging top link */
/* Profiles verification - top link */
/* Premoderation Top Link */

* Copy the code from `bb_plugins_sepr.code.txt` and paste it to bb_plugins.php right after the top link(s) sequence. It could look like this:

/* Private Messaging top link */
/* Profiles verification - top link */
/* Premoderation Top Link */
/* Newline Separator */

If you already have this code from other add-ons, skip this step.

* Continue editing `bb_plugins.php` and paste the code from `bb_plugins.code_2.txt` - it could be pasted straight after `/* Newline Separator */` code or wherever else.

* The administrative top menu item is recommended to appear on the second line. `{$adminSepr}` will provide a <br> tag and additional HTML for the generic layout, and it's generated in the code mentioned above. Paste it to the menu items of `/templates/main_header.html` straight after {$l_menu[6]}.

* Continue editing `/templates/main_header.html` and paste: {$pfverifyView} - after the `{$adminSepr}` and possibly in the middle of other top links you may have, for example:

{$l_menu[6]}{$adminSepr}{$pmView}{$pfverifyView}{$premodLink}

where `{$pmView}` stands for the Private Messages top link, `{$premodLink}` stands for the Premoderation link. If there are no other links planned, it could look like:

{$l_menu[6]}{$adminSepr}{$pfverifyView}

* Alternatively, you could edit `/templates/admin_panel.html` and add the direct link to the Check Profiles list:

<a href="{$main_url}/{$indexphp}action=pfcheck" class="mnblnk">{$l_pfc_menu}</a>

If you'd like to appear it in the Administration Panel only, skip the steps described above for pasting `/* Profiles verification - top link */`, `{$adminSepr}` and `{$pfverifyView}` codes.

* Edit bb_plugins2.php, paste the code provided in bb_plugins2.code.txt. 

* Copy addon_pfchecker.php, addon_pfchecker_options.php to your root forums folder.

* Copy shared_files/profiles_verification.txt file to your forums /shared_files/ folder. If such folder is not created (it may be used for wide list of other add-ons as well), create the folder and give it full permission for writing (CHMOD 0777 on Linux/Unix). The file itself should be allowed for writing as well. This file will keep the date of the last queue check, actually the date of the last profile checked out. Next time when you visit the queue, it will display only profiles, which were updated later than this date.

==USAGE==

Sign in to forums as moderator or administrator and click "Check Profiles" link, or follow the direct add-on's URL. When you start the add-on for the first time, it will display _all profiles_, as the default date in profiles_verification.txt is set to 0. Profiles will be always sorted by the most recent update time in ascending order (older updates first). Profiles will be displayed one by one in the very brief style. Click "Check" link located at the bottom right of each profile record to reset the queued date, assuming next time you could start checking with only profiles left in the queue. "Delete Profile" link, available only for forums Administrator, will open the regular profile removing page in admin panel. Clicking on username will open profile page as it's shown on forums, where it's possible to edit or suspend the profile.


==FINALLY==

Questions? Suggestions? Improvements? Post them quickly on our support forums:
http://www.minibb.com/forums/
