--- loncom/interface/lonmenu.pm 2003/01/31 21:46:36 1.32 +++ 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.32 2003/01/31 21:46:36 www Exp $ +# $Id: lonmenu.pm,v 1.65 2003/04/18 17:51:32 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,46 +25,488 @@ # # 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 + +sub menubuttons { + my $forcereg=shift; + my $target =shift; + my $registration=shift; + 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=(<Navigate Contents +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=(<Return to Last Location +ENDRELOAD + } + } + my $output=(< +// BEGIN LON-CAPA Internal + +Main Menu +$reloadlink $navmaps
+ +ENDMAINMENU + if ($registration) { $output.=&innerregister($forcereg,$target); } + return $output."
"; + } 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=(< +Navigate Contents +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=(< +Return to Last Location +ENDRELOAD + } + } + my $reg=''; + if ($registration) { + $reg=&innerregister($forcereg,$target); + } + return (< +// BEGIN LON-CAPA Internal + + + + +$reloadlink +$navmaps + + + +
+Main Menu + + +Launch Remote Control + +LON-CAPA
+ +$reg +ENDINLINEMENU + } else { + return ''; + } +} + +# ====================================== This gets called in the header section + +sub registerurl { + my $forcereg=shift; + my $target = shift; + my $result = ''; + + if ($target eq 'edit') { + $result .="\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. + ''; + } +# 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); + + @inlineremote=(); + undef @inlineremote; + + my $reopen=&Apache::lonmenu::reopenmenu(); + + my $newmail=''; + if ($noremote) { + $newmail='
'; + } + 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? + 'You have new messages
': + 'swmenu.setstatus("you have","messages");'); + } + if ($noremote) { + $newmail.='
'; + } + my $timesync=($textual?'':'swmenu.syncclock(1000*'.time.');'); + my $tablestart=($noremote?'':''); + my $tableend=($noremote?'
':''); +# ============================================================================= +# ============================ 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 (&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) { + $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.=&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.=&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 + ### + my $editbutton = ''; + if ($ENV{'user.author'}) { + if ($ENV{'request.role'}=~/^(ca|au)/) { + # Set defaults for authors + my ($top,$bottom) = ('con-','struct'); + my $action = "go('/priv/".$ENV{'user.name'}."');"; + my $cadom = $ENV{'request.role.domain'}; + my $caname = $ENV{'user.name'}; + my $desc = "Enter my resource construction space"; + # Set defaults for co-authors + if ($ENV{'request.role'} =~ /^ca/) { + ($cadom,$caname)=($ENV{'request.role'}=~/(\w+)\/(\w+)$/); + ($top,$bottom) = ('co con-','struct'); + $action = "go('/priv/".$caname."');"; + $desc = "Enter construction space as co-author"; + } + # Check that we are on the correct machine + my $home = &Apache::lonnet::homeserver($caname,$cadom); + if ($home eq $Apache::lonnet::perlvar{'lonHostID'}) { + $editbutton=&switch + ('','',6,1,$top,,$bottom,$action,$desc); + } + } + ## + ## Determine if user can edit url. + ## + my $cfile=''; + my $cfuname=''; + my $cfudom=''; + if ($ENV{'request.filename'}) { + my $file=&Apache::lonnet::declutter($ENV{'request.filename'}); + $file=~s/^(\w+)\/(\w+)/\/priv\/$2/; + # Chech that the user has permission to edit this resource + ($cfuname,$cfudom)=&Apache::loncacc::constructaccess($file,$1); + if (defined($cfudom)) { + if (&Apache::lonnet::homeserver($cfuname,$cfudom) + eq $Apache::lonnet::perlvar{'lonHostID'}) { + $cfile=$file; + } + } + } + # Finally, turn the button on or off + if ($cfile) { + $editbutton=&switch + ('','',6,1,'cstr.gif','edit','resource', + "go('".$cfile."');","Edit this resource"); + } elsif ($editbutton eq '') { + $editbutton=&clear(6,1); + } + } + ### + ### +# Prepare the rest of the buttons + my $menuitems=(< +// BEGIN LON-CAPA Internal +$utility + +$timesync +$newmail +$tablestart +$inlinebuttons +$tableend +$form + + +ENDREGTEXT +# Registered, graphical output + } else { + $result = (< +// 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+window.location.search; + swmenu.currentSymb="$ENV{'request.symb'}"; + swmenu.reloadSymb="$ENV{'request.symb'}"; + swmenu.currentStale=0; + $hwkadd + $editbutton + } + + function LONCAPAstale() { + swmenu=$reopen + swmenu.currentStale=1; + if (swmenu.reloadURL!='' && swmenu.reloadURL!= null) { + swmenu.switchbutton + (3,1,'reload.gif','return','location','go(reloadURL)','Return to the last known location in the course sequence'); + } + swmenu.clearbut(7,1); + swmenu.clearbut(7,2); + swmenu.clearbut(7,3); + swmenu.menucltim=swmenu.setTimeout( + 'clearbut(2,1);clearbut(2,3);clearbut(8,1);clearbut(8,2);clearbut(8,3);'+ + 'clearbut(9,1);clearbut(9,2);clearbut(9,3);clearbut(6,3);clearbut(6,1)', + 2000); + + } + +// END LON-CAPA Internal + +ENDREGTHIS + } +# ============================================================================= + } else { +# ========================================== This can or will not be registered + if ($textual) { +# Not registered, textual + $result= (< +// BEGIN LON-CAPA Internal +var swmenu=null; + + function LONCAPAreg() { + swmenu=$reopen + $timesync + swmenu.currentStale=1; + swmenu.clearbut(2,1); + swmenu.clearbut(2,3); + swmenu.clearbut(8,1); + swmenu.clearbut(8,2); + swmenu.clearbut(8,3); + if (swmenu.currentURL) { + swmenu.switchbutton + (3,1,'reload.gif','return','location','go(currentURL)'); + } else { + swmenu.clearbut(3,1); + } + } + + function LONCAPAstale() { + } + +// END LON-CAPA Internal + +ENDDONOTREGTHIS + } +# ============================================================================= + } + return $result; +} + +sub loadevents() { + return 'LONCAPAreg();'; +} + +sub unloadevents() { + return 'LONCAPAstale();'; +} # ============================================================= Start up remote sub startupremote { my ($lowerurl)=@_; + if (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off')) { + return (''); + } +# +# The Remote actually gets launched! +# my $configmenu=&rawconfig(); + my $esclowerurl=&Apache::lonnet::escape($lowerurl); + return(< +function wheelswitch() { + if (window.status=='|') { + window.status='/'; + } else { + if (window.status=='/') { + window.status='-'; + } else { + if (window.status=='-') { + window.status='\\\\'; + } else { + if (window.status=='\\\\') { window.status='|'; } + } + } + } +} + // ---------------------------------------------------------- The wait function var canceltim; function wait() { if ((menuloaded==1) || (tim==1)) { + window.status='Done.'; if (tim==0) { clearTimeout(canceltim); $configmenu window.location='$lowerurl'; } else { - alert("Remote Control Timed Out."); + window.location='/adm/remote?action=collapse&url=$esclowerurl'; } } else { - setTimeout('wait();',100); + wheelswitch(); + setTimeout('wait();',200); } } function main() { - canceltim=setTimeout('tim=1;',80000); + canceltim=setTimeout('tim=1;',30000); + window.status='-'; wait(); } @@ -82,6 +524,8 @@ ENDSETFLAGS } sub maincall() { + if (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off')) { return ''; } return(< main(); @@ -91,16 +535,19 @@ ENDMAINCALL # ================================================================= Reopen menu sub reopenmenu { - my $nothing=''; + 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') || + ($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 @@ -112,40 +559,62 @@ if (window.screen) { ENDRESIZE } $returnval.=(<'.$returnval.''; } -# ============================================================ Switch Menu Item - -sub switchmenu { - my ($row,$col,$imgsrc,$texttop,$textbot,$action,$description)=@_; - my $openwin=&openmenu(); - return(< - var swmenu=$openwin - swmenu.switchbutton($row,$col,"$imgsrc","$texttop","$textbot","$action","$description"); - -ENDSMENU -} # ================================================================== Raw Config sub clear { my ($row,$col)=@_; - return qq(swmenu.clearbut($row,$col);); + unless (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off')) { + return "\n".qq(window.status+='.';swmenu.clearbut($row,$col);); + } else { + $inlineremote[10*$row+$col]=''; + 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; - return "\n". - qq(swmenu.switchbutton($row,$col,"$img","$top","$bot","$act","$desc");); + 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?' ':'
'). + ''.$text.' '. + ($nobreak?'':$desc); + } else { +# Inline Remote + if ($nobreak==2) { return ''; } + my $text=$top.' '.$bot; + $text=~s/\- //; + $inlineremote[10*$row+$col]="\n". + ($nobreak==3?''.$text.''. + ($nobreak?'':''.$desc.'').($nobreak!=1?'':''); + } + return ''; } sub secondlevel { @@ -164,15 +633,30 @@ sub secondlevel { sub openmenu { my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'}; - 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 $output="var swmenu=".&openmenu(); + my $textualoverride=shift; + my $output=''; + 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 ';"; + } else { + unless ($textualoverride) { return ''; } + } my $uname=$ENV{'user.name'}; my $udom=$ENV{'user.domain'}; my $adv=$ENV{'user.adv'}; @@ -239,20 +723,30 @@ sub rawconfig { } } } - $output.="swmenu.syncclock(1000*".time.");"; + 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; } # ======================================================================= Close sub close { + if (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off')) { return ''; } my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'}; return(< +window.status='Accessing Remote Control'; menu=window.open("/adm/rat/empty.html","$menuname", "height=350,width=150,scrollbars=no,menubar=no"); +window.status='Disabling Remote Control'; +menu.active=0; menu.autologout=0; +window.status='Closing Remote Control'; menu.close(); +window.status='Done.'; ENDCLOSE } @@ -263,6 +757,113 @@ 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 (< + + + + + +ENDSERVERFORM +} +# ================================================ Handler when called directly + + +sub handler { + my $r = shift; + $r->content_type('text/html'); + $r->send_http_header; + return OK if $r->header_only; + + my $form=&serverform(); + my $bodytag=&Apache::loncommon::bodytag('Main Menu'); + 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(< +LON-CAPA Main Menu + + +$bodytag +ENDHEADER + $r->print(''.&inlinemenu().'
'.$form); + $r->print(''); + return OK; +} + # ================================================================ Main Program BEGIN {