--- rat/lonwrapper.pm	2017/12/30 00:16:36	1.68
+++ rat/lonwrapper.pm	2021/10/19 00:16:32	1.77
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Wrapper for external and binary files as standalone resources
 #
-# $Id: lonwrapper.pm,v 1.68 2017/12/30 00:16:36 raeburn Exp $
+# $Id: lonwrapper.pm,v 1.77 2021/10/19 00:16:32 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -44,7 +44,7 @@ use HTML::Entities();
 
 # ================================================================ Main Handler
 sub wrapper {
-    my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
+    my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
         $title,$width,$height) = @_;
 
     my $forcereg;
@@ -56,7 +56,10 @@ sub wrapper {
                                           'show' => 'Show content in pop-up window',
                                         );
 
-    my $anchor;
+    (undef,undef,undef,undef,undef,undef,my $clientmobile) =
+        &Apache::loncommon::decode_user_agent($r);
+
+    my ($anchor,$uselink);
     if ($is_ext) {
         if ($env{'form.symb'}) {
             (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
@@ -66,6 +69,12 @@ sub wrapper {
         } elsif ($env{'form.anchor'} ne '') {
             $anchor = '#'.$env{'form.anchor'};
         }
+        unless (($is_pdf) && ($clientmobile)) {
+            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);
@@ -83,7 +92,7 @@ sub wrapper {
         $args->{'only_body'} = $env{'form.only_body'};
     }
 
-    my ($countdown,$donemsg);
+    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'}) {
@@ -129,25 +138,41 @@ sub wrapper {
         }
     }
 
-    my $startpage = &Apache::loncommon::start_page('Menu',undef,$args).$countdown.$donemsg;
+#
+# 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 ($clientmobile || ($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') || ($exttool eq 'tab')) {
+    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 ($clientmobile || ($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/(\?[^\?]+)$//;
-                    }
-                }
-            }
-            unless ($title eq '') {
-                $output .= $title.'<br />';
-            }
-            $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
+            $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');
@@ -162,9 +187,9 @@ sub wrapper {
                 $output .= <<"ENDLINK";
 <script type="text/javascript">
 // <![CDATA[
-var windowObjectReference = null; 
-var PreviousUrl; 
-                           
+var windowObjectReference = null;
+var PreviousUrl;
+
 function openSinglePopup(strUrl) {
     if (windowObjectReference == null || windowObjectReference.closed) {
         windowObjectReference = window.open(strUrl, "LCExternalToolPopUp",
@@ -193,15 +218,23 @@ ENDLINK
                 $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
             }
         } 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";
+            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']);
@@ -230,8 +263,20 @@ ENDLINK
                 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,'&<>"');
@@ -246,6 +291,26 @@ 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');
@@ -259,12 +324,11 @@ sub handler {
 
     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+)/ext\.tool$}) {
@@ -286,10 +350,10 @@ sub handler {
             $width = $toolhash{'width'};
             $height = $toolhash{'height'};
         } elsif ($toolhash{'target'} eq 'tab') {
-            $exttool = 'tab'; 
+            $exttool = 'tab';
         }
         if (($exttool eq 'window') || ($exttool eq 'tab')) {
-            $linktext = $toolhash{'linktext'}; 
+            $linktext = $toolhash{'linktext'};
             $explanation = $toolhash{'explanation'};
         } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
             $exttool = 'tab';
@@ -367,7 +431,7 @@ sub handler {
             &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
@@ -395,14 +459,21 @@ described at http://www.lon-capa.org.
 
 =over
 
-=item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$linktext,$explanation,$title,$width,$height)
+=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
 
@@ -437,20 +508,69 @@ 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'} 
-is true, a link to a PDF is shown. The "title" will be displayed
+optional. If wrapped item is a PDF, and $clientmobile is true,
+a link to a PDF is shown. The "title" will be displayed
 above the link, but if not provided as an arg, $env{'form.title'}
 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