Fixed get_post() support for numeric fields.
[fa-stable.git] / includes / ui / ui_controls.inc
index 559d1751b9eda8fcce0de7037cd1b4507550388b..c2dbae05a715440633230fafe231d2850d931d24 100644 (file)
@@ -9,15 +9,37 @@
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
 ***********************************************************************/
+/*
+       Retrieve value of POST variable(s).
+       For $name passed as array $dflt is not used, 
+       default values can be passed as values with non-numeric keys instead.
+       If some field have user formatted numeric value, pass float default value to
+       convert automatically to POSIX.
+*/
 function get_post($name, $dflt='')
 {
-       return ((!isset($_POST[$name]) || $_POST[$name] === '') ? $dflt : $_POST[$name]);
+       if (is_array($name)) {
+               $ret = array();
+               foreach($name as $key => $dflt)
+                       if (!is_numeric($key)) {
+                               $ret[$key] = is_numeric($dflt) ? input_num($key, $dflt) : get_post($key, $dflt);
+                       } else {
+                               $ret[$dflt] = get_post($dflt, null);
+                       }
+               return $ret;
+       } else
+               return is_float($dflt) ? input_num($name, $dflt) :
+                               ((!isset($_POST[$name]) /*|| $_POST[$name] === ''*/) ? $dflt : $_POST[$name]);
 }
 //---------------------------------------------------------------------------------
+$form_nested = -1;
 
 function start_form($multi=false, $dummy=false, $action="", $name="")
 {
        // $dummy - leaved for compatibility with 2.0 API
+       global $form_nested;
+
+       if (++$form_nested) return;
 
        if ($name != "")
                $name = "name='$name'";
@@ -31,36 +53,77 @@ function start_form($multi=false, $dummy=false, $action="", $name="")
 
 }
 
+/*
+       Flush hidden fields buffer.
+*/
+function output_hidden()
+{
+       global $hidden_fields;
+
+       if (is_array($hidden_fields))
+               echo implode('', $hidden_fields);
+       $hidden_fields = array();
+}
 //---------------------------------------------------------------------------------
 
 function end_form($breaks=0)
 {
+       global $Ajax, $form_nested, $hidden_fields;
+
+       if ($form_nested-- > 0) return;
+
+       $_SESSION['csrf_token'] = random_id();
        if ($breaks)
                br($breaks);
-       echo "<input type=\"hidden\" name=\"_focus\" value=\"".get_post('_focus')."\">\n";
+       hidden('_focus');
+       hidden('_modified', get_post('_modified', 0));
+       hidden('_confirmed'); // helper for final form confirmation
+       hidden('_token', $_SESSION['csrf_token']);
+
+       output_hidden();
        echo "</form>\n";
+       $Ajax->activate('_token');
+       $Ajax->activate('_confirmed');
+}
+
+function check_csrf_token()
+{
+       if ($_SESSION['csrf_token'] != @$_POST['_token'])
+       {
+               display_error(_("Request from outside of this page is forbidden."));
+               error_log(_("CSRF attack detected from: ").@$_SERVER['HTTP_HOST'].' ('.@$_SERVER['HTTP_REFERER'].')');
+               return false;
+       }
+       return true;
 }
 
-function start_table($extra="", $padding='2', $spacing='0')
+function start_table($class=false, $extra="", $padding='2', $spacing='0')
 {
        echo "<center><table";
+       if ($class == TABLESTYLE_NOBORDER)
+               echo " class='tablestyle_noborder'";
+       elseif ($class == TABLESTYLE2)
+               echo " class='tablestyle2'";
+       elseif ($class == TABLESTYLE)
+               echo " class='tablestyle'";
        if ($extra != "")
                echo " $extra";
-       echo " cellpadding=$padding cellspacing=$spacing>\n";
+       echo " cellpadding='$padding' cellspacing='$spacing'>\n";
 }
 
 function end_table($breaks=0)
 {
        echo "</table></center>\n";
+       output_hidden();
        if ($breaks)
                br($breaks);
 }
 
-function start_outer_table($extra="", $padding='2', $spacing='0', $br=false)
+function start_outer_table($class=false, $extra="", $padding='2', $spacing='0', $br=false)
 {
        if ($br)
                br();
-       start_table($extra, $padding, $spacing);
+       start_table($class, $extra, $padding, $spacing);
        echo "<tr valign=top><td>\n"; // outer table
 }
 
@@ -69,16 +132,20 @@ function table_section($number=1, $width=false)
        if ($number > 1)
        {
                echo "</table>\n";
-               $width = ($width ? "width=$width" : "");
-               echo "</td><td class='tableseparator' $width>\n"; // outer table
+               output_hidden();
+               $width = ($width ? "width='$width'" : "");
+               echo "</td><td style='border-left:1px solid #cccccc;' $width>\n"; // outer table
        }
-       echo "<table>\n";
+       echo "<table class='tablestyle_inner'>\n";
 }      
 
 function end_outer_table($breaks=0, $close_table=true)
 {
        if ($close_table)
+       {
                echo "</table>\n";
+               output_hidden();
+       }
        echo "</td></tr>\n";
        end_table($breaks);
 }
@@ -90,15 +157,15 @@ function vertical_space($params='')
        echo "</td></tr><tr><td valign=center $params>";
 }
 
-function meta_forward($forward_to, $params="")
+function meta_forward($forward_to, $params="", $timeout=0, $return=false)
 {
     global $Ajax;
-       echo "<meta http-equiv='Refresh' content='0; url=$forward_to?$params'>\n";
+       echo "<meta http-equiv='Refresh' content='".$timeout."; url=$forward_to?$params'>\n";
        echo "<center><br>" . _("You should automatically be forwarded.");
        echo " " . _("If this does not happen") . " " . "<a href='$forward_to?$params'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
        if ($params !='') $params = '?'.$params;
        $Ajax->redirect($forward_to.$params);
-       exit;
+       if (!$return) exit;
 }
 
 //-----------------------------------------------------------------------------------
@@ -124,11 +191,30 @@ function access_string($label, $clean=false)
        return $clean ? $label : array($label, $access);
 }
 
-function hyperlink_back($center=true)
+function hyperlink_back($center=true, $no_menu=true, $type_no=0, $trans_no=0, $final=false)
 {
+       global $path_to_root;
+
        if ($center)
                echo "<center>";
-       echo "<p><a href='javascript:goBack();'>"._("Back")."</a></p>\n";
+       $id = 0;        
+       if ($no_menu && $trans_no != 0)
+       {
+               include_once($path_to_root."/admin/db/attachments_db.inc");
+               $id = has_attachment($type_no, $trans_no);
+               $attach = get_attachment_string($type_no, $trans_no);
+       echo $attach;
+       }
+       $width = ($id != 0 ? "30%" : "20%");    
+       start_table(false, "width='$width'");
+       start_row();
+       if ($no_menu)
+       {
+               echo "<td align=center><a href='javascript:window.print();'>"._("Print")."</a></td>\n";
+       }       
+       echo "<td align=center><a href='javascript:goBack(".($final ? '-2' : '').");'>".($no_menu ? _("Close") : _("Back"))."</a></td>\n";
+       end_row();
+       end_table();
        if ($center)
                echo "</center>";
        echo "<br>";
@@ -142,7 +228,7 @@ function hyperlink_no_params($target, $label, $center=true)
                $target = $_SERVER['PHP_SELF'];
        if ($center)
                echo "<br><center>";
-       echo "<a href='$target' $id='$id' $pars[1]>$pars[0]</a>\n";
+       echo "<a href='$target' id='$id' $pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -173,32 +259,36 @@ function viewer_link($label, $url='', $class='', $id='',  $icon=null)
        }
        else
                $preview_str = $label;
-
  return $preview_str;
 }
 
 function menu_link($url, $label, $id=null)
 {
+       global $path_to_root;
 
        $id = default_focus($id);
        $pars = access_string($label);
+
+       if ($url[0] != '/')
+               $url = '/'.$url;
+       $url = $path_to_root.$url;
+
        return "<a href='$url' class='menu_option' id='$id' $pars[1]>$pars[0]</a>";
 }
 
 function submenu_option($title, $url, $id=null)
 {
-       global $path_to_root;
-       display_note(menu_link($path_to_root . $url, $title, $id), 0, 1);
+       display_note( menu_link($url, $title, $id), 0, 1);
 }
 
 function submenu_view($title, $type, $number, $id=null)
 {
-       display_note(get_trans_view_str($type, $number, $title, false, 'menu_option', $id), 0, 1);
+       display_note(get_trans_view_str($type, $number, $title, false, 'viewlink', $id), 0, 1);
 }
 
-function submenu_print($title, $type, $number, $id=null)
+function submenu_print($title, $type, $number, $id=null, $email=0, $extra=0)
 {
-       display_note(print_document_link($number, $title, true, $type, false, 'menu_option', $id), 0, 1);
+       display_note(print_document_link($number, $title, true, $type, false, 'printlink', $id, $email, $extra), 0, 1);
 }
 //-----------------------------------------------------------------------------------
 
@@ -232,7 +322,7 @@ function hyperlink_params_separate($target, $label, $params, $center=false)
        $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a target='_blank' $id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
+       echo "<a target='_blank' id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -246,18 +336,20 @@ function hyperlink_params_separate_td($target, $label, $params)
 
 //--------------------------------------------------------------------------------------------------
 
-function alt_table_row_color(&$k)
+function alt_table_row_color(&$k, $extra_class=null)
 {
+       $classes = $extra_class ? array($extra_class) : array();
        if ($k == 1)
        {
-               echo "<tr class='oddrow'>\n";
+               array_push($classes, 'oddrow');
                $k = 0;
        }
        else
        {
-               echo "<tr class='evenrow'>\n";
+               array_push($classes, 'evenrow');
                $k++;
        }
+       echo "<tr class='".implode(' ', $classes)."'>\n";
 }
 
 function table_section_title($msg, $colspan=2)
@@ -313,14 +405,136 @@ function div_end()
 {
     global $ajax_divs, $Ajax;
 
+       output_hidden();
     if (count($ajax_divs))
     {
                $div = array_pop($ajax_divs);
                if ($div[1] !== null)
                        $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
-               echo "</div>";
     }
+       echo "</div>";
+}
+
+//-----------------------------------------------------------------------------
+//     Tabbed area:
+//     $name - prefix for widget internal elements:
+//             Nth tab submit name:  {$name}_N
+//             div id: _{$name}_div
+//             sel (hidden) name: _{$name}_sel
+// $tabs - array of tabs; string: tab title or array(tab_title, enabled_status)
+
+function tabbed_content_start($name, $tabs, $dft='') {
+    global $Ajax;
+
+    $selname = '_'.$name.'_sel';
+       $div = '_'.$name.'_div';
+
+       $sel = find_submit($name.'_', false);
+       if($sel==null)
+               $sel = get_post($selname, (string)($dft==='' ? key($tabs) : $dft));
+
+       if ($sel!==@$_POST[$selname])
+               $Ajax->activate($name);
+
+       $_POST[$selname] = $sel;
+
+       div_start($name);
+       $str = "<ul class='ajaxtabs' rel='$div'>\n";
+       foreach($tabs as $tab_no => $tab) {
+               
+               $acc = access_string(is_array($tab) ? $tab[0] : $tab);
+               $disabled = (is_array($tab) && !$tab[1])  ? 'disabled ' : '';
+               $str .= ( "<li>"
+                       ."<button type='submit' name='{$name}_".$tab_no
+                       ."' class='".((string)$tab_no===$sel ? 'current':'ajaxbutton')."' $acc[1] $disabled>"
+                       ."<span>$acc[0]</span>"
+                       ."</button>\n"
+                       ."</li>\n" );
+       }
+
+       $str .= "</ul>\n";
+       $str .= "<div class='spaceBox'></div>\n";
+       $str .= "<input type='hidden' name='$selname' value='$sel'>\n";
+       $str .= "<div class='contentBox' id='$div'>\n";
+       echo $str;
+}
+
+function tabbed_content_end() {
+       output_hidden();
+       echo "</div>"; // content box (don't change to div_end() unless div_start() is used above)
+       div_end(); // tabs widget
+}
+
+function tab_changed($name)
+{
+       $to = find_submit("{$name}_", false);
+       if (!$to) return null;
+
+       return array('from' => $from = get_post("_{$name}_sel"),
+               'to' => $to);
+}
+/*
+       Check whether tab has been just switched on
+*/
+function tab_opened($name, $tab)
+{
+       return (get_post('_'.$name.'_sel') != $tab) && (find_submit($name.'_', false) == $tab);
+}
+/*
+       Check whether tab has been just switched off
+*/
+function tab_closed($name, $tab)
+{
+       return (get_post('_'.$name.'_sel') == $tab) && (find_submit($name.'_', false) != $tab);
+}
+/*
+       Check whether tab is visible on current page
+*/
+function tab_visible($name, $tab)
+{
+       $new = find_submit($name.'_', false);
+       return (get_post('_'.$name.'_sel') == $tab && !$new) || $new==$tab;
+}
+
+/* Table editor interfaces. Key is editor type
+       0 => url of editor page
+       1 => hotkey code
+       2 => context help
+*/
+$popup_editors = array(
+       'customer' => array('/sales/manage/customers.php?debtor_no=', 
+               113,    _("Customers"), 900, 600),
+       'branch' => array('/sales/manage/customer_branches.php?SelectedBranch=', 
+               114, _("Branches"), 900, 700),
+       'supplier' => array('/purchasing/manage/suppliers.php?supplier_id=', 
+               113, _("Suppliers"), 900, 700),
+       'item' => array('/inventory/manage/items.php?stock_id=', 
+               115, _("Items"), 800, 600),
+       'fa_item' => array('/inventory/manage/items.php?FixedAsset=1&stock_id=', 
+               115, _("Items"), 800, 600)
+);
+/*
+       Bind editors for various selectors.
+       $type - type of editor
+       $input - name of related input field
+       $caller - optional function key code (available values F1-F12: 112-123,
+               true: default)
+*/
+function set_editor($type, $input, $caller=true)
+{
+       global $path_to_root, $Editors, $popup_editors, $Pagehelp;
+
+       $key = $caller===true ? $popup_editors[$type][1] : $caller;
+
+       $Editors[$key] = array( $path_to_root . $popup_editors[$type][0], $input, 
+               $popup_editors[$type][3], $popup_editors[$type][4]);
+       
+       $help = 'F' . ($key - 111) . ' - ';
+       $help .= $popup_editors[$type][2];
+       $Pagehelp[] = $help;
 }
+//------------------------------------------------------------------------------
+// Procedures below are now obsolete. Preserved for eventual future use.
 
 /*
        External page call with saving current context.
@@ -388,7 +602,6 @@ function context_reset()
 {
        $_SESSION['Context'] = array();
 }
-
 /*
        Context stack initialization
 */
@@ -424,4 +637,57 @@ function editor_return($vars, $restore_fun='') {
        }
 }
 
-?>
\ No newline at end of file
+function confirm_dialog($submit, $msg) {
+       if (find_post($submit)) {
+               display_warning($msg);
+               br();
+               submit_center_first('DialogConfirm', _("Proceed"), '', true);
+               submit_center_last('DialogCancel', _("Cancel"), '', 'cancel');
+               return 0;
+       } else
+               return get_post('DialogConfirm', 0);
+}
+/*
+       Confirm dialog to be used optionally in final form checking routine.
+       Displays warning conditionally unless it was displayed
+*/
+function display_confirmation($msg)
+{
+       global $Ajax;
+
+       if (!get_post('_confirmed'))
+       {
+               $_POST['_confirmed'] = 1;
+               display_warning($msg);
+               return false;
+       } else
+               return true;
+}
+/*
+       Block menu/shortcut links during transaction procesing.
+*/
+function page_processing($msg = false)
+{
+       global $Ajax;
+
+       if ($msg === true)
+               $msg = _("Entered data has not been saved yet.\nDo you want to abandon changes?");
+
+       $js = "_validate._processing=" . (
+               $msg ? '\''.strtr($msg, array("\n"=>'\\n')) . '\';' : 'null;');
+       if (in_ajax()) {
+               $Ajax->addScript(true, $js);
+       } else
+               add_js_source($js);
+}
+
+function page_modified($status = true)
+{
+       global $Ajax;
+
+       $js = "_validate._modified=" . ($status ? 1:0).';';
+       if (in_ajax()) {
+               $Ajax->addScript(true, $js);
+       } else
+               add_js_source($js);
+}