tag.php

<?php
/**
* Displays related (tagged) content from across multiple modules in a unified feed
* 
* Can be used to replace the standard ImpressCMS root index page. Retrieves related (tagged) content 
* from across multiple modules in the Gone Native collection. Page must be enabled and the required
* content objects selected in the Sprockets module preferences.
*
* @copyright	Copyright Madfish (Simon Wilkinson) 2011
* @license		http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License (GPL)
* @since		1.0
* @author		Madfish (Simon Wilkinson) <simon@isengard.biz>
* @package		sprockets
* @version		$Id$
*/

include_once 'header.php';
$xoopsOption['template_main'] = 'sprockets_tag.html';
include_once ICMS_ROOT_PATH . '/header.php';

// Check if this page has been enabled in the Sprockets module preferences
if (icms_getConfig("enable_user_side_pages", "sprockets")) {

	// Sanitise the tag_id and start (pagination) parameters
	$untagged_content = FALSE; // Flag indicating that UNTAGGED content should be returned
	if (isset($_GET['tag_id'])) {
		if ($_GET['tag_id'] == 'untagged') {
			$untagged_content = TRUE;
		}
	}
	$clean_tag_id = isset($_GET['tag_id']) ? (int)$_GET['tag_id']: 0 ;
	$clean_start = isset($_GET['start']) ? (int)$_GET['start'] : 0;

	// Get tag/taglink handlers
	$sprockets_tag_handler = icms_getModuleHandler('tag', 'sprockets', 'sprockets');
	$sprockets_taglink_handler = icms_getModuleHandler('taglink', 'sprockets', 'sprockets');

	// Initialise a containers for taglink and content objects
	$content_count = 0;
	$taglinkObjects = array();
	$taglinkObjectsSortedByType = array();
	$combinedContentObjects = array();

	// Get relative path to document root for this ICMS install
	$directory_name = basename(__DIR__);
	$script_name = getenv("SCRIPT_NAME");
	$document_root = str_replace('/modules/' . $directory_name . '/tag.php', '', $script_name);

	// Retrieve untagged content
	if ($untagged_content) {
		$tagObj = $sprockets_tag_handler->create(); // Inflate an empty "Untagged" tag object
		$tagObj->setVar('title', _CO_SPROCKETS_TAG_UNTAGGED_CONTENT);
		$tagObj->setVar('description', _CO_SPROCKETS_TAG_UNTAGGED_CONTENT_DSC);	
		$icmsTpl->assign('sprockets_tag', $tagObj->toArray());
		$combinedContentObjects = $sprockets_taglink_handler->getUntaggedContent(
			FALSE, // Module ID
			icms_getConfig("client_objects", "sprockets"), // Permitted client objects set in prefs
			$clean_start, // Pagination control
			icms_getConfig("pagination_limit", "sprockets")); // Pagination limit
	} else {
		// Retrieve tagged content (or all content, if tag_id == 0)
		if ($clean_tag_id) {
			$tagObj = $sprockets_tag_handler->get($clean_tag_id);
			if($tagObj && !$tagObj->isNew()) {
				$icmsTpl->assign('sprockets_tag', $tagObj->toArray());
			}
		}
		
		// $tag_id = FALSE, $module_id = FALSE, $item_type = FALSE, $start = FALSE, $limit = FALSE, $sort = 'DESC'
		$combinedContentObjects = $sprockets_taglink_handler->getTaggedItems(
			$clean_tag_id, // Tag ID
			FALSE, // Module ID
			icms_getConfig("client_objects", "sprockets"), // Permitted client objects set in prefs
			$clean_start, // Pagination control
			icms_getConfig("pagination_limit", "sprockets"), // Pagination limit
			'DESC');
	}

	// Extract the results count needed to build the pagination control
	if ($combinedContentObjects) {
		$content_count = array_shift($combinedContentObjects);
	}
	if ($content_count) {
		// Prepare objects for display (includes assignment of type-specific subtemplates)
		$combinedContentObjects = $sprockets_tag_handler->prepareClientItemsForDisplay($combinedContentObjects);

		// Adjust image file path for subdirectory installs of ICMS (resize Smarty plugin needs fix)
		foreach ($combinedContentObjects as &$object) {
			if (!empty($object['image'])) {
				$object['image'] = $document_root . $object['image'];
			}
		}

		/////////////////////////////////////////////////////////////////////////////
		////////// LOOKUP AND APPEND TAGS FOR THE RETURNED CONTENT OBJECTS //////////
		/////////////////////////////////////////////////////////////////////////////

		// Tag assembly is not necessary for untagged content!
		if ($untagged_content == FALSE) {

			// Build a tag buffer for lightweight lookups
			$tag_buffer = $sprockets_tag_handler->getTagBuffer();

			// Build a taglink buffer (use combination of item and iid to identify distinct rows)
			$sql = $result = $count = '';
			$count = count($combinedContentObjects);
			$sql = "SELECT DISTINCT `item`,`iid`, `tid` FROM " 
					. icms::$xoopsDB->escape($sprockets_taglink_handler->table)
					. " INNER JOIN " . icms::$xoopsDB->escape($sprockets_tag_handler->table)
					. " ON " . icms::$xoopsDB->escape($sprockets_taglink_handler->table) 
					. ".tid = " . icms::$xoopsDB->escape($sprockets_tag_handler->table) 
					. ".tag_id WHERE ";
			foreach ($combinedContentObjects as $item) {
				$count--;
				$sql .= " (`item` = '" . icms::$xoopsDB->escape($item['item']) 
						. "' AND `iid` = '" . (int)$item['iid']
						. "' AND " . icms::$xoopsDB->escape($sprockets_tag_handler->table)
						. ".label_type = '0')";
				if ($count > 0) {
					$sql .= " OR ";
				}
			}

			// Retrieve the results and sort by i) item and ii) iid for easy retrieval
			$tag_info = array();
			$result = icms::$xoopsDB->query($sql);
			if (!$result) {
					echo 'Error5';
					exit;
			} else {
				while ($row = icms::$xoopsDB->fetchArray($result)) {
					if (!isset($tag_info[$row['item']], $tag_info)) {
						$tag_info[$row['item']] = array();
					}
					if (!isset($tag_info[$row['item']][$row['iid']], $tag_info[$row['item']])) {
						$tag_info[$row['item']][$row['iid']] = array();
					}
					$tag_info[$row['item']][$row['iid']][] = '<a href="' . $script_name
							. '?tag_id=' . $row['tid'] . '">' . $tag_buffer[$row['tid']] . '</a>';
				}
			}
			// Iterate through content items appending the sorted tags
			foreach ($combinedContentObjects as &$obj) {
				if (isset($obj['iid'], $tag_info[$obj['item']])) {
					$obj['tags'] = implode(', ', $tag_info[$obj['item']][$obj['iid']]);
				}
			}
		}
		//////////////////////////////////////////////////////////
		//////////////////// END TAG ASSEMBLY ////////////////////
		//////////////////////////////////////////////////////////

		// Prepare a tag navigation select box
		if ($untagged_content) {
			$selected_tag_id = 'untagged';
		} else {
			$selected_tag_id = $clean_tag_id;
		}
		$tag_select_box = $sprockets_tag_handler->getTagSelectBox('tag.php', $selected_tag_id, 
				_CO_SPROCKETS_TAG_ALL_TAGS, TRUE, null, null, TRUE);
		$icmsTpl->assign('sprockets_tag_select_box', $tag_select_box);
		
		// Prepare RSS feed (only for tags with RSS enabled)
		$icmsTpl->assign('sprockets_rss_image', SPROCKETS_IMAGES_URL . 'rss.png');
		if (isset($tagObj) && !$tagObj->isNew()) {
			if ($tagObj->getVar('rss', 'e') == 1) {
				$rss_link = 'rss.php?tag_id=' . $tagObj->getVar('tag_id', 'e');
				$rss_attributes = array('type' => 'application/rss+xml', 
					'title' => $icmsConfig['sitename'] . ' - ' 
					. $tagObj->getVar('title'));
				$icmsTpl->assign('sprockets_rss_link', $rss_link);
				$icmsTpl->assign('sprockets_rss_title', _CO_SPROCKETS_SUBSCRIBE_RSS_ON
						. $tagObj->getVar('title'));
				$icmsTpl->assign('sprockets_tag_name', $tagObj->getVar('title'));
			}
		} else { // display latest content across all tags
			if ($untagged_content) {
				// No RSS feed available for untagged content
				$icmsTpl->assign('sprockets_tag_name', _CO_SPROCKETS_TAG_UNTAGGED_CONTENT);
			} else {
				$rss_link = 'rss.php';
				$rss_attributes = array('type' => 'application/rss+xml', 'title' => $icmsConfig['sitename'] 
					. ' - ' .  _CO_SPROCKETS_RSS_LATEST_CONTENT);
				$icmsTpl->assign('sprockets_rss_link', $rss_link);
				$icmsTpl->assign('sprockets_rss_title', _CO_SPROCKETS_SUBSCRIBE_RSS);
				$icmsTpl->assign('sprockets_tag_name', _CO_SPROCKETS_RSS_LATEST_CONTENT);
			}
		}
		if (!empty($rss_link) && !empty($rss_attributes)) {
			$xoTheme->addLink('alternate', $rss_link, $rss_attributes);
		}

		// Assign content to template, together with relevant module preferences
		$icmsTpl->assign('sprockets_tagged_content', $combinedContentObjects);
		$icmsTpl->assign('thumbnail_height', icms_getConfig('thumbnail_height', 'sprockets'));
		$icmsTpl->assign('thumbnail_height', icms_getConfig('thumbnail_height', 'sprockets'));
		$icmsTpl->assign('thumbnail_width', icms_getConfig('thumbnail_width', 'sprockets'));
		$icmsTpl->assign('thumbnail_height', icms_getConfig('thumbnail_height', 'sprockets'));
		$icmsTpl->assign('image_width', icms_getConfig('image_width', 'sprockets'));
		$icmsTpl->assign('image_height', icms_getConfig('image_height', 'sprockets'));

		// Pagination control
		if ($clean_tag_id) {
			$extra_arg = 'tag_id=' . $clean_tag_id;
		} else {
			$extra_arg = FALSE;
		}
		$pagenav = new icms_view_PageNav($content_count, 
			icms_getConfig('pagination_limit', 'sprockets'), $clean_start, 'start', $extra_arg);
		$icmsTpl->assign('sprockets_navbar', $pagenav->renderNav());
	} else {
		// Nothing to display
		$icmsTpl->assign('sprockets_nothing_to_display', _CO_SPROCKETS_CONTENT_NOTHING_TO_DISPLAY);
	}

	// Generate meta information for this page
	if (isset($tagObj) && !$tagObj->isNew()) {
		$icms_metagen = new icms_ipf_Metagen($tagObj->getVar('title'),
			$tagObj->getVar('meta_keywords','n'), $tagObj->getVar('meta_description', 'n'));
	} else {
		if ($untagged_content) {
			$icms_metagen = new icms_ipf_Metagen($icmsConfig['sitename']. ' - ' 
				. _CO_SPROCKETS_TAG_UNTAGGED_CONTENT, _CO_SPROCKETS_TAG_UNTAGGED_CONTENT, 
				_CO_SPROCKETS_TAG_UNTAGGED_CONTENT_DSC);
		} else {
			$icms_metagen = new icms_ipf_Metagen($icmsConfig['sitename']. ' - ' 
				. _CO_SPROCKETS_RSS_LATEST_CONTENT, _CO_SPROCKETS_ALL_TAGGED_CONTENT_KEYWORDS, 
				_CO_SPROCKETS_NEW_DSC);
		}
	}
	$icms_metagen->createMetaTags();

	$icmsTpl->assign('sprockets_module_home', sprockets_getModuleName(TRUE, TRUE));
	$icmsTpl->assign('sprockets_display_breadcrumb', $sprocketsConfig['display_breadcrumb']);
} else {
	exit; // This page is disable in the module preferences
}
include_once 'footer.php';