--- rat/lonwrapper.pm 2020/05/22 23:54:42 1.49.2.4.4.2
+++ rat/lonwrapper.pm 2024/07/04 02:30:39 1.49.2.12
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Wrapper for external and binary files as standalone resources
#
-# $Id: lonwrapper.pm,v 1.49.2.4.4.2 2020/05/22 23:54:42 raeburn Exp $
+# $Id: lonwrapper.pm,v 1.49.2.12 2024/07/04 02:30:39 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -37,12 +37,10 @@ use Apache::lonlocal;
use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::lonextresedit();
-use LONCAPA qw(:DEFAULT :match);
# ================================================================ Main Handler
sub wrapper {
- my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
- $title,$width,$height) = @_;
+ my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_;
my $forcereg;
unless ($env{'form.folderpath'}) {
@@ -54,7 +52,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,$linktext);
if ($is_ext) {
if ($env{'form.symb'}) {
(undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
@@ -64,9 +65,15 @@ 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);
+ my $noiframe = &Apache::loncommon::modal_link(&HTML::Entities::encode($url.$anchor,'&<>"\''),$lt{'show'},500,400);
my $args = {'bgcolor' => '#FFFFFF'};
if ($forcereg) {
$args->{'force_register'} = $forcereg;
@@ -81,74 +88,61 @@ sub wrapper {
$args->{'only_body'} = $env{'form.only_body'};
}
- my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
- my $endpage = &Apache::loncommon::end_page();
+ my $headjs;
- 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/(\?[^\?]+)$//;
- }
- }
- }
- unless ($title eq '') {
- $output .= $title.'
';
- }
- $output .= ''.&mt('Link to PDF (for mobile devices)').'';
- } elsif (($exttool eq 'window') || ($exttool eq 'tab')) {
- if ($linktext eq '') {
- $linktext = &mt('Launch External Tool');
- }
- if ($exttool eq 'tab') {
- $output .= '
';
- } else {
- $output .= <<"ENDLINK";
+#
+# 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 || $uselink) {
+ $headjs = '
-
-ENDLINK
- }
- if ($explanation ne '') {
- $output .= ''.$explanation.'
';
+'."\n";
+ }
+
+ my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args);
+ my $endpage = &Apache::loncommon::end_page();
+
+ 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) {
+ my $output = $startpage;
+ if ($is_pdf) {
+ $linktext = &mt('Link to PDF (for mobile devices)');
+ $output .= &create_link($url,$anchor,$title,$linktext);
} else {
- $output .= ''."\n".
- '\n".
- "
\n";
+ if ($uselink) {
+ $linktext = &mt('Link to resource');
+ $output .= &create_link($url,$anchor,$title,$linktext);
+ } else {
+ my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
+ $output .= ''."\n".
+ '\n".
+ "
\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']);
@@ -177,8 +171,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)
return <'.$title.'
';
+ }
+ my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
+ $shownlink .= ''.$linktext.'';
+ return $shownlink;
+}
+
sub handler {
my $r=shift;
&Apache::loncommon::content_type($r,'text/html');
@@ -200,47 +226,20 @@ sub handler {
return OK if $r->header_only;
my $url = $r->uri;
- my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,
- $linktext,$explanation,$width,$height);
+ my ($is_ext,$brcrum,$absolute,$is_pdf,$cdom,$cnum,$hostname);
for ($url){
s|^/adm/wrapper||;
- $is_ext = $_ =~ s|^/ext/|http://|;
- s|http://https://|https://|;
- s|:|:|g;
+ $is_ext = $_ =~ s|^/ext/|http://|;
+ s|http://https://|https://| if ($is_ext);
+ s|:|:|g;
}
if ($url =~ /\.pdf$/i) {
$is_pdf = 1;
- } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
- $cdom = $1;
- $cnum = $2;
- my $marker = $3;
- $exttool = 'iframe';
- 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';
- $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)) {
+
+ if ($is_ext) {
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['forceedit','register','folderpath','symb','idx','title','anchor']);
if (($env{'form.forceedit'}) &&
@@ -257,15 +256,15 @@ sub handler {
$url .= '#'.$env{'form.anchor'};
}
}
- my $type = 'ext';
- if ($exttool) {
- $type = 'tool';
+ if (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
+ $hostname = $r->hostname();
}
+ my $type = 'ext';
$r->print(
&Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
$env{'form.symb'},
$env{'form.idx'},$type,$cdom,
- $cnum));
+ $cnum,$hostname));
return OK;
} elsif ($env{'form.folderpath'} =~ /^supplemental/) {
my $crstype = &Apache::loncommon::course_type();
@@ -281,7 +280,7 @@ sub handler {
#
# Actual URL
#
- if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
+ if ($url=~/$LONCAPA::assess_re/) {
#
# This is uploaded homework
#
@@ -291,7 +290,7 @@ sub handler {
#
# This is not homework
#
- if (($is_ext) || ($exttool)) {
+ if ($is_ext) {
$absolute = $env{'request.use_absolute'};
$ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
$ENV{'QUERY_STRING'} =~ s/\&$//;
@@ -302,12 +301,9 @@ sub handler {
}
# encrypt url if not external
- unless ($is_ext) {
- &Apache::lonenc::check_encrypt(\$url);
- }
+ &Apache::lonenc::check_encrypt(\$url) if $url !~ /^https?\:/ ;
- $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
- $linktext,$explanation,undef,$width,$height) );
+ $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf) );
} # not just the menu
@@ -334,10 +330,14 @@ described at http://www.lon-capa.org.
=over
-=item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height)
+=item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
=over
+=item $r
+
+request object
+
=item $url
url to display by including in an iframe within a
@@ -376,44 +376,14 @@ 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.