--- rat/lonwrapper.pm 2022/08/30 11:48:33 1.49.2.11.2.2
+++ rat/lonwrapper.pm 2017/02/07 02:07:28 1.56
@@ -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.11.2.2 2022/08/30 11:48:33 raeburn Exp $
+# $Id: lonwrapper.pm,v 1.56 2017/02/07 02:07:28 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -38,30 +38,22 @@ use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::lonextresedit();
use Apache::lonexttool();
-use Apache::lonnavmaps();
-use LONCAPA qw(:DEFAULT :match);
-use HTML::Entities();
-use Digest::MD5();
+use LONCAPA qw(:DEFAULT :match);;
# ================================================================ Main Handler
sub wrapper {
- my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
- $title,$width,$height,$reuse) = @_;
+ my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$title) = @_;
my $forcereg;
unless ($env{'form.folderpath'}) {
$forcereg = 1;
}
-
my %lt = &Apache::lonlocal::texthash(
'noif' => 'No iframe support.',
'show' => 'Show content in pop-up window',
);
- (undef,undef,undef,undef,undef,undef,my $clientmobile) =
- &Apache::loncommon::decode_user_agent($r);
-
- my ($anchor,$uselink);
+ my $anchor;
if ($is_ext) {
if ($env{'form.symb'}) {
(undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
@@ -71,15 +63,6 @@ sub wrapper {
} elsif ($env{'form.anchor'} ne '') {
$anchor = '#'.$env{'form.anchor'};
}
- if (($is_ext eq 'tab') || ($is_ext eq 'window')) {
- $uselink = 1;
- }
- unless (($is_pdf && $clientmobile) || $uselink) {
- 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);
@@ -91,167 +74,45 @@ sub wrapper {
$args->{'bread_crumbs'} = $brcrum;
}
if ($absolute) {
- $args->{'use_absolute'} = $absolute;
+ $args->{'use_absolute'} = $absolute;
}
if ($env{'form.only_body'}) {
$args->{'only_body'} = $env{'form.only_body'};
}
- my $headjs;
-
-#
-# 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 = '
-'."\n";
- }
-
- my $startpage = &Apache::loncommon::start_page('Menu',$headjs,$args);
+ my $startpage = &Apache::loncommon::start_page('Menu',undef,$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 || ($exttool eq 'window') || ($exttool eq 'tab') ||
- ($is_ext eq 'tab') || ($is_ext eq 'window')) {
+
+ if (($env{'browser.mobile'}) || ($exttool eq 'window')) {
my $output = $startpage;
if ($is_pdf) {
- $linktext = &mt('Link to PDF (for mobile devices)');
- $output .= &create_link($url,$anchor,$title,$linktext);
- } elsif (($exttool eq 'window') || ($exttool eq 'tab') ||
- ($is_ext eq 'tab') || ($is_ext eq 'window')) {
- my $preamble;
- if ($linktext eq '') {
- if ($exttool) {
- $linktext = &mt('Launch External Tool');
- } else {
- $linktext = &mt('Link to External Resource');
- }
- }
- if ($exttool) {
- $url = &HTML::Entities::encode($url,'"<>&');
- } else {
- $url = &HTML::Entities::encode($url.$anchor,'&<>"');
- }
- if (($exttool eq 'tab') || ($is_ext eq 'tab')) {
- my $target;
- if ($exttool) {
- $target = 'LCExternalToolTab';
- } else {
- if ($reuse) {
- $target = 'LCExternalResTab';
- } else {
- $target = '_blank';
- }
- if ($title ne '') {
- $preamble = ''.$title.'
';
- }
- }
- $output .= '
';
- } else {
- my ($target,$extlinkimg);
- if ($exttool) {
- $target = 'LCExternalToolPopUp';
- } else {
- $target = 'LCExternalResPopUp';
- if ($title ne '') {
- $preamble = ''.$title.'
';
- }
- $extlinkimg = '';
- unless ($reuse) {
- my $resid;
- if ($env{'request.course.id'}) {
- unless ($env{'form.folderpath'} =~ /^supplemental/) {
- my $symb=&Apache::lonnet::symbread($r->uri);
- if ($symb) {
- my $navmap = Apache::lonnavmaps::navmap->new();
- if (ref($navmap)) {
- my $res = $navmap->getBySymb($symb);
- if (ref($res)) {
- $resid = $res->id;
- $resid =~ s/\./_/g;
- }
- }
- }
- }
- }
- if ($resid eq '') {
- $resid = substr(Digest::MD5::md5_hex(Digest::MD5::md5_hex(time(). {}. rand(). $$)), 0, 8);
- }
- &js_escape(\$resid);
- $target .= $resid;
+ if ($title eq '') {
+ $title = $env{'form.title'};
+ if ($title eq '') {
+ unless ($env{'request.enc'}) {
+ ($title) = ($url =~ m{/([^/]+)$});
+ $title =~ s/(\?[^\?]+)$//;
}
}
- $output .= <<"ENDLINK";
-
-
-ENDLINK
}
- if ($exttool) {
- if ($explanation ne '') {
- $output .= ''.$explanation.'
';
- }
+ unless ($title eq '') {
+ $output .= $title.'
';
}
+ $output .= ''.&mt('Link to PDF (for mobile devices)').'';
+ } elsif ($exttool eq 'window') {
+ $output .= '';
} else {
- 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 .= ''."\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']);
@@ -280,54 +141,21 @@ ENDLINK
var pos = height + hdrtop + offset;
\$('.LC_iframecontainer').css('top', pos);
});
- LCresizedef = 1;
- if (LCnotready == 1) {
- LCnotready = 0;
- \$(window).trigger('resize');
- }
});
- window.onload = function(){
- if (LCresizedef) {
- LCnotready = 0;
- \$(window).trigger('resize');
- } else {
- LCnotready = 1;
- }
- };
+ window.onload = function(){ \$(window).trigger('resize') };
SCRIPT
# javascript will position the iframe if window was resized (or zoomed)
- my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
return <
-
+
$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 = ''.$title.'
';
- }
- my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
- $shownlink .= ''.$linktext.'';
- return $shownlink;
-}
-
sub handler {
my $r=shift;
&Apache::loncommon::content_type($r,'text/html');
@@ -336,65 +164,26 @@ sub handler {
return OK if $r->header_only;
my $url = $r->uri;
- my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
- $linktext,$explanation,$width,$height,$reuse);
+ my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum);
for ($url){
s|^/adm/wrapper||;
- $is_ext = $_ =~ s|^/ext/|http://|;
- s|http://https://|https://| if ($is_ext);
- s|:|:|g;
+ $is_ext = $_ =~ s|^/ext/|http://|;
+ s|http://https://|https://|;
+ s|:|:|g;
}
+
if ($url =~ /\.pdf$/i) {
$is_pdf = 1;
- } elsif (($is_ext) && ($env{'request.course.id'})) {
- if ($env{'course.'.$env{'request.course.id'}.'.extresource'}) {
- (my $selected,$reuse,$width,$height) = split(/:/,$env{'course.'.$env{'request.course.id'}.'.extresource'});
- if ($selected eq 'tab') {
- $is_ext = 'tab';
- $width = '';
- $height = '';
- } elsif ($selected eq 'window') {
- $is_ext = 'window';
- unless ($width =~ /^\d+$/) {
- $width = '';
- }
- unless ($height =~ /^\d+$/) {
- $height = '';
- }
- } else {
- $width = '';
- $height = '';
- $reuse = '';
- }
- }
- } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
+ } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/exttools?$}) {
$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'};
- }
- }
+ my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target'],$cdom,$cnum);
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';
+ $exttool = 'window';
}
}
if (($is_ext) || ($exttool)) {
@@ -415,16 +204,16 @@ sub handler {
}
}
my $type = 'ext';
+ my %ltitools;
if ($exttool) {
$type = 'tool';
- } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
- $hostname = $r->hostname();
+ %ltitools = &Apache::lonnet::get_domain_ltitools($cdom);
}
$r->print(
&Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
$env{'form.symb'},
$env{'form.idx'},$type,$cdom,
- $cnum,$hostname));
+ $cnum,\%ltitools));
return OK;
} elsif ($env{'form.folderpath'} =~ /^supplemental/) {
my $crstype = &Apache::loncommon::course_type();
@@ -444,7 +233,7 @@ sub handler {
#
# Actual URL
#
- if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
+ if ($url=~/$LONCAPA::assess_re/) {
#
# This is uploaded homework
#
@@ -465,12 +254,11 @@ sub handler {
}
# encrypt url if not external
- unless ($is_ext) {
+ unless ($is_ext || $exttool) {
&Apache::lonenc::check_encrypt(\$url);
}
- $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
- $linktext,$explanation,undef,$width,$height,$reuse) );
+ $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool) );
} # not just the menu
@@ -497,21 +285,14 @@ described at http://www.lon-capa.org.
=over
-=item wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title,$width,$height,$reuse)
+=item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
=over
-=item $r
-
-request object
-
=item $url
-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.
+url to display by including in an iframe within a
+LON-CAPA page which has a standard LON-CAPA inline menu.
=item $brcrum
@@ -540,89 +321,26 @@ in Firefox 23 and later, when serving fr
=item $is_ext
-true if URL is for an external resource. Default true value
-is 1 (display in iframe, unless $uselink is true).
-If external resource is to be displayed in a tab,
-value of $is_ext will be tab, if to be displayed in a pop-up window,
-value of $is_ext will be window.
+true if URL is for an external resource.
=item $is_pdf
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 $clientmobile is true,
-a link to a PDF is shown. The "title" will be displayed
+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
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. If the URL is for an External Resource, and
-$is_ext is window, then a default width (px) may have been defined in the current
-course for all external resource instances.
-
-=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. If the URL is for an External Resource, and
-$is_ext is window, then a default height (px) may have been defined in the current
-course for all external resource instances.
-
-=item $reuse
-
-optional. If the URL is for an External Resource, and $is_ext is tab or window,
-then $reuse will be true if the same tab or window is to be reused for display
-of all external resource instances in a a course.
-
=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 displayed 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