Menu hotkeys system implementation.
[fa-stable.git] / includes / ui / ui_controls.inc
index 09b6e0e673b0f18af01ebfbe30316ee70ee884e7..2693b07943db5c0caa04a5479ee328f995800f8d 100644 (file)
@@ -52,12 +52,34 @@ function meta_forward($forward_to, $params="")
     global $Ajax;
        echo "<meta http-equiv='Refresh' content='0; url=$forward_to?$params'>\n";
        echo "<center><br>" . _("You should automatically be forwarded.");
-       echo " " . _("If this does not happen") . " " . "<a href='$forward_to'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
-       $Ajax->redirect($forward_to.'?'.$params);
+       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;
 }
 
 //-----------------------------------------------------------------------------------
+// Find and replace hotkey marker.
+// if $clean == true marker is removed and clean label is returned 
+// (for use in wiki help system), otherwise result is array of label 
+// with underlined hotkey letter and access property string.
+//
+function access_string($label, $clean=false)
+{
+       $access = '';
+       $slices = array();
+
+       if (preg_match('/(.*)&([a-zA-Z0-9])(.*)/', $label, $slices))    
+       {
+               $label = $clean ? $slices[1].$slices[2].$slices[3] :
+                       $slices[1].'<u>'.$slices[2].'</u>'.$slices[3];
+               $access = " accesskey='".strtoupper($slices[2])."'";
+       }
+       
+       $label = str_replace( '&&', '&', $label);
+
+       return $clean ? $label : array($label, $access);
+}
 
 function hyperlink_back($center=true)
 {
@@ -72,9 +94,10 @@ function hyperlink_back($center=true)
 
 function hyperlink_no_params($target, $label, $center=true)
 {
+       $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a href='$target?=" . SID . "'>$label</a>\n";
+       echo "<a href='$target?=" . SID . "'$pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -90,9 +113,10 @@ function hyperlink_no_params_td($target, $label)
 
 function hyperlink_params($target, $label, $params, $center=true)
 {
+       $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a href='$target?$params'>$label</a>\n";
+       echo "<a href='$target?$params'$pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -108,9 +132,10 @@ function hyperlink_params_td($target, $label, $params)
 
 function hyperlink_params_separate($target, $label, $params, $center=false)
 {
+       $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a target='_blank' href='$target?$params" . SID . "'>$label</a>\n";
+       echo "<a target='_blank' href='$target?$params" . SID . "'$pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -163,10 +188,21 @@ function delete_link_cell($param, $title=false)
        .($title ? " title='$title'":'') .">" . _("Delete") . "</a>", "nowrap");
 }
 
+function edit_button($name, $value, $title=false)
+{
+// php silently changes dots,spaces,'[' and characters 128-159
+// to underscore in POST names, to maintain compatibility with register_globals
+       echo "<input type=\"submit\" class=\"editbutton\" name=\""
+               .htmlentities(strtr($name, array('.'=>'=2E',' '=>'=20','='=>'=3D','['=>'=5B')))
+               ."\" value=\"$value\""
+               .($title ? " title='$title'":'')." />\n";
+}
+
 function edit_button_cell($name, $value, $title=false)
 {
-    label_cell("<input type=\"submit\" class=\"editbutton\" name=\"$name\" value=\"$value\""
-       .($title ? " title='$title'":'')." />\n");
+       echo "<td>";
+       edit_button($name, $value, $title);
+       echo "</td>";
 }
 
 //-----------------------------------------------------------------------------------
@@ -192,13 +228,18 @@ function br($num=1)
 
 $ajax_divs = array();
 
-function div_start($id='', $trigger=null)
+function div_start($id='', $trigger=null, $non_ajax=false)
 {
     global $ajax_divs;
 
-    array_push($ajax_divs, array($id, $trigger===null ? $id : $trigger));
-    echo "<div ". ($id !='' ? "id='$id'" : '').">";
-    ob_start();
+       if ($non_ajax) { // div for non-ajax elements
+               array_push($ajax_divs, array($id, null));
+               echo "<div style='display:none' class='js_only' ".($id !='' ? "id='$id'" : '').">";
+       } else { // ajax ready div
+               array_push($ajax_divs, array($id, $trigger===null ? $id : $trigger));
+               echo "<div ". ($id !='' ? "id='$id'" : '').">";
+               ob_start();
+       }
 }
 
 function div_end()
@@ -208,8 +249,84 @@ function div_end()
     if (count($ajax_divs))
     {
                $div = array_pop($ajax_divs);
-               $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
+               if ($div[1] !== null)
+                       $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
                echo "</div>";
     }
 }
+
+/*
+       External page call with saving current context.
+       $call - url of external page
+       $ctx - optional. name of SESSION context object or array of names of POST 
+               variables saved on call
+*/
+function context_call($call, $ctx='')
+{
+       if (is_array($ctx)) 
+       {
+               foreach($ctx as $postname)
+               {
+                       $context[$postname] = get_post($postname);
+               }
+       } else 
+               $context = isset($_SESSION[$ctx]) ? $_SESSION[$ctx] : null;
+
+       array_unshift($_SESSION['Context'], array('name' => $ctx, 
+               'ctx' => $context,
+               'caller' => $_SERVER['PHP_SELF'],
+               'ret' => array()));
+       meta_forward($call);
+}
+/*
+       Restores context after external page call and
+       returns array of data passed by external page.
+*/
+function context_restore()
+{
+       if ( count($_SESSION['Context'])) {
+               if ($_SERVER['PHP_SELF'] == $_SESSION['Context'][0]['caller']) {
+                       $ctx = array_shift($_SESSION['Context']);
+                       if ($ctx) {
+                               if (is_array($ctx['ctx'])) {
+                                       foreach($ctx['ctx'] as $name => $val) 
+                                       {
+                                               $_POST[$name] = $val;
+                                       }
+                               } else
+                                       if ($ctx['name']!='')
+                                               $_SESSION[$ctx['name']] = $ctx['ctx'];
+                               return $ctx['ret'];
+                       }
+               }
+       }
+       return false;
+}
+
+/*
+       Return to caller page if the page was called from external context.
+*/
+function context_return($ret)
+{
+       if ( count($_SESSION['Context'])) {
+               $ctx = &$_SESSION['Context'][0];
+               $ctx['ret'] = $ret;
+               meta_forward( $ctx['caller'] );
+       }
+}
+/*
+       Clearing context stack after page cancel.
+*/
+function context_reset()
+{
+       $_SESSION['Context'] = array();
+}
+
+/*
+       Context stack initialization
+*/
+if (!isset($_SESSION['Context'])) {
+               context_reset();
+}
+
 ?>
\ No newline at end of file