/components/com_content/models/category.php

<?php

/**

 * @version		$Id: category.php 10094 2008-03-02 04:35:10Z instance $

 * @package		Joomla

 * @subpackage	Content

 * @copyright	Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.

 * @license		GNU/GPL, see LICENSE.php

 * Joomla! is free software. This version may have been modified pursuant to the

 * GNU General Public License, and as distributed it includes or is derivative

 * of works licensed under the GNU General Public License or other free or open

 * source software licenses. See COPYRIGHT.php for copyright notices and

 * details.

 */



// Check to ensure this file is included in Joomla!

defined('_JEXEC') or die( 'Restricted access' );



jimport('joomla.application.component.model');



/**

 * Content Component Category Model

 *

 * @author	Louis Landry <louis.landry@joomla.org>

 * @package		Joomla

 * @subpackage	Content

 * @since 1.5

 */

class ContentModelCategory extends JModel

{

	/**

	 * Category id

	 *

	 * @var int

	 */

	var $_id = null;



	/**

	 * Category items data

	 *

	 * @var array

	 */

	var $_data = null;



	/**

	 * Category number items

	 *

	 * @var integer

	 */

	var $_total = null;



	/**

	 * Category data

	 *

	 * @var object

	 */

	var $_category = null;



	/**

	 * Category data

	 *

	 * @var array

	 */

	var $_siblings = null;



	/**

	 * Constructor

	 *

	 * @since 1.5

	 */

	function __construct()

	{

		parent::__construct();



		global $mainframe;



		$id = JRequest::getVar('id', 0, '', 'int');

		$this->setId((int)$id);



		// here we initialize defaults for category model

		$params = &$mainframe->getParams();

		$params->def('filter',					1);

		$params->def('filter_type',				'title');

	}



	/**

	 * Method to set the category id

	 *

	 * @access	public

	 * @param	int	Category ID number

	 */

	function setId($id)

	{

		// Set category ID and wipe data

		$this->_id			= $id;

		$this->_category	= null;

		$this->_siblings	= null;

		$this->_data		= array();

		$this->_total		= null;

	}



	/**

	 * Method to get content item data for the current category

	 *

	 * @param	int	$state	The content state to pull from for the current

	 * category

	 * @since 1.5

	 */

	function getData($state = 1)

	{

		// Load the Category data

		if ($this->_loadCategory() && $this->_loadData($state))

		{

			// Initialize some variables

			$user	=& JFactory::getUser();



			// Make sure the category is published

			if (!$this->_category->published)

			{

				JError::raiseError(404, JText::_("Resource Not Found"));

				return false;

			}



			// check whether category access level allows access

			if ($this->_category->access > $user->get('aid', 0))

			{

				JError::raiseError(403, JText::_("ALERTNOTAUTH"));

				return false;

			}

		}

		return $this->_data[$state];

	}



	/**

	 * Method to get the total number of content items for the frontpage

	 *

	 * @access public

	 * @return integer

	 */

	function getTotal($state = 1)

	{

		// Lets load the content if it doesn't already exist

		if (empty($this->_total))

		{

			$query = $this->_buildQuery($state);

			$this->_total[$state] = $this->_getListCount($query);

		}



		return $this->_total[$state];

	}



	/**

	 * Method to get category data for the current category

	 *

	 * @since 1.5

	 */

	function getCategory()

	{

		// Load the Category data

		if ($this->_loadCategory())

		{

			// Initialize some variables

			$user = &JFactory::getUser();



			// Make sure the category is published

			if (!$this->_category->published) {

				JError::raiseError(404, JText::_("Resource Not Found"));

				return false;

			}

			// check whether category access level allows access

			if ($this->_category->access > $user->get('aid', 0)) {

				JError::raiseError(403, JText::_("ALERTNOTAUTH"));

				return false;

			}

		}

		return $this->_category;

	}



	/**

	 * Method to get sibling category data for the current category

	 *

	 * @since 1.5

	 */

	function getSiblings()

	{

		// Initialize some variables

		$user	=& JFactory::getUser();



		// Load the Category data

		if ($this->_loadCategory() && $this->_loadSiblings())

		{

			// Make sure the category is published

			if (!$this->_category->published)

			{

				JError::raiseError(404, JText::_("Resource Not Found"));

				return false;

			}



			// check whether category access level allows access

			if ($this->_category->access > $user->get('aid', 0))

			{

				JError::raiseError(403, JText::_("ALERTNOTAUTH"));

				return false;

			}

		}

		return $this->_siblings;

	}



	/**

	 * Method to get archived article data for the current category

	 *

	 * @param	int	$state	The content state to pull from for the current section

	 * @since 1.5

	 */

	function getArchives($state = -1)

	{

		return $this->getContent(-1);

	}



	/**

	 * Method to load category data if it doesn't exist.

	 *

	 * @access	private

	 * @return	boolean	True on success

	 */

	function _loadCategory()

	{

		if (empty($this->_category))

		{

			// Lets get the information for the current category

			$query = 'SELECT c.*, s.id as sectionid, s.title as sectiontitle,' .

					' CASE WHEN CHAR_LENGTH(c.alias) THEN CONCAT_WS(":", c.id, c.alias) ELSE c.id END as slug'.

					' FROM #__categories AS c' .

					' INNER JOIN #__sections AS s ON s.id = c.section' .

					' WHERE c.id = '. (int) $this->_id;

			$this->_db->setQuery($query, 0, 1);

			$this->_category = $this->_db->loadObject();

		}

		return true;

	}



	/**

	 * Method to load sibling category data if it doesn't exist.

	 *

	 * @access	private

	 * @return	boolean	True on success

	 */

	function _loadSiblings()

	{

		global $mainframe;



		if (empty($this->_category))

		{

			return false; // TODO: set error -- can't get siblings when we don't know the category

		}



		// Lets load the siblings if they don't already exist

		if (empty($this->_siblings))

		{

			$user	 =& JFactory::getUser();



			// Get the page/component configuration

			$params = &$mainframe->getParams();



			$noauth	 = !$params->get('show_noauth');

			$gid		 = (int) $user->get('aid', 0);

			$now		 = $mainframe->get('requestTime');

			$nullDate = $this->_db->getNullDate();

			$section	 = $this->_category->section;



			// Get the parameters of the active menu item

			$menu	=& JSite::getMenu();

			$item    = $menu->getActive();

			$params	=& $menu->getParams($item->id);



			if ($user->authorize('com_content', 'edit', 'content', 'all'))

			{

				$xwhere = '';

				$xwhere2 = ' AND b.state >= 0';

			}

			else

			{

				$xwhere = ' AND c.published = 1';

				$xwhere2 = ' AND b.state = 1' .

						' AND ( publish_up = '.$this->_db->Quote($nullDate).' OR publish_up <= '.$this->_db->Quote($now).' )' .

						' AND ( publish_down = '.$this->_db->Quote($nullDate).' OR publish_down >= '.$this->_db->Quote($now).' )';

			}



			// show/hide empty categories

			$empty = null;

			if (!$params->get('empty_cat'))

			{

				$empty = ' HAVING COUNT( b.id ) > 0';

			}



			// Get the list of sibling categories [categories with the same parent]

			$query = 'SELECT c.*, COUNT( b.id ) AS numitems' .

					' FROM #__categories AS c' .

					' LEFT JOIN #__content AS b ON b.catid = c.id '.

					$xwhere2.

					($noauth ? ' AND b.access <= '. (int) $gid : '') .

					' WHERE c.section = '. $this->_db->Quote($section).

					$xwhere.

					($noauth ? ' AND c.access <= '. (int) $gid : '').

					' GROUP BY c.id'.$empty.

					' ORDER BY c.ordering';

			$this->_db->setQuery($query);

			$this->_siblings = $this->_db->loadObjectList();

		}

		return true;

	}



	/**

	 * Method to load content item data for items in the category if they don't

	 * exist.

	 *

	 * @access	private

	 * @return	boolean	True on success

	 */

	function _loadData($state = 1)

	{

		if (empty($this->_category)) {

			return false; // TODO: set error -- can't get siblings when we don't know the category

		}



		// Lets load the siblings if they don't already exist

		if (empty($this->_content[$state]))

		{

			// Get the pagination request variables

			$limit		= JRequest::getVar('limit', 0, '', 'int');

			$limitstart	= JRequest::getVar('limitstart', 0, '', 'int');



			$query = $this->_buildQuery();

			$Arows = $this->_getList($query, $limitstart, $limit);



			// special handling required as Uncategorized content does not have a section / category id linkage

			$i = $limitstart;

			$rows = array();

			foreach ($Arows as $row)

			{

				// check to determine if section or category has proper access rights

				$rows[$i] = $row;

				$i ++;

			}

			$this->_data[$state] = $rows;

		}

		return true;

	}



	function _buildQuery($state = 1)

	{

		global $mainframe;

		// Get the page/component configuration

		$params = &$mainframe->getParams();



		// If voting is turned on, get voting data as well for the content items

		$voting	= ContentHelperQuery::buildVotingQuery($params);



		// Get the WHERE and ORDER BY clauses for the query

		$where		= $this->_buildContentWhere($state);

		$orderby	= $this->_buildContentOrderBy($state);



		$query = 'SELECT cc.title AS category, a.id, a.title, a.title_alias, a.introtext, a.fulltext, a.sectionid, a.state, a.catid, a.created, a.created_by, a.created_by_alias, a.modified, a.modified_by,' .

			' a.checked_out, a.checked_out_time, a.publish_up, a.publish_down, a.attribs, a.hits, a.images, a.urls, a.ordering, a.metakey, a.metadesc, a.access,' .

			' CASE WHEN CHAR_LENGTH(a.alias) THEN CONCAT_WS(":", a.id, a.alias) ELSE a.id END as slug,'.

			' CASE WHEN CHAR_LENGTH(cc.alias) THEN CONCAT_WS(":", cc.id, cc.alias) ELSE cc.id END as catslug,'.

			' CHAR_LENGTH( a.`fulltext` ) AS readmore, u.name AS author, u.usertype, g.name AS groups'.$voting['select'] .

			' FROM #__content AS a' .

			' LEFT JOIN #__categories AS cc ON a.catid = cc.id' .

			' LEFT JOIN #__users AS u ON u.id = a.created_by' .

			' LEFT JOIN #__groups AS g ON a.access = g.id'.

			$voting['join'].

			$where.

			$orderby;



		return $query;

	}



	function _buildContentOrderBy($state = 1)

	{

		global $mainframe;

		// Get the page/component configuration

		$params = &$mainframe->getParams();



		$filter_order		= JRequest::getCmd('filter_order');

		$filter_order_Dir	= JRequest::getWord('filter_order_Dir');



		$orderby = ' ORDER BY ';

		if ($filter_order && $filter_order_Dir)

		{

			$orderby .= $filter_order .' '. $filter_order_Dir.', ';

		}



		if ($filter_order == 'author')

		{

			$orderby .= 'created_by_alias '. $filter_order_Dir.', ';

		}

		switch ($state)

		{

			case -1:

				// Special ordering for archive articles

				$orderby_sec	= $params->def('orderby', 'rdate');

				$secondary		= ContentHelperQuery::orderbySecondary($orderby_sec).', ';

				$primary		= '';

				break;



			case 1:

			default:

				$orderby_sec	= $params->def('orderby_sec', 'rdate');

				$orderby_sec	= ($orderby_sec == 'front') ? '' : $orderby_sec;

				$orderby_pri	= $params->def('orderby_pri', '');

				$secondary		= ContentHelperQuery::orderbySecondary($orderby_sec).', ';

				$primary		= ContentHelperQuery::orderbyPrimary($orderby_pri);

				break;

		}

		$orderby .= $primary .' '. $secondary .' a.created DESC';



		return $orderby;

	}



	function _buildContentWhere($state = 1)

	{

		global $mainframe;



		$user		=& JFactory::getUser();

		$gid		= $user->get('aid', 0);



		$jnow		=& JFactory::getDate();

		$now			= $jnow->toMySQL();



		// Get the page/component configuration

		$params = &$mainframe->getParams();

		$noauth		= !$params->get('show_noauth');

		$nullDate	= $this->_db->getNullDate();



        $where = ' WHERE 1';



		// Does the user have access to view the items?

		if ($noauth) {

			$where .= ' AND a.access <= '.(int) $gid;

		}



		// First thing we need to do is assert that the articles are in the current category

		if ($this->_id)

		{

			$where .= ' AND a.catid = '.(int) $this->_id;

		}



		// Regular Published Content

		switch ($state)

		{

			case 1:

				if ($user->authorize('com_content', 'edit', 'content', 'all'))

				{

					$where .= ' AND a.state >= 0';

				}

				else

				{

					$where .= ' AND a.state = 1' .

							' AND ( publish_up = '.$this->_db->Quote($nullDate).' OR publish_up <= '.$this->_db->Quote($now).' )' .

							' AND ( publish_down = '.$this->_db->Quote($nullDate).' OR publish_down >= '.$this->_db->Quote($now).' )';

				}

				break;



			// Archive Content

			case -1:

				// Get some request vars specific to this state

				$year	= JRequest::getInt( 'year', date('Y') );

				$month	= JRequest::getInt( 'month', date('m') );



				$where .= ' AND a.state = -1';

				$where .= ' AND YEAR( a.created ) = '.(int) $year;

				$where .= ' AND MONTH( a.created ) = '.(int) $month;

				break;



			default:

				$where .= ' AND a.state = '.(int) $state;

				break;

		}



		/*

		 * If we have a filter, and this is enabled... lets tack the AND clause

		 * for the filter onto the WHERE clause of the content item query.

		 */

		if ($params->get('filter'))

		{

			$filter = JRequest::getString('filter', '', 'request');

			if ($filter)

			{

				// clean filter variable

				$filter = JString::strtolower($filter);

				$filter	= $this->_db->Quote( '%'.$this->_db->getEscaped( $filter, true ).'%', false );



				switch ($params->get('filter_type'))

				{

					case 'title' :

						$where .= ' AND LOWER( a.title ) LIKE '.$filter;

						break;



					case 'author' :

						$where .= ' AND ( ( LOWER( u.name ) LIKE '.$filter.' ) OR ( LOWER( a.created_by_alias ) LIKE '.$filter.' ) )';

						break;



					case 'hits' :

						$where .= ' AND a.hits LIKE '.$filter;

						break;

				}

			}

		}

		return $where;

	}

}