Who Viewed This Thread - Enhanced Version
 

Who Viewed This Thread - Enhanced Version v1.3.2


Version: 1.3.2
vB Version: 3.0.3
Developer: Ocean
Install Difficulty: Moderately Easy



The original hack this references was done by Gary King (https://vborg.vbsupport.ru/showthread.php?t=61222). I modified his hack in order to gain some additional functionality.

This hack is meant to be installed instead of Gary's original version - not in addition to it (for sanity's sake, as far as managing the code is concerned).


(This was submitted as a seperate hack with Gary's permission. If this belongs in a different group, I'm sure a Moderator will move it accordingly. :) )


Description:

This hack will allow you to see which users have viewed any given Thread. In addition, there is a second section that is resettable. What this means, is that there are two sections that show a list of users who have viewed the Thread in question.

The first section is a Master List - it shows all users who have viewed that thread at ANY point in time (since the hack was installed).

The second section works like your car's Trip Meter. You can Reset that second section at any time and it will then show only the users that have viewed that thread FROM THAT POINT ON. In addition, this second section will show you the Date/Time of the last Reset, so that you know from what point that second list is showing. This is useful, for example, if you want to be able to see which users have viewed a thread after you have updated it, or after a particular post of interest has been made.

You can choose which UserGroups can view the Who Viewed information, or even if you want all users to be able to see the first section - but only certain UserGroups to see the second.

You can also choose whether you want the Who Viewed information to be displayed directly on the ShowThread page, or if you would prefer to only show a link that opens a Pop Up Window with the Who Viewed information there.




Release Notes:


v1.3.2

Fixed the problem where the Pop-Up Link was visible to users who didn't have permission to view that information. (They still wouldn't be shown the information - but the link shouldn't have been visible to them in the first place)


v1.3.1

Minor modifications to the Aesthetics of the ShowThread page, as well as the Who Viewed Pop Up Window. No functional changes. If you are using v1.3.0, you do not need to upgrade, unless you wish to have the new aesthetics.


v1.3.0

Added the ability to choose whether you want the Who Viewed information to be displayed directly on the ShowThread page (as it was for all prior versions of this hack), or if you would prefer to only show a link that opens a Pop Up Window with the Who Viewed information there. Also consolidated and cleaned up the code.


v1.2.6

Fixed the problem with the "Who Viewed Since" table collapsing the wrong object


v1.2.5

Minor changes to optimize code. No functional changes. If you have v1.2.4, you do not need to upgrade to v1.2.5.


v1.2.4

Reworked the Security Sections so that they are exponentially easier to set. Now, other than choosing which UserGroups you want to have access to this hack, you only need to change ONE variable in order to choose which Security Layout you want to use. :)


v1.2.3

Updated all of the Security Sections to allow for more flexibility in selecting which UserGroups may view the WhoViewed Information.


v1.2.1

Upgrade Notes have been updated, and an Upgrade Script provided for those who have Gary's original version installed. If you have already successfully installed v1.2 of this hack, there is no need to do anything further.


v1.2

The original hack allowed you to see which users had viewed any particular thread on your board. It was and is an excellent hack - however, I desired some additional functionality, and so I made the following changes:


1. The format of stored User IDs has changed to a comma delineated format. This was done to optimize the code by stripping out the need for an additional explode() and implode().

2. An additional set of information is now being kept and maintained. However, unlike the first set (which will show you who has viewed a particular thread - ever), the second set is resettable at any time by Admins. This gives you a "tripmeter" of sorts, as you can now tell who has viewed a particular thread from the last time you reset that counter for that thread.

3. The date and time of the last reset for each thread is kept and displayed. Otherwise, it would be self-defeating, as you wouldn't remember when you last reset it. :)

4. This hack has been written so that all functions are for Admins only. Instructions are included for modifying this, if you wish. (Note: Even if you make ALL information viewable to ALL users, only Admins are allowed to Reset Counters. It is recommended that you do not change this)

5. I have the template additions being added at the bottom of the ShowThread page (right above the posting permissions). It seems to make more sense putting it there, as it doesn't get in the way, aesthetically speaking. Basically, if you want to check that section, it's there - if not, you'll never be bothered by it. If you prefer to have it somewhere else, feel free to insert the ShowThread Template portion of the code wherever you wish.



UPGRADE NOTES:

The instructions for this hack assume that you do NOT have any prior version installed.

At the moment, if you already have Gary's original 1.0 version installed, you will either need to completely clear out the existing data, before installing this hack - or you can download the "WhoViewedUpgradeFormat.php" script in order to convert the data format over to the new style.

Instructions are included for upgrading.

Wow, looks nice, thanks for sharing ;)

You're welcome. And I'm glad you like it. :)

One more question... does this hack/mod adds any queries to a board?

Yes, this one does. More so because of the added functionality.

Speaking for v1.2 of this hack - if you install it as is, meaning as a tool for Admins only, than it will add 2 Queries for regular users and 4 Queries for Admins - but only on the ShowThread page.

Also, the first time a user visits a thread, there will be one additional Query (the one that adds them to the database).


So, if, for example, your board has 8 Queries per page for the ShowThread page - after installing this hack in it's default format...

...regular users will see 11 Queries the very first time they view any given thread - but only 10 Queries for each subsequent visit.

...Admins will see 13 Queries the first time they view any given thread - but only 12 Queries for each subsequent visit.


It doesn't add nearly as much as, say, a Portal hack. But I do still wish I could trim it down further. If anyone has any suggestions, I'd be happy to consider it - but at the moment, this is what's necessary to get this functionality. :)

Great, thanks for sharing!

You're welcome!

I hope you like it. :)

is there anyway to make this only apply to certain forum sections?

What do you mean by forum sections? Do you mean that you want this to only apply to certain Subs? That you don't want it to function at all in any other sub? Or just that you don't want the fields to be displayed?

Give me some more details, and I'll be able to help you better. :)

He only wants it to function in certain forums.

yeah...I only want it to show up in certain subforums, more then 1....anyway to do that?

Absolutely. I should be able to post the code later today or tomorrow. :)

Okay, if you want this hack to only work for certain Forums/Subboards, than there are two steps you need to perform:


Step 1

In the ShowThread.php file, you are supposed to insert a section of code (from the hack instructions). What you need to do is to add the following code first (in the spot indicated by the hack instructions). Then, follow the instructions given in the commented section of the following code. Finally, add the section of code from the hack instructions where indicated below.



Step 2

In the ShowThread Template, you are also supposed to insert a section of code (from the hack instructions). What you need to do is to add the following code first (in the spot indicated by the hack instructions). Then, add the section of code from the hack instructions where indicated below.




And that should do it!

I get this error when trying to Reset Counter

" Could not find phrase 'redirect'. "

I would double check the code you pasted into the Misc.php file. That code references the phrase "redirecting", not "redirect" - so it might be that the code didn't get inserted properly.

I have just released v1.2.1 of this hack.

Anyone who has successfully installed v1.2, doesn't need to do anything. The changes were all related to upgrading from Gary's original version.

I released an upgrade script that would convert the data from the old format to the new - so anyone who hasn't installed this yet because you don't want to lose your current WhoViwed data, can now do so with no worries. :)


Upgrade instructions are included in the Instructions file.

can you plz be so kind and change the way it shows the stats ?!
I mean the load-time is much higher if 1000+ members viewed a thread..

a much better way would be doing it via POP-UP...
When u view a Forum you can see the Views and replies of the Topic... The Number of Replies leads to a POP-UP where u have short and clear listed who viewed the topic...

(its and integrated vb-feature)... but the number of views isnt hotlinked..
so why not hotlink it too and make it redirect to a pop up which dispalys the content of ya hack..!!

I hope u got what i mean and would be very cool if u release it..!!
Much eazier to handle then..!!

Thhnx and respect ;)

Actually, that link leads to a list of who has posted in that thread, not who has viewed it. :)


Doing that would actually make things much less efficient, in so far as Admin actions are concerned. Usually, you need to know who viewed a thread once you're in it. To have to back out and click a link is a bit counterproductive.

Now, what I might do for a future version is offer an option whereby there will be a link within the thread that you could click in order to bring up the popup. If I did that, I might also add the View number hyperlink in addition.


I'll consider it for a future version. :)

Sorry for being a bit of a dummy, but how and where do I run these queries

1. Run the following SQL Queries (Adjust accordingly, if you use Table Prefixes):

**********

ALTER TABLE thread ADD whoviewed TEXT NOT NULL;
ALTER TABLE thread ADD whoviewedcounter TEXT NOT NULL;
ALTER TABLE thread ADD whoviewedreset INT(10) UNSIGNED NOT NULL;

I am very new to this and do not really understand what this means

SQL Queries can be run from Admin CP/Import & Maintenance/Execute SQL Query.

However, in order to run SQL Queries, your Config.php file has to have been configured to allow your User ID to run them - since SQL Queries can cause a lot of damage if not used properly. :)

Does this hack work with VB 3.0.1?

It should work fine with 3.0.1 - however the instructions were written for 3.0.3 - so you might find that some of the code you have to look for is slightly different. That aside, however, the code you have to insert should work fine as is. :)

Ocean big thanks for your help! Is there anyway to make it so the "Already viewed this thread" "Already viewed this thread since" tables do not show up at all in forums i didnt specify them in? I know it doesnt show the names of people but Id prefer for it not to show at all

thanks!

If you followed my instructions properly, you shouldn't see them at all in the Subs you chose to exclude.

That's what the new addition to the ShowThread template is for. :)

ha....sorry, I dont know how I overlooked the template change. it works fine, thanks :nervous:

You're welcome. I'm glad everything worked out. :)

hey mate,

i reckon the popup would be much better to hold the info - otherwise my server will die.

if :
Currently Active Users Viewing This Thread: 1 (1 members and 0 guests) [put your link here]

and make it say "people who have already viewed this thread."

that would be fantastic.
Take care mate.

I kinda like the pop-up idea as you only pull the information when you want it.

A question: Does this show you when the user first (or last) read the message? I think it would be great if the master (original) "read" list included when the user first read the message and the secondary (trip-metered) "read" list included the last time someone read the message.

I belienve that if the above were in this hack, I would install it in a heartbeat! On Ikonboard, this was a great add-on. I would love to be able to add it on my vB board!

The Pop-Up window is something that I will probably add to the next version of this hack.

As to your question, unfortunately it does not show when a post has been read. But that is also why I added the second resetable counter. This way, you can add a post, for example, and reset the second counter so that you can see who has viewed that thread from that point on. This allows you to easily see who has viewed that thread at all, and who has viewed it after that particular change has been made.

Adding a date/time stamp would mean an additional Query for every thread view on your board. I'm not sure it would be worth the overhead - especially on larger boards.

Perhaps, then, instead of storing a bit that indicates that it has been viewed (assuming that is how you are doing it), you store the time and date value and check for a nul entry in the event that is has not been viewed? Doing this should not increase the queries as you are just querying for different data.

The value I have seen in this is when an announcement is made in the forums for whatever reason, people have stated that they never read the message. If there was a time limit on response to a message, if they had read the message, the time stamp would indicate that they saw it in the time allowed and had the chance to respond.

In any case, it is a great hack. This is just that extra function that I would not mind seeing.

that'd be nice


:) then you can record IDs of those who has view thread in successive order. so it can be show as who viewed last with be displayed last (or first).
This include when you view the thread AGAIN, the script will check if your ID is already in the list, if it is, then your ID is moved to the end (or beginning) of the list. It might help knowing the sequence of reading (but losing the order of first reading)


The information is important, but another query wouldnt be good.

Unfortunately, it's more than that. Right now, when a thread is viewed, the code will query the DB and check to see if that person's UserID is present in the list of users who have viewed that thread.

If it's present, than it leaves things be. If not, then it takes an additional query to add that UserID.

If we wanted to keep track of the date/time that each user last viewed each thread - than every thread view would need to look for and then add or edit the current date/time stamp.

Plus, since the user and date/time stamp would be stored together - and all users + date/time stamps are stored in a single field per thread, the added parsing adds no small amount of processing that needs to be done. Or rather, it's a small addition by itself - but not cumulatively when 5,000 users are all viewing threads simultaneously. :)

I'm not sure it's worth the processing time/power for any boards except small ones. However, I might add it in a future version, nevertheless. :)


Actually, you can accomplish that function right now. In fact, it's easy when it's a new and single announcement - because all you have to do is save the user list once the time is up, and you'll know who viewed it by that point and who didn't.

Where it gets tricky, is if you edit or add to that announcement - because then the question is who read it since it was updated. It's for that reason that I added that second counter. Now, once you edit or add to an Announcement/Bulletin/Post, just reset the second counter for that thread. Now you'll know exactly who read it before your changes and who read it afterwards. :)

That would also add an additional query to every thread view. In addition, it's usefulness - in my opinion - is somewhat limited. Not to mention the fact that it would confuse a lot of people. :)

If we were going to go that route, we might as well add the full date/time stamp. (Which still may happen)


:)

Awesome!! *Clicks install!

I'm sorta confused...I do not have Garys hack installed...I would like ot install this enhanced version.

The instructions seem to be geared towards upgrades from previous versions.

Do you have a step by step to install this version?

Thanks

bnn121, the instructions you are referring to are the upgrade instructions given in subsequent posts.

If you want the full instructions - you need to download the TXT file from the very first post in this thread - the same as you would do for any other hack on this site. :)

Okay...I have downloaded the txt file from first post. Please dont hurt me...LOL...I'm just trying to figure out this hack and how to install it...it refers to some php files which are not located in either of the two files you have in the first post of this thread.

Where exactly does the fresh install portion start?

I see release notes section, then a UPGRADE NOTES section.

>Choice One or Choice Two

After that is shows

File Modifications:
showthread.php
misc.php

Template Modifications:
ShowThread

New Phrases:
already_viewed_this_thread
already_viewed_this_thread_since

Number of SQL Queries: 3

After that I see nothing to indicate...begin here for a fresh or new install

Is this the begining of the install process? I do not have those files listed above...the showthread.php or misc.php
********************************

1. Run the following SQL Queries (Adjust accordingly, if you use Table Prefixes):

**********

ALTER TABLE thread ADD whoviewed TEXT NOT NULL;
ALTER TABLE thread ADD whoviewedcounter TEXT NOT NULL;
ALTER TABLE thread ADD whoviewedreset INT(10) UNSIGNED NOT NULL;

The Upgrade Notes section tells you what you need to do in order to modify the Full Install instructions - which start at Step 1.

As for the PHP files listed - the reason they are listed as files which need to be modified is because they are your files that need to be modified.

Those two PHP files in question are supposed to be in the root of your vB folder, not supplied by me. After all, if I supplied them - why would you need to further modify them? :)

LOL...I just relized those two files are in the root of VB...hmm...I've been looking over the instructions...and theres some files I cant find...eith in the showthread.php or even in any other folder?

5. Open the "SHOWTHREAD" template and Find

I'm unsure of where this is within VB

I did a search of the entire VB folder and within showthread.php and coame up with no such file or phrase.

Is it obviouls I have never done tis before...HEHE...guess you got to start somewhere...why not your hack...which I like, just wish I could figure this out

okay, go into your vb Admin section.

open 'Styles & Templates' from the left menu.
choose 'Style Manager'
press the [ << >> ] button on the right hand side. that will show you all the templates that are used on the site.
(i.e. the file forum.php [for instance] only holds all the coding for that particular page. all the looks and style of the page will be kept in the template system under a similar name )

Okay, now it's showing templates - but only the custom-added ones. press the, now standard font << >> link, and it will open up every single group.
[ctrl] + [f] and type in 'showthread' then just click 'edit' or 'customise' next to the template, select all and copy and paste into dreamweaver to get better search and replace capabilites.

hope that helps.