--- loncom/interface/lonmenu.pm 2003/02/17 17:34:16 1.40 +++ loncom/interface/lonmenu.pm 2003/04/18 17:51:32 1.65 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Routines to control the menu # -# $Id: lonmenu.pm,v 1.40 2003/02/17 17:34:16 www Exp $ +# $Id: lonmenu.pm,v 1.65 2003/04/18 17:51:32 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,21 +25,30 @@ # # 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); +my @inlineremote; +my $font; +my $tabbg; +my $pgbg; # ============================= This gets called at the top of the body section @@ -47,10 +56,106 @@ sub menubuttons { my $forcereg=shift; my $target =shift; my $registration=shift; - unless ($ENV{'browser.interface'} eq 'textual') { return ''; } - my $output='<a href="/adm/menu">Main Menu</a><br />'; - if ($registration) { $output.=&innerregister($forcereg,$target); } - return $output."<hr />"; + my $navmaps=''; + my $reloadlink=''; + my $escurl=&Apache::lonnet::escape($ENV{'REQUEST_URI'}); + my $escsymb=&Apache::lonnet::escape($ENV{'request.symb'}); + if ($ENV{'browser.interface'} eq 'textual') { +# Textual display only + if ($ENV{'request.course.id'}) { + $navmaps=(<<ENDNAV); +<a href="/adm/navmaps?postdata=$escurl&postsymb=$escsymb" target="_top">Navigate Contents</a> +ENDNAV + if (($ENV{'REQUEST_URI'}=~/^\/adm\//) && + ($ENV{'REQUEST_URI'}!~/^\/adm\/wrapper\//) && + ($ENV{'REQUEST_URI'}!~/^\/adm\/.*\/(smppg|bulletinboard|aboutme)(\?|$)/)) { + my $escreload=&Apache::lonnet::escape('return:'); + $reloadlink=(<<ENDRELOAD); +<a href="/adm/flip?postdata=$escreload" target="_top"><font color="$font">Return to Last Location</font></a> +ENDRELOAD + } + } + my $output=(<<ENDMAINMENU); +<script> +// BEGIN LON-CAPA Internal +</script> +<a href="/adm/menu" target="_top">Main Menu</a> +$reloadlink $navmaps<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 +# figure out colors + my $function='student'; + if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) { + $function='coordinator'; + } + if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) { + $function='admin'; + } + if (($ENV{'request.role'}=~/^(au|ca)/) || + ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) { + $function='author'; + } + my $domain=&Apache::loncommon::determinedomain(); + $pgbg=&Apache::loncommon::designparm($function.'.pgbg',$domain); + $tabbg=&Apache::loncommon::designparm($function.'.tabbg',$domain); + $font=&Apache::loncommon::designparm($function.'.font',$domain); + my $link=&Apache::loncommon::designparm($function.'.link',$domain); + my $alink=&Apache::loncommon::designparm($function.'.alink',$domain); + my $vlink=&Apache::loncommon::designparm($function.'.vlink',$domain); + my $sidebg=&Apache::loncommon::designparm($function.'.sidebg',$domain); +# Do we have a NAV link? + if ($ENV{'request.course.id'}) { + $navmaps=(<<ENDNAVREM); +<td bgcolor="$tabbg"> +<a href="/adm/navmaps?postdata=$escurl&postsymb=$escsymb" target="_top"><font color="$font">Navigate Contents</font></a></td> +ENDNAVREM + if (($ENV{'REQUEST_URI'}=~/^\/adm\//) && + ($ENV{'REQUEST_URI'}!~/^\/adm\/wrapper\//) && + ($ENV{'REQUEST_URI'}!~/^\/adm\/.*\/(smppg|bulletinboard|aboutme)(\?|$)/)) { + my $escreload=&Apache::lonnet::escape('return:'); + $reloadlink=(<<ENDRELOAD); +<td bgcolor="$tabbg"> +<a href="/adm/flip?postdata=$escreload" target="_top"><font color="$font">Return to Last Location</font></a></td> +ENDRELOAD + } + } + my $reg=''; + if ($registration) { + $reg=&innerregister($forcereg,$target); + } + return (<<ENDINLINEMENU); +<script> +// BEGIN LON-CAPA Internal +</script> +<table bgcolor="$pgbg" width="100%" border="0" cellpadding="3" cellspacing="3"> +<tr> +<td bgcolor="$tabbg"> +<a href="/adm/menu" target="_top"><font color="$font">Main Menu</font></a> +</td> +$reloadlink +$navmaps +<td bgcolor="$tabbg"> +<a href="/adm/remote?action=launch&url=$escurl" target="_top"> +<font color="$font">Launch Remote Control</font></a></td> +<td bgcolor="$tabbg"> +<img align="right" src="/adm/lonIcons/minilogo.gif" /> +<b>LON-CAPA</b></td> +</tr> +</table> +<script> +// END LON-CAPA Internal +</script> +$reg +ENDINLINEMENU + } else { + return ''; + } } # ====================================== This gets called in the header section @@ -61,18 +166,20 @@ 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"; } if (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off') || ((($ENV{'request.publicaccess'}) || (!&Apache::lonnet::is_on_map($ENV{'REQUEST_URI'}))) && (!$forcereg))) { 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; @@ -88,16 +195,46 @@ sub innerregister { $Apache::lonxml::registered=1; - my $textual=($ENV{'browser.interface'} eq 'textual'); + my $textinter=($ENV{'browser.interface'} eq 'textual'); + my $noremote=($ENV{'environment.remote'} eq 'off'); + + my $textual=($textinter || $noremote); + + @inlineremote=(); + undef @inlineremote; + my $reopen=&Apache::lonmenu::reopenmenu(); my $newmail=''; + if ($noremote) { + $newmail='<table bgcolor="'.$pgbg.'" border="0" cellspacing="3" cellpadding="3" width="100%"><tr><td bgcolor="'.$tabbg.'">'; + } + if (($textual) && ($ENV{'request.symb'}) && ($ENV{'request.course.id'})) { + my ($mapurl,$rid,$resurl)=split(/\_\_\_/,$ENV{'request.symb'}); + $newmail.=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + my $maptitle=&Apache::lonnet::gettitle($mapurl); + my $restitle=&Apache::lonnet::gettitle($resurl); + if ($maptitle) { + $newmail.=', '.$maptitle; + } + if ($restitle) { + $newmail.=': '.$restitle; + } + $newmail.=' '; + } if (&Apache::lonmsg::newmail()) { - $newmail=($textual?'<b>You have messages</b><br />': + $newmail=($textual? + '<b><a href="/adm/communicate">You have new messages</a></b><br />': 'swmenu.setstatus("you have","messages");'); } + if ($noremote) { + $newmail.='</td></tr></table>'; + } my $timesync=($textual?'':'swmenu.syncclock(1000*'.time.');'); -# -- This is for URLs that actually can be registered + my $tablestart=($noremote?'<table bgcolor="'.$pgbg.'" border="0" cellspacing="3" cellpadding="3" width="100%">':''); + my $tableend=($noremote?'</table>':''); +# ============================================================================= +# ============================ 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=''; @@ -176,40 +313,69 @@ sub innerregister { } ### ### - $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&3 +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(); + my $inlinebuttons= + join('',map { (defined($_)?$_:'') } @inlineremote); + $result =(<<ENDREGTEXT); +<script> +// BEGIN LON-CAPA Internal +$utility +</script> +$timesync +$newmail +$tablestart +$inlinebuttons +$tableend +$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 } @@ -234,12 +400,21 @@ sub innerregister { // 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 @@ -264,6 +439,8 @@ ENDREGTHIS // END LON-CAPA Internal </script> ENDDONOTREGTHIS + } +# ============================================================================= } return $result; } @@ -280,10 +457,16 @@ 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(); + my $esclowerurl=&Apache::lonnet::escape($lowerurl); + return(<<ENDREMOTESTARTUP); <script> @@ -313,7 +496,7 @@ function wait() { $configmenu window.location='$lowerurl'; } else { - alert("Remote Control timed out. It is possible that it was blocked by pop-up window filters."); + window.location='/adm/remote?action=collapse&url=$esclowerurl'; } } else { wheelswitch(); @@ -322,7 +505,7 @@ function wait() { } function main() { - canceltim=setTimeout('tim=1;',60000); + canceltim=setTimeout('tim=1;',30000); window.status='-'; wait(); } @@ -341,7 +524,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(); @@ -351,18 +535,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 @@ -386,9 +571,13 @@ 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 ''; } + } else { + $inlineremote[10*$row+$col]=''; + return ''; + } } # ============================================ Switch a button or create a link @@ -399,15 +588,33 @@ sub switch { 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/\- //; + $inlineremote[10*$row+$col]="\n".($nobreak?' ':'<br />'). + '<a href="javascript:'.$act.';">'.$text.'</a> '. + ($nobreak?'':$desc); } else { +# Inline Remote + if ($nobreak==2) { return ''; } my $text=$top.' '.$bot; $text=~s/\- //; - return ($nobreak?'':'<br />'). - '<a href="javascript:'.$act.';">'.$text.'</a> '.$desc; + $inlineremote[10*$row+$col]="\n". + ($nobreak==3?'<td width="50%" colspan="2" align="right"':'<tr><td'). + ' bgcolor="'.$tabbg.'"'.($nobreak==1?' width="50%" colspan="2"':''). + '"><a href="javascript:'.$act.';"><font color="'.$font.'"'. + ($nobreak?' size="+1"':''). + '>'.$text.'</font></a></td>'. + ($nobreak?'':'<td colspan="3" width="80%"><font color="'.$font.'" size="-1">'.$desc.'</font>').($nobreak!=1?'</tr>':''); } + return ''; } sub secondlevel { @@ -426,18 +633,24 @@ 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 inlinemenu { + @inlineremote=(); + undef @inlineremote; + &rawconfig(1); + return join('',map { (defined($_)?$_:'') } @inlineremote); } 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 ';"; @@ -510,7 +723,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; @@ -519,7 +733,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> @@ -542,6 +757,68 @@ 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(); + } +} + +function catalog_info() { + loncatinfo=window.open(window.location.pathname+'.meta',"LONcatInfo",'height=320,width=280,resizeable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no'); +} + +function chat_win() { + lonchat=window.open('/res/adm/pages/chatroom.html',"LONchat",'height=320,width=280,resizeable=yes,location=no,menubar=no,toolbar=no'); +} +ENDUTILITY +} + +sub serverform { + return(<<ENDSERVERFORM); + +<form name="server" action="/adm/logout" method="post" target="_top"> +<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 @@ -551,23 +828,38 @@ sub handler { $r->send_http_header; return OK if $r->header_only; + my $form=&serverform(); my $bodytag=&Apache::loncommon::bodytag('Main Menu'); -# ------------------------------------------------------------ Print the screen + my $function='student'; + if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) { + $function='coordinator'; + } + if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) { + $function='admin'; + } + if (($ENV{'request.role'}=~/^(au|ca)/) || + ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) { + $function='author'; + } + my $domain=&Apache::loncommon::determinedomain(); + $pgbg=&Apache::loncommon::designparm($function.'.pgbg',$domain); + $tabbg=&Apache::loncommon::designparm($function.'.tabbg',$domain); + $font=&Apache::loncommon::designparm($function.'.font',$domain); +# ---- Print the screen, pretent to be in text mode to generate text-based menu + unless ($ENV{'brower.interface'} eq 'textual') { + $ENV{'environment.remote'}='off'; + } + my $utility=&utilityfunctions(); $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('<table>'.&inlinemenu().'</table>'.$form); $r->print('</body></html>'); return OK; }