--- rat/lonwrapper.pm 2022/08/30 11:48:33 1.49.2.11.2.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.11.2.2 2022/08/30 11:48:33 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,16 +37,10 @@ use Apache::lonlocal;
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();
# ================================================================ Main Handler
sub wrapper {
- my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
- $title,$width,$height,$reuse) = @_;
+ my ($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_;
my $forcereg;
unless ($env{'form.folderpath'}) {
@@ -61,7 +55,7 @@ sub wrapper {
(undef,undef,undef,undef,undef,undef,my $clientmobile) =
&Apache::loncommon::decode_user_agent($r);
- my ($anchor,$uselink);
+ my ($anchor,$uselink,$linktext);
if ($is_ext) {
if ($env{'form.symb'}) {
(undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
@@ -71,10 +65,7 @@ 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) {
+ unless (($is_pdf) && ($clientmobile)) {
my $hostname = $r->hostname();
my $lonhost = $r->dir_config('lonHostID');
my $ip = &Apache::lonnet::get_host_ip($lonhost);
@@ -82,7 +73,7 @@ sub wrapper {
}
}
- 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;
@@ -106,7 +97,7 @@ sub wrapper {
# do not obscure the Functions menu.
#
- unless ($clientmobile || ($exttool eq 'window') || ($exttool eq 'tab') || $uselink) {
+ unless ($clientmobile || $uselink) {
$headjs = '
-
-ENDLINK
- }
- if ($exttool) {
- if ($explanation ne '') {
- $output .= ''.$explanation.'
';
- }
- }
} else {
if ($uselink) {
$linktext = &mt('Link to resource');
@@ -296,12 +187,11 @@ ENDLINK
};
SCRIPT
# javascript will position the iframe if window was resized (or zoomed)
- my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
return <
-
+
$endpage
ENDFRAME
@@ -336,8 +226,7 @@ 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,$cdom,$cnum,$hostname);
for ($url){
s|^/adm/wrapper||;
@@ -348,56 +237,9 @@ sub handler {
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$}) {
- $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'}) &&
@@ -414,12 +256,10 @@ sub handler {
$url .= '#'.$env{'form.anchor'};
}
}
- my $type = 'ext';
- if ($exttool) {
- $type = 'tool';
- } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
+ 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'},
@@ -430,11 +270,7 @@ sub handler {
my $crstype = &Apache::loncommon::course_type();
my $title = $env{'form.title'};
if ($title eq '') {
- if ($is_ext) {
- $title = &mt('External Resource');
- } else {
- $title = &mt('External Tool');
- }
+ $title = &mt('External Resource');
}
$brcrum =
&Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
@@ -444,7 +280,7 @@ sub handler {
#
# Actual URL
#
- if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
+ if ($url=~/$LONCAPA::assess_re/) {
#
# This is uploaded homework
#
@@ -454,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/\&$//;
@@ -465,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($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
- $linktext,$explanation,undef,$width,$height,$reuse) );
+ $r->print( wrapper($r,$url,$brcrum,$absolute,$is_ext,$is_pdf) );
} # not just the menu
@@ -497,7 +330,7 @@ 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($r,$url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
=over
@@ -507,11 +340,8 @@ 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,32 +370,12 @@ 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,
@@ -574,55 +384,12 @@ 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. 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