--- rat/lonwrapper.pm 2008/12/21 04:49:58 1.28.2.1
+++ rat/lonwrapper.pm 2017/12/18 23:23:14 1.66
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Wrapper for external and binary files as standalone resources
#
-# $Id: lonwrapper.pm,v 1.28.2.1 2008/12/21 04:49:58 raeburn Exp $
+# $Id: lonwrapper.pm,v 1.66 2017/12/18 23:23:14 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,84 +26,193 @@
# http://www.lon-capa.org/
#
+
package Apache::lonwrapper;
use strict;
use Apache::Constants qw(:common);
-use Apache::lonnet;
-use Apache::lonxml();
use Apache::lonenc();
-use Apache::lonmenu();
+use Apache::lonnet;
+use Apache::lonlocal;
+use Apache::loncommon();
+use Apache::lonhtmlcommon();
+use Apache::lonextresedit();
+use Apache::lonexttool();
+use LONCAPA qw(:DEFAULT :match);
+use HTML::Entities();
# ================================================================ Main Handler
+sub wrapper {
+ my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,
+ $title,$width,$height) = @_;
-sub simple_menu {
-#
-# Producing the menu buttons
-#
- return &Apache::loncommon::start_page('Menu',undef,
- {'only_body' => 1,
- 'bgcolor' => '#FFFFFF',}).
- &Apache::lonmenu::menubuttons(1,'web',1).
- &Apache::loncommon::end_page();
-}
+ my $forcereg;
+ unless ($env{'form.folderpath'}) {
+ $forcereg = 1;
+ }
+ my %lt = &Apache::lonlocal::texthash(
+ 'noif' => 'No iframe support.',
+ 'show' => 'Show content in pop-up window',
+ );
+
+ my $anchor;
+ if ($is_ext) {
+ if ($env{'form.symb'}) {
+ (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
+ if ($res =~ /(#[^#]+)$/) {
+ $anchor = $1;
+ }
+ } elsif ($env{'form.anchor'} ne '') {
+ $anchor = '#'.$env{'form.anchor'};
+ }
+ }
+ my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
+ my $args = {'bgcolor' => '#FFFFFF'};
+ if ($forcereg) {
+ $args->{'force_register'} = $forcereg;
+ }
+ if (ref($brcrum) eq 'ARRAY') {
+ $args->{'bread_crumbs'} = $brcrum;
+ }
+ if ($absolute) {
+ $args->{'use_absolute'} = $absolute;
+ }
+ if ($env{'form.only_body'}) {
+ $args->{'only_body'} = $env{'form.only_body'};
+ }
-sub wrapper {
- my ($topurl,$bottomurl) = @_;
+ my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
+ my $endpage = &Apache::loncommon::end_page();
- if ($env{'browser.interface'} eq 'textual') {
-#
-# ssi-based rendering for text-based interface
-#
- return
- &Apache::loncommon::start_page('Menu',undef,
- {'bgcolor' => '#FFFFFF',
- 'force_register' => 1,
- }).
- &Apache::lonnet::ssi_body($bottomurl).
- &Apache::loncommon::end_page();
+ if (($exttool) && (&Apache::lonnet::EXT('resource.0.gradable'))) {
+ my $resource_due = &Apache::lonhomework::due_date(0, $env{'request.symb'});
+ if ($resource_due) {
+ my $time_left = $resource_due - time();
+ if ($resource_due && ($time_left > 0)) {
+ $startpage .='
+'."\n".
+ &Apache::lonhtmlcommon::set_due_date($resource_due);
+ }
+ }
}
-
- my %layout = ('border' => 0);
- if ($env{'environment.remote'} eq 'off') {
- if ($env{'environment.icons'} eq 'iconsonly') {
- $layout{'rows'} = "100,*";
+ 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');
+ }
+ $url = &HTML::Entities::encode($url,'"<>&');
+ if ($exttool eq 'tab') {
+ $output .= '';
+ } else {
+ $output .= <<"ENDLINK";
+
+
+ENDLINK
+ }
+ if ($explanation ne '') {
+ $output .= ''.$explanation.'
';
+ }
+ if (&Apache::lonnet::EXT('resource.0.gradable')) {
+ $output .= &Apache::lonfeedback::list_discussion('tool','OPEN');
+ }
} else {
- $layout{'rows'} = "200,*";
+ my $dest = &HTML::Entities::encode($url.$anchor,'&<>"');
+ $output .= ''."\n".
+ '\n".
+ "
\n";
}
+ $output .= $endpage;
+ return $output;
} else {
- $layout{'rows'} = "1,*";
- $topurl = "/adm/rat/empty.html";
+ my $offset = 5;
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
+ if ($env{'form.inhibitmenu'} eq 'yes') {
+ $offset = 0;
+ }
+ my $script = &Apache::lonhtmlcommon::scripttag(<"');
+ return <
+
+
+ $endpage
+ENDFRAME
}
-
- my $start_page =
- &Apache::loncommon::start_page(undef,undef,
- {'force_register' => 1,
- 'frameset' => 1,
- 'add_entries' => \%layout, });
-
- my $end_page =
- &Apache::loncommon::end_page({'frameset' => 1});
-
- foreach my $url ($topurl,$bottomurl) {
- if ($url !~ /^https?\:/) {
- $url = &Apache::lonenc::check_encrypt($url);
- }
- }
-#
-# frame-based rendering for graphical interface
-#
- my $result =<
-
-$end_page
-ENDDOCUMENT
-
- return $result;
}
sub handler {
@@ -113,51 +222,205 @@ sub handler {
return OK if $r->header_only;
- &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- ['wrapperdisplay']);
- if ($env{'form.wrapperdisplay'} eq 'menu') {
- $r->print(&simple_menu());
- return OK;
- }
-
- my $orgurl=$r->uri;
- my $url=$orgurl;
- $orgurl.=(($orgurl=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
- $orgurl.=(($orgurl=~/\?/)?'&':'?').'wrapperdisplay=menu';
- $url=~s/^\/adm\/wrapper//;
- my $is_ext = $url =~ m|^/ext/|;
- $url=~s{^/ext/}{http://};
- $url=~s|http://https://|https://|;
- $url=~s|:|:|g;
+ my $url = $r->uri;
+ 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|:|:|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)) {
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ ['forceedit','register','folderpath','symb','idx','title','anchor']);
+ if (($env{'form.forceedit'}) &&
+ (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
+ (($env{'form.folderpath'} =~ /^supplemental/) ||
+ ($env{'form.symb'} =~ /^uploaded/))) {
+ if ($env{'form.symb'}) {
+ (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
+ if ($res =~ /(#[^#]+)$/) {
+ $url .= $1;
+ }
+ } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
+ if ($env{'form.anchor'} ne '') {
+ $url .= '#'.$env{'form.anchor'};
+ }
+ }
+ my $type = 'ext';
+ if ($exttool) {
+ $type = 'tool';
+ } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
+ $hostname = $r->hostname();
+ }
+ $r->print(
+ &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
+ $env{'form.symb'},
+ $env{'form.idx'},$type,$cdom,
+ $cnum,$hostname));
+ return OK;
+ } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
+ 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');
+ }
+ }
+ $brcrum =
+ &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
+ }
+ }
+
#
# Actual URL
#
- if ($url=~/\.(problem|exam|quiz|assess|survey|form|library)$/) {
+ if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
#
# This is uploaded homework
#
- $env{'request.state'}='uploaded';
- &Apache::lonhomework::renderpage($r,$url);
+ $env{'request.state'}='uploaded';
+ &Apache::lonhomework::renderpage($r,$url);
} else {
#
# This is not homework
#
- if ($is_ext) {
- $ENV{'QUERY_STRING'}=~s/(^|\&)symb=[^\&]*/$1/;
- }
- $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
- # reappend the query arguments
- $r->print(&wrapper($orgurl,$url));
+ if (($is_ext) || ($exttool)) {
+ $absolute = $env{'request.use_absolute'};
+ $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
+ $ENV{'QUERY_STRING'} =~ s/\&$//;
+ }
+
+ unless ($ENV{'QUERY_STRING'} eq '') {
+ $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
+ }
+
+ # encrypt url if not external
+ unless ($is_ext) {
+ &Apache::lonenc::check_encrypt(\$url);
+ }
+
+ $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,
+ $linktext,$explanation,undef,$width,$height) );
+
} # not just the menu
+
return OK;
} # handler
1;
__END__
+=pod
+
+=head1 NAME
+
+Apache::lonwrapper - External and binary file management.
+
+=head1 SYNOPSIS
+
+Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 Subroutines
+
+=over
+
+=item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$linktext,$explanation,$title,$width,$height)
+
+=over
+
+=item $url
+
+url to display by including in an iframe within a
+LON-CAPA page which has a standard LON-CAPA inline menu.
+
+=item $brcrum
+
+breadcrumbs for unregistered urls
+(i.e., external resources in Supplemental Content).
+
+=item $absolute
+
+contains protocol (http or https) followed by
+the hostname, if menu items in the standard LON-CAPA
+interface created by the call to loncommon::start_page()
+within &wrapper() need to use absolute URLs rather than
+relative URLs.
+
+That will be the case where an external resource has been
+served from port 80, when the server customarily serves
+requests using Apache/SSL (i.e., port 443). mod_rewrite
+is used to switch requests for external resources and
+the syllabus: /public///syllabus
+(which might also point at an external resource)
+from https:// to http:// where the the URL of the remote site
+specified in the resource itself is http://.
+
+This is done to avoid default mixed content blocking
+in Firefox 23 and later, when serving from Apache/SSL.
+
+=item $is_ext
+
+true if URL is for an external resource.
+
+=item $is_pdf
+
+true if URL is for a PDF (based on file extension).
+
+=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
+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).
+=back
+Returns markup for the entire page.
+=item handler()
+=back
+=cut