# The LearningOnline Network with CAPA
# Routines to control the menu
#
# $Id: lonmenu.pm,v 1.118 2004/10/28 16:25:21 albertel Exp $
#
# 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'
#
package Apache::lonmenu;
use strict;
use Apache::lonnet();
use Apache::Constants qw(:common);
use Apache::lonhtmlcommon();
use Apache::loncommon();
use Apache::lonnavmaps();
use Apache::lonlocal;
use vars qw(@desklines $readdesk);
my @inlineremote;
my $font;
my $tabbg;
my $pgbg;
# ================================================================ Little texts
sub initlittle {
return &Apache::lonlocal::texthash('ret' => 'Return to Last Location',
'nav' => 'Navigate Contents',
'main' => 'Main Menu',
'launch' => 'Launch Remote Control');
}
# ============================= This gets called at the top of the body section
sub menubuttons {
my $forcereg=shift;
my $target =shift;
my $registration=shift;
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['inhibitmenu']);
if ($ENV{'form.inhibitmenu'} eq 'yes') { return ''; }
my $navmaps='';
my $reloadlink='';
my $escurl=&Apache::lonnet::escape($ENV{'request.noversionuri'});
my $escsymb=&Apache::lonnet::escape($ENV{'request.symb'});
if ($ENV{'browser.interface'} eq 'textual') {
# Textual display only
my %lt=&initlittle();
$pgbg='#FFFFFF';
$tabbg='#FFFFFF';
$font='#000000';
if ($ENV{'request.course.id'}) {
$navmaps=(<$lt{'nav'}
ENDNAV
if (($ENV{'request.noversionuri'}=~/^\/adm\//) &&
($ENV{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
($ENV{'request.noversionuri'}!~/^\/adm\/.*\/(smppg|bulletinboard|aboutme)(\?|$)/)) {
my $escreload=&Apache::lonnet::escape('return:');
$reloadlink=(<$lt{'ret'}
ENDRELOAD
}
}
my $utility=&utilityfunctions();
my $output=(<
// BEGIN LON-CAPA Internal
$utility
$lt{'main'}
$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 %lt=&initlittle();
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.noversionuri'}=~/^(\/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=(<$lt{'nav'}
ENDNAV
if (($ENV{'request.noversionuri'}=~/^\/adm\//) &&
($ENV{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
($ENV{'request.noversionuri'}!~/^\/adm\/.*\/(smppg|bulletinboard|aboutme)(\?|$)/)) {
my $escreload=&Apache::lonnet::escape('return:');
$reloadlink=(<$lt{'ret'}
ENDRELOAD
}
}
my $reg='';
if ($registration) {
$reg=&innerregister($forcereg,$target);
}
my $utility=&utilityfunctions();
return (<
// BEGIN LON-CAPA Internal
$utility
$reg
ENDINLINEMENU
} else {
return '';
}
}
# ====================================== This gets called in the header section
sub registerurl {
my $forcereg=shift;
my $target = shift;
my $result = '';
if ($ENV{'request.noversionuri'} eq '/res/adm/pages/menu.html') { return ''; }
my $force_title='';
if ($ENV{'request.state'} eq 'construct') {
$force_title=&Apache::lonxml::display_title();
}
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(
&Apache::lonnet::unescape($ENV{'request.noversionuri'})))) &&
(!$forcereg))) {
return $result.
''.$force_title;
}
# Graphical display after login only
if ($Apache::lonxml::registered && !$forcereg) { return ''; }
if ($target ne 'edit') {
$result.=&innerregister($forcereg,$target);
}
return $result.$force_title;
}
# =========== 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 = '';
if ($ENV{'request.noversionuri'} eq '/res/adm/pages/menu.html') { return ''; }
$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)=&Apache::lonnet::decode_symb($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?'
':'').($textinter?'':'');
# =============================================================================
# ============================ This is for URLs that actually can be registered
if (($ENV{'request.noversionuri'}!~/^\/(res\/)*adm\//) || ($forcereg)) {
# -- This applies to homework problems for users with grading privileges
my $crs='/'.$ENV{'request.course.id'};
if ($ENV{'request.course.sec'}) {
$crs.='_'.$ENV{'request.course.sec'};
}
$crs=~s/\_/\//g;
my $hwkadd='';
if ($ENV{'request.filename'}=~/\.(problem|exam|quiz|assess|survey|form)$/) {
if (&Apache::lonnet::allowed('vgr',$crs)) {
$hwkadd.=&switch('','',7,1,'subm.gif','view sub-[_1]','missions[_1]',
"gocmd('/adm/grades','submission')",
'View user submissions for this assessment resource');
}
if (&Apache::lonnet::allowed('mgr',$crs)) {
$hwkadd.=&switch('','',7,2,'pgrd.gif','problem[_1]','grades[_3]',
"gocmd('/adm/grades','gradingmenu')",
'Modify user grades for this assessment resource');
}
}
if (&Apache::lonnet::allowed('opa',$crs)) {
$hwkadd.=&switch('','',7,3,'pparm.gif','problem[_2]','parms[_2]',
"gocmd('/adm/parmset','set')",
'Modify deadlines, etc, for this 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);
my $allowed=0;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if (!$allowed) {
$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/;
# Check that the user has permission to edit this resource
($cfuname,$cfudom)=&Apache::loncacc::constructaccess($file,$1);
if (defined($cfudom)) {
my $home=&Apache::lonnet::homeserver($cfuname,$cfudom);
my $allowed=0;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if ($allowed) {
$cfile=$file;
}
}
}
# Finally, turn the button on or off
if ($cfile) {
$editbutton=&switch
('','',6,1,'cstr.gif','edit[_1]','resource[_2]',
"go('".$cfile."');","Edit this resource");
} elsif ($editbutton eq '') {
$editbutton=&clear(6,1);
}
}
###
###
# Prepare the rest of the buttons
my $menuitems=(<
$inlineremote[21]
 
$inlineremote[23]
$inlineremote[61]
$inlineremote[62]
$inlineremote[63]
$inlineremote[71]
$inlineremote[72]
$inlineremote[73]
$inlineremote[81]
$inlineremote[82]
$inlineremote[83]
$inlineremote[91]
$inlineremote[92]
$inlineremote[93]
ENDINLINE
}
$result =(<
// BEGIN LON-CAPA Internal
$timesync
$newmail
$tablestart
$inlinebuttons
$tableend
$form
ENDREGTEXT
# Registered, graphical output
} else {
my $requri=(split(/\?/,$ENV{'request.noversionuri'}))[0];
$requri=&Apache::lonnet::unescape($requri);
my $navstatus=&get_nav_status();
$result = (<
// BEGIN LON-CAPA Internal
var swmenu=null;
function LONCAPAreg() {
swmenu=$reopen;
swmenu.clearTimeout(swmenu.menucltim);
$timesync
$newmail
$buttons
swmenu.currentURL="$requri";
swmenu.reloadURL=swmenu.currentURL+window.location.search;
swmenu.currentSymb="$ENV{'request.symb'}";
swmenu.reloadSymb="$ENV{'request.symb'}";
swmenu.currentStale=0;
$navstatus
$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,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() {
if ($ENV{'request.noversionuri'} eq '/res/adm/pages/menu.html') { return ''; }
return 'LONCAPAreg();';
}
sub unloadevents() {
if ($ENV{'request.noversionuri'} eq '/res/adm/pages/menu.html') { return ''; }
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);
my $message=&mt('"Waiting for remote to load "+[_1]','waited');
return(<
var timestart;
function wheelswitch() {
if (typeof(document.wheel) != 'undefined') {
if (typeof(document.wheel.spin) != 'undefined') {
var date=new Date();
var waited=Math.round(30-((date.getTime()-timestart)/1000));
document.wheel.spin.value=$message;
}
}
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='-';
var date=new Date();
timestart=date.getTime();
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
}
sub load_remote_msg {
my ($lowerurl)=@_;
if (($ENV{'browser.interface'} eq 'textual') ||
($ENV{'environment.remote'} eq 'off')) { return ''; }
my $esclowerurl=&Apache::lonnet::escape($lowerurl);
my $link=&mt('Continue on in inline remote mode',
"/adm/remote?action=collapse?url=$esclowerurl");
return(<
$link
ENDREMOTEFORM
}
# ================================================================= 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)=@_;
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,$nobreak)=@_;
$act=~s/\$uname/$uname/g;
$act=~s/\$udom/$udom/g;
$top=&mt($top);
$bot=&mt($bot);
$desc=&mt($desc);
$img=&mt($img);
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/\s*\-\s*//gs;
if ($nobreak) {
$inlineremote[10*$row+$col]=
''.$text.'';
} else {
$inlineremote[10*$row+$col]="\n ".
$desc.' '.$text.'';
}
} else {
# Inline Remote
if ($nobreak==2) { return ''; }
my $text=$top.' '.$bot;
$text=~s/\s*\-\s*//gs;
my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
my $pic=
'';
if (($ENV{'browser.interface'} eq 'textual') || ($ENV{'browser.interface'} eq 'faketextual')) {
# Accessibility
if ($nobreak==3) {
$inlineremote[10*$row+$col]="\n".
'