--- loncom/interface/lonmenu.pm	2013/08/06 16:02:31	1.418
+++ loncom/interface/lonmenu.pm	2015/04/14 21:35:52	1.431.2.2
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Routines to control the menu
 #
-# $Id: lonmenu.pm,v 1.418 2013/08/06 16:02:31 raeburn Exp $
+# $Id: lonmenu.pm,v 1.431.2.2 2015/04/14 21:35:52 musolffc Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -128,6 +128,33 @@ Inputs: 4 - (a) link and (b) target for
             (c) title for text wrapped by anchor tag in top level item.
             (d) reference to array of arrays of sub-menu items.
 
+ 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()
 
 This gets called in order to register a URL in the body of the document
@@ -261,7 +288,7 @@ sub primary_menu {
                     push(@primsub,$item);
                 }
                 if (@primsub > 0) {
-                    $menu{$position} .= &create_submenu($link,$target,$title,\@primsub);
+                    $menu{$position} .= &create_submenu($link,$target,$title,\@primsub,1);
                 } elsif ($link) {
                     $menu{$position} .= '<li><a href="'.$link.'" target="'.$target.'">'.&mt($title).'</a></li>';
                 }
@@ -283,8 +310,14 @@ sub primary_menu {
             $menu{$position} .= prep_menuitem($menuitem);
         }
     }
-    return ("<ol class=\"LC_primary_menu LC_floatleft\">$menu{'left'}</ol>",
-            "<ol class=\"LC_primary_menu LC_floatright LC_right\">$menu{'right'}</ol>");
+    my @output = ('','');
+    if ($menu{'left'} ne '') {
+        $output[0] = "<ol class=\"LC_primary_menu LC_floatleft\">$menu{'left'}</ol>";
+    }
+    if ($menu{'right'} ne '') {
+        $output[1] = "<ol class=\"LC_primary_menu LC_floatright LC_right\">$menu{'right'}</ol>";
+    }
+    return @output;
 }
 
 #returns hashref {user=>'',dom=>''} containing:
@@ -313,6 +346,7 @@ sub getauthor{
 }
 
 sub secondary_menu {
+    my ($httphost) = @_;
     my $menu;
 
     my $crstype = &Apache::loncommon::course_type();
@@ -417,7 +451,8 @@ 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 {
@@ -469,7 +504,7 @@ sub secondary_menu {
 }
 
 sub create_submenu {
-    my ($link,$target,$title,$submenu) = @_;
+    my ($link,$target,$title,$submenu,$translate) = @_;
     return unless (ref($submenu) eq 'ARRAY');
     my $disptarget;
     if ($target ne '') {
@@ -491,27 +526,74 @@ sub create_submenu {
                '<span class="LC_fontsize_small" style="font-weight:normal;">'.
                ' &#9660;</span></span></a>'.
                '<ul>';
+
+    # $link and $title are only used in the initial string written in $menu
+    # as seen above, not needed for nested submenus
+    $menu .= &build_submenu($target, $submenu, $translate, '1');
+    $menu .= '</ul></li>';
+
+    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) = @_; 
+    if (!defined(@{$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];
-            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;
-            }
+            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 .= '<li style="margin:0;padding:0;'.$bordertop . $borderbot . '">';
+                $menu .= '<p><span class="LC_primary_menu_innertitle">'
+					. $title . '</span><span class="LC_primary_menu_innerarrow">&#9654;</span></p>';
+                $menu .= '<ul>';
+                $menu .= &build_submenu($target, $href, $translate);
+                $menu .= '</ul>';
+                $menu .= '</li>';    
+            } 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 .= '<li style="margin:0;padding:0;'. $bordertop . $borderbot .'">';
+                $menu .= '<a href="'.$href.'"'.$target.'>' .  $title . '</a>';
+                $menu .= '</li>';
             }
-            $menu .= '<li style="margin:0;padding:0;'.
-                     $borderbot.'"><a href="'.$href.'">'.
-                     &mt($item->[1]).'</a></li>';
         }
     }
-    $menu .= '</ul></li>';
     return $menu;
 }
 
@@ -736,7 +818,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 .= (<<ENDMENUITEMS);
-s&9&1&wishlist-link.png&Stored Links&wishlistlink[_2]&set_wishlistlink()&Save a link for this resource in your personal Stored Links repository&&1
+s&9&1&wishlist-link.png&Stored Links&wishlistlink[_2]&set_wishlistlink()&Save a link for this resource in my personal Stored Links repository&&1
 ENDMENUITEMS
                 $got_wishlist = 1;
             }
@@ -752,21 +834,28 @@ if(length($annotation) > 0){
 }
 $menuitems.="&Notes&&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.=(<<ENDREALRES);
-s&6&3&catalog.png&Info&info[_1]&catalog_info()&Show Metadata
+s&6&3&catalog.png&Info&info[_1]&catalog_info('$is_mobile')&Show Metadata
 ENDREALRES
                 }
-                unless ($env{'request.noversionuri'} =~ m{^/uploaded/$match_domain/$match_courseid/docs/}) {
+                unless (($env{'request.noversionuri'} =~ m{^/uploaded/$match_domain/$match_courseid/docs/}) ||
+                        ($env{'request.noversionuri'} =~ m{^\Q/adm/wrapper/\E(ext|uploaded)/})) {  
                     $menuitems.=(<<ENDREALRES);
 s&8&1&eval.png&Evaluate&this[_1]&gopost('/adm/evaluate',currentURL,1)&Provide my evaluation of this resource
 ENDREALRES
                 }
-                $menuitems.=(<<ENDREALRES);
+                unless ($env{'request.noversionuri'} =~ m{^\Q/adm/wrapper/\E(ext|uploaded)/}) {
+                    $menuitems.=(<<ENDREALRES);
 s&8&2&fdbk.png&Communicate&discuss[_1]&gopost('/adm/feedback',currentURL,1)&Provide feedback messages or contribute to the course discussion about this resource
 ENDREALRES
+                }
 	    }
         }
 	if ($env{'request.uri'} =~ /^\/res/) {
@@ -1210,7 +1299,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;
@@ -1224,7 +1316,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);
@@ -1260,8 +1358,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')) {
@@ -1371,7 +1470,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'},
@@ -1437,7 +1536,48 @@ function toggleCountdown() {
 END
 }
 
+# This creates a "done button" for timed events.  The confirmation box is a jQuerey
+# dialog widget.  Clicking OK will set (done = 'true') which is checked in 
+# lonhomework.pm.
+sub done_button_js {
+    return <<END;
+
+<form method="post" name="doneButton">
+    <input type="hidden" name="done" value=""/>
+    <button id="done-confirm-opener" type="button">Done</button>
+</form> 
+
+<div id="done-confirm" title="WARNING!">
+    <p></span>You are trying to end this timed event early.  Confirming that you are done will cause the time to expire and prevent you from changing any answers in the current folder.  Click "OK" if you are completely finished.  Click "Cancel" to continue working.</p>
+</div>
+
+<script>
+\$( "#done-confirm" ).dialog({ autoOpen: false });
+\$( "#done-confirm-opener" ).click(function() {
+    \$( "#done-confirm" ).dialog( "open" );
+    \$( "#done-confirm" ).dialog({
+      resizable: false,
+      height:320,
+      modal: true,
+      buttons: {
+        "OK": function() {
+            \$( this ).dialog( "close" );
+            \$( '[name="done"]' )[0].value = 'true';
+            \$( '[name="doneButton"]' )[0].submit();
+        },
+        Cancel: function() {
+          \$( this ).dialog( "close" );
+        }
+      }    
+    })
+});
+</script>
+
+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'} ) {
@@ -1472,8 +1612,26 @@ sub utilityfunctions {
 
     my $countdown = &countdown_toggle_js();
 
-return (<<ENDUTILITY)
+    my $hostvar = '
+function setLCHost() {
+    var lcHostname="";
+';
+    if ($httphost =~ m{^https?\://}) {
+        $hostvar .= '    var lcServer="'.$httphost.'";'."\n".
+                    '    var hostReg = /^https?:\/\/([^\/]+)$/i;'."\n".
+                    '    var match = hostReg.exec(lcServer);'."\n".
+                    '    if (match.length) {'."\n".
+                    '        if (match[1] == location.hostname) {'."\n".
+                    '            lcHostname=lcServer;'."\n".
+                    '        }'."\n".
+                    '    }'."\n";
+    }
+    
+    $hostvar .= '    return lcHostname;'."\n".
+'}'."\n";
 
+return (<<ENDUTILITY)
+    $hostvar
     var currentURL=unescape("$esc_url");
     var reloadURL=unescape("$esc_url");
     var currentSymb=unescape("$esc_symb");
@@ -1484,7 +1642,8 @@ $jumptores
 
 function gopost(url,postdata) {
    if (url!='') {
-      this.document.server.action=url;
+      var lcHostname = setLCHost();
+      this.document.server.action=lcHostname+url;
       this.document.server.postdata.value=postdata;
       this.document.server.command.value='';
       this.document.server.url.value='';
@@ -1495,7 +1654,8 @@ function gopost(url,postdata) {
 
 function gocmd(url,cmd) {
    if (url!='') {
-      this.document.server.action=url;
+      var lcHostname = setLCHost();
+      this.document.server.action=lcHostname+url;
       this.document.server.postdata.value='';
       this.document.server.command.value=cmd;
       this.document.server.url.value=currentURL;
@@ -1547,22 +1707,29 @@ function golist(url) {
    if (url!='' && url!= null) {
        currentURL = null;
        currentSymb= null;
-       top.location.href=url;
+       var lcHostname = setLCHost();
+       top.location.href=lcHostname+url;
    }
 }
 
 
 
-function catalog_info() {
-   openMyModal(window.location.pathname+'.meta',500,400,'yes');
+function catalog_info(isMobile) {
+    if (isMobile == 1) {
+        openMyModal(window.location.pathname+'.meta?modal=1',500,400,'yes');
+    } else {
+        loncatinfo=window.open(window.location.pathname+'.meta',"LONcatInfo",'height=500,width=400,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
+    }
 }
 
 function chat_win() {
-   lonchat=window.open('/res/adm/pages/chatroom.html',"LONchat",'height=320,width=480,resizable=yes,location=no,menubar=no,toolbar=no');
+   var lcHostname = setLCHost();
+   lonchat=window.open(lcHostname+'/res/adm/pages/chatroom.html',"LONchat",'height=320,width=480,resizable=yes,location=no,menubar=no,toolbar=no');
 }
 
 function group_chat(group) {
-   var url = '/adm/groupchat?group='+group;
+   var lcHostname = setLCHost();
+   var url = lcHostname+'/adm/groupchat?group='+group;
    var winName = 'LONchat_'+group;
    grpchat=window.open(url,winName,'height=320,width=280,resizable=yes,location=no,menubar=no,toolbar=no');
 }
@@ -1582,12 +1749,13 @@ function annotate() {
 
 function open_StoredLinks_Import(rat) {
    var newWin;
+   var lcHostname = setLCHost();
    if (rat) {
-       newWin = window.open('/adm/wishlist?inhibitmenu=yes&mode=import&rat='+rat,
+       newWin = window.open(lcHostname+'/adm/wishlist?inhibitmenu=yes&mode=import&rat='+rat,
                             'wishlistImport','scrollbars=1,resizable=1,menubar=0');
    }
    else {
-       newWin = window.open('/adm/wishlist?inhibitmenu=yes&mode=import',
+       newWin = window.open(lcHostname+'/adm/wishlist?inhibitmenu=yes&mode=import',
                             'wishlistImport','scrollbars=1,resizable=1,menubar=0');
    }
    newWin.focus();
@@ -1652,7 +1820,7 @@ sub hidden_button_check {
 }
 
 sub roles_selector {
-    my ($cdom,$cnum) = @_;
+    my ($cdom,$cnum,$httphost) = @_;
     my $crstype = &Apache::loncommon::course_type();
     my $now = time;
     my (%courseroles,%seccount,%courseprivs);
@@ -1745,7 +1913,7 @@ sub roles_selector {
             }
         }
     }
-    $switchtext = &mt('Switch role');
+    $switchtext = 'Switch role'; # do not translate here
     my @roles_order = ($ccrole,'in','ta','ep','ad','st');
     my $numdiffsec;
     if (keys(%seccount) == 1) {
@@ -1757,7 +1925,7 @@ sub roles_selector {
         my @submenu;
         $js = &jump_to_role($cdom,$cnum,\%seccount,\%courseroles,\%courseprivs,$priv);
         $form = 
-            '<form name="rolechooser" method="post" action="/adm/roles">'."\n".
+            '<form name="rolechooser" method="post" action="'.$httphost.'/adm/roles">'."\n".
             '  <input type="hidden" name="destinationurl" value="'.
             &HTML::Entities::encode($destinationurl).'" />'."\n".
             '  <input type="hidden" name="gotorole" value="1" />'."\n".
@@ -2083,11 +2251,14 @@ sub countdown_timer {
         if (($duedate && $duedate > time) ||
             (!$duedate && $hastimeleft) ||
             ($slot_name ne '' && $slothastime)) {
-            my ($collapse,$expand,$alttxt,$title,$currdisp);
+            my ($collapse,$expand,$alttxt,$title,$currdisp,$donebutton);
             if ((@interval > 1 && $hastimeleft) ||
                 ($type eq 'Task' && $slothastime)) {
                 $currdisp = 'inline';
                 $collapse = '&#9658;&nbsp;';
+                $donebutton = &done_button_js();
+
+
             } else {
                 $currdisp = 'none';
                 $expand = '&#9668;&nbsp;';
@@ -2097,6 +2268,7 @@ sub countdown_timer {
                 $title = $alttxt.'&nbsp;';
             }
             my $desc = &mt('Countdown to due date/time');
+
             return <<END;
 
 <a href="javascript:toggleCountdown();" class="LC_menubuttons_link">
@@ -2107,6 +2279,7 @@ $collapse
 <a href="javascript:toggleCountdown();" class="LC_menubuttons_link">
 <span id="ddcountexpand" class="LC_menubuttons_inline_text" >$expand</span>
 <img src="/res/adm/pages/timer.png" title="$desc" class="LC_icon" alt="$alttxt" /><span class="LC_menubuttons_inline_text">$title</span></a>
+$donebutton
 END
         }
     }