includes/ui/ui_controls.inc

   1 <?php
   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 ***********************************************************************/
  12 /*
  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.
  18 */
  19 function get_post($name, $dflt='')
  20 {
  21         if (is_array($name)) {
  22                 $ret = array();
  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);
  26                         } else {
  27                                 $ret[$dflt] = get_post($dflt, null);
  28                         }
  29                 return $ret;
  30         } else
  31                 return is_float($dflt) ? input_num($name, $dflt) :
  32                                 ((!isset($_POST[$name]) /*|| $_POST[$name] === ''*/) ? $dflt : $_POST[$name]);
  33 }
  34 //---------------------------------------------------------------------------------
  35 $form_nested = -1;
  36
  37 function start_form($multi=false, $dummy=false, $action="", $name="")
  38 {
  39         // $dummy - leaved for compatibility with 2.0 API
  40         global $form_nested;
  41
  42         if (++$form_nested) return;
  43
  44         if ($name != "")
  45                 $name = "name='$name'";
  46         if ($action == "")
  47                 $action = $_SERVER['PHP_SELF'];
  48
  49         if ($multi)
  50                 echo "<form enctype='multipart/form-data' method='post' action='$action' $name>\n";
  51         else
  52                 echo "<form method='post' action='$action' $name>\n";
  53
  54 }
  55
  56 /*
  57         Flush hidden fields buffer.
  58 */
  59 function output_hidden()
  60 {
  61         global $hidden_fields;
  62
  63         if (is_array($hidden_fields))
  64                 echo implode('', $hidden_fields);
  65         $hidden_fields = array();
  66 }
  67 //---------------------------------------------------------------------------------
  68
  69 function end_form($breaks=0)
  70 {
  71         global $Ajax, $form_nested, $hidden_fields;
  72
  73         if ($form_nested-- > 0) return;
  74
  75         $_SESSION['csrf_token'] = hash('sha256', uniqid(mt_rand(), true));
  76         if ($breaks)
  77                 br($breaks);
  78         hidden('_focus');
  79         hidden('_modified', get_post('_modified', 0));
  80         hidden('_confirmed'); // helper for final form confirmation
  81         hidden('_token', $_SESSION['csrf_token']);
  82
  83         output_hidden();
  84         echo "</form>\n";
  85         $Ajax->activate('_token');
  86         $Ajax->activate('_confirmed');
  87 }
  88
  89 function check_csrf_token()
  90 {
  91         if ($_SESSION['csrf_token'] != @$_POST['_token'])
  92         {
  93                 display_error(_("Request from outside of this page is forbidden."));
  94                 error_log(_("CSRF attack detected from: ").@$_SERVER['HTTP_HOST'].' ('.@$_SERVER['HTTP_REFERER'].')');
  95                 return false;
  96         }
  97         return true;
  98 }
  99
 100 function start_table($class=false, $extra="", $padding='2', $spacing='0')
 101 {
 102         echo "<center><table";
 103         if ($class == TABLESTYLE_NOBORDER)
 104                 echo " class='tablestyle_noborder'";
 105         elseif ($class == TABLESTYLE2)
 106                 echo " class='tablestyle2'";
 107         elseif ($class == TABLESTYLE)
 108                 echo " class='tablestyle'";
 109         if ($extra != "")
 110                 echo " $extra";
 111         echo " cellpadding='$padding' cellspacing='$spacing'>\n";
 112 }
 113
 114 function end_table($breaks=0)
 115 {
 116         echo "</table></center>\n";
 117         output_hidden();
 118         if ($breaks)
 119                 br($breaks);
 120 }
 121
 122 function start_outer_table($class=false, $extra="", $padding='2', $spacing='0', $br=false)
 123 {
 124         if ($br)
 125                 br();
 126         start_table($class, $extra, $padding, $spacing);
 127         echo "<tr valign=top><td>\n"; // outer table
 128 }
 129
 130 function table_section($number=1, $width=false)
 131 {
 132         if ($number > 1)
 133         {
 134                 echo "</table>\n";
 135                 output_hidden();
 136                 $width = ($width ? "width='$width'" : "");
 137                 //echo "</td><td class='tableseparator' $width>\n"; // outer table
 138                 echo "</td><td style='border-left:1px solid #cccccc;' $width>\n"; // outer table
 139         }
 140         echo "<table class='tablestyle_inner'>\n";
 141 }
 142
 143 function end_outer_table($breaks=0, $close_table=true)
 144 {
 145         if ($close_table)
 146         {
 147                 echo "</table>\n";
 148                 output_hidden();
 149         }
 150         echo "</td></tr>\n";
 151         end_table($breaks);
 152 }
 153 //
 154 //  outer table spacer
 155 //
 156 function vertical_space($params='')
 157 {
 158         echo "</td></tr><tr><td valign=center $params>";
 159 }
 160
 161 function meta_forward($forward_to, $params="", $timeout=0)
 162 {
 163     global $Ajax;
 164         echo "<meta http-equiv='Refresh' content='".$timeout."; url=$forward_to?$params'>\n";
 165         echo "<center><br>" . _("You should automatically be forwarded.");
 166         echo " " . _("If this does not happen") . " " . "<a href='$forward_to?$params'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
 167         if ($params !='') $params = '?'.$params;
 168         $Ajax->redirect($forward_to.$params);
 169         exit;
 170 }
 171
 172 //-----------------------------------------------------------------------------------
 173 // Find and replace hotkey marker.
 174 // if $clean == true marker is removed and clean label is returned
 175 // (for use in wiki help system), otherwise result is array of label
 176 // with underlined hotkey letter and access property string.
 177 //
 178 function access_string($label, $clean=false)
 179 {
 180         $access = '';
 181         $slices = array();
 182
 183         if (preg_match('/(.*)&([a-zA-Z0-9])(.*)/', $label, $slices))
 184         {
 185                 $label = $clean ? $slices[1].$slices[2].$slices[3] :
 186                         $slices[1].'<u>'.$slices[2].'</u>'.$slices[3];
 187                 $access = " accesskey='".strtoupper($slices[2])."'";
 188         }
 189
 190         $label = str_replace( '&&', '&', $label);
 191
 192         return $clean ? $label : array($label, $access);
 193 }
 194
 195 function hyperlink_back($center=true, $no_menu=true, $type_no=0, $trans_no=0, $final=false)
 196 {
 197         global $path_to_root;
 198
 199         if ($center)
 200                 echo "<center>";
 201         $id = 0;
 202         if ($no_menu && $trans_no != 0)
 203         {
 204                 include_once($path_to_root."/admin/db/attachments_db.inc");
 205                 $id = has_attachment($type_no, $trans_no);
 206                 $attach = get_attachment_string($type_no, $trans_no);
 207         echo $attach;
 208         }
 209         $width = ($id != 0 ? "30%" : "20%");
 210         start_table(false, "width='$width'");
 211         start_row();
 212         if ($no_menu)
 213         {
 214                 echo "<td align=center><a href='javascript:window.print();'>"._("Print")."</a></td>\n";
 215         }
 216         echo "<td align=center><a href='javascript:goBack(".($final ? '-2' : '').");'>".($no_menu ? _("Close") : _("Back"))."</a></td>\n";
 217         end_row();
 218         end_table();
 219         if ($center)
 220                 echo "</center>";
 221         echo "<br>";
 222 }
 223
 224 function hyperlink_no_params($target, $label, $center=true)
 225 {
 226         $id = default_focus();
 227         $pars = access_string($label);
 228         if ($target == '')
 229                 $target = $_SERVER['PHP_SELF'];
 230         if ($center)
 231                 echo "<br><center>";
 232         echo "<a href='$target' id='$id' $pars[1]>$pars[0]</a>\n";
 233         if ($center)
 234                 echo "</center>";
 235 }
 236
 237 function hyperlink_no_params_td($target, $label)
 238 {
 239         echo "<td>";
 240         hyperlink_no_params($target, $label);
 241         echo "</td>\n";
 242 }
 243
 244 function viewer_link($label, $url='', $class='', $id='',  $icon=null)
 245 {
 246         global $path_to_root;
 247
 248         if ($class != '')
 249                 $class = " class='$class'";
 250
 251         if ($id != '')
 252                 $class = " id='$id'";
 253
 254         if ($url != "")
 255         {
 256                 $pars = access_string($label);
 257                 if (user_graphic_links() && $icon)
 258                         $pars[0] = set_icon($icon, $pars[0]);
 259 -               $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>";
 260         }
 261         else
 262                 $preview_str = $label;
 263  return $preview_str;
 264 }
 265
 266 function menu_link($url, $label, $id=null)
 267 {
 268         $id = default_focus($id);
 269         $pars = access_string($label);
 270         return "<a href='$url' class='menu_option' id='$id' $pars[1]>$pars[0]</a>";
 271 }
 272
 273 function submenu_option($title, $url, $id=null)
 274 {
 275         display_note( menu_link($url, $title, $id), 0, 1);
 276 }
 277
 278 function submenu_view($title, $type, $number, $id=null)
 279 {
 280         display_note(get_trans_view_str($type, $number, $title, false, 'viewlink', $id), 0, 1);
 281 }
 282
 283 function submenu_print($title, $type, $number, $id=null, $email=0, $extra=0)
 284 {
 285         display_note(print_document_link($number, $title, true, $type, false, 'printlink', $id, $email, $extra), 0, 1);
 286 }
 287 //-----------------------------------------------------------------------------------
 288
 289 function hyperlink_params($target, $label, $params, $center=true)
 290 {
 291         $id = default_focus();
 292
 293         $pars = access_string($label);
 294         if ($target == '')
 295                 $target = $_SERVER['PHP_SELF'];
 296         if ($center)
 297                 echo "<br><center>";
 298         echo "<a id='$id' href='$target?$params'$pars[1]>$pars[0]</a>\n";
 299         if ($center)
 300                 echo "</center>";
 301 }
 302
 303 function hyperlink_params_td($target, $label, $params)
 304 {
 305         echo "<td>";
 306         hyperlink_params($target, $label, $params, false);
 307         echo "</td>\n";
 308 }
 309
 310 //-----------------------------------------------------------------------------------
 311
 312 function hyperlink_params_separate($target, $label, $params, $center=false)
 313 {
 314         $id = default_focus();
 315
 316         $pars = access_string($label);
 317         if ($center)
 318                 echo "<br><center>";
 319         echo "<a target='_blank' id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
 320         if ($center)
 321                 echo "</center>";
 322 }
 323
 324 function hyperlink_params_separate_td($target, $label, $params)
 325 {
 326         echo "<td>";
 327         hyperlink_params_separate($target, $label, $params);
 328         echo "</td>\n";
 329 }
 330
 331 //--------------------------------------------------------------------------------------------------
 332
 333 function alt_table_row_color(&$k, $extra_class=null)
 334 {
 335         $classes = $extra_class ? array($extra_class) : array();
 336         if ($k == 1)
 337         {
 338                 array_push($classes, 'oddrow');
 339                 $k = 0;
 340         }
 341         else
 342         {
 343                 array_push($classes, 'evenrow');
 344                 $k++;
 345         }
 346         echo "<tr class='".implode(' ', $classes)."'>\n";
 347 }
 348
 349 function table_section_title($msg, $colspan=2)
 350 {
 351         echo "<tr><td colspan=$colspan class='tableheader'>$msg</td></tr>\n";
 352 }
 353
 354 function table_header($labels, $params='')
 355 {
 356         start_row();
 357         foreach ($labels as $label)
 358                 labelheader_cell($label, $params);
 359         end_row();
 360 }
 361 //-----------------------------------------------------------------------------------
 362
 363 function start_row($param="")
 364 {
 365         if ($param != "")
 366                 echo "<tr $param>\n";
 367         else
 368                 echo "<tr>\n";
 369 }
 370
 371 function end_row()
 372 {
 373         echo "</tr>\n";
 374 }
 375
 376 function br($num=1)
 377 {
 378         for ($i = 0; $i < $num; $i++)
 379                 echo "<br>";
 380 }
 381
 382 $ajax_divs = array();
 383
 384 function div_start($id='', $trigger=null, $non_ajax=false)
 385 {
 386     global $ajax_divs;
 387
 388         if ($non_ajax) { // div for non-ajax elements
 389                 array_push($ajax_divs, array($id, null));
 390                 echo "<div style='display:none' class='js_only' ".($id !='' ? "id='$id'" : '').">";
 391         } else { // ajax ready div
 392                 array_push($ajax_divs, array($id, $trigger===null ? $id : $trigger));
 393                 echo "<div ". ($id !='' ? "id='$id'" : '').">";
 394                 ob_start();
 395         }
 396 }
 397
 398 function div_end()
 399 {
 400     global $ajax_divs, $Ajax;
 401
 402         output_hidden();
 403     if (count($ajax_divs))
 404     {
 405                 $div = array_pop($ajax_divs);
 406                 if ($div[1] !== null)
 407                         $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
 408     }
 409         echo "</div>";
 410 }
 411
 412 //-----------------------------------------------------------------------------
 413 //      Tabbed area:
 414 //      $name - prefix for widget internal elements:
 415 //              Nth tab submit name:  {$name}_N
 416 //              div id: _{$name}_div
 417 //              sel (hidden) name: _{$name}_sel
 418 // $tabs - array of tabs; string: tab title or array(tab_title, enabled_status)
 419
 420 function tabbed_content_start($name, $tabs, $dft='') {
 421     global $Ajax;
 422
 423     $selname = '_'.$name.'_sel';
 424         $div = '_'.$name.'_div';
 425
 426         $sel = find_submit($name.'_', false);
 427         if($sel==null)
 428                 $sel = get_post($selname, (string)($dft==='' ? key($tabs) : $dft));
 429
 430         if ($sel!==@$_POST[$selname])
 431                 $Ajax->activate($name);
 432
 433         $_POST[$selname] = $sel;
 434
 435         div_start($name);
 436         $str = "<ul class='ajaxtabs' rel='$div'>\n";
 437         foreach($tabs as $tab_no => $tab) {
 438
 439                 $acc = access_string(is_array($tab) ? $tab[0] : $tab);
 440                 $disabled = (is_array($tab) && !$tab[1])  ? 'disabled ' : '';
 441                 $str .= ( "<li>"
 442                         ."<button type='submit' name='{$name}_".$tab_no
 443                         ."' class='".((string)$tab_no===$sel ? 'current':'ajaxbutton')."' $acc[1] $disabled>"
 444                         ."<span>$acc[0]</span>"
 445                         ."</button>\n"
 446                         ."</li>\n" );
 447         }
 448
 449         $str .= "</ul>\n";
 450         $str .= "<div class='spaceBox'></div>\n";
 451         $str .= "<input type='hidden' name='$selname' value='$sel'>\n";
 452         $str .= "<div class='contentBox' id='$div'>\n";
 453         echo $str;
 454 }
 455
 456 function tabbed_content_end() {
 457         output_hidden();
 458         echo "</div>"; // content box (don't change to div_end() unless div_start() is used above)
 459         div_end(); // tabs widget
 460 }
 461
 462 function tab_changed($name)
 463 {
 464         $to = find_submit("{$name}_", false);
 465         if (!$to) return null;
 466
 467         return array('from' => $from = get_post("_{$name}_sel"),
 468                 'to' => $to);
 469 }
 470 /*
 471         Check whether tab has been just switched on
 472 */
 473 function tab_opened($name, $tab)
 474 {
 475         return (get_post('_'.$name.'_sel') != $tab) && (find_submit($name.'_', false) == $tab);
 476 }
 477 /*
 478         Check whether tab has been just switched off
 479 */
 480 function tab_closed($name, $tab)
 481 {
 482         return (get_post('_'.$name.'_sel') == $tab) && (find_submit($name.'_', false) != $tab);
 483 }
 484 /*
 485         Check whether tab is visible on current page
 486 */
 487 function tab_visible($name, $tab)
 488 {
 489         $new = find_submit($name.'_', false);
 490         return (get_post('_'.$name.'_sel') == $tab && !$new) || $new==$tab;
 491 }
 492
 493 /* Table editor interfaces. Key is editor type
 494         0 => url of editor page
 495         1 => hotkey code
 496         2 => context help
 497 */
 498 $popup_editors = array(
 499         'customer' => array('/sales/manage/customers.php?debtor_no=',
 500                 113,    _("Customers"), 900, 500),
 501         'branch' => array('/sales/manage/customer_branches.php?SelectedBranch=',
 502                 114, _("Branches"), 900, 700),
 503         'supplier' => array('/purchasing/manage/suppliers.php?supplier_id=',
 504                 113, _("Suppliers"), 900, 700),
 505         'item' => array('/inventory/manage/items.php?stock_id=',
 506                 115, _("Items"), 800, 600)
 507 );
 508 /*
 509         Bind editors for various selectors.
 510         $type - type of editor
 511         $input - name of related input field
 512         $caller - optional function key code (available values F1-F12: 112-123,
 513                 true: default)
 514 */
 515 function set_editor($type, $input, $caller=true)
 516 {
 517         global $path_to_root, $Editors, $popup_editors, $Pagehelp;
 518
 519         $key = $caller===true ? $popup_editors[$type][1] : $caller;
 520
 521         $Editors[$key] = array( $path_to_root . $popup_editors[$type][0], $input,
 522                 $popup_editors[$type][3], $popup_editors[$type][4]);
 523
 524         $help = 'F' . ($key - 111) . ' - ';
 525         $help .= $popup_editors[$type][2];
 526         $Pagehelp[] = $help;
 527 }
 528 //------------------------------------------------------------------------------
 529 // Procedures below are now obsolete. Preserved for eventual future use.
 530
 531 /*
 532         External page call with saving current context.
 533         $call - url of external page
 534         $ctx - optional. name of SESSION context object or array of names of POST
 535                 variables saved on call
 536 */
 537 function context_call($call, $ctx='')
 538 {
 539         if (is_array($ctx))
 540         {
 541                 foreach($ctx as $postname)
 542                 {
 543                         $context[$postname] = get_post($postname);
 544                 }
 545         } else
 546                 $context = isset($_SESSION[$ctx]) ? $_SESSION[$ctx] : null;
 547
 548         array_unshift($_SESSION['Context'], array('name' => $ctx,
 549                 'ctx' => $context,
 550                 'caller' => $_SERVER['PHP_SELF'],
 551                 'ret' => array()));
 552         meta_forward($call);
 553 }
 554 /*
 555         Restores context after external page call and
 556         returns array of data passed by external page.
 557 */
 558 function context_restore()
 559 {
 560         if ( count($_SESSION['Context'])) {
 561                 if ($_SERVER['PHP_SELF'] == $_SESSION['Context'][0]['caller']) {
 562                         $ctx = array_shift($_SESSION['Context']);
 563                         if ($ctx) {
 564                                 if (is_array($ctx['ctx'])) {
 565                                         foreach($ctx['ctx'] as $name => $val)
 566                                         {
 567                                                 $_POST[$name] = $val;
 568                                         }
 569                                 } else
 570                                         if ($ctx['name']!='')
 571                                                 $_SESSION[$ctx['name']] = $ctx['ctx'];
 572                                 return $ctx['ret'];
 573                         }
 574                 }
 575         }
 576         return false;
 577 }
 578
 579 /*
 580         Return to caller page if the page was called from external context.
 581 */
 582 function context_return($ret)
 583 {
 584         if ( count($_SESSION['Context'])) {
 585                 $ctx = &$_SESSION['Context'][0];
 586                 $ctx['ret'] = $ret;
 587                 meta_forward( $ctx['caller'] );
 588         }
 589 }
 590 /*
 591         Clearing context stack after page cancel.
 592 */
 593 function context_reset()
 594 {
 595         $_SESSION['Context'] = array();
 596 }
 597 /*
 598         Context stack initialization
 599 */
 600 if (!isset($_SESSION['Context'])) {
 601                 context_reset();
 602 }
 603 /*
 604         Redirector for selector F4 calls.
 605         $sel_editors is array of selname=>editor_page
 606 */
 607 function editor_redirect($sel_editors, $save_fun='') {
 608         foreach ($sel_editors as $selname=>$editor)
 609                 if (isset($_POST['_'.$selname.'_editor'])) {
 610                         if (function_exists($save_fun))
 611                                 $save_fun();
 612                         unset($_POST['_'.$selname.'_editor']);
 613                         context_call($editor, array_keys($_POST));
 614                 }
 615 }
 616 /*
 617         Return procedure for selector F4 calls
 618 */
 619 function editor_return($vars, $restore_fun='') {
 620         if (function_exists($restore_fun))
 621                 $restore_fun();
 622
 623         if ($ret = context_restore()) {
 624                 foreach ($vars as $postname=>$retname)
 625                         if (isset($ret[$retname])) {
 626                                 $_POST[$postname] = $ret[$retname];
 627                                 set_focus($postname);
 628                         }
 629         }
 630 }
 631
 632 function confirm_dialog($submit, $msg) {
 633         if (find_post($submit)) {
 634                 display_warning($msg);
 635                 br();
 636                 submit_center_first('DialogConfirm', _("Proceed"), '', true);
 637                 submit_center_last('DialogCancel', _("Cancel"), '', 'cancel');
 638                 return 0;
 639         } else
 640                 return get_post('DialogConfirm', 0);
 641 }
 642 /*
 643         Confirm dialog to be used optionally in final form checking routine.
 644         Displays warning conditionally unless it was displayed
 645 */
 646 function display_confirmation($msg)
 647 {
 648         global $Ajax;
 649
 650         if (!get_post('_confirmed'))
 651         {
 652                 $_POST['_confirmed'] = 1;
 653                 display_warning($msg);
 654                 return false;
 655         } else
 656                 return true;
 657 }
 658 /*
 659         Block menu/shortcut links during transaction procesing.
 660 */
 661 function page_processing($msg = false)
 662 {
 663         global $Ajax;
 664
 665         if ($msg === true)
 666                 $msg = _('Entered data has not been saved yet.\nDo you want to abandon changes?');
 667
 668         $js = "_validate._processing=" . (
 669                 $msg ? '\''.strtr($msg, array("\n"=>'\\n')) . '\';' : 'null;');
 670         if (in_ajax()) {
 671                 $Ajax->addScript(true, $js);
 672         } else
 673                 add_js_source($js);
 674 }
 675
 676 function page_modified($status = true)
 677 {
 678         global $Ajax;
 679
 680         $js = "_validate._modified=" . ($status ? 1:0).';';
 681         if (in_ajax()) {
 682                 $Ajax->addScript(true, $js);
 683         } else
 684                 add_js_source($js);
 685 }