--- loncom/interface/lonmenu.pm 2001/06/08 13:02:44 1.5 +++ loncom/interface/lonmenu.pm 2003/04/03 15:23:41 1.52 @@ -1,74 +1,546 @@ # The LearningOnline Network with CAPA # Routines to control the menu # -# (TeX Conversion Module +# $Id: lonmenu.pm,v 1.52 2003/04/03 15:23:41 www Exp $ # -# 05/29/00,05/30 Gerd Kortemeyer) +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +# +# 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 Gerd Kortemeyer 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); - -# =============================================================== Open the menu -sub open { - return(< -window.status='MenuControl:nologout'; -menu=window.open("/res/adm/pages/menu.html","LONCAPAmenu", - "height=350,width=150,scrollbars=no,menubar=no"); +// BEGIN LON-CAPA Internal -ENDOPEN +Main Menu
+ +ENDMAINMENU + if ($registration) { $output.=&innerregister($forcereg,$target); } + return $output."
"; + } elsif ($ENV{'environment.remote'} eq 'off') { +# Remote Control is switched off + my $output=(< +// BEGIN LON-CAPA Internal + +Main Menu +Launch Remote Control + +ENDINLINEMENU + if ($registration) { $output.=&innerregister($forcereg,$target); } + return $output."
"; + } else { + return ''; + } } -# ============================================================ Switch Menu Item +# ====================================== This gets called in the header section -sub switchmenu { - my ($row,$col,$imgsrc,$texttop,$textbot,$action)=@_; - return(<\n". + "if (typeof swmenu != 'undefined') {swmenu.currentURL=null;}\n". + &Apache::loncommon::browser_and_searcher_javascript(). + "\n\n"; + } + if (($ENV{'browser.interface'} eq 'textual') || + ((($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); + + my $reopen=&Apache::lonmenu::reopenmenu(); + + my $newmail=''; + if (&Apache::lonmsg::newmail()) { + $newmail=($textual? + 'You have new messages
': + '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 (&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=(< - swmenu=window.open('','LONCAPAmenu'); - swmenu.switchbutton($row,$col,"$imgsrc","$texttop","$textbot","$action"); +// BEGIN LON-CAPA Internal +$utility + +$timesync +$newmail +$buttons +$hwkadd +$editbutton +$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 -ENDSMENU +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 { + window.location='/adm/remote?action=collapse&url=$esclowerurl'; + } + } else { + wheelswitch(); + setTimeout('wait();',200); + } +} + +function main() { + canceltim=setTimeout('tim=1;',30000); + window.status='-'; + wait(); +} + + +ENDREMOTESTARTUP +} + +sub setflags() { + return(< + menuloaded=0; + tim=0; + +ENDSETFLAGS +} + +sub maincall() { + if (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off')) { return ''; } + return(< + main(); + +ENDMAINCALL +} +# ================================================================= Reopen menu + +sub reopenmenu { + if (($ENV{'browser.interface'} eq 'textual') || + ($ENV{'environment.remote'} eq 'off')) { return ''; } + my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'}; + 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 + $returnval.=(<'.$returnval.''; +} + + # ================================================================== 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 { 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)=@_; + 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");); + 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?' ':'
'). + ''.$text.' '. + ($nobreak?'':$desc); + } else { +# Inline Remote + if ($nobreak==2) { return ''; } + my $text=$top.' '.$bot; + $text=~s/\- //; + return "\n".($nobreak?' ':'
'). + ''.$text.' '. + ($nobreak?'':$desc); + } } sub secondlevel { my $output=''; my - ($uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act)=@_; + ($uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc)=@_; if ($prt eq 'any') { - $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act); + $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc); } elsif ($prt=~/^r(\w+)/) { if ($rol eq $1) { - $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act); + $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc); } } return $output; } +sub openmenu { + my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'}; + 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 $output="swmenu=window.open('','LONCAPAmenu');"; + 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'}; @@ -76,52 +548,89 @@ sub rawconfig { my $crs=''; if ($ENV{'request.course.id'}) { $crs='/'.$ENV{'request.course.id'}; - $crs=~s/\_/\//; + if ($ENV{'request.course.sec'}) { + $crs.='_'.$ENV{'request.course.sec'}; + } + $crs=~s/\_/\//g; } my $pub=($ENV{'request.state'} eq 'published'); my $con=($ENV{'request.state'} eq 'construct'); my $rol=$ENV{'request.role'}; - map { - my ($row,$col,$pro,$prt,$img,$top,$bot,$act)=split(/\:/,$_); + my $requested_domain = $ENV{'request.role.domain'}; + foreach (@desklines) { + my ($row,$col,$pro,$prt,$img,$top,$bot,$act,$desc)=split(/\:/,$_); $prt=~s/\$uname/$uname/g; $prt=~s/\$udom/$udom/g; $prt=~s/\$crs/$crs/g; + $prt=~s/\$requested_domain/$requested_domain/g; if ($pro eq 'clear') { $output.=&clear($row,$col); } elsif ($pro eq 'any') { $output.=&secondlevel( - $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act); + $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc); } elsif ($pro eq 'smp') { unless ($adv) { $output.=&secondlevel( - $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act); + $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc); } } elsif ($pro eq 'adv') { if ($adv) { $output.=&secondlevel( - $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act); + $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc); } } elsif (($pro=~/p(\w+)/) && ($prt)) { if (&Apache::lonnet::allowed($1,$prt)) { - $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act); + $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc); } + } elsif ($pro eq 'course') { + if ($ENV{'request.course.fn'}) { + $output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc); + } } elsif ($pro eq 'author') { if ($author) { + if ((($prt eq 'rca') && ($ENV{'request.role'}=~/^ca/)) || + (($prt eq 'rau') && ($ENV{'request.role'}=~/^au/))) { + # Check that we are on the correct machine + my $cadom=$requested_domain; + my $caname=$ENV{'user.name'}; + if ($prt eq 'rca') { + ($cadom,$caname)= + ($ENV{'request.role'}=~/(\w+)\/(\w+)$/); + } + $act =~ s/\$caname/$caname/g; + my $home = &Apache::lonnet::homeserver($caname,$cadom); + if ($home eq $Apache::lonnet::perlvar{'lonHostID'}) { + $output.=switch($caname,$cadom, + $row,$col,$img,$top,$bot,$act,$desc); + } + } } } - } @desklines; + } + 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='MenuControl:nologout'; -menu=window.open("/adm/rat/empty.html","LONCAPAmenu", +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 } @@ -132,20 +641,107 @@ 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 $utility=&utilityfunctions(); + my $form=&serverform(); + my $bodytag=&Apache::loncommon::bodytag('Main Menu'); +# ------------------------------------------------------------ Print the screen + $r->print(< +LON-CAPA Main Menu + + +$bodytag +ENDHEADER + $r->print(&rawconfig(1).$form); + $r->print(''); + return OK; +} + # ================================================================ Main Program -sub BEGIN { -if ($readdesk ne 'done') { - { +BEGIN { + if (! defined($readdesk)) { + { my $config=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}. - '/mydesk.tab'); + '/mydesk.tab'); while (my $configline=<$config>) { + $configline=(split(/\#/,$configline))[0]; + $configline=~s/^\s+//; chomp($configline); - $desklines[$#desklines+1]=$configline; + if ($configline) { + $desklines[$#desklines+1]=$configline; + } } + } + $readdesk='done'; } } -} + 1; __END__