--- rat/lonwrapper.pm	2017/03/08 02:51:18	1.58
+++ rat/lonwrapper.pm	2020/02/29 16:05:26	1.76
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Wrapper for external and binary files as standalone resources
 #
-# $Id: lonwrapper.pm,v 1.58 2017/03/08 02:51:18 raeburn Exp $
+# $Id: lonwrapper.pm,v 1.76 2020/02/29 16:05:26 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -38,11 +38,14 @@ use Apache::loncommon();
 use Apache::lonhtmlcommon();
 use Apache::lonextresedit();
 use Apache::lonexttool();
-use LONCAPA qw(:DEFAULT :match);;
+use Apache::lonhomework();
+use LONCAPA qw(:DEFAULT :match);
+use HTML::Entities();
 
 # ================================================================ Main Handler
 sub wrapper {
-    my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$title) = @_;
+    my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
+        $title,$width,$height) = @_;
 
     my $forcereg;
     unless ($env{'form.folderpath'}) {
@@ -53,7 +56,7 @@ sub wrapper {
                                           'show' => 'Show content in pop-up window',
                                         );
 
-    my $anchor;
+    my ($anchor,$uselink);
     if ($is_ext) {
         if ($env{'form.symb'}) {
             (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
@@ -63,6 +66,12 @@ sub wrapper {
         } elsif ($env{'form.anchor'} ne '') {
             $anchor = '#'.$env{'form.anchor'};
         }
+        unless (($is_pdf) && ($env{'browser.mobile'})) {
+            my $hostname = $r->hostname();
+            my $lonhost = $r->dir_config('lonHostID');
+            my $ip = &Apache::lonnet::get_host_ip($lonhost);
+            $uselink = &Apache::loncommon::is_nonframeable($url,$absolute,$hostname,$ip);
+        }
     }
 
     my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
@@ -80,39 +89,149 @@ sub wrapper {
         $args->{'only_body'} = $env{'form.only_body'};
     }
 
-    my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
+    my ($countdown,$donemsg,$headjs);
+    if (($exttool) && (&Apache::lonnet::EXT('resource.0.gradable') =~ /^yes$/i)) {
+        $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$url);
+        if ($env{'form.markaccess'}) {
+            my $symb=&Apache::lonnet::symbread($url);
+            my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb);
+            my ($timelimit) = split(/_/,$interval[0]);
+            my $setres = &Apache::lonnet::set_first_access($interval[1],$timelimit);
+            if ($setres eq 'ok') {
+                delete($env{'form.markaccess'});
+            }
+        } elsif ($env{'form.LC_interval_done'} eq 'true') {
+            my $symb=&Apache::lonnet::symbread($url);
+            if ($symb) {
+                (my $donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb);
+                undef($env{'form.LC_interval_done'});
+                undef($env{'form.LC_interval_done_proctorpass'});
+            }
+        }
+        my ($status,$result,$resource_due) =
+            &Apache::lonexttool::gradabletool_access_check();
+        undef($Apache::lonhomework::browse);
+        if ($status eq 'CAN_ANSWER') {
+            if ($resource_due) {
+                my $time_left = $resource_due - time();
+                if ($resource_due && ($time_left > 0)) {
+                    $countdown ='
+<script type="text/javascript">
+// <![CDATA['."\n".
+                             &Apache::lonhtmlcommon::countdown().'
+// ]]>
+</script>'."\n".
+                    &Apache::lonhtmlcommon::set_due_date($resource_due);
+                }
+            }
+        } else {
+            if ($status eq 'SHOW_ANSWER') {
+                $result = &Apache::lonexttool::display_score().
+                          &Apache::lonfeedback::list_discussion('tool','OPEN');
+            }
+            return &Apache::loncommon::start_page('Menu',undef,$args).
+                   $result.
+                   &Apache::loncommon::end_page();
+        }
+    }
+
+#
+# Where iframe is in use, if window.onload() executes before the custom resize function
+# has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
+# are used to ensure document.ready() triggers a call to resize, so the iframe contents
+# do not obscure the Functions menu.
+#
+
+    unless (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
+        $headjs = '
+<script type="text/javascript">
+// <![CDATA[
+var LCnotready = 0;
+var LCresizedef = 0;
+// ]]>
+</script>'."\n";
+    }
+
+    my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args).$countdown.$donemsg;
     my $endpage = &Apache::loncommon::end_page();
-    
-    if (($env{'browser.mobile'}) || ($exttool eq 'window')) {
+
+    if (($uselink) && ($title eq '')) {
+        if ($env{'form.symb'}) {
+            $title=&Apache::lonnet::gettitle($env{'form.symb'});
+        } else {
+            my $symb=&Apache::lonnet::symbread($r->uri);
+            if ($symb) {
+                $title=&Apache::lonnet::gettitle($symb);
+            }
+        }
+    }
+    if (($env{'browser.mobile'}) || ($exttool eq 'window') || ($exttool eq 'tab')) {
         my $output = $startpage;
         if ($is_pdf) {
-            if ($title eq '') {
-                $title = $env{'form.title'};
-                if ($title eq '') {
-                    unless ($env{'request.enc'}) {
-                        ($title) = ($url =~ m{/([^/]+)$});
-                        $title =~ s/(\?[^\?]+)$//;
-                    }
-                }
+            $linktext = &mt('Link to PDF (for mobile devices)');
+            $output .= &create_link($url,$anchor,$title,$linktext);
+        } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {
+            if ($linktext eq '') {
+                $linktext = &mt('Launch External Tool');
             }
-            unless ($title eq '') {
-                $output .= $title.'<br />';
+            $url = &HTML::Entities::encode($url,'"<>&');
+            if ($exttool eq 'tab') {
+                $output .= '<div>'.
+                           '<a href="'.$url.'" target="LCExternalToolTab" style="padding:0;clear:both;margin:0;border:0">'.
+                           $linktext.'</a>'.
+                           '</div>';
+            } else {
+                $output .= <<"ENDLINK";
+<script type="text/javascript">
+// <![CDATA[
+var windowObjectReference = null;
+var PreviousUrl;
+
+function openSinglePopup(strUrl) {
+    if (windowObjectReference == null || windowObjectReference.closed) {
+        windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
+                                            "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
+    } else if(PreviousUrl != strUrl) {
+        windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
+                                            "height=$height,width=$width,scrollbars=yes,resizable=yes,status=yes,menubar=no,location=no'");
+        windowObjectReference.focus();
+    } else {
+        windowObjectReference.focus();
+    };
+    PreviousUrl = strUrl;
+}
+// ]]>
+</script>
+<div>
+<a href="$url" target="LCExternalToolPopUp" onclick="openSinglePopup(this.href); return false;">
+$linktext</a>
+</div>
+ENDLINK
+            }
+            if ($explanation ne '') {
+                $output .= '<div>'.$explanation.'</div>';
+            }
+            if (&Apache::lonnet::EXT('resource.0.gradable')) {
+                $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
             }
-            $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
-        } elsif ($exttool eq 'window') {
-            $output .= '<div>'.
-                       '<a href="'.$url.'" target="LC_LTI" style="padding:0;clear:both;margin:0;border:0">'.
-                       &mt('Launch External Tool').'</a>'.
-                       '</div>';
         } else {
-            $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
-                       '<iframe src="'.$url.$anchor.'" height="100%" width="100%" frameborder="0">'."\n".
-                       "$lt{'noif'} $noiframe\n".
-                       "</iframe>\n".
-                       "</div>\n";
+            if ($uselink) {
+                $linktext = &mt('Link to resource');
+                $output .= &create_link($url,$anchor,$title,$linktext);
+            } else {
+                my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
+                $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
+                           '<iframe src="'.$dest.'" height="100%" width="100%" frameborder="0">'."\n".
+                           "$lt{'noif'} $noiframe\n".
+                           "</iframe>\n".
+                           "</div>\n";
+            }
         }
         $output .= $endpage;
         return $output;
+    } elsif ($uselink) {
+        $linktext = &mt('Link to resource');
+        return $startpage.&create_link($url,$anchor,$title,$linktext).$endpage;
     } else {
         my $offset = 5;
         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
@@ -141,21 +260,54 @@ sub wrapper {
                 var pos = height + hdrtop + offset;
                 \$('.LC_iframecontainer').css('top', pos);
             });
+            LCresizedef = 1;
+            if (LCnotready == 1) {
+                LCnotready = 0;
+                \$(window).trigger('resize');
+            }
         });
-        window.onload = function(){  \$(window).trigger('resize') };
+        window.onload = function(){
+             if (LCresizedef) {
+                 LCnotready = 0;
+                 \$(window).trigger('resize');
+             } else {
+                 LCnotready = 1;
+             }
+        };
 SCRIPT
         # javascript will position the iframe if window was resized (or zoomed)
+        my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
         return <<ENDFRAME;
         $startpage
         $script
         <div class="LC_iframecontainer">
-            <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>
+            <iframe src="$dest">$lt{'noif'} $noiframe</iframe>
         </div>
         $endpage
 ENDFRAME
     }
 }
 
+sub create_link {
+    my ($url,$anchor,$title,$linktext) = @_;
+    my $shownlink;
+    if ($title eq '') {
+        $title = $env{'form.title'};
+        if ($title eq '') {
+            unless ($env{'request.enc'}) {
+                ($title) = ($url =~ m{/([^/]+)$});
+                $title =~ s/(\?[^\?]+)$//;
+            }
+        }
+    }
+    unless ($title eq '') {
+        $shownlink = '<span style="font-weight:bold;">'.$title.'</span><br />';
+    }
+    my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
+    $shownlink .= '<a href="'.$dest.'">'.$linktext.'</a>';
+    return $shownlink;
+}
+
 sub handler {
     my $r=shift;
     &Apache::loncommon::content_type($r,'text/html');
@@ -164,26 +316,44 @@ sub handler {
     return OK if $r->header_only;
 
     my $url = $r->uri;
-    my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname);
+    my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
+        $linktext,$explanation,$width,$height);
 
     for ($url){
         s|^/adm/wrapper||;
-        $is_ext = $_ =~ s|^/ext/|http://|;         
-        s|http://https://|https://|;
-        s|&colon;|:|g;              
+        $is_ext = $_ =~ s|^/ext/|http://|;
+        s|http://https://|https://| if ($is_ext);
+        s|&colon;|:|g;
     }
 
-
     if ($url =~ /\.pdf$/i) {
         $is_pdf = 1;
-    } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/exttools?$}) {
+    } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
         $cdom = $1;
         $cnum = $2;
         my $marker = $3;
         $exttool = 'iframe';
-        my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target'],$cdom,$cnum);
+        my $exttoolremote;
+        my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id','width','height'],
+                                            $cdom,$cnum);
+        if ($toolhash{'id'}) {
+            my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
+            if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {
+                $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};
+            }
+        }
         if ($toolhash{'target'} eq 'window') {
-           $exttool = 'window'; 
+            $exttool = 'window';
+            $width = $toolhash{'width'};
+            $height = $toolhash{'height'};
+        } elsif ($toolhash{'target'} eq 'tab') {
+            $exttool = 'tab';
+        }
+        if (($exttool eq 'window') || ($exttool eq 'tab')) {
+            $linktext = $toolhash{'linktext'};
+            $explanation = $toolhash{'explanation'};
+        } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
+            $exttool = 'tab';
         }
     }
     if (($is_ext) || ($exttool)) {
@@ -233,7 +403,7 @@ sub handler {
 #
 # Actual URL
 #
-    if ($url=~/$LONCAPA::assess_re/) {
+    if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
 #
 # This is uploaded homework
 #
@@ -254,11 +424,12 @@ sub handler {
         }
 
         # encrypt url if not external
-        unless ($is_ext || $exttool) {
+        unless ($is_ext) {
             &Apache::lonenc::check_encrypt(\$url);
         }
 
-        $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool) );
+        $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
+                           $linktext,$explanation,undef,$width,$height) );
 
     } # not just the menu
     
@@ -285,14 +456,21 @@ described at http://www.lon-capa.org.
 
 =over
 
-=item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
+=item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
 
 =over
 
+=item $r
+
+request object
+
 =item $url
 
-url to display by including in an iframe within a
-LON-CAPA page which has a standard LON-CAPA inline menu.
+url to display either by including in an iframe within a
+LON-CAPA page which has a standard LON-CAPA inline menu,
+or in some cases launched in a separate tab or window,
+launched via a link in a LON-CAPA page with standard inline
+menu.
 
 =item $brcrum
 
@@ -327,6 +505,22 @@ true if URL is for an external resource.
 
 true if URL is for a PDF (based on file extension).
 
+=item $exttool
+
+If URL is for an External Tool, will contain the target type: iframe, window or tab.
+
+=item $linktext
+
+optional. If URL is for an External Tool, and target type is window or tab, 
+then the link text may be an option set in the course for each tool instance,
+or may be a default defined in the domain for all instances of the tool.
+
+=item $explanation
+
+optional. If URL is for an External Tool, and target type is window or tab, 
+then the explanation is an option set in the course for each tool instance,
+or may be a default defined in the domain for all instances of the tool.
+
 =item $title
 
 optional. If wrapped item is a PDF, and $env{'browser.mobile'} 
@@ -335,12 +529,45 @@ above the link, but if not provided as a
 will be used, otherwise, the filename will be displayed (unless
 hidden URL set for the resource).
 
+=item $width
+
+optional. If URL is for an External Tool, and target type is window,
+then a default width may have been defined in the domain for all instances of 
+the tool.  If so, that width will be used for the window opened (via a link)
+to launch the external tool.
+
+=item $height
+
+optional. If URL is for an External Tool, and target type is window,
+then a default height may have been defined in the domain for all instances of 
+the tool.  If so, that height will be used for the window opened (via a link)
+to launch the external tool.
+
 =back
 
 Returns markup for the entire page.
 
 =item handler()
 
+Content handler for requests for: /adm/wrapper/...
+used for content to be displayed in an iframe, or launched in a separate tab
+or window via a link.  The target URL is extracted from the requested URL, by
+removing the /adm/wrapper prefix. 
+
+The target URL will typically be a PDF served from the current server, an 
+external resource URL served from a different server, or an external tool
+(from an LTI Provider) launched from LON-CAPA (as LTI Consumer) and launched
+via a link.
+
+If the request included forceedit in the query string, and the requester has
+rights to modify course content, then the editor will be didplayed to allow
+changes to be made to the resource (e.g., change the URL of the external resource,
+or change the setting for the external tool instance.
+
+If not in edit mode, then the wrapper() subroutine will be called to generate the
+standard LON-CAPA inline menu, and then either a link to launch a separate tab or
+window, or an iframe to display the content inline. 
+
 =back
 
 =cut