Commit 62154401 authored by Côme Bernigaud's avatar Côme Bernigaud Committed by Benoit Mortier
Browse files

Fixes: #2407 removed sortableListing

parent 567480e3
<?php
/*
This code is part of FusionDirectory (http://www.fusiondirectory.org/)
Copyright (C) 2003-2010 Cajus Pollmeier
Copyright (C) 2011-2013 FusionDirectory
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.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*!
* \file class_sortableListing.inc
* Source code for class sortableListing
*/
define ('LIST_NORMAL', 0);
define ('LIST_MARKED', 1);
define ('LIST_DISABLED', 2);
/*! \brief This class contains all the function needed to make list
* and management them
*/
class sortableListing {
private $header = NULL;
private $colspecs = NULL;
private $reorderable = TRUE;
private $width = "400px";
private $height = "100px";
private $cssclass = "";
private $id;
private $data = array();
private $keys = array();
private $modes = array();
private $displayData = array();
private $columns = 0;
private $deleteable = FALSE;
private $editable = FALSE;
private $colorAlternate = FALSE;
private $instantDelete = TRUE;
private $action;
private $mapping;
private $current_mapping;
private $active_index;
private $scrollPosition = 0;
private $sortColumn = 0;
private $sortDirection = array();
private $acl = "";
private $modified = FALSE;
/*!
* \brief Create a sortaleListing
*
* \param array $data
*
* \param $displayData NULL
*
* \param boolean $reorderable FALSE
*/
public function sortableListing($data = array(), $displayData = NULL, $reorderable = FALSE)
{
global $config;
// Save data to display
$this->setListData($data, $displayData);
// Get list of used IDs
if (!session::is_set('sortableListing_USED_IDS')) {
session::set('sortableListing_USED_IDS', array());
}
$usedIds = session::get('sortableListing_USED_IDS');
// Generate instance wide unique ID
$id = "";
while ($id == "" || in_array($id, $usedIds)) {
// Wait 1 msec to ensure that we definately get a new id
if ($id != "") {
usleep(1);
}
$tmp = gettimeofday();
$id = 'l'.md5(microtime().$tmp['sec']);
}
// Only keep the last 10 list IDsi
$usedIds = array_slice($usedIds, count($usedIds) - 10, 10);
$usedIds[] = $id;
session::set('sortableListing_USED_IDS', $usedIds);
$this->id = $id;
// Set reorderable flag
$this->reorderable = $reorderable;
if (!$reorderable) {
$this->sortData();
}
}
/*!
* \brief Set new reorderable value
*
* \param boolean $bool
*/
public function setReorderable($bool)
{
$this->reorderable = $bool;
}
/*!
* \brief Set a default sort column
*
* \param integer $id
*/
public function setDefaultSortColumn($id)
{
$this->sortColumn = $id;
}
/*!
* \brief Set a list data
*
* \param array $data
*
* \param array $displayData
*/
public function setListData($data, $displayData = NULL)
{
// Save data to display
$this->setData($data);
if (!$displayData) {
$displayData = array();
foreach ($data as $key => $value) {
$displayData[$key] = array("data" => array($value));
}
}
$this->setDisplayData($displayData);
}
/*!
* \brief Set a data
*
* \param array $data
*/
private function setData($data)
{
$this->data = $data;
}
/*!
* \brief Set a display data
*
* \param array $data
*/
private function setDisplayData($data)
{
if (!is_array($data)) {
trigger_error ("sortableList needs an array as data!");
}
// Transfer information
$this->displayData = array();
$this->modes = array();
$this->mapping = array();
foreach ($data as $key => $value) {
$this->displayData[] = $value['data'];
if (isset($value['mode'])) {
$this->modes[] = $value['mode'];
}
}
$this->keys = array_keys($data);
// Create initial mapping
if (count($this->keys)) {
$this->mapping = range(0, abs(count($this->keys) - 1));
}
$this->current_mapping = $this->mapping;
// Find the number of coluns
reset($this->displayData);
$first = current($this->displayData);
if (is_array($first)) {
$this->columns = count($first);
} else {
$this->columns = 1;
}
// Preset sort orders to 'down'
for ($column = 0; $column < $this->columns; $column++) {
if (!isset($this->sortDirection[$column])) {
$this->sortDirection[$column] = TRUE;
}
}
}
/*!
* \brief Set width
*
* \param string $width px
*/
public function setWidth($width)
{
$this->width = $width;
}
/*!
* \brief Set instant delete value
*
* \param boolean $flag
*/
public function setInstantDelete($flag)
{
$this->instantDelete = $flag;
}
/*!
* \brief Set color alternate value
*
* \param boolean $flag
*/
public function setColorAlternate($flag)
{
$this->colorAlternate = $flag;
}
/*!
* \brief Set editable value
*
* \param boolean $flag
*/
public function setEditable($flag)
{
$this->editable = $flag;
}
/*!
* \brief Set editable value
*
* \param boolean $flag
*/
public function setDeleteable($flag)
{
$this->deleteable = $flag;
}
/*!
* \brief Set height
*
* \param string $height px
*/
public function setHeight($height)
{
$this->height = $height;
}
/*!
* \brief Set CSS class
*
* \param string $css
*/
public function setCssClass($css)
{
$this->cssclass = $css;
}
/*!
* \brief Set header
*
* \param array $header
*/
public function setHeader($header)
{
$this->header = $header;
}
/*!
* \brief Set a colspecs
*
* \param array $specs
*/
public function setColspecs($specs)
{
$this->colspecs = $specs;
}
/*!
* \brief Render
*/
public function render()
{
$result = "<div class='sortableListContainer' id='scroll_".$this->id."' style='min-width:".$this->width.";height: ".$this->height."'>\n";
$result .= "<table cellpadding='0' style='width:100%;border-spacing:0px;border:none;' ".(!empty($this->cssclass)?" class='".$this->cssclass."'":"").">\n";
$action_width = 0;
if (strpos($this->acl, 'w') === FALSE) {
$edit_image = $this->editable?"<img class='center' src='images/lists/edit-grey.png' alt='"._("Edit")."'>":"";
} else {
$edit_image = $this->editable?"<input class='center' type='image' src='images/lists/edit.png' alt='"._("Edit")."' name='%ID' id='%ID' title='"._("Edit this entry")."'>":"";
}
if (strpos($this->acl, 'w') === FALSE) {
$delete_image = $this->deleteable?"<img class='center' src='images/lists/trash-grey.png' alt='"._("Delete")."'>":"";
} else {
$delete_image = $this->deleteable?"<input class='center' type='image' src='images/lists/trash.png' alt='"._("Delete")."' name='%ID' title='"._("Delete this entry")."'>":"";
}
// Do we need colspecs?
$action_width = ($this->editable?30:0) + ($this->deleteable?30:0);
if ($this->colspecs) {
$result .= " <colgroup>\n";
for ($i = 0; $i < $this->columns; $i++) {
if (isset($this->colspecs[$i]) && $this->colspecs[$i] != '*') {
$result .= " <col style='width:".($this->colspecs[$i])."'>\n";
} else {
$result .= " <col>\n";
}
}
// Extend by another column if we've actions specified
if ($action_width) {
$result .= " <col style='width:".$action_width."px' >\n";
}
$result .= " </colgroup>\n";
}
// Do we need a header?
if ($this->header) {
$result .= " <thead>\n <tr>\n";
$first = " style='border-left:0'";
for ($i = 0; $i < $this->columns; $i++) {
$link = "href='?plug=".$_GET['plug']."&amp;PID=".$this->id."&amp;act=SORT_$i'";
$sorter = "";
if ($i == $this->sortColumn) {
$sorter = "&nbsp;<img title='".($this->sortDirection[$i]?_("Up"):_("Down"))."'
src='images/lists/sort-".($this->sortDirection[$i]?"up":"down").".png'/>";
}
if ($this->reorderable) {
$result .= " <th$first>".(isset($this->header[$i])?$this->header[$i]:"")."</th>";
} else {
$result .= " <th$first><a $link>".(isset($this->header[$i])?$this->header[$i]:"")."</a>$sorter</th>";
}
$first = "";
}
if ($action_width) {
$result .= "<th>&nbsp;</th>";
}
$result .= "\n </tr>\n </thead>\n";
}
// Render table body if we've read permission
$result .= " <tbody id='".$this->id."'>\n";
$reorderable = $this->reorderable?"":" style='cursor:default'";
if (strpos($this->acl, 'r') !== FALSE) {
foreach ($this->mapping as $nr => $row) {
$editable = $this->editable?" onClick='$(\"edit_".$this->id."_$nr\").click()'":"";
$id = "";
if (isset($this->modes[$row])) {
switch ($this->modes[$row]) {
case LIST_DISABLED:
$id = " sortableListItemDisabled";
$editable = "";
break;
case LIST_MARKED:
$id = " sortableListItemMarked";
break;
}
}
$result .= " <tr class='sortableListItem".
((($nr & 1) || !$this->colorAlternate)?'':'Odd').
"$id' id='item_".$this->id."_$nr'$reorderable>\n";
$first = " style='border:0'";
foreach ($this->displayData[$row] as $column) {
// Do NOT use the onClick statement for columns that contain links or buttons.
if (preg_match("<.*type=.submit..*>", $column) || preg_match("<a.*href=.*>", $column)) {
$result .= " <td$first>".$column."</td>\n";
} else {
$result .= " <td$editable$first>".$column."</td>\n";
}
$first = "";
}
if ($action_width) {
$result .= "<td>".str_replace('%ID', "edit_".$this->id."_$nr", $edit_image).
str_replace('%ID', "del_".$this->id."_$nr", $delete_image)."</td>";
}
$result .= " </tr>\n";
}
}
// Add spacer
$result .= " <tr class='sortableListItemFill' style='height:100%'><td style='border:0'></td>";
$num = ($action_width?$this->columns:$this->columns - 1);
for ($i = 0; $i < $num; $i++) {
$result .= "<td class='sortableListItemFill'></td>";
}
$result .= "</tr>\n";
$result .= " </tbody>\n</table>\n</div>\n";
$result .= " <input type='hidden' name='position_".$this->id."' id='position_".$this->id."'>\n";
$result .= " <input type='hidden' name='reorder_".$this->id."' id='reorder_".$this->id."'>\n";
// Append script stuff if needed
$result .= '<script type="text/javascript">';
if ($this->reorderable) {
$result .= ' function updateOrder(){';
$result .= ' var ampcharcode= \'%26\';';
$result .= ' var serializeOpts = Sortable.serialize(\''.$this->id.'\')+"='.$this->id.'";';
$result .= ' $("reorder_'.$this->id.'").value= serializeOpts;';
$result .= ' document.mainform.submit();';
$result .= ' }';
$result .= 'Position.includeScrollOffsets = true;';
$result .= ' Sortable.create(\''.$this->id.'\',{tag:\'tr\', ghosting:false, constraint:\'vertical\', scroll:\'scroll_'.$this->id.'\',onUpdate : updateOrder});';
}
$result .= '$("scroll_'.$this->id.'").scrollTop= '.$this->scrollPosition.';';
$result .= 'var box = $("scroll_'.$this->id.'").onscroll= function() {$("position_'.$this->id.'").value= this.scrollTop;}';
$result .= '</script>';
return $result;
}
/*!
* \brief Update sortableListing
*/
public function update()
{
// Filter GET with "act" attributes
if (!$this->reorderable) {
if (isset($_GET['act']) && isset($_GET['PID']) && $this->id == $_GET['PID']) {
$key = validate($_GET['act']);
if (preg_match('/^SORT_([0-9]+)$/', $key, $match)) {
// Switch to new column or invert search order?
$column = $match[1];
if ($this->sortColumn != $column) {
$this->sortColumn = $column;
} else {
$this->sortDirection[$column] = !$this->sortDirection[$column];
}
}
}
// Update mapping according to sort parameters
$this->sortData();
}
}
/*!
* \brief Save an object
*/
public function save_object()
{
// Do not do anything if this is not our PID, or there's even no PID available...
if (isset($_REQUEST['PID']) && $_REQUEST['PID'] != $this->id) {
return;
}
// Do not do anything if we're not posted - or have no permission
if (strpos($this->acl, 'w') !== FALSE && isset($_POST['reorder_'.$this->id])) {
if (isset($_POST['position_'.$this->id]) && is_numeric($_POST['position_'.$this->id])) {
$this->scrollPosition = $_POST['position_'.$this->id];
}
// Move requested?
$move = $_POST['reorder_'.$this->id];
if ($move != "") {
preg_match_all('/=([0-9]+)[&=]/', $move, $matches);
$this->action = "reorder";
$tmp = array();
foreach ($matches[1] as $id => $row) {
$tmp[$id] = $this->mapping[$row];
}
$this->mapping = $tmp;
$this->current_mapping = $matches[1];
$this->modified = TRUE;
return;
}
}
// Delete requested?
$this->action = "";
if (strpos($this->acl, 'd') !== FALSE) {
foreach ($_POST as $key => $value) {
if (preg_match('/^del_'.$this->id.'_([0-9]+)_x$/', $key, $matches)) {
$this->active_index = $this->mapping[$matches[1]];
// Ignore request if mode requests it
if (isset($this->modes[$this->active_index]) && $this->modes[$this->active_index] == LIST_DISABLED) {
$this->active_index = NULL;
continue;
}
// Set action
$this->action = "delete";
// Remove value if requested
if ($this->instantDelete) {
$this->deleteEntry($this->active_index);
}
}
}
}
// Edit requested?
if (strpos($this->acl, 'w') !== FALSE) {
foreach ($_POST as $key => $value) {
if (preg_match('/^edit_'.$this->id.'_([0-9]+)_x$/', $key, $matches)) {
$this->active_index = $this->mapping[$matches[1]];
// Ignore request if mode requests it
if (isset($this->modes[$this->active_index]) && $this->modes[$this->active_index] == LIST_DISABLED) {
$this->active_index = NULL;
continue;
}
$this->action = "edit";
}
}
}
}
/*!
* \brief Get action
*/
public function getAction()
{
// Do not do anything if we're not posted
if (!isset($_POST['reorder_'.$this->id])) {
return;
}
// For reordering, return current mapping
if ($this->action == 'reorder') {
return array("targets" => $this->current_mapping, "mapping" => $this->mapping, "action" => $this->action);
}
// Edit and delete
$result = array("targets" => array($this->active_index), "action" => $this->action);
return $result;
}
/*!
* \brief Delete an entry
*
* \param $id Entry identifier
*/
private function deleteEntry($id)
{
// Remove mapping
$index = array_search($id, $this->mapping);
if ($index !== FALSE) {
unset($this->mapping[$index]);
$this->mapping = array_values($this->mapping);
$this->modified = TRUE;
}
}
/*!
* \brief GEt maintained data
*/
public function getMaintainedData()
{
$tmp = array();
foreach ($this->mapping as $src => $dst) {
$realKey = $this->keys[$dst];
$tmp[$realKey] = $this->data[$realKey];
}
return $tmp;
}
/*!
* \brief Chech if is modified
*
* \return TRUE if is modified, return FALSE otherwise
*/
public function isModified()
{
return $this->modified;
}
/*!
* \brief Set a acl value
*
* \param string $acl
*/
public function setAcl($acl)
{
$this->acl = $acl;
}
/*!
* \brief Sort the data
*/
public function sortData()
{
if (!count($this->data)) return;
// Extract data