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
)
76 $this->table
= $table;
77 $this->idfield
= $idfield;
78 $this->sortfield
= $idfield;
79 $this->idfield_editable
= $editid;
80 $this->whereclause
= '1';
81 $r = XDB
::iterator("SHOW FULL COLUMNS FROM $table");
82 $this->vars
= array();
83 while ($a = $r->next()) {
84 // desc will be the title of the column
85 $a['desc'] = $a['Field'];
88 if (substr($a['Type'],0,8) == 'varchar(') {
89 // limit editing box size
90 $a['Size'] = $a['Maxlength'] = substr($a['Type'], 8, strlen($a['Type']) - 9);
91 if ($a['Size'] > 40) $a['Size'] = 40;
92 // if too big, put a textarea
93 $a['Type'] = ($a['Maxlength']<200)?
'varchar':'varchar200';
95 elseif ($a['Type'] == 'text' ||
$a['Type'] == 'mediumtext')
96 $a['Type'] = 'textarea';
97 elseif (substr($a['Type'],0,4) == 'set(') {
98 // get the list of options
99 $a['List'] = explode('§',str_replace("','","§",substr($a['Type'], 5, strlen($a['Type']) - 7)));
100 if (count($a['List']) == 1) {
101 $a['Type'] = 'checkbox';
102 $a['Value'] = $a['List'][0];
107 elseif (substr($a['Type'],0,5) == 'enum(') {
108 // get the list of options
109 $a['List'] = explode('§',str_replace("','","§",substr($a['Type'], 6, strlen($a['Type']) - 8)));
112 elseif (substr($a['Type'],0,10) == 'timestamp(' ||
$a['Type'] == 'datetime') {
113 $a['Type'] = 'timestamp';
115 elseif ($a['Comment'] == 'ip_address') {
116 $a['Type']='ip_address';
119 $this->vars
[$a['Field']] = $a;
121 $this->vars
[$idfield]['desc'] = 'id';
124 // called before creating a new entry
125 private function prepare_new()
128 foreach ($this->vars
as $field => $descr) {
129 $entry[$field] = $descr['Default'];
131 return $this->prepare_edit($entry);
134 // called before editing $entry
135 private function prepare_edit(&$entry)
137 foreach ($this->vars
as $field => $descr) {
138 if ($descr['Type'] == 'set') {
139 // get the list of options selected
140 $selected = explode(',', $entry[$field]);
141 $entry[$field] = array();
142 foreach ($selected as $option)
143 $entry[$field][$option] = 1;
145 if ($descr['Type'] == 'timestamp') {
146 // set readable timestamp
147 $date =& $entry[$field];
148 $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);
150 if ($descr['Type'] == 'date') {
151 $date =& $entry[$field];
152 $date = preg_replace('/([0-9]{4})-?([0-9]{2})-?([0-9]{2})/', '\3/\2/\1', $date);
154 if ($descr['Type'] == 'ip_address') {
155 $ip = & $entry[$field];
162 // set whether the save button show redirect to list view or edit view
163 public function list_on_edit($var)
165 $this->auto_return
= $var;
168 // change display of a field
169 public function describe($name, $desc, $display)
171 $this->vars
[$name]['desc'] = $desc;
172 $this->vars
[$name]['display'] = $display;
175 // add a join table, when deleting a row corresponding entries will be deleted in these tables
176 public function add_join_table($name,$joinid,$joindel,$joinextra="")
179 $this->jtables
[$name] = array("joinid" => $joinid,"joinextra" => $joinextra?
(" AND ".$joinextra):"");
182 /** Add optional table
183 * @see add_option_field
184 * @param $name the table sql name
185 * @param $jointclause the full joint clause. Use t as main table alias
188 public function add_option_table($name, $jointclause)
190 $this->otables
[$name] = $jointclause;
193 /** Add optional field
194 * These fields are used to display additionnal infos in listing (and only
195 * there). The additionnal infos are retreived from other tables.
196 * @param $sqlname is the full sql name (table.field) where table must be
197 * added with add_option_table
198 * @param $name the name used for sort (please make it different from
199 * other fields in main table or subtables)
200 * @param $desc the description displayed as column header
201 * @param $type the typed used for display
203 public function add_option_field($sqlname, $name, $desc, $type = null
, $nextvar = null
)
205 $this->ofields
[$sqlname] = array($name, $desc, $type, $nextvar);
209 public function add_sort_field($key, $desc = false
, $default = false
)
212 $this->sortfield
= $key . ($desc ?
' DESC' : '');
214 $this->sort
[] = $key . ($desc ?
' DESC' : '');
218 // add a where clause to limit table listing
219 public function set_where_clause($whereclause="1")
221 $this->whereclause
= $whereclause;
224 // set an action when trying to delete row
225 public function on_delete($action = NULL
, $message = NULL
)
227 $this->delete_action
= $action;
228 $this->delete_message
= $message;
232 public function apply(PlPage
&$page, $action, $id = false
)
234 $page->coreTpl('table-editor.tpl');
236 if ($action == 'delete' && $id !== false
) {
237 S
::assert_xsrf_token();
239 if (!isset($this->delete_action
)) {
240 foreach ($this->jtables
as $table => $j)
241 XDB
::execute("DELETE FROM {$table} WHERE {$j['joinid']} = {?}{$j['joinextra']}", $id);
242 XDB
::execute("DELETE FROM {$this->table} WHERE {$this->idfield} = {?}",$id);
243 $page->trigSuccess("L'entrée ".$id." a été supprimée.");
244 } else if ($this->delete_action
) {
245 XDB
::execute($this->delete_action
, $id);
246 if (isset($this->delete_message
)) {
247 $page->trigSuccess($this->delete_message
);
249 $page->trigSuccess("L'entrée ".$id." a été supprimée.");
252 $page->trigError("Impossible de supprimer l'entrée.");
255 if ($action == 'edit' && $id !== false
) {
256 $r = XDB
::query("SELECT * FROM {$this->table} WHERE {$this->idfield} = {?} AND {$this->whereclause}",$id);
257 $entry = $r->fetchOneAssoc();
258 $page->assign('entry', $this->prepare_edit($entry));
259 $page->assign('id', $id);
262 if ($action == 'massadd') {
263 $importer = new CSVImporter($this->table
, $this->idfield_editable ?
$this->idfield
: null
);
265 foreach ($this->vars
as $field=>$descr) {
266 if ($this->idfield_editable ||
$field != $this->idfield
) {
268 $importer->describe($field, @$descr['desc']);
271 $page->assign('massadd', true
);
272 $importer->apply($page, $this->pl
. '/massadd', $fields);
275 if ($action == 'new') {
276 if (!$this->idfield_editable
) {
277 $page->assign('entry', $this->prepare_new());
281 if ($action == 'update') {
282 S
::assert_xsrf_token();
286 foreach ($this->vars
as $field => $descr) {
287 if ($values) $values .= ',';
288 if (($field == $this->idfield
) && !$this->idfield_editable
) {
289 if ($id === false ||
$id === null
) {
290 $val = "'".addslashes(XDB
::fetchOneCell("SELECT MAX( {$field} ) + 1 FROM {$this->table}"))."'";
292 $val = "'".addslashes($id)."'";
294 } elseif ($descr['Type'] == 'set') {
296 if (Post
::has($field)) foreach (Post
::v($field) as $option) {
297 if ($val) $val .= ',';
300 $val = "'".addslashes($val)."'";
301 } elseif ($descr['Type'] == 'checkbox') {
302 $val = Post
::has($field)?
"'".addslashes($descr['Value'])."'":"''";
303 } elseif (Post
::has($field)) {
304 $val = Post
::v($field);
305 if ($descr['Type'] == 'timestamp') {
306 $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);
308 elseif ($descr['Type'] == 'date') {
309 $val = preg_replace('/([0-9]{1,2})\/([0-9]{1,2})\/([0-9]{4})/', '\3-\2-\1', $val);
311 elseif ($descr['Type'] == 'ip_address') {
312 $val = ip2long($val);
314 $val = "'".addslashes($val)."'";
317 $page->trigError("Il manque le champ ".$field);
322 if ($this->idfield_editable
&& $id != Post
::v($this->idfield
))
323 XDB
::execute("UPDATE {$this->table} SET {$this->idfield} = {?} WHERE {$this->idfield} = {?} AND {$this->whereclause}", Post
::v($this->idfield
), $id);
324 XDB
::execute("REPLACE INTO {$this->table} VALUES ($values)");
325 if ($id !== false
&& $id !== null
) {
326 $page->trigSuccess("L'entrée ".$id." a été mise à jour.");
328 $page->trigSuccess("Une nouvelle entrée a été créée.");
329 $id = XDB
::insertId();
332 $page->trigError("Impossible de mettre à jour.");
333 if (!$this->auto_return
) {
334 return $this->apply($page, 'edit', $id);
337 if ($action == 'sort') {
338 $this->sortfield
= $id;
340 if ($action == 'sortdesc') {
341 $this->sortfield
= $id.' DESC';
344 // user can sort by field by clicking the title of the column
345 if (isset($this->sortfield
)) {
346 // add this sort order after the others (chosen by dev)
347 $this->add_sort_field($this->sortfield
);
348 if (substr($this->sortfield
,-5) == ' DESC') {
349 $this->sortfield
= substr($this->sortfield
,0,-5);
350 $this->sortdesc
= true
;
353 if (count($this->sort
) > 0) {
354 $sort = 'ORDER BY ' . join($this->sort
, ',');
356 // optional infos columns
357 $optional_fields = '';
358 if (count($this->ofields
)) {
360 foreach ($this->vars
as $i => $aliasname) {
361 $order[sprintf('%f',count($order))] = $i;
363 // delta for indexing optional columns between existing ones
365 foreach ($this->ofields
as $sqlname => $ofieldvalues) {
366 list($aliasname, $desc, $type, $nextvar) = $ofieldvalues;
367 $optional_fields .= ', '.$sqlname.' AS '.$aliasname;
368 $this->describe($aliasname, $desc, true
);
369 $this->vars
[$aliasname]['optional'] = true
;
371 $this->vars
[$aliasname]['Type'] = $type;
373 if (isset($nextvar) && isset($this->vars
[$nextvar]) && $nextvar != $aliasname) {
374 $nextkey = array_search($nextvar, $order);
375 $order[sprintf('%f',$nextkey - $changeorder)] = $aliasname;
376 $changeorder = $changeorder / 2;
378 $order[sprintf('%f',count($order))] = $aliasname;
380 $this->vars
[$aliasname]['Field'] = $aliasname;
382 if ($changeorder != 0.5) {
384 $orderedvars = array();
385 foreach ($order as $aliasname) {
386 $orderedvars[$aliasname] = $this->vars
[$aliasname];
388 $this->vars
= $orderedvars;
391 $optional_joints = '';
392 foreach ($this->otables
as $tablename => $jointclause) {
393 $optional_joints .= ' LEFT JOIN '.$tablename.' ON ('.$jointclause.')';
395 $it = XDB
::iterator("SELECT t.* {$optional_fields} FROM {$this->table} AS t {$optional_joints} WHERE {$this->whereclause} $sort");
397 foreach ($this->vars
as $field => $descr)
398 if ($descr['display']) $this->nbfields++
;
399 $page->assign('list', $it);
401 $page->assign('t', $this);
405 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: