--- loncom/interface/lonmenu.pm 2005/02/26 06:14:01 1.150
+++ loncom/interface/lonmenu.pm 2009/02/08 20:50:19 1.251
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Routines to control the menu
#
-# $Id: lonmenu.pm,v 1.150 2005/02/26 06:14:01 albertel Exp $
+# $Id: lonmenu.pm,v 1.251 2009/02/08 20:50:19 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -36,77 +36,226 @@
# browser.interface is 'textual'
#
+=head1 NAME
+
+Apache::lonmenu
+
+=head1 SYNOPSIS
+
+Coordinates the response to clicking an image.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=item show_course()
+
+Little texts
+
+=item initlittle()
+
+=item menubuttons()
+
+This gets called at the top of the body section
+
+=item show_return_link()
+
+=item registerurl()
+
+This gets called in the header section
+
+=item innerregister()
+
+This gets called in order to register a URL, both with the Remote
+and in the body of the document
+
+=item loadevents()
+
+=item unloadevents()
+
+=item startupremote()
+
+=item setflags()
+
+=item maincall()
+
+=item load_remote_msg()
+
+=item get_menu_name()
+
+=item reopenmenu()
+
+=item open()
+
+Open the menu
+
+=item clear()
+
+=item switch()
+
+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(..)".
+
+=item secondlevel()
+
+=item openmenu()
+
+=item inlinemenu()
+
+=item rawconfig()
+
+=item close()
+
+=item footer()
+
+=item utilityfunctions()
+
+=item serverform()
+
+=item constspaceform()
+
+=item get_nav_status()
+
+=item convert_menu_function()
+
+FIXME this needs to move into mydesktab and the other locations
+the text is generated
+
+=item hidden_button_check()
+
+=item roles_selector()
+
+=item jump_to_role()
+
+=back
+
+=cut
+
package Apache::lonmenu;
use strict;
-use Apache::lonnet();
-use Apache::Constants qw(:common);
+use Apache::lonnet;
use Apache::lonhtmlcommon();
use Apache::loncommon();
use Apache::lonenc();
use Apache::lonlocal;
+use LONCAPA qw(:DEFAULT :match);
-use vars qw(@desklines $readdesk);
+use vars qw(@desklines %category_names %category_members %category_positions $readdesk);
my @inlineremote;
-my $font;
-my $tabbg;
-my $pgbg;
-# ================================================================ Little texts
+
+
+sub show_course {
+ my $course = !$env{'user.adv'};
+ if (!$env{'user.adv'}) {
+ foreach my $env (keys(%env)) {
+ next if ($env !~ m/^user\.priv\./);
+ if ($env !~ m/^user\.priv\.(?:st|cm)/) {
+ $course = 0;
+ last;
+ }
+ }
+ }
+ return $course;
+}
sub initlittle {
return &Apache::lonlocal::texthash('ret' => 'Return to Last Location',
'nav' => 'Navigate Contents',
'main' => 'Main Menu',
- 'roles' => ($ENV{'user.adv'}?
- 'Roles':'Courses'),
+ 'roles' => (&show_course()?
+ 'Courses':'Roles'),
+ 'other' => 'Other Roles',
+ 'docs' => 'Edit Course',
'exit' => 'Exit',
- 'launch' => 'Launch Remote Control');
+ '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 $target =shift;
my $registration=shift;
my $titletable=shift;
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['inhibitmenu']);
- if (($ENV{'form.inhibitmenu'} eq 'yes') ||
+ 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 $escurl=&Apache::lonnet::escape(&Apache::lonenc::check_encrypt($ENV{'request.noversionuri'}));
- my $escsymb=&Apache::lonnet::escape(&Apache::lonenc::check_encrypt($ENV{'request.symb'}));
- if ($ENV{'request.state'} eq 'construct') {
- if (($ENV{'request.noversionuri'} eq '') || (!defined($ENV{'request.noversionuri'}))) {
- my $returnurl = $ENV{'request.filename'};
+ my $docs='';
+ my $groups='';
+ my $roles=''.$lt{'roles'}.'';
+ my $role_selector;
+ my $showgroups=0;
+ my ($cnum,$cdom);
+ 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 = &Apache::lonnet::escape($returnurl);
+ $escurl = &escape($returnurl);
}
}
- if ($ENV{'browser.interface'} eq 'textual') {
+ if ($env{'request.course.id'}) {
+ $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+ $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+ 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'},$cdom,$cnum);
+ }
+ if ((keys(%coursegroups) > 0) || ($viewgrps_permission)) {
+ $showgroups = 1;
+ }
+ $role_selector = &roles_selector($cdom,$cnum);
+ if ($role_selector) {
+ $roles = ''.$role_selector.' '.$lt{'other'}.'';
+ }
+ }
+
+ if ($env{'browser.interface'} eq 'textual') {
# Textual display only
- my %lt=&initlittle();
- $pgbg='#FFFFFF';
- $tabbg='#FFFFFF';
- $font='#000000';
- if ($ENV{'request.course.id'}) {
+ if ($env{'request.course.id'}) {
$navmaps=(<$lt{'nav'}
+$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:');
+ if (&show_return_link()) {
+ my $escreload=&escape('return:');
$reloadlink=(<$lt{'ret'}
+$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();
@@ -115,76 +264,90 @@ ENDRELOAD
// BEGIN LON-CAPA Internal
$utility
+
';
# Do we have a NAV link?
- if ($ENV{'request.course.id'}) {
+ if ($env{'request.course.id'}) {
my $link='/adm/navmaps?postdata='.$escurl.'&postsymb='.
$escsymb;
- if ($ENV{'environment.remotenavmap'} eq 'on') {
+ if ($env{'environment.remotenavmap'} eq 'on') {
$link="javascript:gonav('".$link."')";
}
$navmaps=(<
-$lt{'nav'}
+
';
+ my ($mapurl,$rid,$resurl)=
+ &Apache::lonnet::decode_symb(&Apache::lonnet::symbread());
+ my $coursetitle=$env{'course.'.$env{'request.course.id'}.'.description'};
+ $newmail.=$coursetitle;
my $maptitle=&Apache::lonnet::gettitle($mapurl);
- my $restitle=&Apache::lonnet::gettitle($resurl);
- if ($maptitle && $maptitle ne 'default.sequence') {
+ my $restitle=&Apache::lonnet::gettitle(&Apache::lonnet::symbread());
+ if ($maptitle && ($maptitle ne 'default.sequence') && ($maptitle ne $coursetitle)) {
$newmail.=', '.$maptitle;
}
if ($restitle) {
$newmail.=': '.$restitle;
}
- $newmail.=' ';
- }
- if (&Apache::lonmsg::newmail()) {
- $newmail=($textual?
- 'You have new messages ':
- 'swmenu.setstatus("you have","messages");');
+ $newmail.='
';
}
- if ($ENV{'request.state'} eq 'construct') {
+ if ($env{'request.state'} eq 'construct') {
$newmail = $titletable;
} else {
if ($noremote) {
- $newmail.='
';
+ $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)) {
+ 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'};
+ 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)$/) {
- 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 ($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 '' &&
+ 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 deadlines, etc, for this resource');
+ 'Modify parameter settings for this resource');
}
# -- End Homework
###
@@ -353,20 +513,25 @@ sub innerregister {
### resource
###
my $editbutton = '';
- if ($ENV{'user.author'}) {
- if ($ENV{'request.role'}=~/^(ca|au)/) {
+ if ($env{'user.author'}) {
+ if ($env{'request.role'}=~/^(aa|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";
+ my $action = "go('/priv/".$env{'user.name'}."');";
+ my $cadom = $env{'request.role.domain'};
+ my $caname = $env{'user.name'};
+ my $desc = "Enter my construction space";
# Set defaults for co-authors
- if ($ENV{'request.role'} =~ /^ca/) {
- ($cadom,$caname)=($ENV{'request.role'}=~/(\w+)\/(\w+)$/);
+ 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";
+ } elsif ($env{'request.role'} =~ /^aa/) {
+ ($cadom,$caname)=($env{'request.role'}=~/($match_domain)\/($match_username)$/);
+ ($top,$bottom) = ('co con-','struct');
+ $action = "go('/priv/".$caname."');";
+ $desc = "Enter construction space as assistant co-author";
}
# Check that we are on the correct machine
my $home = &Apache::lonnet::homeserver($caname,$cadom);
@@ -383,9 +548,9 @@ sub innerregister {
my $cfile='';
my $cfuname='';
my $cfudom='';
- if ($ENV{'request.filename'}) {
- my $file=&Apache::lonnet::declutter($ENV{'request.filename'});
- $file=~s/^(\w+)\/(\w+)/\/priv\/$2/;
+ 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)) {
@@ -401,7 +566,7 @@ sub innerregister {
# Finally, turn the button on or off
if ($cfile && !$const_space) {
$editbutton=&switch
- ('','',6,1,'cstr.gif','edit[_1]','resource[_2]',
+ ('','',6,1,'pcstr.gif','edit[_1]','resource[_2]',
"go('".$cfile."');","Edit this resource");
} elsif ($editbutton eq '') {
$editbutton=&clear(6,1);
@@ -413,48 +578,80 @@ sub innerregister {
my $menuitems;
if ($const_space) {
my ($uname,$thisdisfn) =
- ($ENV{'request.filename'}=~m|^/home/([^/]+)/public_html/(.*)|);
+ ($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=(< 0){
+ $menuitems.="anot2.gif";
+}else{
+ $menuitems.="anot.gif";
+}
+$menuitems.="&anno-[_1]&tations[_1]&annotate()&";
+$menuitems.="Make notes and annotations about this resource&&1\n";
+
+ unless ($env{'request.noversionuri'}=~/\/(bulletinboard|smppg|navmaps|syllabus|aboutme)(\?|$)/) {
+ if (!$env{'request.enc'}) {
+ $menuitems.=(<
+$inlineremote[21] $inlineremote[23]
+ENDARROWSINLINE
+ if (&hidden_button_check() ne 'yes') {
+ $inlinebuttons .= (<
+ENDINLINEICONS
+ }
+ } else {
+ if ($inlineremote[21] ne '' || $inlineremote[23] ne '') {
+ $inlinebuttons=(<
$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
- }
+ENDFIRSTLINE
+ }
+ if (&hidden_button_check() ne 'yes') {
+ foreach my $row (6..9) {
+ if ($inlineremote[${row}.'1'] ne ''
+ || $inlineremote[$row.'2'] ne ''
+ || $inlineremote[$row.'3'] ne '') {
+ $inlinebuttons .= <<"ENDLINE";
+
$inlineremote["${row}1"]
$inlineremote["${row}2"]
$inlineremote["${row}3"]
+ENDLINE
+ }
+ }
+ }
+ }
+ }
}
$result =(<
// BEGIN LON-CAPA Internal
$timesync
-$newmail
$tablestart
$inlinebuttons
$tableend
+$newmail
@@ -494,13 +714,13 @@ $tableend
ENDREGTEXT
# Registered, graphical output
} else {
- my $requri=&Apache::lonnet::clutter(&Apache::lonnet::fixversion((split(/\?/,$ENV{'request.noversionuri'}))[0]));
- $requri=&Apache::lonenc::check_encrypt(&Apache::lonnet::unescape($requri));
- my $cursymb=&Apache::lonenc::check_encrypt($ENV{'request.symb'});
+ 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)'; }
+ if ($env{'user.adv'}) { $clearcstr='clearbut(6,1)'; }
$result = (<
@@ -530,7 +750,6 @@ var swmenu=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(
@@ -588,30 +807,29 @@ ENDDONOTREGTHIS
}
sub loadevents() {
- if ($ENV{'request.state'} eq 'construct' ||
- $ENV{'request.noversionuri'} eq '/res/adm/pages/menu.html') { return ''; }
+ 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'} eq '/res/adm/pages/menu.html') { return ''; }
+ 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')) {
+ 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 $esclowerurl=&escape($lowerurl);
my $message=&mt('"Waiting for Remote Control window to load: "+[_1]','waited');
return(<
@@ -679,8 +897,8 @@ ENDSETFLAGS
}
sub maincall() {
- if (($ENV{'browser.interface'} eq 'textual') ||
- ($ENV{'environment.remote'} eq 'off')) { return ''; }
+ if (($env{'browser.interface'} eq 'textual') ||
+ ($env{'environment.remote'} eq 'off')) { return ''; }
return(<
main();
@@ -691,12 +909,12 @@ ENDMAINCALL
sub load_remote_msg {
my ($lowerurl)=@_;
- if (($ENV{'browser.interface'} eq 'textual') ||
- ($ENV{'environment.remote'} eq 'off')) { return ''; }
+ if (($env{'browser.interface'} eq 'textual') ||
+ ($env{'environment.remote'} eq 'off')) { return ''; }
- my $esclowerurl=&Apache::lonnet::escape($lowerurl);
+ my $esclowerurl=&escape($lowerurl);
my $link=&mt('Continue on in Inline Menu mode',
- "/adm/remote?action=collapse?url=$esclowerurl");
+ "/adm/remote?action=collapse&url=$esclowerurl");
return(<