# The LearningOnline Network with CAPA
# Routines to control the menu
#
# $Id: lonmenu.pm,v 1.210 2007/04/11 15:37:04 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::lonhtmlcommon();
use Apache::loncommon();
use Apache::lonenc();
use Apache::lonlocal;
use LONCAPA qw(:DEFAULT :match);
use vars qw(@desklines %category_names %category_members %category_positions $readdesk);
my @inlineremote;
# ================================================================ Little texts
sub initlittle {
return &Apache::lonlocal::texthash('ret' => 'Return to Last Location',
'nav' => 'Navigate Contents',
'main' => 'Main Menu',
'roles' => ($env{'user.adv'}?
'Roles':'Courses'),
'docs' => 'Course Documents',
'exit' => 'Exit',
'login' => 'Log In',
'launch' => 'Launch Remote Control',
'groups' => 'Groups',
'gdoc' => 'Group Documents',
);
}
# ============================= This gets called at the top of the body section
sub menubuttons {
my $forcereg=shift;
my $registration=shift;
my $titletable=shift;
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['inhibitmenu']);
if (($env{'form.inhibitmenu'} eq 'yes') ||
($ENV{'REQUEST_URI'} eq '/adm/logout')) { return ''; }
if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
my %lt=&initlittle();
my $navmaps='';
my $reloadlink='';
my $docs='';
my $groups='';
my $showgroups=0;
my $escurl=&escape(&Apache::lonenc::check_encrypt($env{'request.noversionuri'}));
my $escsymb=&escape(&Apache::lonenc::check_encrypt($env{'request.symb'}));
my $logo=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/minilogo.gif");
$logo = '
';
if ($env{'request.state'} eq 'construct') {
if (($env{'request.noversionuri'} eq '') || (!defined($env{'request.noversionuri'}))) {
my $returnurl = $env{'request.filename'};
$returnurl =~ s:^/home/([^/]+)/public_html/(.*)$:/priv/$1/$2:;
$escurl = &escape($returnurl);
}
}
if ($env{'request.course.id'}) {
my %coursegroups;
my $viewgrps_permission =
&Apache::lonnet::allowed('vcg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
if (!$viewgrps_permission) {
%coursegroups = &Apache::lonnet::get_active_groups($env{'user.domain'},$env{'user.name'},$env{'course.'.$env{'request.course.id'}.'.domain'}, $env{'course.'.$env{'request.course.id'}.'.num'});
}
if ((keys(%coursegroups) > 0) || ($viewgrps_permission)) {
$showgroups = 1;
}
}
if ($env{'browser.interface'} eq 'textual') {
# Textual display only
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=&escape('return:');
$reloadlink=(<$lt{'ret'}
ENDRELOAD
}
if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
$docs=(<$lt{'docs'}
ENDDOCS
}
if ($showgroups) {
$groups =(<$lt{'groups'}
ENDGROUPS
}
}
my $form=&serverform();
my $utility=&utilityfunctions();
my $output=(<
// BEGIN LON-CAPA Internal
$utility
$form
ENDMAINMENU
if ($registration) { $output.=&innerregister($forcereg); }
return $output."";
} elsif ($env{'environment.remote'} eq 'off') {
# Remote Control is switched off
# figure out colors
my %lt=&initlittle();
my $domain=&Apache::loncommon::determinedomain();
my $function =&Apache::loncommon::get_users_function();
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);
if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
return (<
ENDINLINEMENU
}
# Do we have a NAV link?
if ($env{'request.course.id'}) {
my $link='/adm/navmaps?postdata='.$escurl.'&postsymb='.
$escsymb;
if ($env{'environment.remotenavmap'} eq 'on') {
$link="javascript:gonav('".$link."')";
}
$navmaps=(<$lt{'nav'}
ENDNAV
my $is_group = (&Apache::loncommon::course_type() eq 'Group');
if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
my $text = ($is_group) ? $lt{'gdoc'} : $lt{'docs'};
$docs=(<$text
ENDDOCS
}
if ($showgroups) {
$groups =(<$lt{'groups'}
ENDGROUPS
}
if (
($env{'request.noversionuri'}=~m[^/(res|public)/] &&
$env{'request.symb'} eq '')
||
(($env{'request.noversionuri'}=~/^\/adm\//) &&
($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) &&
($env{'request.noversionuri'}!~
m[^/adm/.*/(smppg|bulletinboard|aboutme)($|\?)])
)
) {
my $escreload=&escape('return:');
$reloadlink=(<$lt{'ret'}
ENDRELOAD
}
}
if (($env{'request.state'} eq 'construct') && ($env{'request.course.id'})) {
my $escreload=&escape('return:');
$reloadlink=(<$lt{'ret'}
ENDCRELOAD
}
my $reg='';
if ($registration) {
$reg=&innerregister($forcereg,$titletable);
}
my $form=&serverform();
my $utility=&utilityfunctions();
my $remote;
if ($env{'user.adv'}) {
$remote = '
$form
$reg
ENDINLINEMENU
} else {
return '';
}
}
# ====================================== This gets called in the header section
sub registerurl {
my ($forcereg) = @_;
my $result = '';
if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
my $force_title='';
if ($env{'request.state'} eq 'construct') {
$force_title=&Apache::lonxml::display_title();
}
if (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off') ||
((($env{'request.publicaccess'}) ||
(!&Apache::lonnet::is_on_map(
&unescape($env{'request.noversionuri'})))) &&
(!$forcereg))) {
return $result.
''.$force_title;
}
# Graphical display after login only
if ($env{'request.registered'} && !$forcereg) { return ''; }
$result.=&innerregister($forcereg);
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, $titletable) = @_;
my $result = '';
my ($uname,$thisdisfn);
my $const_space = ($env{'request.state'} eq 'construct');
my $is_const_dir = 0;
if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
$env{'request.registered'} = 1;
my $textinter=($env{'browser.interface'} eq 'textual');
my $noremote=($env{'environment.remote'} eq 'off');
my $textual=($textinter || $noremote);
undef(@inlineremote);
my $reopen=&Apache::lonmenu::reopenmenu();
my $newmail='';
if ($noremote) {
$newmail='
';
}
if (&Apache::lonmsg::newmail()) {
if ($textual) {
$newmail.= '
';
my ($mapurl,$rid,$resurl)=
&Apache::lonnet::decode_symb(&Apache::lonnet::symbread());
$newmail.=$env{'course.'.$env{'request.course.id'}.'.description'};
my $maptitle=&Apache::lonnet::gettitle($mapurl);
my $restitle=&Apache::lonnet::gettitle(&Apache::lonnet::symbread());
if ($maptitle && $maptitle ne 'default.sequence') {
$newmail.=', '.$maptitle;
}
if ($restitle) {
$newmail.=': '.$restitle;
}
$newmail.='
';
}
if ($env{'request.state'} eq 'construct') {
$newmail = $titletable;
} else {
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'}!~m|^/(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.symb'} ne '' &&
$env{'request.filename'}=~/\.(problem|exam|quiz|assess|survey|form|task)$/) {
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');
} elsif (&Apache::lonnet::allowed('vgr',$crs)) {
$hwkadd.=&switch('','',7,2,'subm.gif','view sub-[_1]','missions[_1]',
"gocmd('/adm/grades','submission')",
'View user submissions for this assessment resource');
}
}
if ($env{'request.symb'} ne '' &&
&Apache::lonnet::allowed('opa',$crs)) {
$hwkadd.=&switch('','',7,3,'pparm.gif','problem[_2]','parms[_2]',
"gocmd('/adm/parmset','set')",
'Modify parameter settings 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'}=~/($match_domain)\/($match_username)$/);
($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/^($match_domain)\/($match_username)/\/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 && !$const_space) {
$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;
if ($const_space) {
my ($uname,$thisdisfn) =
($env{'request.filename'}=~m|^/home/([^/]+)/public_html/(.*)|);
my $currdir = '/priv/'.$uname.'/'.$thisdisfn;
if ($currdir =~ m-/$-) {
$is_const_dir = 1;
} else {
$currdir =~ s#[^/]+$##;
my $cleandisfn = &Apache::loncommon::escape_single($thisdisfn);
my $esc_currdir = &Apache::loncommon::escape_single($currdir);
$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
ENDREGTEXT
# Registered, graphical output
} else {
my $requri=&Apache::lonnet::clutter(&Apache::lonnet::fixversion((split(/\?/,$env{'request.noversionuri'}))[0]));
$requri=&Apache::lonenc::check_encrypt(&unescape($requri));
my $cursymb=&Apache::lonenc::check_encrypt($env{'request.symb'});
my $navstatus=&get_nav_status();
my $clearcstr;
if ($env{'user.adv'}) { $clearcstr='clearbut(6,1)'; }
$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="$cursymb";
swmenu.reloadSymb="$cursymb";
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,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);$clearcstr',
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.state'} eq 'construct' ||
$env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
return 'LONCAPAreg();';
}
sub unloadevents() {
if ($env{'request.state'} eq 'construct' ||
$env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { 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=&escape($lowerurl);
my $message=&mt('"Waiting for Remote Control window 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=&escape($lowerurl);
my $link=&mt('Continue on in Inline Menu 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,$cat,$nobreak)=@_;
$act=~s/\$uname/$uname/g;
$act=~s/\$udom/$udom/g;
$top=&mt($top);
$bot=&mt($bot);
$desc=&mt($desc);
$img=&mt($img);
my $idx=10*$row+$col;
$category_members{$cat}.=':'.$idx;
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[$idx]=
''.$text.'';
} else {
$inlineremote[$idx]="\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 'faketextual') {
# Accessibility
if ($nobreak==3) {
$inlineremote[$idx]="\n".
'