--- loncom/interface/lonmenu.pm 2012/12/31 14:54:55 1.369.2.32 +++ loncom/interface/lonmenu.pm 2016/09/15 02:25:12 1.369.2.58 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Routines to control the menu # -# $Id: lonmenu.pm,v 1.369.2.32 2012/12/31 14:54:55 raeburn Exp $ +# $Id: lonmenu.pm,v 1.369.2.58 2016/09/15 02:25:12 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -106,10 +106,11 @@ secondary_menu(). =item primary_menu() -This routine evaluates @primary_menu and returns XHTML for the menu -that contains following links: About, Message, Roles, Help, Logout +This routine evaluates @primary_menu and returns a two item array, +with the array elements containing XHTML for the left and right sides of +the menu that contains the following links: About, Message, Roles, Help, Logout @primary_menu is filled within the BEGIN block of this module with -entries from mydesk.tab +entries from mydesk.tab =item secondary_menu() @@ -123,9 +124,41 @@ dropdown list when mouse hovers over top (no hover psuedo class) via LC_hoverable class for
  • tag for top- level item, which employs jQuery to handle behavior on mouseover. -Inputs: 4 - (a) link and (b) target for anchor href in top level item, +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 + 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. + + 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 +] + =item innerregister() @@ -223,15 +256,16 @@ sub prep_menuitem { . qq| href="$$menuitem[0]" target="_top">$link
    • |; } -# primary_menu() evaluates @primary_menu and returns XHTML for the menu -# that contains following links: -# About, Message, Personal, Roles, Help, Logout +# primary_menu() evaluates @primary_menu and returns a two item array, +# with the array elements containing XHTML for the left and right sides of +# the menu that contains the following links: +# Personal, About, Message, Roles, Help, Logout # @primary_menu is filled within the BEGIN block of this module with # entries from mydesk.tab sub primary_menu { - my $menu; + my %menu; # each element of @primary contains following array: - # (link url, icon path, alt text, link text, condition) + # (link url, icon path, alt text, link text, condition, position) my $public; if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')) || (($env{'user.name'} eq '') && ($env{'user.domain'} eq ''))) { @@ -256,6 +290,10 @@ sub primary_menu { && !&Apache::loncommon::show_course(); ## my $title = $menuitem->[3]; + my $position = $menuitem->[5]; + if ($position eq '') { + $position = 'right'; + } if (defined($primary_submenu{$title})) { my ($link,$target); if ($menuitem->[0] ne '') { @@ -268,17 +306,21 @@ sub primary_menu { if (ref($primary_submenu{$title}) eq 'ARRAY') { foreach my $item (@{$primary_submenu{$title}}) { next if (($item->[2] eq 'wishlist') && (!$env{'user.adv'})); - next if (($item->[2] eq 'reqcrs') && (!&check_for_rcrs())); next if ((($item->[2] eq 'portfolio') || ($item->[2] eq 'blog')) && (!&Apache::lonnet::usertools_access('','',$item->[2], undef,'tools'))); push(@primsub,$item); } + if ($title eq 'Personal' && $env{'user.name'} && $env{'user.domain'} ) { + $title = &Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'}); + } else { + $title = &mt($title); + } if (@primsub > 0) { - $menu .= &create_submenu($link,$target,$title,\@primsub); + $menu{$position} .= &create_submenu($link,$target,$title,\@primsub,1); } elsif ($link) { - $menu .= '
  • '.&mt($title).'
    • '; + $menu{$position} .= '
  • '.&mt($title).'
    • '; } } } elsif ($$menuitem[3] eq 'Help') { # special treatment for helplink @@ -289,19 +331,23 @@ sub primary_menu { 'helpdeskmail', $defdom,$origmail); if ($to ne '') { - $menu .= &prep_menuitem($menuitem); + $menu{$position} .= &prep_menuitem($menuitem); } } else { - $menu .= '
  • '.&Apache::loncommon::top_nav_help('Help').'
    • '; + $menu{$position} .= '
  • '.&Apache::loncommon::top_nav_help('Help').'
    • '; } } else { - $menu .= prep_menuitem($menuitem); + $menu{$position} .= prep_menuitem($menuitem); } } - $menu =~ s/\[domain\]/$env{'user.domain'}/g; - $menu =~ s/\[user\]/$env{'user.name'}/g; - - return "
      $menu
    "; + my @output = ('',''); + if ($menu{'left'} ne '') { + $output[0] = "
      $menu{'left'}
    "; + } + if ($menu{'right'} ne '') { + $output[1] = "
      $menu{'right'}
    "; + } + return @output; } #returns hashref {user=>'',dom=>''} containing: @@ -330,6 +376,7 @@ sub getauthor{ } sub secondary_menu { + my ($httphost) = @_; my $menu; my $crstype = &Apache::loncommon::course_type(); @@ -338,6 +385,9 @@ sub secondary_menu { : ''); my $canedit = &Apache::lonnet::allowed('mdc', $env{'request.course.id'}); my $canviewroster = $env{'course.'.$env{'request.course.id'}.'.student_classlist_view'}; + if ($canviewroster eq 'disabled') { + undef($canviewroster); + } my $canviewgrps = &Apache::lonnet::allowed('vcg', $crs_sec); my $canmodifyuser = &Apache::lonnet::allowed('cst', $crs_sec); my $canviewwnew = &Apache::lonnet::allowed('whn', $crs_sec); @@ -346,6 +396,31 @@ sub secondary_menu { my $canmgr = &Apache::lonnet::allowed('mgr', $crs_sec); my $author = &getauthor(); + my ($cdom,$cnum,$showsyllabus,$showfeeds,$showresv); + if ($env{'request.course.id'}) { + $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + unless ($canedit) { + unless (&Apache::lonnet::is_on_map("public/$cdom/$cnum/syllabus")) { + if (($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'}) || + ($env{'course.'.$env{'request.course.id'}.'.uploadedsyllabus'}) || + ($env{'course.'.$env{'request.course.id'}.'.updatedsyllabus'}) || + ($env{'request.course.syllabustime'})) { + $showsyllabus = 1; + } + } + if ($env{'request.course.feeds'}) { + $showfeeds = 1; + } + } + unless ($canmgr) { + my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom); + if (keys(%slots) > 0) { + $showresv = 1; + } + } + } + my ($canmodifycoauthor); if ($env{'request.role'} eq "au./$env{'user.domain'}/") { my $extent = "$env{'user.domain'}/$env{'user.name'}"; @@ -384,14 +459,18 @@ sub secondary_menu { && ($canmodifyuser || !$canviewroster); next if $$menuitem[4] eq 'mgr' && !$canmgr; - next if $$menuitem[4] eq 'nmgr' - && $canmgr; + next if $$menuitem[4] eq 'showresv' + && !$showresv; next if $$menuitem[4] eq 'whn' && !$canviewwnew; next if $$menuitem[4] eq 'opa' && !$canmodpara; next if $$menuitem[4] eq 'nvcg' && ($canviewgrps || !%groups); + next if $$menuitem[4] eq 'showsyllabus' + && !$showsyllabus; + next if $$menuitem[4] eq 'showfeeds' + && !$showfeeds; next if $$menuitem[4] eq 'author' && !$author; next if $$menuitem[4] eq 'cca' @@ -406,7 +485,7 @@ sub secondary_menu { } else { $link = '#'; } - my @scndsub; + my @scndsub; if (ref($secondary_submenu{$title}) eq 'ARRAY') { foreach my $item (@{$secondary_submenu{$title}}) { if (ref($item) eq 'ARRAY') { @@ -415,12 +494,13 @@ sub secondary_menu { next if ($item->[2] eq 'cst' && !$canmodifyuser); next if ($item->[2] eq 'mgr' && !$canmgr); next if ($item->[2] eq 'vcg' && !$canviewgrps); + next if ($item->[2] eq 'mdc' && !$canedit); push(@scndsub,$item); } } if (@scndsub > 0) { - $menu .= &create_submenu($link,$target,$title,\@scndsub); - } elsif ($link) { + $menu .= &create_submenu($link,$target,$title,\@scndsub,1); + } elsif ($link ne '#') { $menu .= '
  • '.&mt($title).'
    • '; } } @@ -429,10 +509,22 @@ sub secondary_menu { ($roleswitcher_js,$roleswitcher_form,my $switcher) = &roles_selector( $env{'course.' . $env{'request.course.id'} . '.domain'}, - $env{'course.' . $env{'request.course.id'} . '.num'} + $env{'course.' . $env{'request.course.id'} . '.num'}, + $httphost ); $menu .= $switcher; } else { + if ($$menuitem[3] eq 'Syllabus' && $env{'request.course.id'}) { + my $url = $$menuitem[0]; + $url =~ s{\[cdom\]/\[cnum\]}{$cdom/$cnum}; + if (&Apache::lonnet::is_on_map($url)) { + unless ($$menuitem[0] =~ /\?register=1/) { + $$menuitem[0] .= '?register=1'; + } + } else { + $$menuitem[0] =~ s{\?register=1}{}; + } + } $menu .= &prep_menuitem(\@$menuitem); } } @@ -456,6 +548,10 @@ sub secondary_menu { } $menu =~ s/\[uname\]/$$author{user}/g; $menu =~ s/\[udom\]/$$author{dom}/g; + if ($env{'request.course.id'}) { + $menu =~ s/\[cnum\]/$cnum/g; + $menu =~ s/\[cdom\]/$cdom/g; + } if ($menu) { $menu = ""; } @@ -466,33 +562,86 @@ sub secondary_menu { } sub create_submenu { - my ($link,$target,$title,$submenu) = @_; + my ($link,$target,$title,$submenu,$translate,$addclass) = @_; return unless (ref($submenu) eq 'ARRAY'); my $disptarget; if ($target ne '') { $disptarget = ' target="'.$target.'"'; } - my $menu = '
  • '. - ''. - ''.&mt($title). + my $menu = '
  • '. + ''. + ''.$title. ''. ' ▼'. '
    • '; + + return $menu; +} + +# helper routine for create_submenu +# build the dropdown (and nested submenus) recursively +# see perldoc create_submenu documentation for further information +sub build_submenu { + my ($target, $submenu, $translate, $first_level) = @_; + unless (@{$submenu}) { + return ''; + } + + my $menu = ''; my $count = 0; my $numsub = scalar(@{$submenu}); foreach my $item (@{$submenu}) { $count ++; if (ref($item) eq 'ARRAY') { + my $href = $item->[0]; + my $bordertop; my $borderbot; + my $title; + + if ($translate) { + $title = &mt($item->[1]); + } else { + $title = $item->[1]; + } + + if ($count == 1 && !$first_level) { + $bordertop = 'border-top: 1px solid black;'; + } if ($count == $numsub) { - $borderbot = 'border-bottom:1px solid black;'; + $borderbot = 'border-bottom: 1px solid black;'; + } + + # href is a reference to another submenu + if (ref($href) eq 'ARRAY') { + $menu .= '
  • '; + $menu .= '

    ' + . $title . '▶

    '; + $menu .= ''; + $menu .= '
    • '; + } else { # href is the actual hyperlink and does not represent another submenu + # for the current menu title + if ($href =~ /(aboutme|rss\.html)$/) { + next unless (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')); + $href =~ s/\[domain\]/$env{'user.domain'}/g; + $href =~ s/\[user\]/$env{'user.name'}/g; + } + unless (($href eq '') || ($href =~ /^\#/)) { + $target = ' target="_top"'; + } + + $menu .= '
  • '; + $menu .= '' . $title . ''; + $menu .= '
    • '; } - $menu .= '
  • '. - &mt($item->[1]).'
    • '; } } - $menu .= ''; return $menu; } @@ -577,9 +726,19 @@ sub innerregister { && $maptitle ne 'default.sequence' && $maptitle ne $coursetitle); - push @crumbs, {text => $restitle, no_mt => 1} if $restitle; + push @crumbs, {text => $restitle, no_mt => 1} if $restitle; + my @tools; + if ($env{'request.filename'} =~ /\.page$/) { + my %breadcrumb_tools = &Apache::lonhtmlcommon::current_breadcrumb_tools(); + if (ref($breadcrumb_tools{'tools'}) eq 'ARRAY') { + @tools = @{$breadcrumb_tools{'tools'}}; + } + } &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb(@crumbs); + if (@tools) { + &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',@tools); + } } else { $resurl = $env{'request.noversionuri'}; my $courseurl = &Apache::lonnet::courseid_to_courseurl($env{'request.course.id'}); @@ -605,6 +764,14 @@ sub innerregister { &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); } return $trail; + } elsif ($resurl =~ m{^\Q/uploaded$courseurl/portfolio/syllabus/}) { + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &prepare_functions('/public'.$courseurl."/syllabus", + $forcereg,$group,undef,undef,1); + $title = &mt('Syllabus File'); + my ($trail) = + &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); + return $trail; } unless ($env{'request.state'} eq 'construct') { &Apache::lonhtmlcommon::clear_breadcrumbs(); @@ -637,6 +804,9 @@ sub innerregister { $forceview,$editbutton); if (($resurl =~ m{^/adm/($match_domain)/($match_username)/aboutme$}) || ($env{'request.role'} !~/^(aa|ca|au)/)) { + if (($env{'environment.remote'} eq 'on') && ($env{'request.symb'})) { + &Apache::lonhtmlcommon::clear_breadcrumbs(); + } $editbutton = &prepare_functions($resurl,$forcereg,$group); } if ($editbutton eq '') { @@ -719,6 +889,9 @@ sub innerregister { my $currdir = '/priv/'.$udom.'/'.$uname.'/'.$thisdisfn; if ($currdir =~ m-/$-) { $is_const_dir = 1; + if ($thisdisfn eq '') { + $is_const_dir = 2; + } } else { $currdir =~ s|[^/]+$||; my $cleandisfn = &Apache::loncommon::escape_single($thisdisfn); @@ -766,7 +939,7 @@ ENDMENUITEMS # wishlist is only available for users with access to resource-pool # and links can only be set for resources within the resource-pool $menuitems .= (< 0){ } $menuitems.="&$swtext{'anot'}&tations[_1]&annotate()&"; $menuitems.="Make notes and annotations about this resource&&1\n"; +my $is_mobile; +if ($env{'browser.mobile'}) { + $is_mobile = 1; +} unless ($env{'request.noversionuri'}=~/\/(bulletinboard|smppg|navmaps|syllabus|aboutme|viewclasslist|portfolio)(\?|$)/) { if ((!$env{'request.enc'}) && ($env{'request.noversionuri'} !~ m{^/adm/wrapper/ext/}) && ($env{'request.noversionuri'} !~ m{^/uploaded/$match_domain/$match_courseid/docs/})) { $menuitems.=(< 2) || ($resurl ne '/adm/supplemental')) { my $esc_path=&escape(&HTML::Entities::encode(&escape($env{'form.folderpath'}),'<>&"')); &switch('','',7,4,'docs-22x22.png','Edit Folder','parms[_2]', - "location.href='/adm/coursedocs?command=direct&forcesupplement=1&supppath=$esc_path'", - 'Folder/Page Content'); + "location.href='/adm/coursedocs?command=direct&forcesupplement=1&supppath=$esc_path'", + 'Folder/Page Content','','',1); } } } @@ -1387,7 +1595,7 @@ sub prepare_functions { &Apache::lonhtmlcommon::clear_breadcrumb_tools(); &advtools_crumbs(@inlineremote); return $editbutton; - } elsif ($env{'request.registered'}) { + } elsif (($env{'request.registered'}) && (!ref($forbodytag))) { return $editbutton; } else { if (ref($bread_crumbs) eq 'ARRAY') { @@ -1400,9 +1608,13 @@ sub prepare_functions { } elsif (@inlineremote > 0) { &Apache::lonhtmlcommon::clear_breadcrumb_tools(); &advtools_crumbs(@inlineremote); - return &Apache::lonhtmlcommon::scripttag('', 'start') - . &Apache::lonhtmlcommon::breadcrumbs(undef,undef,0) - . &Apache::lonhtmlcommon::scripttag('', 'end'); + if (ref($forbodytag)) { + $$forbodytag = + &Apache::lonhtmlcommon::scripttag('', 'start') + .&Apache::lonhtmlcommon::breadcrumbs(undef,undef,0) + .&Apache::lonhtmlcommon::scripttag('', 'end'); + } + return; } } } @@ -1417,7 +1629,7 @@ sub advtools_crumbs { 'advtools', @funcs[61,71,72,73,74,92]); } elsif ($env{'request.noversionuri'} eq '/adm/viewclasslist') { &Apache::lonhtmlcommon::add_breadcrumb_tool( - 'advtools', @funcs[61]); + 'advtools', $funcs[61]); } } @@ -1439,7 +1651,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)=@_; + my ($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat,$nobreak,$infunc)=@_; $act=~s/\$uname/$uname/g; $act=~s/\$udom/$udom/g; $top=&mt($top); @@ -1448,7 +1660,7 @@ sub switch { my $idx=10*$row+$col; $category_members{$cat}.=':'.$idx; - if ($env{'environment.remote'} eq 'on') { + if (($env{'environment.remote'} eq 'on') && (!$infunc)) { if (($row<1) || ($row>13)) { return ''; } if ($env{'request.state'} eq 'construct') { my $text = $top.' '.$bot; @@ -1601,7 +1813,10 @@ sub rawconfig { my $pub=($env{'request.state'} eq 'published'); my $con=($env{'request.state'} eq 'construct'); my $rol=$env{'request.role'}; - my $requested_domain = $env{'request.role.domain'}; + my $requested_domain; + if ($rol) { + $requested_domain = $env{'request.role.domain'}; + } foreach my $line (@desklines) { my ($row,$col,$pro,$prt,$img,$top,$bot,$act,$desc,$cat)=split(/\:/,$line); $prt=~s/\$uname/$uname/g; @@ -1615,7 +1830,13 @@ sub rawconfig { next if ($crstype ne 'Community'); $prt=~s/\$cmty/$crs/g; } - $prt=~s/\$requested_domain/$requested_domain/g; + if ($prt =~ m/\$requested_domain/) { + if ((!$requested_domain) && ($pro eq 'pbre') && ($env{'user.adv'})) { + $prt=~s/\$requested_domain/$env{'user.domain'}/g; + } else { + $prt=~s/\$requested_domain/$requested_domain/g; + } + } if ($category_names{$cat}!~/\w/) { $cat='oth'; } if ($pro eq 'clear') { $output.=&clear($row,$col); @@ -1651,8 +1872,9 @@ sub rawconfig { next; } } - if (&Apache::lonnet::allowed($priv,$prt)) { - $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); + if ((($priv eq 'bre') && (&Apache::lonnet::allowed($priv,$prt) eq 'F')) || + (($priv ne 'bre') && (&Apache::lonnet::allowed($priv,$prt)))) { + $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'course') { if (($env{'request.course.fn'}) && ($crstype ne 'Community')) { @@ -1768,7 +1990,7 @@ sub rawconfig { sub check_for_rcrs { my $showreqcrs = 0; - my @reqtypes = ('official','unofficial','community'); + my @reqtypes = ('official','unofficial','community','textbook'); foreach my $type (@reqtypes) { if (&Apache::lonnet::usertools_access($env{'user.name'}, $env{'user.domain'}, @@ -1857,6 +2079,7 @@ END } sub utilityfunctions { + my ($httphost) = @_; my $currenturl=&Apache::lonnet::clutter(&Apache::lonnet::fixversion((split(/\?/,$env{'request.noversionuri'}))[0])); if ($currenturl =~ m{^/adm/wrapper/ext/} && $env{'request.external.querystring'} ) { @@ -1891,8 +2114,26 @@ sub utilityfunctions { my $countdown = &countdown_toggle_js(); -return (<'."\n". + '
    '."\n". ' '."\n". ' '."\n". @@ -2243,7 +2489,7 @@ sub roles_selector { } } if (@submenu > 0) { - $switcher = &create_submenu('','',$switchtext,\@submenu); + $switcher = &create_submenu('','',&mt('Switch role'),\@submenu); } } return ($js,$form,$switcher); @@ -2309,6 +2555,7 @@ sub get_all_courseroles { push(@{$courseroles->{'st'}},keys(%sections_count)); $seccount->{'st'} = scalar(keys(%sections_count)); } + $seccount->{'st'} ++; # Increment for a section-less student role. my $rolehash = { 'roles' => $courseroles, 'seccount' => $seccount, @@ -2514,7 +2761,6 @@ sub countdown_timer { } my $duedate = &Apache::lonnet::EXT("resource.0.duedate"); my @interval=&Apache::lonnet::EXT("resource.0.interval"); - my $hastimeleft; if (@interval > 1) { my $first_access=&Apache::lonnet::get_first_access($interval[1]); if ($first_access > 0) { @@ -2572,7 +2818,7 @@ BEGIN { $category_positions{$entries[2]}=$entries[1]; $category_names{$entries[2]}=$entries[3]; } elsif ($configline=~/^prim\:/) { - my @entries = (split(/\:/, $configline))[1..5]; + my @entries = (split(/\:/, $configline))[1..6]; push(@primary_menu,\@entries); } elsif ($configline=~/^primsub\:/) { my ($parent,@entries) = (split(/\:/, $configline))[1..4];