File:
[LON-CAPA] /
rat /
lonwrapper.pm
Revision
1.62:
download - view:
text,
annotated -
select for diffs
Mon May 8 14:20:32 2017 UTC (7 years, 1 month ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Bug 6754. Make LON-CAPA an LTI Tool Consumer (LTI 1.1).
- Name as ext.tool (instead of exttool), so that parameters can be specified
in packages.tab, based on extension.
1: # The LearningOnline Network with CAPA
2: # Wrapper for external and binary files as standalone resources
3: #
4: # $Id: lonwrapper.pm,v 1.62 2017/05/08 14:20:32 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28:
29:
30: package Apache::lonwrapper;
31:
32: use strict;
33: use Apache::Constants qw(:common);
34: use Apache::lonenc();
35: use Apache::lonnet;
36: use Apache::lonlocal;
37: use Apache::loncommon();
38: use Apache::lonhtmlcommon();
39: use Apache::lonextresedit();
40: use Apache::lonexttool();
41: use LONCAPA qw(:DEFAULT :match);;
42:
43: # ================================================================ Main Handler
44: sub wrapper {
45: my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation,$title) = @_;
46:
47: my $forcereg;
48: unless ($env{'form.folderpath'}) {
49: $forcereg = 1;
50: }
51: my %lt = &Apache::lonlocal::texthash(
52: 'noif' => 'No iframe support.',
53: 'show' => 'Show content in pop-up window',
54: );
55:
56: my $anchor;
57: if ($is_ext) {
58: if ($env{'form.symb'}) {
59: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
60: if ($res =~ /(#[^#]+)$/) {
61: $anchor = $1;
62: }
63: } elsif ($env{'form.anchor'} ne '') {
64: $anchor = '#'.$env{'form.anchor'};
65: }
66: }
67:
68: my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
69: my $args = {'bgcolor' => '#FFFFFF'};
70: if ($forcereg) {
71: $args->{'force_register'} = $forcereg;
72: }
73: if (ref($brcrum) eq 'ARRAY') {
74: $args->{'bread_crumbs'} = $brcrum;
75: }
76: if ($absolute) {
77: $args->{'use_absolute'} = $absolute;
78: }
79: if ($env{'form.only_body'}) {
80: $args->{'only_body'} = $env{'form.only_body'};
81: }
82:
83: my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
84: my $endpage = &Apache::loncommon::end_page();
85:
86: if (($env{'browser.mobile'}) || ($exttool eq 'window')) {
87: my $output = $startpage;
88: if ($is_pdf) {
89: if ($title eq '') {
90: $title = $env{'form.title'};
91: if ($title eq '') {
92: unless ($env{'request.enc'}) {
93: ($title) = ($url =~ m{/([^/]+)$});
94: $title =~ s/(\?[^\?]+)$//;
95: }
96: }
97: }
98: unless ($title eq '') {
99: $output .= $title.'<br />';
100: }
101: $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
102: } elsif ($exttool eq 'window') {
103: if ($linktext eq '') {
104: $linktext = &mt('Launch External Tool');
105: }
106: $output .= '<div>'.
107: '<a href="'.$url.'" target="LC_LTI" style="padding:0;clear:both;margin:0;border:0">'.
108: $linktext.'</a>'.
109: '</div>';
110: if ($explanation ne '') {
111: $output .= '<div>'.$explanation.'</div>';
112: }
113: } else {
114: $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
115: '<iframe src="'.$url.$anchor.'" height="100%" width="100%" frameborder="0">'."\n".
116: "$lt{'noif'} $noiframe\n".
117: "</iframe>\n".
118: "</div>\n";
119: }
120: $output .= $endpage;
121: return $output;
122: } else {
123: my $offset = 5;
124: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
125: if ($env{'form.inhibitmenu'} eq 'yes') {
126: $offset = 0;
127: }
128: my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
129: \$(document).ready( function() {
130: \$(window).unbind('resize').resize(function(){
131: var header = null;
132: var offset = $offset;
133: var height = 0;
134: var hdrtop = 0;
135: if (\$('div.LC_head_subbox:first').length) {
136: header = \$('div.LC_head_subbox:first');
137: offset = 9;
138: } else {
139: if (\$('#LC_breadcrumbs').length) {
140: header = \$('#LC_breadcrumbs');
141: }
142: }
143: if (header != null && header.length) {
144: height = header.height();
145: hdrtop = header.position().top;
146: }
147: var pos = height + hdrtop + offset;
148: \$('.LC_iframecontainer').css('top', pos);
149: });
150: });
151: window.onload = function(){ \$(window).trigger('resize') };
152: SCRIPT
153: # javascript will position the iframe if window was resized (or zoomed)
154: return <<ENDFRAME;
155: $startpage
156: $script
157: <div class="LC_iframecontainer">
158: <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>
159: </div>
160: $endpage
161: ENDFRAME
162: }
163: }
164:
165: sub handler {
166: my $r=shift;
167: &Apache::loncommon::content_type($r,'text/html');
168: $r->send_http_header;
169:
170: return OK if $r->header_only;
171:
172: my $url = $r->uri;
173: my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum,$hostname,
174: $linktext,$explanation);
175:
176: for ($url){
177: s|^/adm/wrapper||;
178: $is_ext = $_ =~ s|^/ext/|http://|;
179: s|http://https://|https://|;
180: s|:|:|g;
181: }
182:
183:
184: if ($url =~ /\.pdf$/i) {
185: $is_pdf = 1;
186: } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/ext\.tool$}) {
187: $cdom = $1;
188: $cnum = $2;
189: my $marker = $3;
190: $exttool = 'iframe';
191: my $exttoolremote;
192: my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target','linktext','explanation','id'],
193: $cdom,$cnum);
194: if ($toolhash{'id'}) {
195: my %ltitools = &Apache::lonnet::get_domain_ltitools($cdom);
196: if (ref($ltitools{$toolhash{'id'}}) eq 'HASH') {
197: $exttoolremote = $ltitools{$toolhash{'id'}}{'url'};
198: }
199: }
200: if ($toolhash{'target'} eq 'window') {
201: $exttool = 'window';
202: $linktext = $toolhash{'linktext'};
203: $explanation = $toolhash{'explanation'};
204: } elsif (($exttoolremote =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
205: $exttool = 'window';
206: }
207: }
208: if (($is_ext) || ($exttool)) {
209: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
210: ['forceedit','register','folderpath','symb','idx','title','anchor']);
211: if (($env{'form.forceedit'}) &&
212: (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
213: (($env{'form.folderpath'} =~ /^supplemental/) ||
214: ($env{'form.symb'} =~ /^uploaded/))) {
215: if ($env{'form.symb'}) {
216: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
217: if ($res =~ /(#[^#]+)$/) {
218: $url .= $1;
219: }
220: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
221: if ($env{'form.anchor'} ne '') {
222: $url .= '#'.$env{'form.anchor'};
223: }
224: }
225: my $type = 'ext';
226: if ($exttool) {
227: $type = 'tool';
228: } elsif (($url =~ /^http:/) && ($ENV{'SERVER_PORT'} == 443)) {
229: $hostname = $r->hostname();
230: }
231: $r->print(
232: &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
233: $env{'form.symb'},
234: $env{'form.idx'},$type,$cdom,
235: $cnum,$hostname));
236: return OK;
237: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
238: my $crstype = &Apache::loncommon::course_type();
239: my $title = $env{'form.title'};
240: if ($title eq '') {
241: if ($is_ext) {
242: $title = &mt('External Resource');
243: } else {
244: $title = &mt('External Tool');
245: }
246: }
247: $brcrum =
248: &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
249: }
250: }
251:
252: #
253: # Actual URL
254: #
255: if (($url=~/$LONCAPA::assess_re/) && (!$exttool)) {
256: #
257: # This is uploaded homework
258: #
259: $env{'request.state'}='uploaded';
260: &Apache::lonhomework::renderpage($r,$url);
261: } else {
262: #
263: # This is not homework
264: #
265: if (($is_ext) || ($exttool)) {
266: $absolute = $env{'request.use_absolute'};
267: $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
268: $ENV{'QUERY_STRING'} =~ s/\&$//;
269: }
270:
271: unless ($ENV{'QUERY_STRING'} eq '') {
272: $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
273: }
274:
275: # encrypt url if not external
276: unless ($is_ext) {
277: &Apache::lonenc::check_encrypt(\$url);
278: }
279:
280: $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$linktext,$explanation) );
281:
282: } # not just the menu
283:
284: return OK;
285: } # handler
286:
287: 1;
288: __END__
289:
290: =pod
291:
292: =head1 NAME
293:
294: Apache::lonwrapper - External and binary file management.
295:
296: =head1 SYNOPSIS
297:
298: Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
299:
300: This is part of the LearningOnline Network with CAPA project
301: described at http://www.lon-capa.org.
302:
303: =head1 Subroutines
304:
305: =over
306:
307: =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
308:
309: =over
310:
311: =item $url
312:
313: url to display by including in an iframe within a
314: LON-CAPA page which has a standard LON-CAPA inline menu.
315:
316: =item $brcrum
317:
318: breadcrumbs for unregistered urls
319: (i.e., external resources in Supplemental Content).
320:
321: =item $absolute
322:
323: contains protocol (http or https) followed by
324: the hostname, if menu items in the standard LON-CAPA
325: interface created by the call to loncommon::start_page()
326: within &wrapper() need to use absolute URLs rather than
327: relative URLs.
328:
329: That will be the case where an external resource has been
330: served from port 80, when the server customarily serves
331: requests using Apache/SSL (i.e., port 443). mod_rewrite
332: is used to switch requests for external resources and
333: the syllabus: /public/<domain>/<courseid>/syllabus
334: (which might also point at an external resource)
335: from https:// to http:// where the the URL of the remote site
336: specified in the resource itself is http://.
337:
338: This is done to avoid default mixed content blocking
339: in Firefox 23 and later, when serving from Apache/SSL.
340:
341: =item $is_ext
342:
343: true if URL is for an external resource.
344:
345: =item $is_pdf
346:
347: true if URL is for a PDF (based on file extension).
348:
349: =item $title
350:
351: optional. If wrapped item is a PDF, and $env{'browser.mobile'}
352: is true, a link to a PDF is shown. The "title" will be displayed
353: above the link, but if not provided as an arg, $env{'form.title'}
354: will be used, otherwise, the filename will be displayed (unless
355: hidden URL set for the resource).
356:
357: =back
358:
359: Returns markup for the entire page.
360:
361: =item handler()
362:
363: =back
364:
365: =cut
366:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonwrapper.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / rat