<?php

/*
==============================================================================
	Dokeos - elearning and course management software

	Copyright (c) 2005 Dokeos S.A.
	Copyright (c) Bart Mollet (bart.mollet@hogent.be)

	For a full list of contributors, see "credits.txt".
	The full license can be read in "license.txt".

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; either version 2
	of the License, or (at your option) any later version.

	See the GNU General Public License for more details.

	Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium
	Mail: info@dokeos.com
==============================================================================
*/
require_once "HTML/Table.php"; //See http://pear.php.net/package/HTML_Table
require_once "Pager/Pager.php"; //See http://pear.php.net/package/Pager
require_once 'tablesort.lib.php';
/**
 * This class allows you to display a sortable data-table. It is possible to
 * split the data in several pages.
 * Using this class you can:
 * - automatically create checkboxes of the first table column
 *     - a "select all" and "deselect all" link is added
 *     - only if you provide a list of actions for the selected items
 * - click on the table header to sort the data
 * - choose how many items you see per page
 * - navigate through all data-pages
 */
class SortableTable extends HTML_Table
{
	/**
	 * A name for this table
	 */
	var $table_name;
	/**
	 * The page to display
	 */
	var $page_nr;
	/**
	 * The column to sort the data
	 */
	var $column;
	/**
	 * The sorting direction (ASC or DESC)
	 */
	var $direction;
	/**
	 * Number of items to display per page
	 */
	var $per_page;
	/**
	 * The default number of items to display per page
	 */
	var $default_items_per_page;
	/**
	 * A prefix for the URL-parameters, can be used on pages with multiple
	 * SortableTables
	 */
	var $param_prefix;
	/**
	 * The pager object to split the data in several pages
	 */
	var $pager;
	/**
	 * The total number of items in the table
	 */
	var $total_number_of_items;
	/**
	 * The function to get the total number of items
	 */
	var $get_total_number_function;
	/**
	 * The function to the the data to display
	 */
	var $get_data_function;
	/**
	 * An array with defined column-filters
	 */
	var $column_filters;
	/**
	 * A list of actions which will be available through a select list
	 */
	var $form_actions;
	/**
	 * Additional parameters to pass in the URL
	 */
	var $additional_parameters;
	/**
	 * Additional attributes for the th-tags
	 */
	var $th_attributes;
	/**
	 * Additional attributes for the td-tags
	 */
	var $td_attributes;
	/**
	 * Array with names of the other tables defined on the same page of this
	 * table
	 */
	var $other_tables;
	/**
	 * Create a new SortableTable
	 * @param string $table_name A name for the table (default = 'table')
	 * @param string $get_total_number_function A user defined function to get
	 * the total number of items in the table
	 * @param string $get_data_function A function to get the data to display on
	 * the current page
	 * @param int $default_column The default column on which the data should be
	 * sorted
	 * @param int $default_items_per_page The default number of items to show
	 * on one page
	 * @param string $default_order_direction The default order direction;
	 * either the constant 'ASC' or 'DESC'
	 */
	function SortableTable($table_name = 'table', $get_total_number_function = null, $get_data_function = null, $default_column = 1, $default_items_per_page = 20, $default_order_direction = 'ASC')
	{
		parent :: HTML_Table(array ('class' => 'data_table'));
		$this->table_name = $table_name;
		$this->additional_parameters = array ();
		$this->param_prefix = $table_name.'_';
		$this->page_nr = isset ($_SESSION[$this->param_prefix.'page_nr']) ? $_SESSION[$this->param_prefix.'page_nr'] : 1;
		$this->page_nr = isset ($_GET[$this->param_prefix.'page_nr']) ? $_GET[$this->param_prefix.'page_nr'] : $this->page_nr;
		$this->column = isset ($_SESSION[$this->param_prefix.'column']) ? $_SESSION[$this->param_prefix.'column'] : $default_column;
		$this->column = isset ($_GET[$this->param_prefix.'column']) ? $_GET[$this->param_prefix.'column'] : $this->column;
		$this->direction = isset ($_SESSION[$this->param_prefix.'direction']) ? $_SESSION[$this->param_prefix.'direction'] : $default_order_direction;
		$this->direction = isset ($_GET[$this->param_prefix.'direction']) ? $_GET[$this->param_prefix.'direction'] : $this->direction;
		$this->per_page = isset ($_SESSION[$this->param_prefix.'per_page']) ? $_SESSION[$this->param_prefix.'per_page'] : $default_items_per_page;
		$this->per_page = isset ($_GET[$this->param_prefix.'per_page']) ? $_GET[$this->param_prefix.'per_page'] : $this->per_page;
		$_SESSION[$this->param_prefix.'per_page'] = $this->per_page;
		$_SESSION[$this->param_prefix.'direction'] = $this->direction ;
		$_SESSION[$this->param_prefix.'page_nr'] = $this->page_nr;
		$_SESSION[$this->param_prefix.'column'] = $this->column;
		$this->pager = null;
		$this->default_items_per_page = $default_items_per_page;
		$this->total_number_of_items = -1;
		$this->get_total_number_function = $get_total_number_function;
		$this->get_data_function = $get_data_function;
		$this->column_filters = array ();
		$this->form_actions = array ();
		$this->checkbox_name = null;
		$this->td_attributes = array ();
		$this->th_attributes = array ();
		$this->other_tables = array();
	}
	/**
	 * Get the Pager object to split the showed data in several pages
	 */
	function get_pager()
	{
		if (is_null($this->pager))
		{
			$total_number_of_items = $this->get_total_number_of_items();
			$params['mode'] = 'Sliding';
			$params['perPage'] = $this->per_page;
			$params['totalItems'] = $total_number_of_items;
			$params['urlVar'] = $this->param_prefix.'page_nr';
			$params['currentPage'] = $this->page_nr;
			$params['prevImg'] = '<img src="'.api_get_path(WEB_CODE_PATH).'img/prev.png"  style="vertical-align: middle;"/>';
			$params['nextImg'] = '<img src="'.api_get_path(WEB_CODE_PATH).'img/next.png"  style="vertical-align: middle;"/>';
			$params['firstPageText'] = '<img src="'.api_get_path(WEB_CODE_PATH).'img/first.png"  style="vertical-align: middle;"/>';
			$params['lastPageText'] = '<img src="'.api_get_path(WEB_CODE_PATH).'img/last.png"  style="vertical-align: middle;"/>';
			$params['firstPagePre'] = '';
			$params['lastPagePre'] = '';
			$params['firstPagePost'] = '';
			$params['lastPagePost'] = '';
			$params['spacesBeforeSeparator'] = '';
			$params['spacesAfterSeparator'] = '';
			$query_vars = array_keys($_GET);
			$query_vars_needed = array ($this->param_prefix.'column', $this->param_prefix.'direction', $this->param_prefix.'per_page');
			if (count($this->additional_parameters) > 0)
			{
				$query_vars_needed = array_merge($query_vars_needed, array_keys($this->additional_parameters));
			}
			$query_vars_exclude = array_diff($query_vars, $query_vars_needed);
			$params['excludeVars'] = $query_vars_exclude;
			$this->pager = & Pager :: factory($params);
		}
		return $this->pager;
	}
	/**
	 * Displays the table, complete with navigation buttons to browse through
	 * the data-pages.
	 */
	function display()
	{
		$empty_table = false;
		if ($this->get_total_number_of_items() == 0)
		{
			$cols = $this->getColCount();
			$this->setCellAttributes(1, 0, 'style="font-style: italic;text-align:center;" colspan='.$cols);
			$this->setCellContents(1, 0, get_lang('TheListIsEmpty'));
			$empty_table = true;
		}
		if (!$empty_table)
		{
			$form = $this->get_page_select_form();
			$nav = $this->get_navigation_html();
			$html = '<table style="width:100%;">';
			$html .= '<tr>';
			$html .= '<td style="width:25%;">';
			$html .= $form;
			$html .= '</td>';
			$html .= '<td style="text-align:center;">';
			$html .= $this->get_table_title();
			$html .= '</td>';
			$html .= '<td style="text-align:right;width:25%;">';
			$html .= $nav;
			$html .= '</td>';
			$html .= '</tr>';
			$html .= '</table>';
			if (count($this->form_actions) > 0)
			{
				$html .= '<script language="JavaScript" type="text/javascript">
																/*<![CDATA[*/
																function setCheckbox(value) {
													 				d = document.form_'.$this->table_name.';
													 				for (i = 0; i < d.elements.length; i++) {
													   					if (d.elements[i].type == "checkbox") {
																		     d.elements[i].checked = value;
													   					}
													 				}
																}
																/*]]>*/
															</script>';
				$params = $this->get_sortable_table_param_string.'&amp;'.$this->get_additional_url_paramstring();

				$html .= '<form method="post" action="'.$_SERVER['PHP_SELF'].'?'.$params.'" name="form_'.$this->table_name.'">';
			}
		}
		$html .= $this->get_table_html();
		if (!$empty_table)
		{
			$html .= '<table style="width:100%;">';
			$html .= '<tr>';
			$html .= '<td colspan="2">';
			if (count($this->form_actions) > 0)
			{
				$html .= '<a href="?'.$params.'&amp;'.$this->param_prefix.'selectall=1" onclick="javascript:setCheckbox(true);return false;">'.get_lang('SelectAll').'</a> - ';
				$html .= '<a href="?'.$params.'" onclick="javascript:setCheckbox(false);return false;">'.get_lang('UnSelectAll').'</a> ';
				$html .= '<select name="action">';
				foreach ($this->form_actions as $action => $label)
				{
					$html .= '<option value="'.$action.'">'.$label.'</option>';
				}
				$html .= '</select>';
				$html .= '<input type="submit" value="'.get_lang('Ok').'" onclick="javascript:if(!confirm('."'".addslashes(htmlentities(get_lang("ConfirmYourChoice")))."'".')) return false;"/>';
			}
			else
			{
				$html .= $form;
			}
			$html .= '</td>';
			$html .= '<td style="text-align:right;">';
			$html .= $nav;
			$html .= '</td>';
			$html .= '</tr>';
			$html .= '</table>';
			if (count($this->form_actions) > 0)
			{
				$html .= '</form>';
			}
		}
		echo $html;
	}
	/**
	 * Get the HTML-code with the navigational buttons to browse through the
	 * data-pages.
	 */
	function get_navigation_html()
	{
		$pager = $this->get_pager();
		$pager_links = $pager->getLinks();
		$showed_items = $pager->getOffsetByPageId();
		$nav = $pager_links['first'].' '.$pager_links['back'];
		$nav .= ' '.$pager->getCurrentPageId().' / '.$pager->numPages().' ';
		$nav .= $pager_links['next'].' '.$pager_links['last'];
		return $nav;
	}
	/**
	 * Get the HTML-code with the data-table.
	 */
	function get_table_html()
	{
		$pager = $this->get_pager();
		$offset = $pager->getOffsetByPageId();
		$from = $offset[0] - 1;
		$table_data = $this->get_table_data($from);
		foreach ($table_data as $index => $row)
		{
			$row = $this->filter_data($row);
			$this->addRow($row);
		}
		$this->altRowAttributes(0, array ('class' => 'row_odd'), array ('class' => 'row_even'), true);
		foreach ($this->th_attributes as $column => $attributes)
		{
			$this->setCellAttributes(0, $column, $attributes);
		}
		foreach ($this->td_attributes as $column => $attributes)
		{
			$this->setColAttributes($column, $attributes);
		}
		return $this->toHTML();
	}
	/**
	 * Get the HTML-code wich represents a form to select how many items a page
	 * should contain.
	 */
	function get_page_select_form()
	{
		$total_number_of_items = $this->get_total_number_of_items();
		if ($total_number_of_items <= $this->default_items_per_page)
		{
			return '';
		}
		$result[] = '<form method="get" action="'.$_SERVER['PHP_SELF'].'" style="display:inline;">';
		$param[$this->param_prefix.'direction'] = $this->direction;
		$param[$this->param_prefix.'page_nr'] = $this->page_nr;
		$param[$this->param_prefix.'column'] = $this->column;
		$param = array_merge($param, $this->additional_parameters);
		foreach ($param as $key => $value)
		{
			$result[] = '<input type="hidden" name="'.$key.'" value="'.$value.'"/>';
		}
		$result[] = '<select name="'.$this->param_prefix.'per_page" onchange="javascript:this.form.submit();">';
		for ($nr = 10; $nr <= min(50, $total_number_of_items); $nr += 10)
		{
			$result[] = '<option value="'.$nr.'" '. ($nr == $this->per_page ? 'selected="selected"' : '').'>'.$nr.'</option>';
		}
		if ($total_number_of_items < 500)
		{
			$result[] = '<option value="'.$total_number_of_items.'" '. ($total_number_of_items == $this->per_page ? 'selected="selected"' : '').'>ALL</option>';
		}
		$result[] = '</select>';
		$result[] = '<noscript>';
		$result[] = '<input type="submit" value="ok"/>';
		$result[] = '</noscript>';
		$result[] = '</form>';
		$result = implode("\n", $result);
		return $result;
	}
	/**
	 * Get the table title.
	 */
	function get_table_title()
	{
		$pager = $this->get_pager();
		$showed_items = $pager->getOffsetByPageId();
		return $showed_items[0].' - '.$showed_items[1].' / '.$this->get_total_number_of_items();
	}
	/**
	 * Set the header-label
	 * @param int $column The column number
	 * @param string $label The label
	 * @param boolean $sortable Is the table sortable by this column? (defatult
	 * = true)
	 * @param string $th_attributes Additional attributes for the th-tag of the
	 * table header
	 * @param string $td_attributes Additional attributes for the td-tags of the
	 * column
	 */
	function set_header($column, $label, $sortable = true, $th_attributes = null, $td_attributes = null)
	{
		$param['direction'] = 'ASC';
		if ($this->column == $column && $this->direction == 'ASC')
		{
			$param['direction'] = 'DESC';
		}
		$param['page_nr'] = $this->page_nr;
		$param['per_page'] = $this->per_page;
		$param['column'] = $column;
		if ($sortable)
		{
			$link = '<a href="'.$_SERVER['PHP_SELF'].'?';
			foreach ($param as $key => $value)
			{
				$link .= $this->param_prefix.$key.'='.urlencode($value).'&amp;';
			}
			$link .= $this->get_additional_url_paramstring();
			$link .= '">'.$label.'</a>';
			if ($this->column == $column)
			{
				$link .= $this->direction == 'ASC' ? ' &#8595;' : ' &#8593;';
			}
		}
		else
		{
			$link = $label;
		}
		$this->setHeaderContents(0, $column, $link);
		if (!is_null($td_attributes))
		{
			$this->td_attributes[$column] = $td_attributes;
		}
		if (!is_null($th_attributes))
		{
			$this->th_attributes[$column] = $th_attributes;
		}
	}
	/**
	 * Get the parameter-string with additional parameters to use in the URLs
	 * generated by this SortableTable
	 */
	function get_additional_url_paramstring()
	{
		$param_string_parts = array ();
		foreach ($this->additional_parameters as $key => $value)
		{
			$param_string_parts[] = urlencode($key).'='.urlencode($value);
		}
		$result = implode('&amp;', $param_string_parts);
		foreach($this->other_tables as $index => $tablename)
		{
			if( isset($_GET[$tablename.'_direction']))
				$param[$tablename.'_direction'] = $_GET[$tablename.'_direction'];
			if( isset($_GET[$tablename.'_page_nr']))
				$param[$tablename.'_page_nr'] = $_GET[$tablename.'_page_nr'];
			if( isset($_GET[$tablename.'_per_page']))
				$param[$tablename.'_per_page'] = $_GET[$tablename.'_per_page'];
			if( isset($_GET[$tablename.'_column']))
				$param[$tablename.'_column'] = $_GET[$tablename.'_column'];
			$param_string_parts = array ();
			foreach ($param as $key => $value)
			{
				$param_string_parts[] = urlencode($key).'='.urlencode($value);
			}
			if(count($param_string_parts) > 0)
				$result .= '&amp;'.implode('&amp;', $param_string_parts);
		}
		return $result;
	}
	/**
	 * Get the parameter-string with the SortableTable-related parameters to use
	 * in URLs
	 */
	function get_sortable_table_param_string()
	{
		$param[$this->param_prefix.'direction'] = $this->direction;
		$param[$this->param_prefix.'page_nr'] = $this->page_nr;
		$param[$this->param_prefix.'per_page'] = $this->per_page;
		$param[$this->param_prefix.'column'] = $this->column;
		$param_string_parts = array ();
		foreach ($param as $key => $value)
		{
			$param_string_parts[] = urlencode($key).'='.urlencode($value);
		}
		$res = implode('&amp;', $param_string_parts);
		return $res;

	}
	/**
	 * Add a filter to a column. If another filter was allready defined for the
	 * given column, it will be overwritten.
	 * @param int $column The number of the column
	 * @param string $function The name of the filter-function. This should be a
	 * function wich requires 1 parameter and returns the filtered value.
	 */
	function set_column_filter($column, $function)
	{
		$this->column_filters[$column] = $function;
	}
	/**
	 * Define a list of actions which can be performed on the table-date.
	 * If you define a list of actions, the first column of the table will be
	 * converted into checkboxes.
	 * @param array $actions A list of actions. The key is the name of the
	 * action. The value is the label to show in the select-box
	 * @param string $checkbox_name The name of the generated checkboxes. The
	 * value of the checkbox will be the value of the first column.
	 */
	function set_form_actions($actions, $checkbox_name = 'id')
	{
		$this->form_actions = $actions;
		$this->checkbox_name = $checkbox_name;
	}
	/**
	 * Define a list of additional parameters to use in the generated URLs
	 * @param array $parameters
	 */
	function set_additional_parameters($parameters)
	{
		$this->additional_parameters = $parameters;
	}
	/**
	 * Set other tables on the same page.
	 * If you have other sortable tables on the page displaying this sortable
	 * tables, you can define those other tables with this function. If you
	 * don't define the other tables, there sorting and pagination will return
	 * to their default state when sorting this table.
	 * @param array $tablenames An array of table names.
	 */
	function set_other_tables($tablenames)
	{
		$this->other_tables = $tablenames;
	}
	/**
	 * Transform all data in a table-row, using the filters defined by the
	 * function set_column_filter(...) defined elsewhere in this class.
	 * If you've defined actions, the first element of the given row will be
	 * converted into a checkbox
	 * @param array $row A row from the table.
	 */
	function filter_data($row)
	{
		$url_params = $this->get_sortable_table_param_string().'&amp;'.$this->get_additional_url_paramstring();
		foreach ($this->column_filters as $column => $function)
		{
			$row[$column] = call_user_func($function, $row[$column], $url_params, $row);
		}
		if (count($this->form_actions) > 0)
		{
			if (strlen($row[0]) > 0)
			{
				$row[0] = '<input type="checkbox" name="'.$this->checkbox_name.'[]" value="'.$row[0].'"';
				if (isset ($_GET[$this->param_prefix.'selectall']))
				{
					$row[0] .= ' checked="checked"';
				}
				$row[0] .= '/>';
			}
		}
		foreach ($row as $index => $value)
		{
			if (strlen($row[$index]) == 0)
			{
				$row[$index] = '-';
			}
		}
		return $row;
	}
	/**
	 * Get the total number of items. This function calls the function given as
	 * 2nd argument in the constructor of a SortableTable. Make sure your
	 * function has the same parameters as defined here.
	 */
	function get_total_number_of_items()
	{
		if ($this->total_number_of_items == -1 && !is_null($this->get_total_number_function))
		{
			$this->total_number_of_items = call_user_func($this->get_total_number_function);
		}
		return $this->total_number_of_items;
	}
	/**
	 * Get the data to display.  This function calls the function given as
	 * 2nd argument in the constructor of a SortableTable. Make sure your
	 * function has the same parameters as defined here.
	 * @param int $from Index of the first item to return.
	 * @param int $per_page The number of items to return
	 * @param int $column The number of the column on which the data should be
	 * sorted
	 * @param string $direction In which order should the data be sorted (ASC
	 * or DESC)
	 */
	function get_table_data($from = null, $per_page = null, $column = null, $direction = null)
	{
		if (!is_null($this->get_data_function))
		{
			return call_user_func($this->get_data_function, $from, $this->per_page, $this->column, $this->direction);
		}
		return array ();
	}
}
/**
 * Sortable table which can be used for data available in an array
 */
class SortableTableFromArray extends SortableTable
{
	/**
	 * The array containing all data for this table
	 */
	var $table_data;
	/**
	 * Constructor
	 * @param array $table_data
	 * @param int $default_column
	 * @param int $default_items_per_page
	 */
	function SortableTableFromArray($table_data, $default_column = 1, $default_items_per_page = 20, $tablename = 'tablename')
	{
		parent :: SortableTable($tablename, null, null, $default_column, $default_items_per_page);
		$this->table_data = $table_data;
	}
	/**
	 * Get table data to show on current page
	 * @see SortableTable#get_table_data
	 */
	function get_table_data($from = 1)
	{
		$content = TableSort :: sort_table($this->table_data, $this->column, $this->direction == 'ASC' ? SORT_ASC : SORT_DESC);
		return array_slice($content, $from, $this->per_page);
	}
	/**
	 * Get total number of items
	 * @see SortableTable#get_total_number_of_items
	 */
	function get_total_number_of_items()
	{
		return count($this->table_data);
	}
}
?>