Annotation of rat/lonwrapper.pm, revision 1.49.2.3
1.1 www 1: # The LearningOnline Network with CAPA
2: # Wrapper for external and binary files as standalone resources
3: #
1.49.2.3! raeburn 4: # $Id: lonwrapper.pm,v 1.49.2.2 2016/10/31 21:31:42 raeburn Exp $
1.4 www 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: #
1.1 www 28:
1.29 jms 29:
1.1 www 30: package Apache::lonwrapper;
31:
32: use strict;
33: use Apache::Constants qw(:common);
1.38 droeschl 34: use Apache::lonenc();
1.18 albertel 35: use Apache::lonnet;
1.42 raeburn 36: use Apache::lonlocal;
37: use Apache::loncommon();
38: use Apache::lonhtmlcommon();
39: use Apache::lonextresedit();
1.1 www 40:
41: # ================================================================ Main Handler
1.21 albertel 42: sub wrapper {
1.49 raeburn 43: my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$title) = @_;
1.23 albertel 44:
1.42 raeburn 45: my $forcereg;
46: unless ($env{'form.folderpath'}) {
47: $forcereg = 1;
48: }
49:
1.46 raeburn 50: my %lt = &Apache::lonlocal::texthash(
51: 'noif' => 'No iframe support.',
52: 'show' => 'Show content in pop-up window',
53: );
54:
1.49.2.1 raeburn 55: my $anchor;
1.49.2.2 raeburn 56: if ($is_ext) {
57: if ($env{'form.symb'}) {
58: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
1.49.2.3! raeburn 59: if ($res =~ /(#[^#]+)$/) {
1.49.2.2 raeburn 60: $anchor = $1;
61: }
62: } elsif ($env{'form.anchor'} ne '') {
63: $anchor = '#'.$env{'form.anchor'};
1.49.2.1 raeburn 64: }
65: }
66:
67: my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
1.42 raeburn 68: my $args = {'bgcolor' => '#FFFFFF'};
69: if ($forcereg) {
70: $args->{'force_register'} = $forcereg;
71: }
72: if (ref($brcrum) eq 'ARRAY') {
1.45 raeburn 73: $args->{'bread_crumbs'} = $brcrum;
1.42 raeburn 74: }
1.44 raeburn 75: if ($absolute) {
76: $args->{'use_absolute'} = $absolute;
77: }
1.42 raeburn 78:
1.46 raeburn 79: my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
80: my $endpage = &Apache::loncommon::end_page();
1.38 droeschl 81:
1.46 raeburn 82: if ($env{'browser.mobile'}) {
1.47 raeburn 83: my $output = $startpage;
84: if ($is_pdf) {
85: if ($title eq '') {
1.49 raeburn 86: $title = $env{'form.title'};
87: if ($title eq '') {
88: unless ($env{'request.enc'}) {
89: ($title) = ($url =~ m{/([^/]+)$});
90: $title =~ s/(\?[^\?]+)$//;
91: }
1.47 raeburn 92: }
93: }
94: unless ($title eq '') {
95: $output .= $title.'<br />';
96: }
97: $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
98: } else {
99: $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
1.49.2.1 raeburn 100: '<iframe src="'.$url.$anchor.'" height="100%" width="100%" frameborder="0">'."\n".
1.47 raeburn 101: "$lt{'noif'} $noiframe\n".
102: "</iframe>\n".
103: "</div>\n";
104: }
105: $output .= $endpage;
106: return $output;
1.46 raeburn 107: } else {
1.49.2.3! raeburn 108: my $offset = 5;
! 109: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
! 110: if ($env{'form.inhibitmenu'} eq 'yes') {
! 111: $offset = 0;
! 112: }
1.46 raeburn 113: my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
114: \$(document).ready( function() {
115: \$(window).unbind('resize').resize(function(){
1.49.2.3! raeburn 116: var header = null;
! 117: var offset = $offset;
1.46 raeburn 118: var height = 0;
119: var hdrtop = 0;
120: if (\$('div.LC_head_subbox:first').length) {
121: header = \$('div.LC_head_subbox:first');
122: offset = 9;
123: } else {
124: if (\$('#LC_breadcrumbs').length) {
125: header = \$('#LC_breadcrumbs');
126: }
127: }
1.49.2.3! raeburn 128: if (header != null && header.length) {
1.46 raeburn 129: height = header.height();
130: hdrtop = header.position().top;
1.42 raeburn 131: }
1.46 raeburn 132: var pos = height + hdrtop + offset;
133: \$('.LC_iframecontainer').css('top', pos);
134: });
1.38 droeschl 135: });
1.46 raeburn 136: window.onload = function(){ \$(window).trigger('resize') };
1.39 droeschl 137: SCRIPT
1.46 raeburn 138: # javascript will position the iframe if window was resized (or zoomed)
139: return <<ENDFRAME;
140: $startpage
141: $script
142: <div class="LC_iframecontainer">
1.49.2.1 raeburn 143: <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>
1.46 raeburn 144: </div>
145: $endpage
1.38 droeschl 146: ENDFRAME
1.46 raeburn 147: }
1.21 albertel 148: }
149:
150: sub handler {
151: my $r=shift;
152: &Apache::loncommon::content_type($r,'text/html');
153: $r->send_http_header;
154:
155: return OK if $r->header_only;
156:
1.38 droeschl 157: my $url = $r->uri;
1.47 raeburn 158: my ($is_ext,$brcrum,$absolute,$is_pdf);
1.38 droeschl 159:
160: for ($url){
161: s|^/adm/wrapper||;
162: $is_ext = $_ =~ s|^/ext/|http://|;
163: s|http://https://|https://|;
164: s|:|:|g;
1.21 albertel 165: }
166:
1.47 raeburn 167: if ($url =~ /\.pdf$/i) {
168: $is_pdf = 1;
169: }
170:
1.42 raeburn 171: if ($is_ext) {
172: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.49.2.2 raeburn 173: ['forceedit','register','folderpath','symb','idx','title','anchor']);
1.42 raeburn 174: if (($env{'form.forceedit'}) &&
175: (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
176: (($env{'form.folderpath'} =~ /^supplemental/) ||
177: ($env{'form.symb'} =~ /^uploaded/))) {
1.49.2.2 raeburn 178: if ($env{'form.symb'}) {
179: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
180: if ($res =~ /(#[^#]+)$/) {
181: $url .= $1;
182: }
183: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
184: if ($env{'form.anchor'} ne '') {
185: $url .= '#'.$env{'form.anchor'};
186: }
187: }
1.42 raeburn 188: $r->print(
189: &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
190: $env{'form.symb'},
191: $env{'form.idx'}));
192: return OK;
193: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
194: my $crstype = &Apache::loncommon::course_type();
1.43 raeburn 195: my $title = $env{'form.title'};
196: if ($title eq '') {
197: $title = &mt('External Resource');
198: }
1.42 raeburn 199: $brcrum =
1.43 raeburn 200: &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
1.42 raeburn 201: }
202: }
203:
1.21 albertel 204: #
205: # Actual URL
206: #
1.41 www 207: if ($url=~/$LONCAPA::assess_re/) {
1.21 albertel 208: #
209: # This is uploaded homework
210: #
1.38 droeschl 211: $env{'request.state'}='uploaded';
212: &Apache::lonhomework::renderpage($r,$url);
1.21 albertel 213: } else {
214: #
215: # This is not homework
216: #
1.38 droeschl 217: if ($is_ext) {
1.49 raeburn 218: $absolute = $env{'request.use_absolute'};
1.38 droeschl 219: $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
1.42 raeburn 220: $ENV{'QUERY_STRING'} =~ s/\&$//;
1.38 droeschl 221: }
222:
1.35 raeburn 223: unless ($ENV{'QUERY_STRING'} eq '') {
1.38 droeschl 224: $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
1.35 raeburn 225: }
1.38 droeschl 226:
227: # encrypt url if not external
228: &Apache::lonenc::check_encrypt(\$url) if $url !~ /^https?\:/ ;
229:
1.47 raeburn 230: $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf) );
1.38 droeschl 231:
1.21 albertel 232: } # not just the menu
1.38 droeschl 233:
1.21 albertel 234: return OK;
1.13 www 235: } # handler
1.1 www 236:
237: 1;
238: __END__
239:
1.30 jms 240: =pod
1.1 www 241:
1.30 jms 242: =head1 NAME
243:
244: Apache::lonwrapper - External and binary file management.
245:
246: =head1 SYNOPSIS
247:
248: Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
249:
250: This is part of the LearningOnline Network with CAPA project
251: described at http://www.lon-capa.org.
252:
253: =head1 Subroutines
254:
255: =over
256:
1.49 raeburn 257: =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
1.30 jms 258:
1.45 raeburn 259: =over
260:
1.46 raeburn 261: =item $url
262:
1.45 raeburn 263: url to display by including in an iframe within a
264: LON-CAPA page which has a standard LON-CAPA inline menu.
265:
266: =item $brcrum
267:
268: breadcrumbs for unregistered urls
1.42 raeburn 269: (i.e., external resources in Supplemental Content).
1.45 raeburn 270:
1.46 raeburn 271: =item $absolute
1.45 raeburn 272:
273: contains protocol (http or https) followed by
274: the hostname, if menu items in the standard LON-CAPA
275: interface created by the call to loncommon::start_page()
276: within &wrapper() need to use absolute URLs rather than
277: relative URLs.
278:
279: That will be the case where an external resource has been
280: served from port 80, when the server customarily serves
281: requests using Apache/SSL (i.e., port 443). mod_rewrite
1.49 raeburn 282: is used to switch requests for external resources and
283: the syllabus: /public/<domain>/<courseid>/syllabus
284: (which might also point at an external resource)
1.45 raeburn 285: from https:// to http:// where the the URL of the remote site
286: specified in the resource itself is http://.
287:
288: This is done to avoid default mixed content blocking
289: in Firefox 23 and later, when serving from Apache/SSL.
290:
291: =item $is_ext
292:
293: true if URL is for an external resource.
294:
1.47 raeburn 295: =item $is_pdf
296:
297: true if URL is for a PDF (based on file extension).
298:
1.49 raeburn 299: =item $title
300:
301: optional. If wrapped item is a PDF, and $env{'browser.mobile'}
302: is true, a link to a PDF is shown. The "title" will be displayed
303: above the link, but if not provided as an arg, $env{'form.title'}
304: will be used, otherwise, the filename will be displayed (unless
305: hidden URL set for the resource).
306:
1.45 raeburn 307: =back
308:
1.38 droeschl 309: Returns markup for the entire page.
1.30 jms 310:
311: =item handler()
312:
313: =back
314:
315: =cut
1.1 www 316:
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