PunBB Resource

##
##
##        Mod title:  Mark topics as read
##
##      Mod version:  1.1.3
##   Works on PunBB:  1.2.5
##     Release date:  2005-04-22
##           Author:  Miles Kaufmann (webmaster@twmagic.com)
##
##      Description:  This mod makes it so that topics are no longer marked as
##                    "new" in the forum view after they have been read, if
##                    they have not been posted in since being read.  This 
##                    mod also works on the list of forums in index.php.
##
##   Affected files:  header.php
##                    include/functions.php
##                    index.php
##                    lang/English/common.php
##                    lang/English/misc.php
##                    login.php
##                    moderate.php
##                    misc.php
##                    search.php
##                    viewforum.php
##                    viewtopic.php
##
##       Affects DB:  Yes; adds column "read_topics" to table "users".
##
##            Notes:  For notes see the included readme.txt.
##
##       DISCLAIMER:  Please note that "mods" are not officially supported by
##                    PunBB. Installation of this modification is done at your
##                    own risk. Backup your forum database and any and all
##                    applicable files before proceeding.
##
##

###########################################################################
#                                                                         #
#     Mark topics as read v1.1.3                                          #
#     Copyright (C) 2005  Miles Kaufmann                                  #
#     PunBB 1.2.5 mod                                                     #
#                                                                         #
###########################################################################

--[ Description ]----------------------------------------------------------

"Mark topics as read" is a PunBB mod which makes topics which have been
viewed no longer appear as "new" in the forum view. It adds a single column
to the "users" table, and uses no cookies. Installing this mod adds about
6KB of code to PunBB.

If you install this mod, you should set the "timeout_visit" option to at
least 30 minutes.  After the user's visit times out, the data associated
with this mod will be cleared from the database, and all posts before the
user's last visit will be marked read.  I would recommend setting
"timeout_visit" to one hour.

Because of the difficulty of creating mods for PunBB, it has become
impossible for me to maintain concurrent versions of this mod.
Unfortunately this means I have been forced to discontinue support for
older versions of PunBB.  You really should be using the latest version
anyway, so head to http://www.punbb.org/ to grab it.

--[ Installation using patch files ]---------------------------------------

There is a unified diff file provided with this mod, which will allow you
to easily install the mod on an unmodified or lightly modded installation
of PunBB.

To install this mod via patch, first upload install_mod.php to the root of
your PunBB installation, run it, and delete it.  Then, place the patch.diff
in the PARENT directory of your PunBB root directory (i.e., if your forums
are located in public_html/forums/ you should place the patch file directly
in the public_html/ folder).  Then, issue the following command in your
shell:

  patch -ul -d [punbb_dir] -p1 < [patch_file]

Replace [punbb_dir] with the path to your forums root directory and
[patch_file] with the name of the patch file. If you are running an
unmodified version of PunBB, the command should finish quickly without any
failures. If it does fail, you will have to update the failed files
manually.

Remember that YOU MUST RUN INSTALL_MOD.PHP PRIOR TO INSTALLING THIS MOD
WITH A PATCH.  Failure to do so may render your PunBB installation 
INOPERABLE.  You have been warned :)

--[ Version history ]------------------------------------------------------

Changes in v1.1.3:
  o Updated for compatibility with PunBB 1.2.5.
  o Miscellaneous minor code improvements.

Changes in v1.1.2:
  o Topic-read data will now be cleared when the user logs out manually.

Changes in v1.1.1:
  o Fixed bug which caused mod to make database queries more often and 
    take up more database space than was necessary.  Thanks to Smartys for
    pointing out this issue.

Changes in v1.1.0:
  o Fixed major bug with display of index.php; reduced number of DB queries
    made by the mod in index.php to 1.  Reported by cheesypeanut.
  o Updated search.php to display search results with the correct state of
    "newness", like viewtopic.php and moderate.php
  o Added language definitions for mod text.
  o Changed database to use a MEDIUMTEXT column to store the data.
  o Topic is now only marked read if it needs to be.

v1.0.0:
  o Initial release.