Merge pull request #280 from DrudexSoftware/master

Image View Counter, Arrow Navigation, and Custom HTML Headers
This commit is contained in:
Shish 2013-02-25 05:50:27 -08:00
commit a55c5efc4f
3 changed files with 255 additions and 0 deletions

View File

@ -0,0 +1,114 @@
<?php
/**
* Name: Arrow Key Navigation
* Author: Drudex Software <support@drudexsoftware.com>
* Link: http://www.drudexsoftware.com/
* License: GPLv2
* Description: Allows viewers no navigate between images using the left & right arrow keys.
* Documentation:
* Simply enable this extention in the extention manager to enable arrow key navigation.
*/
class arrowkey_navigation extends Extension {
# Adds functionality for post/list
public function onPageRequest(PageRequestEvent $event) {
if ($event->page_matches("post/view")) {
$pageinfo = $this->get_view_pageinfo($event);
$prev_url = make_http(make_link("post/prev/".$pageinfo));
$next_url = make_http(make_link("post/next/".$pageinfo));
$this->add_arrowkeys_code($prev_url, $next_url);
}
else if ($event->page_matches("post/list")) {
$pageinfo = $this->get_list_pageinfo($event);
$prev_url = make_http(make_link("post/list/".$pageinfo["prev"]));
$next_url = make_http(make_link("post/list/".$pageinfo["next"]));
$this->add_arrowkeys_code($prev_url, $next_url);
}
}
# adds the javascript to the page with the given urls
private function add_arrowkeys_code($prev_url, $next_url) {
global $page;
$page->add_html_header("<script type=\"text/javascript\">
document.onkeyup=checkKeycode;
function checkKeycode(e)
{
var keycode;
if(window.event) keycode=window.event.keyCode;
else if(e) keycode=e.which;
if (e.srcElement.tagName != \"INPUT\")
{
if(keycode==\"37\") window.location.href='$prev_url' + window.location.hash;
else if(keycode==\"39\") window.location.href='$next_url' + window.location.hash;
}
}
</script>");
}
# returns info about the current page number
private function get_list_pageinfo($event) {
global $config, $database;
// get the amount of images per page
$images_per_page = $config->get_int('index_images');
// this occurs when viewing post/list without page number
if ($event->get_arg(0) == null) {// no page listed
$prefix = "";
$page_number = 1;
$total_pages = ceil($database->get_one(
"SELECT COUNT(*) FROM images") / $images_per_page);
}
// if there are no tags, use default
else if ($event->get_arg(1) == null){
$prefix = "";
$page_number = (int)$event->get_arg(0);
$total_pages = ceil($database->get_one(
"SELECT COUNT(*) FROM images") / $images_per_page);
}
else { // if there are tags, use pages with tags
$prefix = $event->get_arg(0)."/";
$page_number = (int)$event->get_arg(1);
$total_pages = ceil($database->get_one(
"SELECT count FROM tags WHERE tag=:tag",
array("tag"=>$event->get_arg(0))) / $images_per_page);
}
// creates previous & next values
// When previous first page, go to last page
if ($page_number <= 1) $prev = $total_pages;
else $prev = $page_number-1;
if ($page_number >= $total_pages) $next = 1;
else $next = $page_number+1;
// Create return array
$pageinfo = array(
"prev" => $prefix.$prev.$after,
"next" => $prefix.$next.$after,
);
return $pageinfo;
}
# returns url ext with any tags
private function get_view_pageinfo($event) {
// if there are no tags, use default
if ($event->get_arg(1) == null){
$prefix = "";
$image_id = (int)$event->get_arg(0);
}
else { // if there are tags, use pages with tags
$prefix = $event->get_arg(0)."/";
$image_id = (int)$event->get_arg(1);
}
// returns result
return $prefix.$image_id;
}
}
?>

View File

@ -0,0 +1,33 @@
<?php
/**
* Name: Custom HTML Headers
* Author: Drudex Software <support@drudexsoftware.com>
* Link: http://www.drudexsoftware.com
* License: GPLv2
* Description: Allows admins to set custom <head> content
* Documentation:
* When you go to board config you can find a block named Custom HTML Headers.
* In that block you can simply place any thing you can place within <head></head>
*
* This can be useful if you want to add website tracking code or other javascript.
* NOTE: Only use if you know what you're doing.
*
*/
class custom_html_headers extends Extension {
# Adds setup block for custom <head> content
public function onSetupBuilding(SetupBuildingEvent $event) {
$sb = new SetupBlock("Custom HTML Headers");
$sb->add_longtext_option("custom_html_headers",
"HTML Code to place within &lt;head&gt;&lt;/head&gt; on all pages<br>");
$event->panel->add_block($sb);
}
# Load Analytics tracking code on page request
public function onPageRequest(PageRequestEvent $event) {
global $config, $page;
$header = $config->get_string('custom_html_headers','');
if ($header!='') $page->add_html_header($header);
}
}
?>

View File

@ -0,0 +1,108 @@
<?php
/**
* Name: Image View Counter
* Author: Drudex Software <support@drudexsoftware.com>
* Link: http://www.drudexsoftware.com/
* License: GPLv2
* Description: Tracks & displays how many times an image is viewed
* Documentation:
* Whenever anyone views an image, a view will be added to that image.
* This extension will also track any username & the IP adress.
* This is done to prevent duplicate views.
* A person can only count as a view again 1 hour after viewing the image initially.
*/
class image_view_counter extends Extension {
private $view_interval = 3600; # allows views to be added each hour
# Add Setup Block with options for view counter
public function onSetupBuilding(SetupBuildingEvent $event) {
$sb = new SetupBlock("Image View Counter");
$sb->add_bool_option("image_viewcounter_adminonly", "Display view counter only to admin");
$event->panel->add_block($sb);
}
# Adds view to database if needed
public function onDisplayingImage(DisplayingImageEvent $event) {
$imgid = $event->image->id; // determines image id
$this->addview($imgid); // adds a view
}
# display views to user or admin below image if allowed
public function onImageInfoBoxBuilding(ImageInfoBoxBuildingEvent $event) {
global $user, $config;
$adminonly = $config->get_bool("image_viewcounter_adminonly"); // todo0
if ($adminonly == false || ($adminonly && $user->is_admin()))
$event->add_part("<tr><th>Views:</th><td>".
$this->get_view_count($event->image->id) ."</th></tr>", 38);
}
# Installs DB table
public function onInitExt(InitExtEvent $event) {
global $database, $config;
// if the sql table doesn't exist yet, create it
if($config->get_bool("image_viewcounter_installed") == false) { //todo
$database->create_table("image_views","
id bigint(20) SCORE_AIPK,
image_id INTEGER NOT NULL,
user_id INTEGER NOT NULL,
timestamp INTEGER NOT NULL,
ipaddress SCORE_INET NOT NULL");
$config->set_bool("image_viewcounter_installed", true);
}
}
# Adds a view to the item if needed
private function addview($imgid)
{
global $database, $user;
// don't add view if person already viewed recently
if ($this->can_add_view($imgid) == false) return;
// Add view for current IP
$database->execute("INSERT INTO image_views (image_id, user_id, timestamp, ipaddress)
VALUES (:image_id, :user_id, :timestamp, :ipaddress)", array(
"image_id" => $imgid,
"user_id" => $user->id,
"timestamp" => time(),
"ipaddress" => $_SERVER['REMOTE_ADDR'],
));
}
# Returns true if this IP hasn't recently viewed this image
private function can_add_view($imgid)
{
global $database;
// counts views from current IP in the last hour
$recent_from_ip = (int)$database->get_one("SELECT COUNT(*) FROM image_views WHERE
ipaddress=:ipaddress AND timestamp >:lasthour AND image_id =:image_id",
array( "ipaddress" => $_SERVER['REMOTE_ADDR'],
"lasthour" => time() - $this->view_interval,
"image_id" => $imgid));
// if no views were found with the set criteria, return true
if($recent_from_ip == 0) return true;
else return false;
}
# Returns the int of the view count from the given image id
// $imgid - if not set or 0, return views of all images
private function get_view_count($imgid = 0)
{
global $database;
if ($imgid == 0) // return view count of all images
$view_count = (int)$database->get_one("SELECT COUNT(*) FROM image_views");
else // return view count of specified image
$view_count = (int)$database->get_one("SELECT COUNT(*) FROM image_views WHERE ".
"image_id =:image_id", array("image_id" => $imgid));
// returns the count as int
return $view_count;
}
}
?>