2 /***************************************************************************
3 * Copyright (C) 2003-2010 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
24 // the plat/al name of the page
28 // joint tables to delete when deleting an entry
29 public $jtables = array();
30 /** joint tables to add optional infos
31 * associative array : keys are the tables names, values are the joint
33 * @see add_option_fields
35 public $otables = array();
37 * These fields are used to display additionnal infos in listing (an only
38 * there). The additionnal infos are retreived from other tables. This var
39 * is an associative array : keys are the sql name of the fields
40 * (table.field) where table must be in $otables, values are a list of the
41 * name used in $vars, the description and the type of the field, and the
42 * var it should precede.
44 public $ofields = array();
46 public $sort = array();
49 // possibility to edit the field
50 public $idfield_editable;
53 // number of displayed fields
55 // a where clause to restrict table
57 // the field for sorting entries
59 public $sortdesc = false
;
60 // action to do to delete row:
61 // null => delete effectively, false => no deletion, SQL
62 public $delete_action;
63 public $delete_message;
64 // Should "Save" button return to the list view
65 public $auto_return = true
;
67 /* table editor for platal
68 * $plname : the PLname of the page, ex: admin/payments
69 * $table : the table to edit, ex: profile_medals
70 * $idfield : the field of the table which is the id, ex: id
71 * $editid : is the id editable or not (if not, it is considered as an int)
73 public function __construct($plname, $table, $idfield, $editid = false
, $idfield2 = false
)
76 $this->table
= $table;
77 $this->idfield
= $idfield;
78 $this->idfield2
= $idfield2;
79 $this->sortfield
= $idfield;
80 $this->idfield_editable
= $editid;
81 $this->whereclause
= '1';
82 $r = XDB
::iterator("SHOW FULL COLUMNS FROM $table");
83 $this->vars
= array();
84 while ($a = $r->next()) {
85 // desc will be the title of the column
86 $a['desc'] = $a['Field'];
89 if (substr($a['Type'],0,8) == 'varchar(') {
90 // limit editing box size
91 $a['Size'] = $a['Maxlength'] = substr($a['Type'], 8, strlen($a['Type']) - 9);
92 if ($a['Size'] > 40) $a['Size'] = 40;
93 // if too big, put a textarea
94 $a['Type'] = ($a['Maxlength']<200)?
'varchar':'varchar200';
96 elseif ($a['Type'] == 'text' ||
$a['Type'] == 'mediumtext')
97 $a['Type'] = 'textarea';
98 elseif (substr($a['Type'],0,4) == 'set(') {
99 // get the list of options
100 $a['List'] = explode('§',str_replace("','","§",substr($a['Type'], 5, strlen($a['Type']) - 7)));
101 if (count($a['List']) == 1) {
102 $a['Type'] = 'checkbox';
103 $a['Value'] = $a['List'][0];
108 elseif (substr($a['Type'],0,5) == 'enum(') {
109 // get the list of options
110 $a['List'] = explode('§',str_replace("','","§",substr($a['Type'], 6, strlen($a['Type']) - 8)));
113 elseif (substr($a['Type'],0,10) == 'timestamp(' ||
$a['Type'] == 'datetime') {
114 $a['Type'] = 'timestamp';
116 elseif ($a['Comment'] == 'ip_address') {
117 $a['Type']='ip_address';
120 $this->vars
[$a['Field']] = $a;
122 $this->vars
[$idfield]['desc'] = 'id';
125 // called before creating a new entry
126 private function prepare_new()
129 foreach ($this->vars
as $field => $descr) {
130 $entry[$field] = $descr['Default'];
132 return $this->prepare_edit($entry);
135 // called before editing $entry
136 private function prepare_edit(&$entry)
138 foreach ($this->vars
as $field => $descr) {
139 if ($descr['Type'] == 'set') {
140 // get the list of options selected
141 $selected = explode(',', $entry[$field]);
142 $entry[$field] = array();
143 foreach ($selected as $option)
144 $entry[$field][$option] = 1;
146 if ($descr['Type'] == 'timestamp') {
147 // set readable timestamp
148 $date =& $entry[$field];
149 $date = preg_replace('/([0-9]{4})([0-9]{2})([0-9]{2})([0-9]{2})([0-9]{2})([0-9]{2})/', '\3/\2/\1 \4:\5:\6', $date);
151 if ($descr['Type'] == 'date') {
152 $date =& $entry[$field];
153 $date = preg_replace('/([0-9]{4})-?([0-9]{2})-?([0-9]{2})/', '\3/\2/\1', $date);
155 if ($descr['Type'] == 'ip_address') {
156 $ip = & $entry[$field];
163 // set whether the save button show redirect to list view or edit view
164 public function list_on_edit($var)
166 $this->auto_return
= $var;
169 // change display of a field
170 public function describe($name, $desc, $display)
172 $this->vars
[$name]['desc'] = $desc;
173 $this->vars
[$name]['display'] = $display;
176 // add a join table, when deleting a row corresponding entries will be deleted in these tables
177 public function add_join_table($name,$joinid,$joindel,$joinextra="")
180 $this->jtables
[$name] = array("joinid" => $joinid,"joinextra" => $joinextra?
(" AND ".$joinextra):"");
183 /** Add optional table
184 * @see add_option_field
185 * @param $name the table sql name
186 * @param $jointclause the full joint clause. Use t as main table alias
189 public function add_option_table($name, $jointclause)
191 $this->otables
[$name] = $jointclause;
194 /** Add optional field
195 * These fields are used to display additionnal infos in listing (and only
196 * there). The additionnal infos are retreived from other tables.
197 * @param $sqlname is the full sql name (table.field) where table must be
198 * added with add_option_table
199 * @param $name the name used for sort (please make it different from
200 * other fields in main table or subtables)
201 * @param $desc the description displayed as column header
202 * @param $type the typed used for display
204 public function add_option_field($sqlname, $name, $desc, $type = null
, $nextvar = null
)
206 $this->ofields
[$sqlname] = array($name, $desc, $type, $nextvar);
210 public function add_sort_field($key, $desc = false
, $default = false
)
213 $this->sortfield
= $key . ($desc ?
' DESC' : '');
215 $this->sort
[] = $key . ($desc ?
' DESC' : '');
219 // add a where clause to limit table listing
220 public function set_where_clause($whereclause="1")
222 $this->whereclause
= $whereclause;
225 // set an action when trying to delete row
226 public function on_delete($action = NULL
, $message = NULL
)
228 $this->delete_action
= $action;
229 $this->delete_message
= $message;
233 public function apply(PlPage
&$page, $action, $id = false
, $id2 = false
)
235 $page->coreTpl('table-editor.tpl');
237 if ($action == 'delete' && $id !== false
) {
238 S
::assert_xsrf_token();
240 if (!isset($this->delete_action
)) {
241 foreach ($this->jtables
as $table => $j)
242 XDB
::execute("DELETE FROM {$table} WHERE {$j['joinid']} = {?}{$j['joinextra']}", $id);
243 $where = XDB
::format("{$this->idfield} = {?}", $id);
244 if ($this->idfield2
) {
245 $where .= XDB
::format(" AND {$this->idfield2} = {?}", $id2);
247 XDB
::rawExecute("DELETE FROM {$this->table} WHERE " . $where);
248 $page->trigSuccess("L'entrée " . $id . (($id2) ?
'-' . $id2 : '') . ' a été supprimée.');
249 } else if ($this->delete_action
) {
250 XDB
::execute($this->delete_action
, $id);
251 if (isset($this->delete_message
)) {
252 $page->trigSuccess($this->delete_message
);
254 $page->trigSuccess("L'entrée ".$id." a été supprimée.");
257 $page->trigError("Impossible de supprimer l'entrée.");
260 if ($action == 'edit' && $id !== false
) {
261 $r = XDB
::query("SELECT * FROM {$this->table} WHERE {$this->idfield} = {?} AND {$this->whereclause}",$id);
262 $entry = $r->fetchOneAssoc();
263 $page->assign('entry', $this->prepare_edit($entry));
264 $page->assign('id', $id);
267 if ($action == 'massadd') {
268 $importer = new CSVImporter($this->table
, $this->idfield_editable ?
$this->idfield
: null
);
270 foreach ($this->vars
as $field=>$descr) {
271 if ($this->idfield_editable ||
$field != $this->idfield
) {
273 $importer->describe($field, @$descr['desc']);
276 $page->assign('massadd', true
);
277 $importer->apply($page, $this->pl
. '/massadd', $fields);
280 if ($action == 'new') {
281 if (!$this->idfield_editable
) {
282 $page->assign('entry', $this->prepare_new());
286 if ($action == 'update') {
287 S
::assert_xsrf_token();
292 foreach ($this->vars
as $field => $descr) {
294 $new = ($id === false ||
$id === null
);
295 if ($field == $this->idfield
&& !$this->idfield_editable
) {
297 $val = XDB
::fetchOneCell("SELECT MAX({$field}) + 1
298 FROM {$this->table}");
302 } elseif ($descr['Type'] == 'set') {
303 $val = new PlFlagset();
304 if (Post
::has($field)) {
305 foreach (Post
::v($field) as $option) {
306 $val->addFlag($option);
309 } elseif ($descr['Type'] == 'checkbox') {
310 $val = Post
::has($field)?
$descr['Value'] : "";
311 } elseif (Post
::has($field)) {
312 $val = Post
::v($field);
313 if ($descr['Type'] == 'timestamp') {
314 $val = preg_replace('/([0-9]{1,2})\/([0-9]{1,2})\/([0-9]{4}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})/', '\3\2\1\4\5\6', $val);
315 } else if ($descr['Type'] == 'date') {
316 $val = preg_replace('/([0-9]{1,2})\/([0-9]{1,2})\/([0-9]{4})/', '\3-\2-\1', $val);
317 } elseif ($descr['Type'] == 'ip_address') {
318 $val = ip2long($val);
322 $page->trigError("Il manque le champ ".$field);
324 $values[$field] = XDB
::escape($val);
329 foreach ($values as $field => $value) {
330 $update[] = $field . ' = ' . $value;
332 $update = implode(', ', $update);
333 XDB
::rawExecute("UPDATE {$this->table}
335 WHERE {$this->idfield} = " . XDB
::escape($id) . "
336 AND {$this->whereclause}");
338 $fields = implode(', ', array_keys($values));
339 $values = implode(', ', $values);
340 XDB
::rawExecute("INSERT INTO {$this->table} ({$fields})
341 VALUES ({$values})");
343 if ($id !== false
&& $id !== null
) {
344 $page->trigSuccess("L'entrée ".$id." a été mise à jour.");
346 $page->trigSuccess("Une nouvelle entrée a été créée.");
347 $id = XDB
::insertId();
350 $page->trigError("Impossible de mettre à jour.");
352 if (!$this->auto_return
) {
353 return $this->apply($page, 'edit', $id);
356 if ($action == 'sort') {
357 $this->sortfield
= $id;
359 if ($action == 'sortdesc') {
360 $this->sortfield
= $id.' DESC';
363 // user can sort by field by clicking the title of the column
364 if (isset($this->sortfield
)) {
365 // add this sort order after the others (chosen by dev)
366 $this->add_sort_field($this->sortfield
);
367 if (substr($this->sortfield
,-5) == ' DESC') {
368 $this->sortfield
= substr($this->sortfield
,0,-5);
369 $this->sortdesc
= true
;
372 if (count($this->sort
) > 0) {
373 $sort = 'ORDER BY ' . join($this->sort
, ',');
375 // optional infos columns
376 $optional_fields = '';
377 if (count($this->ofields
)) {
379 foreach ($this->vars
as $i => $aliasname) {
380 $order[sprintf('%f',count($order))] = $i;
382 // delta for indexing optional columns between existing ones
384 foreach ($this->ofields
as $sqlname => $ofieldvalues) {
385 list($aliasname, $desc, $type, $nextvar) = $ofieldvalues;
386 $optional_fields .= ', '.$sqlname.' AS '.$aliasname;
387 $this->describe($aliasname, $desc, true
);
388 $this->vars
[$aliasname]['optional'] = true
;
390 $this->vars
[$aliasname]['Type'] = $type;
392 if (isset($nextvar) && isset($this->vars
[$nextvar]) && $nextvar != $aliasname) {
393 $nextkey = array_search($nextvar, $order);
394 $order[sprintf('%f',$nextkey - $changeorder)] = $aliasname;
395 $changeorder = $changeorder / 2;
397 $order[sprintf('%f',count($order))] = $aliasname;
399 $this->vars
[$aliasname]['Field'] = $aliasname;
401 if ($changeorder != 0.5) {
403 $orderedvars = array();
404 foreach ($order as $aliasname) {
405 $orderedvars[$aliasname] = $this->vars
[$aliasname];
407 $this->vars
= $orderedvars;
410 $optional_joints = '';
411 foreach ($this->otables
as $tablename => $jointclause) {
412 $optional_joints .= ' LEFT JOIN '.$tablename.' ON ('.$jointclause.')';
414 $it = XDB
::iterator("SELECT t.* {$optional_fields} FROM {$this->table} AS t {$optional_joints} WHERE {$this->whereclause} $sort");
416 foreach ($this->vars
as $field => $descr)
417 if ($descr['display']) $this->nbfields++
;
418 $page->assign('list', $it);
420 $page->assign('t', $this);
424 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: