2 /**********************************************************************
3 Copyright (C) FrontAccounting, LLC.
4 Released under the terms of the GNU General Public License, GPL,
5 as published by the Free Software Foundation, either version 3
6 of the License, or (at your option) any later version.
7 This program is distributed in the hope that it will be useful,
8 but WITHOUT ANY WARRANTY; without even the implied warranty of
9 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10 See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
13 Retrieve value of POST variable(s).
14 For $name passed as array $dflt is not used,
15 default values can be passed as values with non-numeric keys instead.
16 If some field have user formatted numeric value, pass float default value to
17 convert automatically to POSIX.
19 function get_post($name, $dflt='')
21 if (is_array($name)) {
23 foreach($name as $key => $dflt)
24 if (!is_numeric($key)) {
25 $ret[$key] = is_float($dflt) ? input_num($key, $dflt) : get_post($key, $dflt);
27 $ret[$dflt] = get_post($dflt, null);
31 return is_float($dflt) ? input_num($name, $dflt) :
32 ((!isset($_POST[$name]) || $_POST[$name] === '') ? $dflt : $_POST[$name]);
34 //---------------------------------------------------------------------------------
36 function start_form($multi=false, $dummy=false, $action="", $name="")
38 // $dummy - leaved for compatibility with 2.0 API
41 $name = "name='$name'";
43 $action = $_SERVER['PHP_SELF'];
46 echo "<form enctype='multipart/form-data' method='post' action='$action' $name>\n";
48 echo "<form method='post' action='$action' $name>\n";
52 //---------------------------------------------------------------------------------
54 function end_form($breaks=0)
58 $_SESSION['csrf_token'] = hash('sha256', uniqid(mt_rand(), true));
62 hidden('_modified', get_post('_modified', 0));
63 hidden('_token', $_SESSION['csrf_token']);
65 $Ajax->activate('_token');
68 function check_csrf_token()
70 if ($_SESSION['csrf_token'] != @$_POST['_token'])
72 display_error(_("Request from outside of this page is forbidden."));
73 error_log(_("CSRF attack detected from: ").@$_SERVER['HTTP_HOST'].' ('.@$_SERVER['HTTP_REFERER'].')');
79 function start_table($class=false, $extra="", $padding='2', $spacing='0')
81 echo "<center><table";
82 if ($class == TABLESTYLE_NOBORDER)
83 echo " class='tablestyle_noborder'";
84 elseif ($class == TABLESTYLE2)
85 echo " class='tablestyle2'";
86 elseif ($class == TABLESTYLE)
87 echo " class='tablestyle'";
90 echo " cellpadding=$padding cellspacing=$spacing>\n";
93 function end_table($breaks=0)
95 echo "</table></center>\n";
100 function start_outer_table($class=false, $extra="", $padding='2', $spacing='0', $br=false)
104 start_table($class, $extra, $padding, $spacing);
105 echo "<tr valign=top><td>\n"; // outer table
108 function table_section($number=1, $width=false)
113 $width = ($width ? "width=$width" : "");
114 //echo "</td><td class='tableseparator' $width>\n"; // outer table
115 echo "</td><td style='border-left:1px solid #cccccc;' $width>\n"; // outer table
117 echo "<table class='tablestyle_inner'>\n";
120 function end_outer_table($breaks=0, $close_table=true)
128 // outer table spacer
130 function vertical_space($params='')
132 echo "</td></tr><tr><td valign=center $params>";
135 function meta_forward($forward_to, $params="")
138 echo "<meta http-equiv='Refresh' content='0; url=$forward_to?$params'>\n";
139 echo "<center><br>" . _("You should automatically be forwarded.");
140 echo " " . _("If this does not happen") . " " . "<a href='$forward_to?$params'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
141 if ($params !='') $params = '?'.$params;
142 $Ajax->redirect($forward_to.$params);
146 //-----------------------------------------------------------------------------------
147 // Find and replace hotkey marker.
148 // if $clean == true marker is removed and clean label is returned
149 // (for use in wiki help system), otherwise result is array of label
150 // with underlined hotkey letter and access property string.
152 function access_string($label, $clean=false)
157 if (preg_match('/(.*)&([a-zA-Z0-9])(.*)/', $label, $slices))
159 $label = $clean ? $slices[1].$slices[2].$slices[3] :
160 $slices[1].'<u>'.$slices[2].'</u>'.$slices[3];
161 $access = " accesskey='".strtoupper($slices[2])."'";
164 $label = str_replace( '&&', '&', $label);
166 return $clean ? $label : array($label, $access);
169 function hyperlink_back($center=true, $no_menu=true, $type_no=0, $trans_no=0, $final=false)
171 global $path_to_root;
176 if ($no_menu && $trans_no != 0)
178 include_once($path_to_root."/admin/db/attachments_db.inc");
179 $id = has_attachment($type_no, $trans_no);
180 $attach = get_attachment_string($type_no, $trans_no);
183 $width = ($id != 0 ? "30%" : "20%");
184 start_table(false, "width=$width");
188 echo "<td align=center><a href='javascript:window.print();'>"._("Print")."</a></td>\n";
190 echo "<td align=center><a href='javascript:goBack(".($final ? '-2' : '').");'>".($no_menu ? _("Close") : _("Back"))."</a></td>\n";
198 function hyperlink_no_params($target, $label, $center=true)
200 $id = default_focus();
201 $pars = access_string($label);
203 $target = $_SERVER['PHP_SELF'];
206 echo "<a href='$target' id='$id' $pars[1]>$pars[0]</a>\n";
211 function hyperlink_no_params_td($target, $label)
214 hyperlink_no_params($target, $label);
218 function viewer_link($label, $url='', $class='', $id='', $icon=null)
220 global $path_to_root;
223 $class = " class='$class'";
226 $class = " id='$id'";
230 $pars = access_string($label);
231 if (user_graphic_links() && $icon)
232 $pars[0] = set_icon($icon, $pars[0]);
233 $preview_str = "<a target='_blank' $class $id href='$path_to_root/$url' onclick=\"javascript:openWindow(this.href,this.target); return false;\"$pars[1]>$pars[0]</a>";
236 $preview_str = $label;
240 function menu_link($url, $label, $id=null)
243 $id = default_focus($id);
244 $pars = access_string($label);
245 return "<a href='$url' class='menu_option' id='$id' $pars[1]>$pars[0]</a>";
248 function submenu_option($title, $url, $id=null)
250 global $path_to_root;
251 display_note(menu_link($path_to_root . $url, $title, $id), 0, 1);
254 function submenu_view($title, $type, $number, $id=null)
256 display_note(get_trans_view_str($type, $number, $title, false, 'viewlink', $id), 0, 1);
259 function submenu_print($title, $type, $number, $id=null, $email=0, $extra=0)
261 display_note(print_document_link($number, $title, true, $type, false, 'printlink', $id, $email, $extra), 0, 1);
263 //-----------------------------------------------------------------------------------
265 function hyperlink_params($target, $label, $params, $center=true)
267 $id = default_focus();
269 $pars = access_string($label);
271 $target = $_SERVER['PHP_SELF'];
274 echo "<a id='$id' href='$target?$params'$pars[1]>$pars[0]</a>\n";
279 function hyperlink_params_td($target, $label, $params)
282 hyperlink_params($target, $label, $params, false);
286 //-----------------------------------------------------------------------------------
288 function hyperlink_params_separate($target, $label, $params, $center=false)
290 $id = default_focus();
292 $pars = access_string($label);
295 echo "<a target='_blank' id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
300 function hyperlink_params_separate_td($target, $label, $params)
303 hyperlink_params_separate($target, $label, $params);
307 //--------------------------------------------------------------------------------------------------
309 function alt_table_row_color(&$k, $extra_class=null)
311 $classes = $extra_class ? array($extra_class) : array();
314 array_push($classes, 'oddrow');
319 array_push($classes, 'evenrow');
322 echo "<tr class='".implode(' ', $classes)."'>\n";
325 function table_section_title($msg, $colspan=2)
327 echo "<tr><td colspan=$colspan class='tableheader'>$msg</td></tr>\n";
330 function table_header($labels, $params='')
333 foreach ($labels as $label)
334 labelheader_cell($label, $params);
337 //-----------------------------------------------------------------------------------
339 function start_row($param="")
342 echo "<tr $param>\n";
354 for ($i = 0; $i < $num; $i++)
358 $ajax_divs = array();
360 function div_start($id='', $trigger=null, $non_ajax=false)
364 if ($non_ajax) { // div for non-ajax elements
365 array_push($ajax_divs, array($id, null));
366 echo "<div style='display:none' class='js_only' ".($id !='' ? "id='$id'" : '').">";
367 } else { // ajax ready div
368 array_push($ajax_divs, array($id, $trigger===null ? $id : $trigger));
369 echo "<div ". ($id !='' ? "id='$id'" : '').">";
376 global $ajax_divs, $Ajax;
378 if (count($ajax_divs))
380 $div = array_pop($ajax_divs);
381 if ($div[1] !== null)
382 $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
387 //-----------------------------------------------------------------------------
389 // $name - prefix for widget internal elements:
390 // Nth tab submit name: {$name}_N
391 // div id: _{$name}_div
392 // sel (hidden) name: _{$name}_sel
393 // $tabs - array of tabs; string: tab title or array(tab_title, enabled_status)
395 function tabbed_content_start($name, $tabs, $dft='') {
398 $selname = '_'.$name.'_sel';
399 $div = '_'.$name.'_div';
401 $sel = find_submit($name.'_', false);
403 $sel = get_post($selname, (string)($dft==='' ? key($tabs) : $dft));
405 if ($sel!==@$_POST[$selname])
406 $Ajax->activate($name);
408 $_POST[$selname] = $sel;
411 $str = "<ul class='ajaxtabs' rel='$div'>\n";
412 foreach($tabs as $tab_no => $tab) {
414 $acc = access_string(is_array($tab) ? $tab[0] : $tab);
415 $disabled = (is_array($tab) && !$tab[1]) ? 'disabled ' : '';
417 ."<button type='submit' name='{$name}_".$tab_no
418 ."' class='".((string)$tab_no===$sel ? 'current':'ajaxbutton')."' $acc[1] $disabled>"
419 ."<span>$acc[0]</span>"
425 $str .= "<div class='spaceBox'></div>\n";
426 $str .= "<input type='hidden' name='$selname' value='$sel'>\n";
427 $str .= "<div class='contentBox' id='$div'>\n";
431 function tabbed_content_end() {
432 echo "</div>"; // content box (don't change to div_end() unless div_start() is used above)
433 div_end(); // tabs widget
436 function tab_changed($name)
438 $to = find_submit("{$name}_", false);
439 if (!$to) return null;
441 return array('from' => $from = get_post("_{$name}_sel"),
445 /* Table editor interfaces. Key is editor type
446 0 => url of editor page
450 $popup_editors = array(
451 'customer' => array('/sales/manage/customers.php?debtor_no=',
452 113, _("Customers"), 900, 500),
453 'branch' => array('/sales/manage/customer_branches.php?SelectedBranch=',
454 114, _("Branches"), 900, 700),
455 'supplier' => array('/purchasing/manage/suppliers.php?supplier_id=',
456 113, _("Suppliers"), 900, 700),
457 'item' => array('/inventory/manage/items.php?stock_id=',
458 115, _("Items"), 800, 600)
461 Bind editors for various selectors.
462 $type - type of editor
463 $input - name of related input field
464 $caller - optional function key code (available values F1-F12: 112-123,
467 function set_editor($type, $input, $caller=true)
469 global $path_to_root, $Editors, $popup_editors, $Pagehelp;
471 $key = $caller===true ? $popup_editors[$type][1] : $caller;
473 $Editors[$key] = array( $path_to_root . $popup_editors[$type][0], $input,
474 $popup_editors[$type][3], $popup_editors[$type][4]);
476 $help = 'F' . ($key - 111) . ' - ';
477 $help .= $popup_editors[$type][2];
480 //------------------------------------------------------------------------------
481 // Procedures below are now obsolete. Preserved for eventual future use.
484 External page call with saving current context.
485 $call - url of external page
486 $ctx - optional. name of SESSION context object or array of names of POST
487 variables saved on call
489 function context_call($call, $ctx='')
493 foreach($ctx as $postname)
495 $context[$postname] = get_post($postname);
498 $context = isset($_SESSION[$ctx]) ? $_SESSION[$ctx] : null;
500 array_unshift($_SESSION['Context'], array('name' => $ctx,
502 'caller' => $_SERVER['PHP_SELF'],
507 Restores context after external page call and
508 returns array of data passed by external page.
510 function context_restore()
512 if ( count($_SESSION['Context'])) {
513 if ($_SERVER['PHP_SELF'] == $_SESSION['Context'][0]['caller']) {
514 $ctx = array_shift($_SESSION['Context']);
516 if (is_array($ctx['ctx'])) {
517 foreach($ctx['ctx'] as $name => $val)
519 $_POST[$name] = $val;
522 if ($ctx['name']!='')
523 $_SESSION[$ctx['name']] = $ctx['ctx'];
532 Return to caller page if the page was called from external context.
534 function context_return($ret)
536 if ( count($_SESSION['Context'])) {
537 $ctx = &$_SESSION['Context'][0];
539 meta_forward( $ctx['caller'] );
543 Clearing context stack after page cancel.
545 function context_reset()
547 $_SESSION['Context'] = array();
550 Context stack initialization
552 if (!isset($_SESSION['Context'])) {
556 Redirector for selector F4 calls.
557 $sel_editors is array of selname=>editor_page
559 function editor_redirect($sel_editors, $save_fun='') {
560 foreach ($sel_editors as $selname=>$editor)
561 if (isset($_POST['_'.$selname.'_editor'])) {
562 if (function_exists($save_fun))
564 unset($_POST['_'.$selname.'_editor']);
565 context_call($editor, array_keys($_POST));
569 Return procedure for selector F4 calls
571 function editor_return($vars, $restore_fun='') {
572 if (function_exists($restore_fun))
575 if ($ret = context_restore()) {
576 foreach ($vars as $postname=>$retname)
577 if (isset($ret[$retname])) {
578 $_POST[$postname] = $ret[$retname];
579 set_focus($postname);
584 function confirm_dialog($submit, $msg) {
585 if (find_post($submit)) {
586 display_warning($msg);
588 submit_center_first('DialogConfirm', _("Proceed"), '', true);
589 submit_center_last('DialogCancel', _("Cancel"), '', 'cancel');
592 return get_post('DialogConfirm', 0);
596 Block menu/shortcut links during transaction procesing.
598 function page_processing($msg = false)
603 $msg = _('Entered data has not been saved yet.\nDo you want to abandon changes?');
605 $js = "_validate._processing=" . (
606 $msg ? '\''.strtr($msg, array("\n"=>'\\n')) . '\';' : 'null;');
608 $Ajax->addScript(true, $js);
613 function page_modified($status = true)
617 $js = "_validate._modified=" . ($status ? 1:0).';';
619 $Ajax->addScript(true, $js);