--- loncom/interface/lonmenu.pm 2021/03/06 19:58:55 1.369.2.82
+++ loncom/interface/lonmenu.pm 2022/05/06 19:36:09 1.515
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Routines to control the menu
#
-# $Id: lonmenu.pm,v 1.369.2.82 2021/03/06 19:58:55 raeburn Exp $
+# $Id: lonmenu.pm,v 1.515 2022/05/06 19:36:09 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -99,7 +99,7 @@ It gets filled in the BEGIN block of thi
=over
-=item prep_menuitems(\@menuitem)
+=item prep_menuitems(\@menuitem,$ltitarget)
This routine wraps a menuitem in proper HTML. It is used by primary_menu() and
secondary_menu().
@@ -118,72 +118,51 @@ Same as primary_menu() but operates on @
=item create_submenu()
-Creates XHTML for unordered list of sub-menu items which belong to a
+Creates XHTML for unordered list of sub-menu items which belong to a
particular top-level menu item. Uses hover pseudo class in css to display
-dropdown list when mouse hovers over top-level item. Support for IE6
+dropdown list when mouse hovers over top-level item. Support for IE6
(no hover psuedo class) via LC_hoverable class for
tag for top-
level item, which employs jQuery to handle behavior on mouseover.
Inputs: 6 - (a) link and (b) target for anchor href in top level item,
- (c) title for text wrapped by anchor tag in top level item.
- (d) reference to array of arrays of sub-menu items.
- (e) boolean to indicate whether to call &mt() to translate
+ (c) title for text wrapped by anchor tag in top level item,
+ (d) reference to array of arrays of sub-menu items,
+ (e) boolean to indicate whether to call &mt() to translate
name of menu item,
(f) optional class for
element in primary menu, for which
sub menu is being generated.
-The underlying datastructure used in (d) contains data from mydesk.tab.
-It consists of an array which has an array for each item appearing in
-the menu (e.g. [["link", "title", "condition"]] for a single-item menu).
-create_submenu() supports also the creation of XHTML for nested dropdown
-menus represented by unordered lists. This is done by replacing the
-scalar used for the link with an arrayreference containing the menuitems
-for the nested menu. This can be done recursively so that the next menu
-may also contain nested submenus.
+ The underlying datastructure used in (d) contains data from mydesk.tab.
+ It consists of an array which has an array for each item appearing in
+ the menu (e.g. [["link", "title", "condition"]] for a single-item menu).
+ create_submenu() supports also the creation of XHTML for nested dropdown
+ menus represented by unordered lists. This is done by replacing the
+ scalar used for the link with an arrayreference containing the menuitems
+ for the nested menu. This can be done recursively so that the next menu
+ may also contain nested submenus.
Example:
- [ # begin of datastructure
- ["/home/", "Home", "condition1"], # 1st item of the 1st layer menu
- [ # 2nd item of the 1st layer menu
- [ # anon. array for nested menu
- ["/path1", "Path1", undef], # 1st item of the 2nd layer menu
- ["/path2", "Path2", undef], # 2nd item of the 2nd layer menu
- [ # 3rd item of the 2nd layer menu
- [[...], [...], ..., [...]], # containing another menu layer
- "Sub-Sub-Menu", # title for this container
- undef
- ]
- ], # end of array/nested menu
- "Sub-Menu", # title for the container item
- undef
- ] # end of 2nd item of the 1st layer menu
+ [ # begin of datastructure
+ ["/home/", "Home", "condition1"], # 1st item of the 1st layer menu
+ [ # 2nd item of the 1st layer menu
+ [ # anon. array for nested menu
+ ["/path1", "Path1", undef], # 1st item of the 2nd layer menu
+ ["/path2", "Path2", undef], # 2nd item of the 2nd layer menu
+ [ # 3rd item of the 2nd layer menu
+ [[...], [...], ..., [...]], # containing another menu layer
+ "Sub-Sub-Menu", # title for this container
+ undef
+ ]
+ ], # end of array/nested menu
+ "Sub-Menu", # title for the container item
+ undef
+ ] # end of 2nd item of the 1st layer menu
]
-
=item innerregister()
This gets called in order to register a URL 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()
@@ -231,6 +210,7 @@ use Apache::lonenc();
use Apache::lonlocal;
use Apache::lonmsg();
use LONCAPA qw(:DEFAULT :match);
+use LONCAPA::ltiutils;
use HTML::Entities();
use Apache::lonwishlist();
@@ -240,7 +220,7 @@ use vars qw(@desklines %category_names %
my @inlineremote;
sub prep_menuitem {
- my ($menuitem) = @_;
+ my ($menuitem,$ltitarget,$listclass,$linkattr) = @_;
return '' unless(ref($menuitem) eq 'ARRAY');
my $link;
if ($$menuitem[1]) { # graphical Link
@@ -250,10 +230,14 @@ sub prep_menuitem {
} else { # textual Link
$link = &mt($$menuitem[3]);
}
- return '
';
+ $menu .= '';
} else { # href is the actual hyperlink and does not represent another submenu
# for the current menu title
if ($href =~ /(aboutme|rss\.html)$/) {
@@ -673,11 +806,15 @@ sub build_submenu {
$href =~ s/\[returnurl\]/$returnurl/;
}
unless (($href eq '') || ($href =~ /^\#/)) {
- $target = ' target="_top"';
+ if ($target eq '_top') {
+ $target = ' target="_top"';
+ }
}
- $menu .= '
-ENDREMOTEFORM
-}
-
-sub get_menu_name {
- my $hostid = $Apache::lonnet::perlvar{'lonHostID'};
- $hostid =~ s/\W//g;
- return 'LCmenu'.$hostid;
-}
-
-
-sub reopenmenu {
- unless ($env{'environment.remote'} eq 'on') { return ''; }
- my $menuname = &get_menu_name();
- my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
- return('window.open('.$nothing.',"'.$menuname.'","",false);');
-}
-
-
-sub open {
- my $returnval='';
- unless ($env{'environment.remote'} eq 'on') {
- return
- '';
- }
- my $menuname = &get_menu_name();
-
-# unless (shift eq 'unix') {
-# resizing does not work on linux because of virtual desktop sizes
-# $returnval.=(<
-ENDOPEN
- return '';
+ my ($topic_help,$topic_help_text);
+ if ($is_const_dir == 2) {
+ if ((($ENV{'SERVER_PORT'} == 443) ||
+ ($Apache::lonnet::protocol{$Apache::lonnet::perlvar{'lonHostID'}} eq 'https')) &&
+ (&Apache::lonnet::usertools_access($env{'user.name'},$env{'user.domain'},'webdav'))) {
+ $topic_help = 'Authoring_WebDAV,Authoring_WebDAV_Mac_10v6,Authoring_WebDAV_Mac_10v10,'.
+ 'Authoring_WebDAV_Windows_v7,Authoring_WebDAV_Linux_Centos';
+ $topic_help_text = 'About WebDAV access';
+ }
+ }
+ return &Apache::lonhtmlcommon::scripttag('', 'start')
+ . &Apache::lonhtmlcommon::breadcrumbs(undef,undef,0,'','','','',$topic_help,$topic_help_text)
+ . &Apache::lonhtmlcommon::scripttag('', 'end');
}
sub get_editbutton {
@@ -1485,31 +1343,15 @@ sub get_editbutton {
$icon = 'tolastloc.png';
$label = 'Exit Editing';
}
- my $infunc = 1;
- my $clearbutton;
- if ($env{'environment.remote'} eq 'on') {
- if ($cfile =~ m{^/priv/}) {
- undef($infunc);
- $label = 'edit';
- } else {
- $clearbutton = 1;
- }
- }
- my $editor = &switch('','',6,1,$icon,$label,'resource[_2]',
- $jscall,"Edit this resource",'','',$infunc);
- if ($infunc) {
- return 1;
- } elsif ($clearbutton) {
- return &clear(6,1);
- } else {
- return $editor;
- }
+ &switch('','',6,1,$icon,$label,'resource[_2]',
+ $jscall,"Edit this resource");
+ return 1;
}
return;
}
sub prepare_functions {
- my ($resurl,$forcereg,$group,$bread_crumbs,$advtools,$docscrumbs,$hostname,$forbodytag) = @_;
+ my ($resurl,$forcereg,$group,$bread_crumbs,$advtools,$docscrumbs,$hostname) = @_;
unless ($env{'request.registered'}) {
undef(@inlineremote);
}
@@ -1524,15 +1366,17 @@ sub prepare_functions {
my $editbutton = '';
my $viewsrcbutton = '';
+ my $clientip = &Apache::lonnet::get_requestor_ip();
#
# Determine whether or not to display 'Edit' or 'View Source' icon/button
#
if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
+ my $blocked = &Apache::loncommon::blocking_status('about',$clientip,$2,$1);
my $file=&Apache::lonnet::declutter($env{'request.filename'});
($cfile,$home,$switchserver,$forceedit,$forceview) =
&Apache::lonnet::can_edit_resource($file,$cnum,$cdom,
&Apache::lonnet::clutter($resurl),$env{'request.symb'},$group);
- if (($cfile) && ($home ne '') && ($home ne 'no_host')) {
+ if (($cfile) && ($home ne '') && ($home ne 'no_host') && (!$blocked)) {
$editbutton = &get_editbutton($cfile,$home,$switchserver,
$forceedit,$forceview,$forcereg);
}
@@ -1557,8 +1401,8 @@ sub prepare_functions {
#
if (($perms{'mdc'}) &&
(($resurl =~ m{^/?public/$cdom/$cnum/syllabus}) ||
- ($resurl =~ m{^/?uploaded/$cdom/$cnum/portfolio/syllabus/}) ||
- (($resurl =~ m{^/?uploaded/$cdom/$cnum/default_\d+\.sequence$}) && ($env{'form.navmap'})))) {
+ ($resurl =~ m{^/?uploaded/$cdom/$cnum/portfolio/syllabus/}) ||
+ (($resurl =~ m{^/?uploaded/$cdom/$cnum/default_\d+\.sequence$}) && ($env{'form.navmap'})))) {
if ($resurl =~ m{^/}) {
$cfile = $resurl;
} else {
@@ -1588,8 +1432,7 @@ sub prepare_functions {
$env{'form.symb'});
if ($cfile ne '') {
$editbutton = &get_editbutton($cfile,$home,$switchserver,
- $forceedit,$forceview,$forcereg,
- $env{'form.title'},$env{'form.suppurl'});
+ $forceedit,$forceview,$forcereg);
}
} elsif (($resurl =~ m{^/?adm/viewclasslist$}) &&
(&Apache::lonnet::allowed('opa',$env{'request.course.id'}))) {
@@ -1607,7 +1450,8 @@ sub prepare_functions {
&Apache::lonnet::clutter($resurl),$env{'request.symb'},$group);
if ($cfile ne '') {
$editbutton = &get_editbutton($cfile,$home,$switchserver,
- $forceedit,$forceview,$forcereg);
+ $forceedit,$forceview,$forcereg,
+ $hostname);
}
if ((($cfile eq '') || (!$editbutton)) &&
($resurl =~ /$LONCAPA::assess_re/)) {
@@ -1645,10 +1489,13 @@ sub prepare_functions {
if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
my ($sdom,$sname) = ($1,$2);
unless (&Apache::lonnet::is_course($sdom,$sname)) {
- &switch('','',6,4,'mail-message-new-22x22.png','Message to user',
- '',
- "go('/adm/email?compose=individual&recname=$sname&recdom=$sdom')",
- 'Send message to specific user','','',1);
+ my $blocked = &Apache::loncommon::blocking_status('about',$clientip,$sname,$sdom);
+ unless ($blocked) {
+ &switch('','',6,4,'mail-message-new-22x22.png','Message to user',
+ '',
+ "go('/adm/email?compose=individual&recname=$sname&recdom=$sdom')",
+ 'Send message to specific user');
+ }
}
my $hideprivileged = 1;
if (&Apache::lonnet::in_course($sdom,$sname,$cdom,$cnum,undef,
@@ -1664,25 +1511,26 @@ sub prepare_functions {
&switch('','',6,5,'trck-22x22.png','Activity',
'',
"go('/adm/trackstudent?selected_student=$sname:$sdom')",
- 'View recent activity by this person','','',1);
+ 'View recent activity by this person');
}
if ($perms{'vgr'}) {
&switch('','',6,6,'rsrv-22x22.png','Reservations',
'',
"go('/adm/slotrequest?command=showresv&origin=aboutme&uname=$sname&udom=$sdom')",
- 'Slot reservation history','','',1);
+ 'Slot reservation history');
}
if ($perms{'srm'}) {
&switch('','',6,7,'contact-new-22x22.png','Records',
'',
"go('/adm/email?recordftf=retrieve&recname=$sname&recdom=$sdom')",
- 'Add records','','',1);
+ 'Add records');
}
}
}
if (($env{'form.folderpath'} =~ /^supplemental/) &&
(&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
(($resurl =~ m{^/adm/wrapper/ext/}) ||
+ ($resurl =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) ||
($resurl =~ m{^/uploaded/$cdom/$cnum/supplemental/}) ||
($resurl eq '/adm/supplemental') ||
($resurl =~ m{^/public/$cdom/$cnum/syllabus$}) ||
@@ -1710,7 +1558,7 @@ sub prepare_functions {
&Apache::lonhtmlcommon::clear_breadcrumb_tools();
&advtools_crumbs(@inlineremote);
return $editbutton;
- } elsif (($env{'request.registered'}) && (!ref($forbodytag))) {
+ } elsif ($env{'request.registered'}) {
return $editbutton || $viewsrcbutton;
} else {
if (ref($bread_crumbs) eq 'ARRAY') {
@@ -1723,13 +1571,9 @@ sub prepare_functions {
} elsif (@inlineremote > 0) {
&Apache::lonhtmlcommon::clear_breadcrumb_tools();
&advtools_crumbs(@inlineremote);
- if (ref($forbodytag)) {
- $$forbodytag =
- &Apache::lonhtmlcommon::scripttag('', 'start')
- .&Apache::lonhtmlcommon::breadcrumbs(undef,undef,0)
- .&Apache::lonhtmlcommon::scripttag('', 'end');
- }
- return;
+ return &Apache::lonhtmlcommon::scripttag('', 'start')
+ . &Apache::lonhtmlcommon::breadcrumbs(undef,undef,0)
+ . &Apache::lonhtmlcommon::scripttag('', 'end');
}
}
}
@@ -1740,25 +1584,26 @@ sub advtools_crumbs {
&Apache::lonhtmlcommon::add_breadcrumb_tool(
'advtools', @funcs[61,64,65,66,67,74]);
} elsif ($env{'request.noversionuri'} !~ m{^/adm/(navmaps|viewclasslist)(\?|$)}) {
- &Apache::lonhtmlcommon::add_breadcrumb_tool(
- 'advtools', @funcs[61,71,72,73,74,92]);
+ if ($env{'request.state'} eq 'construct') {
+ &Apache::lonhtmlcommon::add_breadcrumb_tool(
+ 'advtools', @funcs[61,73,74,71,72]);
+ } else {
+ &Apache::lonhtmlcommon::add_breadcrumb_tool(
+ 'advtools', @funcs[61,71,72,73,74,92]);
+ }
} elsif ($env{'request.noversionuri'} eq '/adm/viewclasslist') {
&Apache::lonhtmlcommon::add_breadcrumb_tool(
'advtools', $funcs[61]);
}
+ return;
}
# ================================================================== Raw Config
sub clear {
my ($row,$col)=@_;
- if ($env{'environment.remote'} eq 'on') {
- if (($row<1) || ($row>13)) { return ''; }
- return "\n".qq(window.status+='.';swmenu.clearbut($row,$col););
- } else {
- $inlineremote[10*$row+$col]='';
- return '';
- }
+ $inlineremote[10*$row+$col]='';
+ return '';
}
# ============================================ Switch a button or create a link
@@ -1766,7 +1611,7 @@ sub clear {
# 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,$infunc)=@_;
+ 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);
@@ -1775,24 +1620,6 @@ sub switch {
my $idx=10*$row+$col;
$category_members{$cat}.=':'.$idx;
- if (($env{'environment.remote'} eq 'on') && (!$infunc)) {
- if (($row<1) || ($row>13)) { return ''; }
- if ($env{'request.state'} eq 'construct') {
- my $text = $top.' '.$bot;
- $text=~s/\s*\-\s*//gs;
- my $pic = '';
- $inlineremote[$idx] =
- ''.
- $pic.''.$top.' ';
- }
-# Remote
- $img=~s/\.png$/\.gif/;
- return "\n".
- qq(window.status+='.';swmenu.switchbutton($row,$col,"$img","$top","$bot","$act","$desc"););
- }
-
# Inline Menu
if ($nobreak==2) { return ''; }
my $text=$top.' '.$bot;
@@ -1827,7 +1654,8 @@ sub switch {
unless ($env{'request.state'} eq 'construct') {
push(@tools,63);
}
- if (($env{'environment.icons'} eq 'iconsonly') &&
+ if ((($env{'environment.icons'} eq 'iconsonly') ||
+ ($env{'environment.icons'} eq '') && ($env{'request.lti.login'})) &&
(grep(/^$idx$/,@tools))) {
$inlineremote[$idx] =
''.$pic.'';
@@ -1854,13 +1682,6 @@ sub secondlevel {
return $output;
}
-sub openmenu {
- my $menuname = &get_menu_name();
- unless ($env{'environment.remote'} eq 'on') { return ''; }
- my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
- return "window.open(".$nothing.",'".$menuname."');";
-}
-
sub inlinemenu {
undef(@inlineremote);
undef(%category_members);
@@ -1903,13 +1724,7 @@ sub rawconfig {
#
my $textualoverride=shift;
my $output='';
- if ($env{'environment.remote'} eq 'on') {
- $output.=
- "window.status='Opening Remote Control';var swmenu=".&openmenu().
-"\nwindow.status='Configuring Remote Control ';";
- } else {
- unless ($textualoverride) { return ''; }
- }
+ return '' unless $textualoverride;
my $uname=$env{'user.name'};
my $udom=$env{'user.domain'};
my $adv=$env{'user.adv'};
@@ -2094,18 +1909,12 @@ sub rawconfig {
$uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat);
}
}
- if ($env{'environment.remote'} eq 'on') {
- $output.="\nwindow.status='Synchronizing Time';swmenu.syncclock(1000*".time.");\nwindow.status='Remote Control Configured.';";
- if (&Apache::lonmsg::newmail()) {
- $output.='swmenu.setstatus("you have","messages");';
- }
- }
return $output;
}
sub check_for_rcrs {
my $showreqcrs = 0;
- my @reqtypes = ('official','unofficial','community','textbook');
+ my @reqtypes = ('official','unofficial','community','textbook','placement');
foreach my $type (@reqtypes) {
if (&Apache::lonnet::usertools_access($env{'user.name'},
$env{'user.domain'},
@@ -2125,28 +1934,6 @@ sub check_for_rcrs {
return $showreqcrs;
}
-# ======================================================================= Close
-
-sub close {
- unless ($env{'environment.remote'} eq 'on') { return ''; }
- my $menuname = &get_menu_name();
- return(<
-//
-
-ENDCLOSE
-}
-
sub dc_popup_js {
my %lt = &Apache::lonlocal::texthash(
more => '(More ...)',
@@ -2193,6 +1980,220 @@ function toggleCountdown() {
END
}
+# This creates a "done button" for timed events. The confirmation box is a jQuery
+# dialog widget. If the interval parameter requires a proctor key for the timed
+# event to be marked done, there will also be a textbox where that can be entered.
+# Clicking OK will set the value of LC_interval_done to 'true', and, if needed will
+# set the value of LC_interval_done_proctorpass to the text entered in that box,
+# and submit the corresponding form.
+#
+# The &zero_time() routine in lonhomework.pm is called when a page is rendered if
+# LC_interval_done is true.
+#
+sub done_button_js {
+ my ($type,$width,$height,$proctor,$donebuttontext) = @_;
+ return unless (($type eq 'map') || ($type eq 'resource'));
+ my %lt = &Apache::lonlocal::texthash(
+ title => 'WARNING!',
+ preamble => 'You are trying to end this timed event early.',
+ map => 'Confirming that you are done will cause the time to expire and prevent you from changing any answers in the current folder.',
+ resource => 'Confirming that you are done will cause the time to expire for this question, and prevent you from changing your answer(s).',
+ okdone => 'Click "OK" if you are completely finished.',
+ cancel => 'Click "Cancel" to continue working.',
+ proctor => 'Ask a proctor to enter the key, then click "OK" if you are completely finished.',
+ ok => 'OK',
+ exit => 'Cancel',
+ key => 'Key:',
+ nokey => 'A proctor key is required',
+ );
+ my $shownsymb = &HTML::Entities::encode(&Apache::lonenc::check_encrypt($env{'request.symb'}));
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ my ($missing,$tried) = (0,0);
+ if (ref($navmap)) {
+ my @resources=();
+ if ($type eq 'map') {
+ my ($mapurl,$rid,$resurl)=&Apache::lonnet::decode_symb($env{'request.symb'});
+ if ($env{'request.symb'} =~ /\.page$/) {
+ @resources=$navmap->retrieveResources($resurl,sub { $_[0]->is_problem() });
+ } else {
+ @resources=$navmap->retrieveResources($mapurl,sub { $_[0]->is_problem() });
+ }
+ } else {
+ my $res = $navmap->getBySymb($env{'request.symb'});
+ if (ref($res)) {
+ if ($res->is_problem()) {
+ push(@resources,$res);
+ }
+ }
+ }
+ foreach my $res (@resources) {
+ if (ref($res->parts()) eq 'ARRAY') {
+ foreach my $part (@{$res->parts()}) {
+ if (!$res->tries($part)) {
+ $missing++;
+ } else {
+ $tried++;
+ }
+ }
+ }
+ }
+ }
+ if ($missing) {
+ $lt{'miss'} .= '
';
+ if ($type eq 'map') {
+ $lt{'miss'} .= &mt('Submissions are missing for [quant,_1,question part,question parts] in this folder.',$missing);
+ } else {
+ $lt{'miss'} .= &mt('Submissions are missing for [quant,_1,part] in this question.',$missing);
+ }
+ if ($missing > 1) {
+ $lt{'miss'} .= ' '.&mt('If you confirm you are done you will be unable to submit answers for them.').'';
+ } else {
+ $lt{'miss'} .= ' '.&mt('If you confirm you are done you will be unable to submit an answer for it.').'