--- loncom/interface/lonmenu.pm	2003/02/14 21:22:04	1.39
+++ loncom/interface/lonmenu.pm	2003/04/03 14:44:01	1.51
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Routines to control the menu
 #
-# $Id: lonmenu.pm,v 1.39 2003/02/14 21:22:04 www Exp $
+# $Id: lonmenu.pm,v 1.51 2003/04/03 14:44:01 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -25,34 +25,66 @@
 #
 # http://www.lon-capa.org/
 #
-# (TeX Conversion Module
 #
-# 05/29/00,05/30 Gerd Kortemeyer)
+# There are two parameters controlling the action of this module:
+#
+# browser.interface - if this is 'textual', it overrides the second parameter
+# and goes to screen reader PDA mode
+#
+# environment.remote - if this is 'on', the routines controll the remote
+# control, otherwise they render the main window controls; ignored it
+# browser.interface is 'textual'
 #
-# 10/05,05/28,05/30,06/01,06/08,06/09,07/04,08/07 Gerd Kortemeyer
-# 02/15/02 Matthew Hall
 
 package Apache::lonmenu;
 
 use strict;
 use Apache::lonnet;
 use Apache::Constants qw(:common);
+use Apache::lonhtmlcommon();
 use Apache::loncommon;
 use Apache::File;
 use vars qw(@desklines $readdesk);
 
-# ======================================================= Make the menu buttons
+# ============================= This gets called at the top of the body section
 
 sub menubuttons {
     my $forcereg=shift;
     my $target  =shift;
-    unless ($ENV{'browser.interface'} eq 'textual') { return ''; }
-    my $output='<a href="/adm/menu">Main Menu</a><br />';
-    return $output."<hr />";
+    my $registration=shift;
+    if ($ENV{'browser.interface'} eq 'textual') {
+# Textual display only
+	my $output=(<<ENDMAINMENU);
+<script>
+// BEGIN LON-CAPA Internal
+</script>
+<a href="/adm/menu" target="_top">Main Menu</a><br />
+<script>
+// END LON-CAPA Internal
+</script>
+ENDMAINMENU
+        if ($registration) { $output.=&innerregister($forcereg,$target); }
+	return $output."<hr />";
+    } elsif ($ENV{'environment.remote'} eq 'off') {
+# Remote Control is switched off
+	my $output=(<<ENDINLINEMENU);
+<script>
+// BEGIN LON-CAPA Internal
+</script>
+<a href="/adm/menu" target="_top">Main Menu</a>
+<a href="/adm/remote?action=launch" target="_top">Launch Remote Control</a>
+<script>
+// END LON-CAPA Internal
+</script>
+ENDINLINEMENU
+        if ($registration) { $output.=&innerregister($forcereg,$target); }
+	return $output."<hr />";
+    } else {
+	return '';
+    }
 }
 
-# ============================================== Register a URL with the remote
-
+# ====================================== This gets called in the header section
 
 sub registerurl {
     my $forcereg=shift;
@@ -60,7 +92,7 @@ sub registerurl {
     my $result = '';
     
     if ($target eq 'edit') {
-        $result .="<script type=\"text/javascrtipt\">\n".
+        $result .="<script type=\"text/javascript\">\n".
             "if (typeof swmenu != 'undefined') {swmenu.currentURL=null;}\n".
             &Apache::loncommon::browser_and_searcher_javascript().
                 "\n</script>\n";
@@ -72,36 +104,60 @@ sub registerurl {
 	return $result.
          '<script type="text/javascript">function LONCAPAreg(){;} function LONCAPAstale(){}</script>';
     }
+# Graphical display after login only
     if ($Apache::lonxml::registered && !$forcereg) { return ''; }
+    $result.=&innerregister($forcereg,$target);
+    return $result;
+}
+
+# =========== This gets called in order to register a URL, both with the Remote
+# =========== and in the body of the document
+
+sub innerregister {
+    my $forcereg=shift;
+    my $target = shift;
+    my $result = '';
+
     $Apache::lonxml::registered=1;
+
+    my $textinter=($ENV{'browser.interface'} eq 'textual');
+    my $noremote=($ENV{'environment.remote'} eq 'off');
+    
+    my $textual=($textinter || $noremote);
+
     my $reopen=&Apache::lonmenu::reopenmenu();
+
     my $newmail='';
     if (&Apache::lonmsg::newmail()) { 
-       $newmail='swmenu.setstatus("you have","messages");';
-    }
-    my $timesync='swmenu.syncclock(1000*'.time.');';
+       $newmail=($textual?
+ '<b><a href="/adm/communicate">You have new messages</a></b><br />':
+                          'swmenu.setstatus("you have","messages");');
+    }
+    my $timesync=($textual?'':'swmenu.syncclock(1000*'.time.');');
+# =============================================================================
+# ============================ This is for URLs that actually can be registered
     if (($ENV{'REQUEST_URI'}!~/^\/(res\/)*adm\//) || ($forcereg)) {
+# -- This applies to homework problems for users with grading privileges
         my $hwkadd='';
-        if ($ENV{'request.filename'}=~/\.(problem|exam|quiz|assess|survey|form)$/) {
+        if 
+      ($ENV{'request.filename'}=~/\.(problem|exam|quiz|assess|survey|form)$/) {
 	    if (&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
-		$hwkadd.=(<<ENDSUBM);
-                     swmenu.switchbutton(7,1,'subm.gif','view sub','missions','gocmd("/adm/grades","submission")',
-                     'View user submissions for this assessment resource');
-ENDSUBM
+		$hwkadd.=&switch('','',7,1,'subm.gif','view sub','missions',
+                       "gocmd('/adm/grades','submission')",
+		       'View user submissions for this assessment resource');
             }
 	    if (&Apache::lonnet::allowed('mgr',$ENV{'request.course.id'})) {
-		$hwkadd.=(<<ENDGRDS);
-                     swmenu.switchbutton(7,2,'pgrd.gif','problem','grades','gocmd("/adm/grades","gradingmenu")',
-                     'Modify user grades for this assessment resource');
-ENDGRDS
+		$hwkadd.=&switch('','',7,2,'pgrd.gif','problem','grades',
+                       "gocmd('/adm/grades','gradingmenu')",
+                       'Modify user grades for this assessment resource');
             }
 	    if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
-		$hwkadd.=(<<ENDPARM);
-                     swmenu.switchbutton(7,3,'pparm.gif','problem','parms','gocmd("/adm/parmset","set")',
-                     'Modify deadlines, etc, for this assessment resource');
-ENDPARM
+		$hwkadd.=&switch('','',7,3,'pparm.gif','problem','parms',
+                       "gocmd('/adm/parmset','set')",
+                       'Modify deadlines, etc, for this assessment resource');
             }
 	}
+# -- End Homework
         ###
         ### Determine whether or not to display the 'cstr' button for this
         ### resource
@@ -125,7 +181,7 @@ ENDPARM
                 # Check that we are on the correct machine
                 my $home = &Apache::lonnet::homeserver($caname,$cadom);
                 if ($home eq $Apache::lonnet::perlvar{'lonHostID'}) {
-                    $editbutton=&Apache::lonmenu::switch
+                    $editbutton=&switch
                         ('','',6,1,$top,,$bottom,$action,$desc);
                 }
             }
@@ -149,49 +205,76 @@ ENDPARM
             }        
             # Finally, turn the button on or off
             if ($cfile) {
-                $editbutton=&Apache::lonmenu::switch
+                $editbutton=&switch
                     ('','',6,1,'cstr.gif','edit','resource',
                      "go('".$cfile."');","Edit this resource");
             } elsif ($editbutton eq '') {
-                $editbutton = '    swmenu.clearbut(6,1);';
+                $editbutton=&clear(6,1);
             }
         }
         ###
         ###
-	$result = (<<ENDREGTHIS);
+# Prepare the rest of the buttons
+	my $menuitems=(<<ENDMENUITEMS);
+c&3&1
+s&2&1&back.gif&backward&&gopost('/adm/flip','back:'+currentURL)&Go to the previous resource in the course sequence&1
+s&2&3&forw.gif&forward&&gopost('/adm/flip','forward:'+currentURL)&Go to the next resource in the course sequence&1
+s&6&3&catalog.gif&catalog&info&catalog_info()&Show catalog information
+s&8&1&eval.gif&evaluate&this&gopost('/adm/evaluate',currentURL)&Provide my evaluation of this resource
+s&8&2&fdbk.gif&feedback&discuss&gopost('/adm/feedback',currentURL)&Provide feedback messages or contribute to the course discussion about this resource
+s&8&3&prt.gif&prepare&printout&gopost('/adm/printout',currentURL)&Prepare a printable document
+s&9&1&sbkm.gif&set&bookmark&set_bookmark()&Set a bookmark for this resource&2
+s&9&2&vbkm.gif&view&bookmark&edit_bookmarks()&Use or edit my bookmark collection&2
+s&9&3&anot.gif&anno-&tations&annotate()&Make notes and annotations about this resource&2
+ENDMENUITEMS
+        my $buttons='';
+        foreach (split(/\n/,$menuitems)) {
+	    my ($command,@rest)=split(/\&/,$_);
+            if ($command eq 's') {
+		$buttons.=&switch('','',@rest);
+            } else {
+                $buttons.=&clear(@rest);
+            }
+        }
+        if ($textual) {
+# Registered, textual output
+            my $utility=&utilityfunctions();
+            my $form=&serverform();
+	    $result =(<<ENDREGTEXT);
+<script>
+// BEGIN LON-CAPA Internal
+$utility
+</script>
+$timesync
+$newmail
+$buttons
+$hwkadd
+$editbutton
+$form
+<script>
+//END LON-CAPA Internal
+</script>
+
+ENDREGTEXT
+# Registered, graphical output
+        } else {
+	    $result = (<<ENDREGTHIS);
      
 <script language="JavaScript">
 // BEGIN LON-CAPA Internal
+var swmenu=null;
 
     function LONCAPAreg() {
 	  swmenu=$reopen;
           swmenu.clearTimeout(swmenu.menucltim);
           $timesync
           $newmail
+          $buttons
 	  swmenu.currentURL=window.location.pathname;
-          swmenu.reloadURL=window.location.pathname;
+          swmenu.reloadURL=window.location.pathname+window.location.search;
           swmenu.currentSymb="$ENV{'request.symb'}";
           swmenu.reloadSymb="$ENV{'request.symb'}";
           swmenu.currentStale=0;
-          swmenu.clearbut(3,1);
-          swmenu.switchbutton
-       (6,3,'catalog.gif','catalog','info','catalog_info()','Show catalog information');
-          swmenu.switchbutton
-       (8,1,'eval.gif','evaluate','this','gopost("/adm/evaluate",currentURL)','Provide my evaluation of this resource');
-          swmenu.switchbutton
-    (8,2,'fdbk.gif','feedback','discuss','gopost("/adm/feedback",currentURL)','Provide feedback messages or contribute to the course discussion about this resource');
-          swmenu.switchbutton
-     (8,3,'prt.gif','prepare','printout','gopost("/adm/printout",currentURL)','Prepare a printable document');
-          swmenu.switchbutton
-       (2,1,'back.gif','backward','','gopost("/adm/flip","back:"+currentURL)','Go to the previous resource in the course sequence');
-          swmenu.switchbutton
-     (2,3,'forw.gif','forward','','gopost("/adm/flip","forward:"+currentURL)','Go to the next resource in the course sequence');
-          swmenu.switchbutton
-                            (9,1,'sbkm.gif','set','bookmark','set_bookmark()','Set a bookmark for this resource');
-          swmenu.switchbutton
-                         (9,2,'vbkm.gif','view','bookmark','edit_bookmarks()','Use or edit my bookmark collection');
-          swmenu.switchbutton
-                               (9,3,'anot.gif','anno-','tations','annotate()','Make notes and annotations about this resource');
           $hwkadd
           $editbutton
     }
@@ -216,12 +299,21 @@ ENDPARM
 // END LON-CAPA Internal
 </script>
 ENDREGTHIS
-
+        }
+# =============================================================================
     } else {
-        $result = (<<ENDDONOTREGTHIS);
+# ========================================== This can or will not be registered
+        if ($textual) {
+# Not registered, textual
+	    $result= (<<ENDDONOTREGTEXT);
+ENDDONOTREGTEXT
+        } else {
+# Not registered, graphical
+           $result = (<<ENDDONOTREGTHIS);
 
 <script language="JavaScript">
 // BEGIN LON-CAPA Internal
+var swmenu=null;
 
     function LONCAPAreg() {
 	  swmenu=$reopen
@@ -246,6 +338,8 @@ ENDREGTHIS
 // END LON-CAPA Internal
 </script>
 ENDDONOTREGTHIS
+       }
+# =============================================================================
     }
     return $result;
 }
@@ -262,9 +356,13 @@ sub unloadevents() {
 
 sub startupremote {
     my ($lowerurl)=@_;
-    if ($ENV{'browser.interface'} eq 'textual') {
+    if (($ENV{'browser.interface'} eq 'textual') ||
+        ($ENV{'environment.remote'} eq 'off')) {
      return ('<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.$lowerurl.'" />');
     }
+#
+# The Remote actually gets launched!
+#
     my $configmenu=&rawconfig();
     return(<<ENDREMOTESTARTUP);
 <script>
@@ -323,7 +421,8 @@ ENDSETFLAGS
 }
 
 sub maincall() {
-    if ($ENV{'browser.interface'} eq 'textual') { return ''; }
+    if (($ENV{'browser.interface'} eq 'textual') ||
+        ($ENV{'environment.remote'} eq 'off')) { return ''; }
     return(<<ENDMAINCALL);
 <script>
     main();
@@ -333,18 +432,19 @@ ENDMAINCALL
 # ================================================================= Reopen menu
 
 sub reopenmenu {
-   my $nothing='';
-   if ($ENV{'browser.interface'} eq 'textual') { return ''; }
+   if (($ENV{'browser.interface'} eq 'textual') ||
+       ($ENV{'environment.remote'} eq 'off')) { return ''; }
    my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
-   if ($ENV{'browser.type'} eq 'explorer') { $nothing='javascript:void(0);'; }
-   return('window.open("'.$nothing.'","'.$menuname.'","",false);');
+   my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
+   return('window.open('.$nothing.',"'.$menuname.'","",false);');
 } 
 
 # =============================================================== Open the menu
 
 sub open {
     my $returnval='';
-    if ($ENV{'browser.interface'} eq 'textual') { return ''; }
+    if (($ENV{'browser.interface'} eq 'textual') ||
+        ($ENV{'environment.remote'} eq 'off')) { return ''; }
     my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
     unless (shift eq 'unix') {
 # resizing does not work on linux because of virtual desktop sizes
@@ -368,24 +468,41 @@ ENDOPEN
 
 sub clear {
     my ($row,$col)=@_;
-    unless ($ENV{'browser.interface'} eq 'textual') {
+    unless (($ENV{'browser.interface'} eq 'textual') ||
+            ($ENV{'environment.remote'} eq 'off')) {
        return "\n".qq(window.status+='.';swmenu.clearbut($row,$col););
    } else { return ''; }
 }
 
+# ============================================ Switch a button or create a link
 # Switch acts on the javascript that is executed when a button is clicked.  
 # The javascript is usually similar to "go('/adm/roles')" or "cstrgo(..)".
+
 sub switch {
-    my ($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc)=@_;
+    my ($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$nobreak)=@_;
     $act=~s/\$uname/$uname/g;
     $act=~s/\$udom/$udom/g;
-    unless ($ENV{'browser.interface'} eq 'textual') {
+    unless (($ENV{'browser.interface'} eq 'textual')  ||
+            ($ENV{'environment.remote'} eq 'off')) {
+# Remote
        return "\n".
  qq(window.status+='.';swmenu.switchbutton($row,$col,"$img","$top","$bot","$act","$desc"););
+   } elsif ($ENV{'browser.interface'} eq 'textual') {
+# Accessibility
+       if ($nobreak==2) { return ''; }
+       my $text=$top.' '.$bot;
+       $text=~s/\- //;
+       return "\n".($nobreak?' ':'<br />').
+        '<a href="javascript:'.$act.';" target="_top">'.$text.'</a> '.
+        ($nobreak?'':$desc);
    } else {
+# Inline Remote
+       if ($nobreak==2) { return ''; }
        my $text=$top.' '.$bot;
        $text=~s/\- //;
-       return '<br /><a href="javascript:'.$act.';">'.$text.'</a> '.$desc;
+       return "\n".($nobreak?' ':'<br />').
+        '<a href="javascript:'.$act.';" target="_top">'.$text.'</a> '.
+        ($nobreak?'':$desc);
    }
 }
 
@@ -405,18 +522,17 @@ sub secondlevel {
 
 sub openmenu {
     my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
-    if ($ENV{'browser.interface'} eq 'textual') { return ''; }
-    if ($ENV{'browser.type'} eq 'explorer') {
-       return "window.open('javascript:void(0);','".$menuname."');";
-   } else {
-       return "window.open('','".$menuname."');";
-   }
+    if (($ENV{'browser.interface'} eq 'textual') ||
+        ($ENV{'environment.remote'} eq 'off')) { return ''; }
+    my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
+    return "window.open(".$nothing.",'".$menuname."');";
 }
 
 sub rawconfig {
     my $textualoverride=shift;
     my $output='';
-    unless ($ENV{'browser.interface'} eq 'textual') {
+    unless (($ENV{'browser.interface'} eq 'textual') ||
+            ($ENV{'environment.remote'} eq 'off')) {
        $output.=
  "window.status='Opening Remote Control';var swmenu=".&openmenu().
 "\nwindow.status='Configuring Remote Control ';";
@@ -489,7 +605,8 @@ sub rawconfig {
             }
         }
     }
-    unless ($ENV{'browser.interface'} eq 'textual') {
+    unless (($ENV{'browser.interface'} eq 'textual') ||
+            ($ENV{'environment.remote'} eq 'off')) {
        $output.="\nwindow.status='Synchronizing Time';swmenu.syncclock(1000*".time.");\nwindow.status='Remote Control Configured.';";
     }
     return $output;
@@ -498,7 +615,8 @@ sub rawconfig {
 # ======================================================================= Close
 
 sub close {
-    if ($ENV{'browser.interface'} eq 'textual') { return ''; }
+    if (($ENV{'browser.interface'} eq 'textual') ||
+        ($ENV{'environment.remote'} eq 'off')) { return ''; }
     my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
     return(<<ENDCLOSE);
 <script>
@@ -521,6 +639,60 @@ sub footer {
 
 }
 
+sub utilityfunctions {
+    unless (($ENV{'browser.interface'} eq 'textual')  ||
+        ($ENV{'environment.remote'} eq 'off')) { return ''; }
+    my $currenturl=$ENV{'REQUEST_URI'};
+    my $currentsymb=$ENV{'request.symb'};
+return (<<ENDUTILITY)
+
+    var currentURL="$currenturl";
+    var reloadURL="$currenturl";
+    var currentSymb="$currentsymb";
+
+function go(url) {
+   if (url!='' && url!= null) {
+       currentURL = null;
+       currentSymb= null;
+       window.location.href=url;
+   }
+}
+
+function gopost(url,postdata) {
+   if (url!='') {
+      this.document.server.action=url;
+      this.document.server.postdata.value=postdata;
+      this.document.server.command.value='';
+      this.document.server.url.value='';
+      this.document.server.symb.value='';
+      this.document.server.submit();
+   }
+}
+
+function gocmd(url,cmd) {
+   if (url!='') {
+      this.document.server.action=url;
+      this.document.server.postdata.value='';
+      this.document.server.command.value=cmd;
+      this.document.server.url.value=currentURL;
+      this.document.server.symb.value=currentSymb;
+      this.document.server.submit();
+   }
+}
+ENDUTILITY
+}
+
+sub serverform {
+    return(<<ENDSERVERFORM);
+
+<form name="server" action="/adm/logout" method="post">
+<input type="hidden" name="postdata" value="none" />
+<input type="hidden" name="command" value="none" />
+<input type="hidden" name="url" value="none" />
+<input type="hidden" name="symb" value="none" />
+</form>
+ENDSERVERFORM
+}
 # ================================================ Handler when called directly
 
 
@@ -530,23 +702,20 @@ sub handler {
     $r->send_http_header;
     return OK if $r->header_only;
 
+    my $utility=&utilityfunctions();
+    my $form=&serverform();
     my $bodytag=&Apache::loncommon::bodytag('Main Menu');
 # ------------------------------------------------------------ Print the screen
     $r->print(<<ENDHEADER);
 <html><head>
 <title>LON-CAPA Main Menu</title>
 <script>
-function go(url) {
-    window.location=url;
-}
-function gopost(url) {
-    window.location=url;
-}
+$utility
 </script>
 </head>
 $bodytag
 ENDHEADER
-    $r->print(&rawconfig(1));
+    $r->print(&rawconfig(1).$form);
     $r->print('</body></html>');
     return OK;
 }