BB Usage Statistics

A Mod for the phpBB Forum Software

Author: Christopher calennert Lennert


Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.



Revision History
Revision 0.30.215 Feb 2003
First Public Release


The Board Usage Statistics mod displays statistical information on a bulletin board user's Profile page detailing the user's per forum and per category posts, post rate, percent of user's total posts, new topics initiated, topic rate, and the number of topics watched.

Table of Contents

1. Introduction
1.1. Purpose
1.2. Feature Summary
1.3. Acknowledgements
1.4. Change Log
1.4.1. v.0.3.2 Release (first public release)
1.4.2. v.0.3.1 Release ( only)
1.4.3. v.0.3.0 Release ( only)
1.4.4. v.0.2.0 Release ( only)
1.4.5. v.0.1.0 Release ( only)
1.5. Potential Future Changes
2. Database Records
3. Installation
3.1. Files and Folders in Distribution
3.2. Necessary Modifications
3.2.1. Copy folders
3.2.2. includes/usercp_viewprofile.php
3.2.3. admin/admin_board.php
3.2.4. templates/subSilver/profile_view_body.tpl
3.2.5. templates/subSilver/admin/board_config_body.tpl
3.3. Test the Installation
3.4. Support and Bug Reporting
4. Enjoy!
5. About This Document
A. GNU Free Documentation License
A.12. ADDENDUM: How to use this License for your documents

List of Figures

BB Usage Stats Example.

Chapter 1. Introduction

1.1. Purpose

This modification software (or mod) is intended to enhance phpBB, the free forum software (, by adding bulletin board usage statistics information to each user's Profile page. The mod aims for maximum configurability as well as ease of installation.

Figure BB Usage Stats Example. 

BB Usage Stats Example

1.2. Feature Summary

The BB Usage Statistics mod displays statistical information on a bulletin board user's Profile page detailing the user's per forum and per category:

  • Posts - The number of posts in the corresponding forum or category.
  • Post Rate - A value that can be scaled by the viewer at the board administrator's discretion. A default scaling factor can be also set by the administrator.
  • Percent of User's Total Posts (%UTP)
  • Percent of User's Total Unpruned Posts (%UTUP) - An optional column that displays more accurate percentages than %UTP for boards that do not reset user post counts following pruning operations.
  • New Topics - The number of new topics initiated by the user.
  • Topic Rate - Functions in the same manner as Post Rate.
  • Watched - The number of topics being watched by the user.

The mod's administrative configuration options include ability to set:

  • The classes of users allowed to view the statistics. The classes of users include Anonymous, Self, Users, Moderators, Admin, and Special Group. The Special Group allows the administrator to define a usergroup and assign it the ability to view users' statistics.
  • View Options which switch on or off various items of information in the statistics table including “Display %UTUP Column in Stats Table”, “Show All Forums Regardless of Post Count”, and viewer scalability of the Post and Topic Rates.
  • The default scaling factors for the Post Rate and Topic Rate columns.

1.3. Acknowledgements

Initially written for's forum, the mod is being made available for the benefit of the broader phpBB community. Thanks go to that site's administrator, Kristofer McCormic (Phade), for proposing the original mod idea, for offering his support and encouragement, and for testing the mod in a live bulletin board environment.

1.4. Change Log

1.4.1. v.0.3.2 Release (first public release)

  • Documentation - .mod file now generated from BB Usage Stats mod manual.

1.4.2. v.0.3.1 Release ( only)

  • Bug Fix - Display - Fixed careless looping error in get_section_usage_rows().
  • New Feature - Moved unshared functions to bb_usage_stats.php from bb_usage_stats_functions.php per phpBB coding guidelines.
  • Clean Up - bb_usage_stats_functions.php.

1.4.3. v.0.3.0 Release ( only)

  • Modification - Security - Do not permit display of forums which viewer is not authorized to see.
  • New feature - Added Topics Watched column.
  • New feature - Added Administrative configuration options for setting the default PR & TR scaling factors.
  • Modification - Viewer scaling row now hidden if neither post rate or topic rate is scalable by viewer.

1.4.4. v.0.2.0 Release ( only)

  • New feature - View Option added - Allow Post Rate to be scaled by viewer.
  • New feature - View Option added - Allow Topic Rate to be scaled by viewer.
  • Modification - Viewlevel modifiable via checkboxes.
  • Presentation Polish - %UTUP doesn't fill in ending 0's after decimal point.
  • New feature - Search Link - The name of the forum links to search results showing user's posts in the forum.
  • New feature - View Option added - show all forums regardless of whether or not user has posted in the forum.
  • Modification - rename "Posts/Day" to "Post Rate".
  • Modification - rename "Topics/Day" to "Topic Rate".
  • New feature - View Option added - Make display of Miscellaneous section optional.
  • New feature - View Option added - Make display of "Total Unpruned Posts" row in Miscellaneous Section optional.
  • New feature - View Option added - make %UTUP column optional for boards that reset post counts after pruning.
  • Modification - Changing the viewlevel on the admin config page sets/unsets the checkboxes.

1.4.5. v.0.1.0 Release ( only)

  • Initial release.

1.5. Potential Future Changes

Suggestions welcome!

  • Misc Info row to display PMs sent, PMs received, and rates.
  • Watched column entries link to search results showing the topics user is watching.
  • Section/forum images that link directly to the full view of the section/forum (as opposed to just search results).
  • Allow creation of a hit list assigned to a designated user; the designee can only view the usage stats of users on their assigned hit list.

Chapter 2. Database Records

This mod depends on the following board configuration records:

  • bb_usage_stats_viewlevel
  • bb_usage_stats_viewoptions
  • bb_usage_stats_specialgrp
  • bb_usage_stats_prscale
  • bb_usage_stats_trscale

These records are automatically inserted into phpBB's config table if they are not present when the user Profile page or the administrative Configuration page are first viewed after installation. The adminstrator may easily change these values via the interface provided on the administrative Configuration page.

The first record, bb_usage_stats_viewlevel, stores the types of users allowed to view the usage statistics. This setting permits granting the viewing of statistics by any combination of the following: Anonymous, Self, Users, Moderators, Administrators, and a Special Group. Upon first use, this field's default value of “16” allows only administrators to view the usage statistics.

The second record, bb_usage_stats_viewoptions, enables and disables various optional components such as displaying all forums regardless of the user's post count, permitting the stats viewer to change the scaling factors for the Post and Topic rate columns, and hiding the Miscellaneous section (which as of this writing is fairly limited). The default value of “1” shows all forums regardless of forum post count. For large boards with many forums, the administrator may choose to turn off this particular setting.

The third record, bb_usage_stats_specialgrp, stores the group_id of the special group permitted to view the usage statistics. The Special Group View Level, however, must be enabled. The default value of “-1” names no particular usergroup.

The fourth and fifth records, bb_usage_stats_prscale and bb_usage_stats_trscale, sets the board global scaling factors for the Post Rate and Topic Rate columns. The scaling factors, in general, will be useful to boards where users' post counts are significantly less than the duration of their membership. The default value for these two records is “1”.

Chapter 3. Installation

Installation Level: Easy

Installation Time: 15 minutes

3.1. Files and Folders in Distribution

The following files are included in the distribution package:

|   mod_bb_usage_stats.pdf
|   mod_bb_usage_stats.mod
|   |   index.html
|   |   
|   \---bb_usage_stats
|       |   bb_usage_stats_coldesc.php
|       |   index.html
|       |   
|       +---admin
|       |       bb_usage_stats_admin.php
|       |       index.html
|       |       
|       +---includes
|       |       bb_usage_stats.php
|       |       bb_usage_stats_constants.php
|       |       bb_usage_stats_functions.php
|       |       index.html
|       |       
|       \---language
|           |   index.html
|           |   
|           \---lang_english
|                   bb_usage_stats_lang.php
|                   index.html
            |   index.html
                |   bb_usage_stats.tpl
                |   bb_usage_stats_coldesc.tpl
                |   index.html

3.2. Necessary Modifications

The following phpBB files must be modified:

  • includes/usercp_viewprofile.php
  • admin/admin_board.php
  • templates/subSilver/profile_view_body.tpl
  • templates/subSilver/admin/board_config_body.tpl

3.2.1. Copy folders COPY

mods/      =>  PHPBBROOT/
templates/ =>  PHPBBROOT/

3.2.2. includes/usercp_viewprofile.php OPEN

includes/usercp_viewprofile.php FIND

$template->pparse('body'); BEFORE, ADD

include($phpbb_root_path . 'mods/bb_usage_stats/includes/bb_usage_stats.'.$phpEx);

3.2.3. admin/admin_board.php OPEN

admin/admin_board.php FIND

$template->pparse('body'); BEFORE, ADD

include($phpbb_root_path . 'mods/bb_usage_stats/admin/bb_usage_stats_admin.'.$phpEx);

3.2.4. templates/subSilver/profile_view_body.tpl OPEN

templates/subSilver/profile_view_body.tpl FIND

<table width="100%" border="0" cellspacing="0" cellpadding="0" align="center">
    <td align="right"><span class="nav"><br />{JUMPBOX}</span></td>
</table> BEFORE, ADD


3.2.5. templates/subSilver/admin/board_config_body.tpl OPEN

templates/subSilver/admin/board_config_body.tpl FIND

    <th class="thHead" colspan="2">{L_COOKIE_SETTINGS}</th>


Of course, you can insert the line anywhere within this file, as long as it appears before one of the <tr><th></th></tr> sequences that mark the beginning of a configuration section. SAVE/CLOSE ALL FILES

3.3. Test the Installation

Once you have unzipped the files and performed the modifications described above, you can test the installation by signing on as the Site Admin and viewing a user's profile. If all is well, you should see the user's stats in a separate table below the basic profile information.


At this point, the bb_usage_stats_viewlevel record (see Chapter 2, Database Records) has been created and you can confirm this by examining phpBB's config table using whatever tool you use to administer your database. The default View Level value is “16”.

To change the View Level, you will need to be logged in as the Site Admin. Go to the phpBB Administration Panel, click on the Configuration option in the General Admin menu. Scrolling down the page, you should see the Board Usage Statistics Settings section which will allow you to change the View Level according to the instructions shown. In addition, you may also designate a special user group to have access to the board usage statistics.


You are encouraged to try different View Levels and examine the effects while logged on as various types of users.

3.4. Support and Bug Reporting

If you have problems, discover a bug, or typo in this documentation, feel free to visit the Lennertmods home page at SourceForge. Your comments and suggestions are always welcome!

Chapter 4. Enjoy!

Chapter 5. About This Document

All versions of this article are produced in a J2SDK v.1.4.1 environment with the following components:

In addition, production of the PDF version utilizes:

Appendix A. GNU Free Documentation License

Version 1.2, November 2002

Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.


The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.


This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.


You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.


If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.


You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

  1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
  2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
  4. Preserve all the copyright notices of the Document.
  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
  6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
  8. Include an unaltered copy of this License.
  9. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
  10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
  11. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
  12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
  13. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
  14. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
  15. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.


You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".


You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.


A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.


Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warrany Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.


You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.


The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

A.12. ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this:

with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.