Annotation of loncom/interface/loncommon.pm, revision 1.1442
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1442 ! raeburn 4: # $Id: loncommon.pm,v 1.1441 2024/10/08 21:15:42 raeburn Exp $
1.10 albertel 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 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.1383 raeburn 64: use Apache::lonnavmaps();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1409 raeburn 74: use LONCAPA::ltiutils;
1.1280 raeburn 75: use LONCAPA::LWPReq;
1.1395 raeburn 76: use LONCAPA::map();
1.1328 raeburn 77: use HTTP::Request;
1.657 raeburn 78: use DateTime::TimeZone;
1.1241 raeburn 79: use DateTime::Locale;
1.1220 raeburn 80: use Encode();
1.1091 foxr 81: use Text::Aspell;
1.1094 raeburn 82: use Authen::Captcha;
83: use Captcha::reCAPTCHA;
1.1234 raeburn 84: use JSON::DWIW;
1.1174 raeburn 85: use Crypt::DES;
86: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 87: use MIME::Lite;
88: use MIME::Types;
1.1292 raeburn 89: use File::Copy();
1.1300 raeburn 90: use File::Path();
1.1309 raeburn 91: use String::CRC32();
92: use Short::URL();
1.117 www 93:
1.517 raeburn 94: # ---------------------------------------------- Designs
95: use vars qw(%defaultdesign);
96:
1.22 www 97: my $readit;
98:
1.517 raeburn 99:
1.157 matthew 100: ##
101: ## Global Variables
102: ##
1.46 matthew 103:
1.643 foxr 104:
105: # ----------------------------------------------- SSI with retries:
106: #
107:
108: =pod
109:
1.648 raeburn 110: =head1 Server Side include with retries:
1.643 foxr 111:
112: =over 4
113:
1.648 raeburn 114: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 115:
116: Performs an ssi with some number of retries. Retries continue either
117: until the result is ok or until the retry count supplied by the
118: caller is exhausted.
119:
120: Inputs:
1.648 raeburn 121:
122: =over 4
123:
1.643 foxr 124: resource - Identifies the resource to insert.
1.648 raeburn 125:
1.643 foxr 126: retries - Count of the number of retries allowed.
1.648 raeburn 127:
1.643 foxr 128: form - Hash that identifies the rendering options.
129:
1.648 raeburn 130: =back
131:
132: Returns:
133:
134: =over 4
135:
1.643 foxr 136: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 137:
1.643 foxr 138: response - The response from the last attempt (which may or may not have been successful.
139:
1.648 raeburn 140: =back
141:
142: =back
143:
1.643 foxr 144: =cut
145:
146: sub ssi_with_retries {
147: my ($resource, $retries, %form) = @_;
148:
149:
150: my $ok = 0; # True if we got a good response.
151: my $content;
152: my $response;
153:
154: # Try to get the ssi done. within the retries count:
155:
156: do {
157: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
158: $ok = $response->is_success;
1.650 www 159: if (!$ok) {
160: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
161: }
1.643 foxr 162: $retries--;
163: } while (!$ok && ($retries > 0));
164:
165: if (!$ok) {
166: $content = ''; # On error return an empty content.
167: }
168: return ($content, $response);
169:
170: }
171:
172:
173:
1.20 www 174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 175: my %language;
1.124 www 176: my %supported_language;
1.1088 foxr 177: my %supported_codes;
1.1048 foxr 178: my %latex_language; # For choosing hyphenation in <transl..>
179: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 180: my %cprtag;
1.192 taceyjo1 181: my %scprtag;
1.351 www 182: my %fe; my %fd; my %fm;
1.41 ng 183: my %category_extensions;
1.12 harris41 184:
1.46 matthew 185: # ---------------------------------------------- Thesaurus variables
1.144 matthew 186: #
187: # %Keywords:
188: # A hash used by &keyword to determine if a word is considered a keyword.
189: # $thesaurus_db_file
190: # Scalar containing the full path to the thesaurus database.
1.46 matthew 191:
192: my %Keywords;
193: my $thesaurus_db_file;
194:
1.144 matthew 195: #
196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
197: # thesaurus.tab, and filecategories.tab.
198: #
1.18 www 199: BEGIN {
1.46 matthew 200: # Variable initialization
201: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
202: #
1.22 www 203: unless ($readit) {
1.12 harris41 204: # ------------------------------------------------------------------- languages
205: {
1.158 raeburn 206: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
207: '/language.tab';
1.1317 raeburn 208: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
1.1088 foxr 212: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 213: $language{$key}=$val.' - '.$enc;
214: if ($sup) {
215: $supported_language{$key}=$sup;
1.1088 foxr 216: $supported_codes{$key} = $code;
1.158 raeburn 217: }
1.1048 foxr 218: if ($latex) {
219: $latex_language_bykey{$key} = $latex;
1.1088 foxr 220: $latex_language{$code} = $latex;
1.1048 foxr 221: }
1.158 raeburn 222: }
223: close($fh);
224: }
1.12 harris41 225: }
226: # ------------------------------------------------------------------ copyrights
227: {
1.158 raeburn 228: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/copyright.tab';
1.1317 raeburn 230: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line=~/^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 235: $cprtag{$key}=$val;
236: }
237: close($fh);
238: }
1.12 harris41 239: }
1.351 www 240: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 241: {
242: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
243: '/source_copyright.tab';
1.1317 raeburn 244: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 249: $scprtag{$key}=$val;
250: }
251: close($fh);
252: }
253: }
1.63 www 254:
1.517 raeburn 255: # -------------------------------------------------------------- default domain designs
1.63 www 256: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 257: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 258: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($key,$val)=(split(/\=/,$line));
263: if ($val) { $defaultdesign{$key}=$val; }
264: }
265: close($fh);
1.63 www 266: }
267:
1.15 harris41 268: # ------------------------------------------------------------- file categories
269: {
1.158 raeburn 270: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filecategories.tab';
1.1317 raeburn 272: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 277: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 278: }
279: close($fh);
280: }
281:
1.15 harris41 282: }
1.12 harris41 283: # ------------------------------------------------------------------ file types
284: {
1.158 raeburn 285: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
286: '/filetypes.tab';
1.1317 raeburn 287: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 288: while (my $line = <$fh>) {
289: next if ($line =~ /^\#/);
290: chomp($line);
291: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 292: if ($descr ne '') {
293: $fe{$ending}=lc($emb);
294: $fd{$ending}=$descr;
1.351 www 295: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 296: }
297: }
298: close($fh);
299: }
1.12 harris41 300: }
1.22 www 301: &Apache::lonnet::logthis(
1.705 tempelho 302: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 303: $readit=1;
1.46 matthew 304: } # end of unless($readit)
1.32 matthew 305:
306: }
1.112 bowersj2 307:
1.42 matthew 308: ###############################################################
309: ## HTML and Javascript Helper Functions ##
310: ###############################################################
311:
312: =pod
313:
1.112 bowersj2 314: =head1 HTML and Javascript Functions
1.42 matthew 315:
1.112 bowersj2 316: =over 4
317:
1.648 raeburn 318: =item * &browser_and_searcher_javascript()
1.112 bowersj2 319:
320: X<browsing, javascript>X<searching, javascript>Returns a string
321: containing javascript with two functions, C<openbrowser> and
322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
323: tags.
1.42 matthew 324:
1.648 raeburn 325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 326:
327: inputs: formname, elementname, only, omit
328:
329: formname and elementname indicate the name of the html form and name of
330: the element that the results of the browsing selection are to be placed in.
331:
332: Specifying 'only' will restrict the browser to displaying only files
1.185 www 333: with the given extension. Can be a comma separated list.
1.42 matthew 334:
335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 336: with the given extension. Can be a comma separated list.
1.42 matthew 337:
1.648 raeburn 338: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 339:
340: Inputs: formname, elementname
341:
342: formname and elementname specify the name of the html form and the name
343: of the element the selection from the search results will be placed in.
1.542 raeburn 344:
1.42 matthew 345: =cut
346:
347: sub browser_and_searcher_javascript {
1.199 albertel 348: my ($mode)=@_;
349: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 350: my $resurl=&escape_single(&lastresurl());
1.42 matthew 351: return <<END;
1.219 albertel 352: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 353: var editbrowser = null;
1.135 albertel 354: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 355: var url = '$resurl/?';
1.42 matthew 356: if (editbrowser == null) {
357: url += 'launch=1&';
358: }
359: url += 'catalogmode=interactive&';
1.199 albertel 360: url += 'mode=$mode&';
1.611 albertel 361: url += 'inhibitmenu=yes&';
1.42 matthew 362: url += 'form=' + formname + '&';
363: if (only != null) {
364: url += 'only=' + only + '&';
1.217 albertel 365: } else {
366: url += 'only=&';
367: }
1.42 matthew 368: if (omit != null) {
369: url += 'omit=' + omit + '&';
1.217 albertel 370: } else {
371: url += 'omit=&';
372: }
1.135 albertel 373: if (titleelement != null) {
374: url += 'titleelement=' + titleelement + '&';
1.217 albertel 375: } else {
376: url += 'titleelement=&';
377: }
1.42 matthew 378: url += 'element=' + elementname + '';
379: var title = 'Browser';
1.435 albertel 380: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 381: options += ',width=700,height=600';
382: editbrowser = open(url,title,options,'1');
383: editbrowser.focus();
384: }
385: var editsearcher;
1.135 albertel 386: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 387: var url = '/adm/searchcat?';
388: if (editsearcher == null) {
389: url += 'launch=1&';
390: }
391: url += 'catalogmode=interactive&';
1.199 albertel 392: url += 'mode=$mode&';
1.42 matthew 393: url += 'form=' + formname + '&';
1.135 albertel 394: if (titleelement != null) {
395: url += 'titleelement=' + titleelement + '&';
1.217 albertel 396: } else {
397: url += 'titleelement=&';
398: }
1.42 matthew 399: url += 'element=' + elementname + '';
400: var title = 'Search';
1.435 albertel 401: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 402: options += ',width=700,height=600';
403: editsearcher = open(url,title,options,'1');
404: editsearcher.focus();
405: }
1.219 albertel 406: // END LON-CAPA Internal -->
1.42 matthew 407: END
1.170 www 408: }
409:
410: sub lastresurl {
1.258 albertel 411: if ($env{'environment.lastresurl'}) {
412: return $env{'environment.lastresurl'}
1.170 www 413: } else {
414: return '/res';
415: }
416: }
417:
418: sub storeresurl {
419: my $resurl=&Apache::lonnet::clutter(shift);
420: unless ($resurl=~/^\/res/) { return 0; }
421: $resurl=~s/\/$//;
422: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 423: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 424: return 1;
1.42 matthew 425: }
426:
1.74 www 427: sub studentbrowser_javascript {
1.111 www 428: unless (
1.258 albertel 429: (($env{'request.course.id'}) &&
1.302 albertel 430: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
431: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
432: '/'.$env{'request.course.sec'})
433: ))
1.258 albertel 434: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 435: ) { return ''; }
1.74 www 436: return (<<'ENDSTDBRW');
1.776 bisitz 437: <script type="text/javascript" language="Javascript">
1.824 bisitz 438: // <![CDATA[
1.74 www 439: var stdeditbrowser;
1.1413 raeburn 440: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74 www 441: var url = '/adm/pickstudent?';
442: var filter;
1.558 albertel 443: if (!ignorefilter) {
444: eval('filter=document.'+formname+'.'+uname+'.value;');
445: }
1.74 www 446: if (filter != null) {
447: if (filter != '') {
448: url += 'filter='+filter+'&';
449: }
450: }
451: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 452: '&udomelement='+udom+
453: '&clicker='+clicker;
1.111 www 454: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 455: if (courseadv == 'condition') {
456: if (document.getElementById('courseadv')) {
457: courseadv = document.getElementById('courseadv').value;
458: }
459: }
460: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413 raeburn 461: if (uident !== '') { url+="&identelement="+uident; }
1.102 www 462: var title = 'Student_Browser';
1.74 www 463: var options = 'scrollbars=1,resizable=1,menubar=0';
464: options += ',width=700,height=600';
465: stdeditbrowser = open(url,title,options,'1');
466: stdeditbrowser.focus();
467: }
1.824 bisitz 468: // ]]>
1.74 www 469: </script>
470: ENDSTDBRW
471: }
1.42 matthew 472:
1.1003 www 473: sub resourcebrowser_javascript {
474: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 475: return (<<'ENDRESBRW');
1.1003 www 476: <script type="text/javascript" language="Javascript">
477: // <![CDATA[
478: var reseditbrowser;
1.1004 www 479: function openresbrowser(formname,reslink) {
1.1005 www 480: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 481: var title = 'Resource_Browser';
482: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 483: options += ',width=700,height=500';
1.1004 www 484: reseditbrowser = open(url,title,options,'1');
485: reseditbrowser.focus();
1.1003 www 486: }
487: // ]]>
488: </script>
1.1004 www 489: ENDRESBRW
1.1003 www 490: }
491:
1.74 www 492: sub selectstudent_link {
1.1413 raeburn 493: my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999 www 494: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
495: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
496: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 497: if ($env{'request.course.id'}) {
1.302 albertel 498: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
499: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
500: '/'.$env{'request.course.sec'})) {
1.111 www 501: return '';
502: }
1.999 www 503: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 504: if ($courseadv eq 'only') {
505: $callargs .= ",'',1,'$courseadv'";
506: } elsif ($courseadv eq 'none') {
507: $callargs .= ",'','','$courseadv'";
508: } elsif ($courseadv eq 'condition') {
509: $callargs .= ",'','','$courseadv'";
1.1413 raeburn 510: } elsif ($identelem ne '') {
511: $callargs .= ",'','',''";
512: }
513: if ($identelem ne '') {
514: $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793 raeburn 515: }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openstdbrowser('.$callargs.');">'.
518: &mt('Select User').'</a></span>';
1.74 www 519: }
1.258 albertel 520: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 521: $callargs .= ",'',1";
1.793 raeburn 522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openstdbrowser('.$callargs.');">'.
524: &mt('Select User').'</a></span>';
1.111 www 525: }
526: return '';
1.91 www 527: }
528:
1.1004 www 529: sub selectresource_link {
530: my ($form,$reslink,$arg)=@_;
531:
532: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
533: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
534: unless ($env{'request.course.id'}) { return $arg; }
535: return '<span class="LC_nobreak">'.
536: '<a href="javascript:openresbrowser('.$callargs.');">'.
537: $arg.'</a></span>';
538: }
539:
540:
541:
1.653 raeburn 542: sub authorbrowser_javascript {
543: return <<"ENDAUTHORBRW";
1.776 bisitz 544: <script type="text/javascript" language="JavaScript">
1.824 bisitz 545: // <![CDATA[
1.653 raeburn 546: var stdeditbrowser;
547:
548: function openauthorbrowser(formname,udom) {
549: var url = '/adm/pickauthor?';
550: url += 'form='+formname+'&roledom='+udom;
551: var title = 'Author_Browser';
552: var options = 'scrollbars=1,resizable=1,menubar=0';
553: options += ',width=700,height=600';
554: stdeditbrowser = open(url,title,options,'1');
555: stdeditbrowser.focus();
556: }
557:
1.824 bisitz 558: // ]]>
1.653 raeburn 559: </script>
560: ENDAUTHORBRW
561: }
562:
1.91 www 563: sub coursebrowser_javascript {
1.1116 raeburn 564: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 565: $credits_element,$instcode) = @_;
1.932 raeburn 566: my $wintitle = 'Course_Browser';
1.931 raeburn 567: if ($crstype eq 'Community') {
1.932 raeburn 568: $wintitle = 'Community_Browser';
1.909 raeburn 569: }
1.876 raeburn 570: my $id_functions = &javascript_index_functions();
571: my $output = '
1.776 bisitz 572: <script type="text/javascript" language="JavaScript">
1.824 bisitz 573: // <![CDATA[
1.468 raeburn 574: var stdeditbrowser;'."\n";
1.876 raeburn 575:
576: $output .= <<"ENDSTDBRW";
1.909 raeburn 577: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 578: var url = '/adm/pickcourse?';
1.895 raeburn 579: var formid = getFormIdByName(formname);
1.876 raeburn 580: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 581: if (domainfilter != null) {
582: if (domainfilter != '') {
583: url += 'domainfilter='+domainfilter+'&';
584: }
585: }
1.91 www 586: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 587: '&cdomelement='+udom+
588: '&cnameelement='+desc;
1.468 raeburn 589: if (extra_element !=null && extra_element != '') {
1.594 raeburn 590: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 591: url += '&roleelement='+extra_element;
592: if (domainfilter == null || domainfilter == '') {
593: url += '&domainfilter='+extra_element;
594: }
1.234 raeburn 595: }
1.468 raeburn 596: else {
597: if (formname == 'portform') {
598: url += '&setroles='+extra_element;
1.800 raeburn 599: } else {
600: if (formname == 'rules') {
601: url += '&fixeddom='+extra_element;
602: }
1.468 raeburn 603: }
604: }
1.230 raeburn 605: }
1.909 raeburn 606: if (type != null && type != '') {
607: url += '&type='+type;
608: }
609: if (type_elem != null && type_elem != '') {
610: url += '&typeelement='+type_elem;
611: }
1.872 raeburn 612: if (formname == 'ccrs') {
613: var ownername = document.forms[formid].ccuname.value;
614: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 615: url += '&cloner='+ownername+':'+ownerdom;
616: if (type == 'Course') {
617: url += '&crscode='+document.forms[formid].crscode.value;
618: }
1.1221 raeburn 619: }
620: if (formname == 'requestcrs') {
621: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 622: }
1.293 raeburn 623: if (multflag !=null && multflag != '') {
624: url += '&multiple='+multflag;
625: }
1.909 raeburn 626: var title = '$wintitle';
1.91 www 627: var options = 'scrollbars=1,resizable=1,menubar=0';
628: options += ',width=700,height=600';
629: stdeditbrowser = open(url,title,options,'1');
630: stdeditbrowser.focus();
631: }
1.876 raeburn 632: $id_functions
633: ENDSTDBRW
1.1116 raeburn 634: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
635: $output .= &setsec_javascript($sec_element,$formname,$role_element,
636: $credits_element);
1.876 raeburn 637: }
638: $output .= '
639: // ]]>
640: </script>';
641: return $output;
642: }
643:
644: sub javascript_index_functions {
645: return <<"ENDJS";
646:
647: function getFormIdByName(formname) {
648: for (var i=0;i<document.forms.length;i++) {
649: if (document.forms[i].name == formname) {
650: return i;
651: }
652: }
653: return -1;
654: }
655:
656: function getIndexByName(formid,item) {
657: for (var i=0;i<document.forms[formid].elements.length;i++) {
658: if (document.forms[formid].elements[i].name == item) {
659: return i;
660: }
661: }
662: return -1;
663: }
1.468 raeburn 664:
1.876 raeburn 665: function getDomainFromSelectbox(formname,udom) {
666: var userdom;
667: var formid = getFormIdByName(formname);
668: if (formid > -1) {
669: var domid = getIndexByName(formid,udom);
670: if (domid > -1) {
671: if (document.forms[formid].elements[domid].type == 'select-one') {
672: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
673: }
674: if (document.forms[formid].elements[domid].type == 'hidden') {
675: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 676: }
677: }
678: }
1.876 raeburn 679: return userdom;
680: }
681:
682: ENDJS
1.468 raeburn 683:
1.876 raeburn 684: }
685:
1.1017 raeburn 686: sub javascript_array_indexof {
1.1018 raeburn 687: return <<ENDJS;
1.1017 raeburn 688: <script type="text/javascript" language="JavaScript">
689: // <![CDATA[
690:
691: if (!Array.prototype.indexOf) {
692: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
693: "use strict";
694: if (this === void 0 || this === null) {
695: throw new TypeError();
696: }
697: var t = Object(this);
698: var len = t.length >>> 0;
699: if (len === 0) {
700: return -1;
701: }
702: var n = 0;
703: if (arguments.length > 0) {
704: n = Number(arguments[1]);
1.1088 foxr 705: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 706: n = 0;
707: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
708: n = (n > 0 || -1) * Math.floor(Math.abs(n));
709: }
710: }
711: if (n >= len) {
712: return -1;
713: }
714: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
715: for (; k < len; k++) {
716: if (k in t && t[k] === searchElement) {
717: return k;
718: }
719: }
720: return -1;
721: }
722: }
723:
724: // ]]>
725: </script>
726:
727: ENDJS
728:
729: }
730:
1.876 raeburn 731: sub userbrowser_javascript {
732: my $id_functions = &javascript_index_functions();
733: return <<"ENDUSERBRW";
734:
1.888 raeburn 735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 736: var url = '/adm/pickuser?';
737: var userdom = getDomainFromSelectbox(formname,udom);
738: if (userdom != null) {
739: if (userdom != '') {
740: url += 'srchdom='+userdom+'&';
741: }
742: }
743: url += 'form=' + formname + '&unameelement='+uname+
744: '&udomelement='+udom+
745: '&ulastelement='+ulast+
746: '&ufirstelement='+ufirst+
747: '&uemailelement='+uemail+
1.881 raeburn 748: '&hideudomelement='+hideudom+
749: '&coursedom='+crsdom;
1.888 raeburn 750: if ((caller != null) && (caller != undefined)) {
751: url += '&caller='+caller;
752: }
1.876 raeburn 753: var title = 'User_Browser';
754: var options = 'scrollbars=1,resizable=1,menubar=0';
755: options += ',width=700,height=600';
756: var stdeditbrowser = open(url,title,options,'1');
757: stdeditbrowser.focus();
758: }
759:
1.888 raeburn 760: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 761: var formid = getFormIdByName(formname);
762: if (formid > -1) {
1.888 raeburn 763: var unameid = getIndexByName(formid,uname);
1.876 raeburn 764: var domid = getIndexByName(formid,udom);
765: var hidedomid = getIndexByName(formid,origdom);
766: if (hidedomid > -1) {
767: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 768: var unameval = document.forms[formid].elements[unameid].value;
769: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
770: if (domid > -1) {
771: var slct = document.forms[formid].elements[domid];
772: if (slct.type == 'select-one') {
773: var i;
774: for (i=0;i<slct.length;i++) {
775: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
776: }
777: }
778: if (slct.type == 'hidden') {
779: slct.value = fixeddom;
1.876 raeburn 780: }
781: }
1.468 raeburn 782: }
783: }
784: }
1.876 raeburn 785: return;
786: }
787:
788: $id_functions
789: ENDUSERBRW
1.468 raeburn 790: }
791:
792: sub setsec_javascript {
1.1116 raeburn 793: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 794: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
795: $communityrolestr);
796: if ($role_element ne '') {
797: my @allroles = ('st','ta','ep','in','ad');
798: foreach my $crstype ('Course','Community') {
799: if ($crstype eq 'Community') {
800: foreach my $role (@allroles) {
801: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
802: }
803: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
804: } else {
805: foreach my $role (@allroles) {
806: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
807: }
808: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
809: }
810: }
811: $rolestr = '"'.join('","',@allroles).'"';
812: $courserolestr = '"'.join('","',@courserolenames).'"';
813: $communityrolestr = '"'.join('","',@communityrolenames).'"';
814: }
1.468 raeburn 815: my $setsections = qq|
816: function setSect(sectionlist) {
1.629 raeburn 817: var sectionsArray = new Array();
818: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
819: sectionsArray = sectionlist.split(",");
820: }
1.468 raeburn 821: var numSections = sectionsArray.length;
822: document.$formname.$sec_element.length = 0;
823: if (numSections == 0) {
824: document.$formname.$sec_element.multiple=false;
825: document.$formname.$sec_element.size=1;
826: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
827: } else {
828: if (numSections == 1) {
829: document.$formname.$sec_element.multiple=false;
830: document.$formname.$sec_element.size=1;
831: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
832: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
833: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
834: } else {
835: for (var i=0; i<numSections; i++) {
836: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
837: }
838: document.$formname.$sec_element.multiple=true
839: if (numSections < 3) {
840: document.$formname.$sec_element.size=numSections;
841: } else {
842: document.$formname.$sec_element.size=3;
843: }
844: document.$formname.$sec_element.options[0].selected = false
845: }
846: }
1.91 www 847: }
1.905 raeburn 848:
849: function setRole(crstype) {
1.468 raeburn 850: |;
1.905 raeburn 851: if ($role_element eq '') {
852: $setsections .= ' return;
853: }
854: ';
855: } else {
856: $setsections .= qq|
857: var elementLength = document.$formname.$role_element.length;
858: var allroles = Array($rolestr);
859: var courserolenames = Array($courserolestr);
860: var communityrolenames = Array($communityrolestr);
861: if (elementLength != undefined) {
862: if (document.$formname.$role_element.options[5].value == 'cc') {
863: if (crstype == 'Course') {
864: return;
865: } else {
866: allroles[5] = 'co';
867: for (var i=0; i<6; i++) {
868: document.$formname.$role_element.options[i].value = allroles[i];
869: document.$formname.$role_element.options[i].text = communityrolenames[i];
870: }
871: }
872: } else {
873: if (crstype == 'Community') {
874: return;
875: } else {
876: allroles[5] = 'cc';
877: for (var i=0; i<6; i++) {
878: document.$formname.$role_element.options[i].value = allroles[i];
879: document.$formname.$role_element.options[i].text = courserolenames[i];
880: }
881: }
882: }
883: }
884: return;
885: }
886: |;
887: }
1.1116 raeburn 888: if ($credits_element) {
889: $setsections .= qq|
890: function setCredits(defaultcredits) {
891: document.$formname.$credits_element.value = defaultcredits;
892: return;
893: }
894: |;
895: }
1.468 raeburn 896: return $setsections;
897: }
898:
1.91 www 899: sub selectcourse_link {
1.909 raeburn 900: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
901: $typeelement) = @_;
902: my $type = $selecttype;
1.871 raeburn 903: my $linktext = &mt('Select Course');
904: if ($selecttype eq 'Community') {
1.909 raeburn 905: $linktext = &mt('Select Community');
1.1239 raeburn 906: } elsif ($selecttype eq 'Placement') {
907: $linktext = &mt('Select Placement Test');
1.906 raeburn 908: } elsif ($selecttype eq 'Course/Community') {
909: $linktext = &mt('Select Course/Community');
1.909 raeburn 910: $type = '';
1.1019 raeburn 911: } elsif ($selecttype eq 'Select') {
912: $linktext = &mt('Select');
913: $type = '';
1.871 raeburn 914: }
1.787 bisitz 915: return '<span class="LC_nobreak">'
916: ."<a href='"
917: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
918: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 919: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 920: ."'>".$linktext.'</a>'
1.787 bisitz 921: .'</span>';
1.74 www 922: }
1.42 matthew 923:
1.653 raeburn 924: sub selectauthor_link {
925: my ($form,$udom)=@_;
926: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
927: &mt('Select Author').'</a>';
928: }
929:
1.876 raeburn 930: sub selectuser_link {
1.881 raeburn 931: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 932: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 933: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 934: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 935: ');">'.$linktext.'</a>';
1.876 raeburn 936: }
937:
1.273 raeburn 938: sub check_uncheck_jscript {
939: my $jscript = <<"ENDSCRT";
940: function checkAll(field) {
941: if (field.length > 0) {
942: for (i = 0; i < field.length; i++) {
1.1093 raeburn 943: if (!field[i].disabled) {
944: field[i].checked = true;
945: }
1.273 raeburn 946: }
947: } else {
1.1093 raeburn 948: if (!field.disabled) {
949: field.checked = true;
950: }
1.273 raeburn 951: }
952: }
953:
954: function uncheckAll(field) {
955: if (field.length > 0) {
956: for (i = 0; i < field.length; i++) {
957: field[i].checked = false ;
1.543 albertel 958: }
959: } else {
1.273 raeburn 960: field.checked = false ;
961: }
962: }
963: ENDSCRT
964: return $jscript;
965: }
966:
1.656 www 967: sub select_timezone {
1.1387 raeburn 968: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
969: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 970: if ($includeempty) {
971: $output .= '<option value=""';
972: if (($selected eq '') || ($selected eq 'local')) {
973: $output .= ' selected="selected" ';
974: }
975: $output .= '> </option>';
976: }
1.657 raeburn 977: my @timezones = DateTime::TimeZone->all_names;
978: foreach my $tzone (@timezones) {
979: $output.= '<option value="'.$tzone.'"';
980: if ($tzone eq $selected) {
981: $output.=' selected="selected"';
982: }
983: $output.=">$tzone</option>\n";
1.656 www 984: }
985: $output.="</select>";
986: return $output;
987: }
1.273 raeburn 988:
1.687 raeburn 989: sub select_datelocale {
1.1256 raeburn 990: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
991: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 992: if ($includeempty) {
993: $output .= '<option value=""';
994: if ($selected eq '') {
995: $output .= ' selected="selected" ';
996: }
997: $output .= '> </option>';
998: }
1.1241 raeburn 999: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 1000: my (@possibles,%locale_names);
1.1241 raeburn 1001: my @locales = DateTime::Locale->ids();
1002: foreach my $id (@locales) {
1003: if ($id ne '') {
1004: my ($en_terr,$native_terr);
1005: my $loc = DateTime::Locale->load($id);
1006: if (ref($loc)) {
1007: $en_terr = $loc->name();
1008: $native_terr = $loc->native_name();
1.687 raeburn 1009: if (grep(/^en$/,@languages) || !@languages) {
1010: if ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: } elsif ($native_terr ne '') {
1013: $locale_names{$id} = $native_terr;
1014: }
1015: } else {
1016: if ($native_terr ne '') {
1017: $locale_names{$id} = $native_terr.' ';
1018: } elsif ($en_terr ne '') {
1019: $locale_names{$id} = '('.$en_terr.')';
1020: }
1021: }
1.1220 raeburn 1022: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1023: push(@possibles,$id);
1024: }
1.687 raeburn 1025: }
1026: }
1027: foreach my $item (sort(@possibles)) {
1028: $output.= '<option value="'.$item.'"';
1029: if ($item eq $selected) {
1030: $output.=' selected="selected"';
1031: }
1032: $output.=">$item";
1033: if ($locale_names{$item} ne '') {
1.1220 raeburn 1034: $output.=' '.$locale_names{$item};
1.687 raeburn 1035: }
1036: $output.="</option>\n";
1037: }
1038: $output.="</select>";
1039: return $output;
1040: }
1041:
1.792 raeburn 1042: sub select_language {
1.1256 raeburn 1043: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1044: my %langchoices;
1045: if ($includeempty) {
1.1117 raeburn 1046: %langchoices = ('' => 'No language preference');
1.792 raeburn 1047: }
1048: foreach my $id (&languageids()) {
1049: my $code = &supportedlanguagecode($id);
1050: if ($code) {
1051: $langchoices{$code} = &plainlanguagedescription($id);
1052: }
1053: }
1.1117 raeburn 1054: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1055: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1056: }
1057:
1.42 matthew 1058: =pod
1.36 matthew 1059:
1.1088 foxr 1060:
1061: =item * &list_languages()
1062:
1063: Returns an array reference that is suitable for use in language prompters.
1064: Each array element is itself a two element array. The first element
1065: is the language code. The second element a descsriptiuon of the
1066: language itself. This is suitable for use in e.g.
1067: &Apache::edit::select_arg (once dereferenced that is).
1068:
1069: =cut
1070:
1071: sub list_languages {
1072: my @lang_choices;
1073:
1074: foreach my $id (&languageids()) {
1075: my $code = &supportedlanguagecode($id);
1076: if ($code) {
1077: my $selector = $supported_codes{$id};
1078: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1079: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1080: }
1081: }
1082: return \@lang_choices;
1083: }
1084:
1085: =pod
1086:
1.648 raeburn 1087: =item * &linked_select_forms(...)
1.36 matthew 1088:
1089: linked_select_forms returns a string containing a <script></script> block
1090: and html for two <select> menus. The select menus will be linked in that
1091: changing the value of the first menu will result in new values being placed
1092: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1093: order unless a defined order is provided.
1.36 matthew 1094:
1095: linked_select_forms takes the following ordered inputs:
1096:
1097: =over 4
1098:
1.112 bowersj2 1099: =item * $formname, the name of the <form> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1102:
1.112 bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36 matthew 1104:
1.112 bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1106:
1.112 bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1108:
1.112 bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1110:
1.609 raeburn 1111: =item * $menuorder, the order of values in the first menu
1112:
1.1115 raeburn 1113: =item * $onchangefirst, additional javascript call to execute for an onchange
1114: event for the first <select> tag
1115:
1116: =item * $onchangesecond, additional javascript call to execute for an onchange
1117: event for the second <select> tag
1118:
1.1245 raeburn 1119: =item * $suffix, to differentiate separate uses of select2data javascript
1120: objects in a page.
1121:
1.41 ng 1122: =back
1123:
1.36 matthew 1124: Below is an example of such a hash. Only the 'text', 'default', and
1125: 'select2' keys must appear as stated. keys(%menu) are the possible
1126: values for the first select menu. The text that coincides with the
1.41 ng 1127: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1128: and text for the second menu are given in the hash pointed to by
1129: $menu{$choice1}->{'select2'}.
1130:
1.112 bowersj2 1131: my %menu = ( A1 => { text =>"Choice A1" ,
1132: default => "B3",
1133: select2 => {
1134: B1 => "Choice B1",
1135: B2 => "Choice B2",
1136: B3 => "Choice B3",
1137: B4 => "Choice B4"
1.609 raeburn 1138: },
1139: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1140: },
1141: A2 => { text =>"Choice A2" ,
1142: default => "C2",
1143: select2 => {
1144: C1 => "Choice C1",
1145: C2 => "Choice C2",
1146: C3 => "Choice C3"
1.609 raeburn 1147: },
1148: order => ['C2','C1','C3'],
1.112 bowersj2 1149: },
1150: A3 => { text =>"Choice A3" ,
1151: default => "D6",
1152: select2 => {
1153: D1 => "Choice D1",
1154: D2 => "Choice D2",
1155: D3 => "Choice D3",
1156: D4 => "Choice D4",
1157: D5 => "Choice D5",
1158: D6 => "Choice D6",
1159: D7 => "Choice D7"
1.609 raeburn 1160: },
1161: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1162: }
1163: );
1.36 matthew 1164:
1165: =cut
1166:
1167: sub linked_select_forms {
1168: my ($formname,
1169: $middletext,
1170: $firstdefault,
1171: $firstselectname,
1172: $secondselectname,
1.609 raeburn 1173: $hashref,
1174: $menuorder,
1.1115 raeburn 1175: $onchangefirst,
1.1245 raeburn 1176: $onchangesecond,
1177: $suffix
1.36 matthew 1178: ) = @_;
1179: my $second = "document.$formname.$secondselectname";
1180: my $first = "document.$formname.$firstselectname";
1181: # output the javascript to do the changing
1182: my $result = '';
1.776 bisitz 1183: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1184: $result.="// <![CDATA[\n";
1.1245 raeburn 1185: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1186: $" = '","';
1187: my $debug = '';
1188: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1189: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1190: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1191: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1192: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1193: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1194: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1195: @s2values = @{$hashref->{$s1}->{'order'}};
1196: }
1.36 matthew 1197: $result.="\"@s2values\");\n";
1.1245 raeburn 1198: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1199: my @s2texts;
1200: foreach my $value (@s2values) {
1.1263 raeburn 1201: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1202: }
1203: $result.="\"@s2texts\");\n";
1204: }
1205: $"=' ';
1206: $result.= <<"END";
1207:
1.1245 raeburn 1208: function select1${suffix}_changed() {
1.36 matthew 1209: // Determine new choice
1.1245 raeburn 1210: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1211: // update select2
1.1245 raeburn 1212: var values = select2data${suffix}[newvalue].values;
1213: var texts = select2data${suffix}[newvalue].texts;
1214: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1215: var i;
1216: // out with the old
1.1245 raeburn 1217: $second.options.length = 0;
1218: // in with the new
1.36 matthew 1219: for (i=0;i<values.length; i++) {
1220: $second.options[i] = new Option(values[i]);
1.143 matthew 1221: $second.options[i].value = values[i];
1.36 matthew 1222: $second.options[i].text = texts[i];
1223: if (values[i] == select2def) {
1224: $second.options[i].selected = true;
1225: }
1226: }
1227: }
1.824 bisitz 1228: // ]]>
1.36 matthew 1229: </script>
1230: END
1231: # output the initial values for the selection lists
1.1245 raeburn 1232: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1233: my @order = sort(keys(%{$hashref}));
1234: if (ref($menuorder) eq 'ARRAY') {
1235: @order = @{$menuorder};
1236: }
1237: foreach my $value (@order) {
1.36 matthew 1238: $result.=" <option value=\"$value\" ";
1.253 albertel 1239: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1240: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1241: }
1242: $result .= "</select>\n";
1.1400 raeburn 1243: my %select2;
1244: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1245: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1246: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1247: }
1248: }
1.36 matthew 1249: $result .= $middletext;
1.1115 raeburn 1250: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1251: if ($onchangesecond) {
1252: $result .= ' onchange="'.$onchangesecond.'"';
1253: }
1254: $result .= ">\n";
1.36 matthew 1255: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1256:
1257: my @secondorder = sort(keys(%select2));
1258: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1259: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1260: }
1261: foreach my $value (@secondorder) {
1.36 matthew 1262: $result.=" <option value=\"$value\" ";
1.253 albertel 1263: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1264: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1265: }
1266: $result .= "</select>\n";
1267: # return $debug;
1268: return $result;
1269: } # end of sub linked_select_forms {
1270:
1.45 matthew 1271: =pod
1.44 bowersj2 1272:
1.1381 raeburn 1273: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1274:
1.112 bowersj2 1275: Returns a string corresponding to an HTML link to the given help
1276: $topic, where $topic corresponds to the name of a .tex file in
1277: /home/httpd/html/adm/help/tex, with underscores replaced by
1278: spaces.
1279:
1280: $text will optionally be linked to the same topic, allowing you to
1281: link text in addition to the graphic. If you do not want to link
1282: text, but wish to specify one of the later parameters, pass an
1283: empty string.
1284:
1285: $stayOnPage is a value that will be interpreted as a boolean. If true,
1286: the link will not open a new window. If false, the link will open
1287: a new window using Javascript. (Default is false.)
1288:
1289: $width and $height are optional numerical parameters that will
1290: override the width and height of the popped up window, which may
1.973 raeburn 1291: be useful for certain help topics with big pictures included.
1292:
1293: $imgid is the id of the img tag used for the help icon. This may be
1294: used in a javascript call to switch the image src. See
1295: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1296:
1.1381 raeburn 1297: $links_target will optionally be set to a target (_top, _parent or _self).
1298:
1.44 bowersj2 1299: =cut
1300:
1301: sub help_open_topic {
1.1381 raeburn 1302: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1303: $text = "" if (not defined $text);
1.44 bowersj2 1304: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1305: $width = 500 if (not defined $width);
1.44 bowersj2 1306: $height = 400 if (not defined $height);
1307: my $filename = $topic;
1308: $filename =~ s/ /_/g;
1309:
1.48 bowersj2 1310: my $template = "";
1311: my $link;
1.572 banghart 1312:
1.159 www 1313: $topic=~s/\W/\_/g;
1.44 bowersj2 1314:
1.572 banghart 1315: if (!$stayOnPage) {
1.1033 www 1316: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1317: } elsif ($stayOnPage eq 'popup') {
1318: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1319: } else {
1.48 bowersj2 1320: $link = "/adm/help/${filename}.hlp";
1321: }
1322:
1323: # Add the text
1.1314 raeburn 1324: my $target = ' target="_top"';
1.1381 raeburn 1325: if ($links_target) {
1326: $target = ' target="'.$links_target.'"';
1327: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1328: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1329: $target = '';
1.1378 raeburn 1330: }
1.1380 raeburn 1331: if ($text ne "") {
1.763 bisitz 1332: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1333: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1334: .$text.'</a>';
1.48 bowersj2 1335: }
1336:
1.763 bisitz 1337: # (Always) Add the graphic
1.179 matthew 1338: my $title = &mt('Online Help');
1.667 raeburn 1339: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1340: if ($imgid ne '') {
1341: $imgid = ' id="'.$imgid.'"';
1342: }
1.1314 raeburn 1343: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1344: .'<img src="'.$helpicon.'" border="0"'
1345: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1346: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1347: .' /></a>';
1348: if ($text ne "") {
1349: $template.='</span>';
1350: }
1.44 bowersj2 1351: return $template;
1352:
1.106 bowersj2 1353: }
1354:
1355: # This is a quicky function for Latex cheatsheet editing, since it
1356: # appears in at least four places
1357: sub helpLatexCheatsheet {
1.1037 www 1358: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1359: my $out;
1.106 bowersj2 1360: my $addOther = '';
1.732 raeburn 1361: if ($topic) {
1.1037 www 1362: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1363: }
1364: $out = '<span>' # Start cheatsheet
1365: .$addOther
1366: .'<span>'
1.1037 www 1367: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1368: .'</span> <span>'
1.1037 www 1369: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1370: .'</span>';
1.732 raeburn 1371: unless ($not_author) {
1.1186 kruse 1372: $out .= '<span>'
1373: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1374: .'</span> <span>'
1.1424 raeburn 1375: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763 bisitz 1376: .'</span>';
1.732 raeburn 1377: }
1.763 bisitz 1378: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1379: return $out;
1.172 www 1380: }
1381:
1.430 albertel 1382: sub general_help {
1383: my $helptopic='Student_Intro';
1384: if ($env{'request.role'}=~/^(ca|au)/) {
1385: $helptopic='Authoring_Intro';
1.907 raeburn 1386: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1387: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1388: } elsif ($env{'request.role'}=~/^dc/) {
1389: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1390: }
1391: return $helptopic;
1392: }
1393:
1394: sub update_help_link {
1395: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1396: my $origurl = $ENV{'REQUEST_URI'};
1397: $origurl=~s|^/~|/priv/|;
1398: my $timestamp = time;
1399: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1400: $$datum = &escape($$datum);
1401: }
1402:
1403: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1404: my $output .= <<"ENDOUTPUT";
1405: <script type="text/javascript">
1.824 bisitz 1406: // <![CDATA[
1.430 albertel 1407: banner_link = '$banner_link';
1.824 bisitz 1408: // ]]>
1.430 albertel 1409: </script>
1410: ENDOUTPUT
1411: return $output;
1412: }
1413:
1414: # now just updates the help link and generates a blue icon
1.193 raeburn 1415: sub help_open_menu {
1.1381 raeburn 1416: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1417: = @_;
1.949 droeschl 1418: $stayOnPage = 1;
1.430 albertel 1419: my $output;
1420: if ($component_help) {
1421: if (!$text) {
1422: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1423: $width,$height,'',$links_target);
1.430 albertel 1424: } else {
1425: my $help_text;
1426: $help_text=&unescape($topic);
1427: $output='<table><tr><td>'.
1428: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1429: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1430: }
1431: }
1432: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1433: return $output.$banner_link;
1434: }
1435:
1436: sub top_nav_help {
1.1369 raeburn 1437: my ($text,$linkattr) = @_;
1.436 albertel 1438: $text = &mt($text);
1.949 droeschl 1439: my $stay_on_page = 1;
1440:
1.1168 raeburn 1441: my ($link,$banner_link);
1442: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1443: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1444: : "javascript:helpMenu('open')";
1445: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1446: }
1.201 raeburn 1447: my $title = &mt('Get help');
1.1168 raeburn 1448: if ($link) {
1449: return <<"END";
1.436 albertel 1450: $banner_link
1.1369 raeburn 1451: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1452: END
1.1168 raeburn 1453: } else {
1454: return ' '.$text.' ';
1455: }
1.436 albertel 1456: }
1457:
1458: sub help_menu_js {
1.1154 raeburn 1459: my ($httphost) = @_;
1.949 droeschl 1460: my $stayOnPage = 1;
1.436 albertel 1461: my $width = 620;
1462: my $height = 600;
1.430 albertel 1463: my $helptopic=&general_help();
1.1154 raeburn 1464: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1465: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1466: my $start_page =
1467: &Apache::loncommon::start_page('Help Menu', undef,
1468: {'frameset' => 1,
1469: 'js_ready' => 1,
1.1154 raeburn 1470: 'use_absolute' => $httphost,
1.331 albertel 1471: 'add_entries' => {
1.1168 raeburn 1472: 'border' => '0',
1.579 raeburn 1473: 'rows' => "110,*",},});
1.331 albertel 1474: my $end_page =
1475: &Apache::loncommon::end_page({'frameset' => 1,
1476: 'js_ready' => 1,});
1477:
1.436 albertel 1478: my $template .= <<"ENDTEMPLATE";
1479: <script type="text/javascript">
1.877 bisitz 1480: // <![CDATA[
1.253 albertel 1481: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1482: var banner_link = '';
1.243 raeburn 1483: function helpMenu(target) {
1484: var caller = this;
1485: if (target == 'open') {
1486: var newWindow = null;
1487: try {
1.262 albertel 1488: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1489: }
1490: catch(error) {
1491: writeHelp(caller);
1492: return;
1493: }
1494: if (newWindow) {
1495: caller = newWindow;
1496: }
1.193 raeburn 1497: }
1.243 raeburn 1498: writeHelp(caller);
1499: return;
1500: }
1501: function writeHelp(caller) {
1.1168 raeburn 1502: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1503: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1504: caller.document.close();
1505: caller.focus();
1.193 raeburn 1506: }
1.877 bisitz 1507: // END LON-CAPA Internal -->
1.253 albertel 1508: // ]]>
1.436 albertel 1509: </script>
1.193 raeburn 1510: ENDTEMPLATE
1511: return $template;
1512: }
1513:
1.172 www 1514: sub help_open_bug {
1515: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1516: unless ($env{'user.adv'}) { return ''; }
1.172 www 1517: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1518: $text = "" if (not defined $text);
1519: $stayOnPage=1;
1.184 albertel 1520: $width = 600 if (not defined $width);
1521: $height = 600 if (not defined $height);
1.172 www 1522:
1523: $topic=~s/\W+/\+/g;
1524: my $link='';
1525: my $template='';
1.379 albertel 1526: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1527: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1528: if (!$stayOnPage)
1529: {
1530: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1531: }
1532: else
1533: {
1534: $link = $url;
1535: }
1.1314 raeburn 1536:
1.1382 raeburn 1537: my $target = '_top';
1538: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1539: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1540: $target = '_blank';
1.1378 raeburn 1541: }
1.1382 raeburn 1542:
1.172 www 1543: # Add the text
1544: if ($text ne "")
1545: {
1546: $template .=
1547: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1548: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1549: }
1550:
1551: # Add the graphic
1.179 matthew 1552: my $title = &mt('Report a Bug');
1.215 albertel 1553: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1554: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1555: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1556: ENDTEMPLATE
1557: if ($text ne '') { $template.='</td></tr></table>' };
1558: return $template;
1559:
1560: }
1561:
1562: sub help_open_faq {
1563: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1564: unless ($env{'user.adv'}) { return ''; }
1.172 www 1565: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1566: $text = "" if (not defined $text);
1567: $stayOnPage=1;
1568: $width = 350 if (not defined $width);
1569: $height = 400 if (not defined $height);
1570:
1571: $topic=~s/\W+/\+/g;
1572: my $link='';
1573: my $template='';
1574: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1575: if (!$stayOnPage)
1576: {
1577: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1578: }
1579: else
1580: {
1581: $link = $url;
1582: }
1583:
1584: # Add the text
1585: if ($text ne "")
1586: {
1587: $template .=
1.173 www 1588: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1589: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1590: }
1591:
1592: # Add the graphic
1.179 matthew 1593: my $title = &mt('View the FAQ');
1.215 albertel 1594: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1595: $template .= <<"ENDTEMPLATE";
1.436 albertel 1596: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1597: ENDTEMPLATE
1598: if ($text ne '') { $template.='</td></tr></table>' };
1599: return $template;
1600:
1.44 bowersj2 1601: }
1.37 matthew 1602:
1.180 matthew 1603: ###############################################################
1604: ###############################################################
1605:
1.45 matthew 1606: =pod
1607:
1.648 raeburn 1608: =item * &change_content_javascript():
1.256 matthew 1609:
1610: This and the next function allow you to create small sections of an
1611: otherwise static HTML page that you can update on the fly with
1612: Javascript, even in Netscape 4.
1613:
1614: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1615: must be written to the HTML page once. It will prove the Javascript
1616: function "change(name, content)". Calling the change function with the
1617: name of the section
1618: you want to update, matching the name passed to C<changable_area>, and
1619: the new content you want to put in there, will put the content into
1620: that area.
1621:
1622: B<Note>: Netscape 4 only reserves enough space for the changable area
1623: to contain room for the original contents. You need to "make space"
1624: for whatever changes you wish to make, and be B<sure> to check your
1625: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1626: it's adequate for updating a one-line status display, but little more.
1627: This script will set the space to 100% width, so you only need to
1628: worry about height in Netscape 4.
1629:
1630: Modern browsers are much less limiting, and if you can commit to the
1631: user not using Netscape 4, this feature may be used freely with
1632: pretty much any HTML.
1633:
1634: =cut
1635:
1636: sub change_content_javascript {
1637: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1638: if ($env{'browser.type'} eq 'netscape' &&
1639: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1640: return (<<NETSCAPE4);
1641: function change(name, content) {
1642: doc = document.layers[name+"___escape"].layers[0].document;
1643: doc.open();
1644: doc.write(content);
1645: doc.close();
1646: }
1647: NETSCAPE4
1648: } else {
1649: # Otherwise, we need to use semi-standards-compliant code
1650: # (technically, "innerHTML" isn't standard but the equivalent
1651: # is really scary, and every useful browser supports it
1652: return (<<DOMBASED);
1653: function change(name, content) {
1654: element = document.getElementById(name);
1655: element.innerHTML = content;
1656: }
1657: DOMBASED
1658: }
1659: }
1660:
1661: =pod
1662:
1.648 raeburn 1663: =item * &changable_area($name,$origContent):
1.256 matthew 1664:
1665: This provides a "changable area" that can be modified on the fly via
1666: the Javascript code provided in C<change_content_javascript>. $name is
1667: the name you will use to reference the area later; do not repeat the
1668: same name on a given HTML page more then once. $origContent is what
1669: the area will originally contain, which can be left blank.
1670:
1671: =cut
1672:
1673: sub changable_area {
1674: my ($name, $origContent) = @_;
1675:
1.258 albertel 1676: if ($env{'browser.type'} eq 'netscape' &&
1677: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1678: # If this is netscape 4, we need to use the Layer tag
1679: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1680: } else {
1681: return "<span id='$name'>$origContent</span>";
1682: }
1683: }
1684:
1685: =pod
1686:
1.648 raeburn 1687: =item * &viewport_geometry_js
1.590 raeburn 1688:
1689: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1690:
1691: =cut
1692:
1693:
1694: sub viewport_geometry_js {
1695: return <<"GEOMETRY";
1696: var Geometry = {};
1697: function init_geometry() {
1698: if (Geometry.init) { return };
1699: Geometry.init=1;
1700: if (window.innerHeight) {
1701: Geometry.getViewportHeight = function() { return window.innerHeight; };
1702: Geometry.getViewportWidth = function() { return window.innerWidth; };
1703: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1704: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1705: }
1706: else if (document.documentElement && document.documentElement.clientHeight) {
1707: Geometry.getViewportHeight =
1708: function() { return document.documentElement.clientHeight; };
1709: Geometry.getViewportWidth =
1710: function() { return document.documentElement.clientWidth; };
1711:
1712: Geometry.getHorizontalScroll =
1713: function() { return document.documentElement.scrollLeft; };
1714: Geometry.getVerticalScroll =
1715: function() { return document.documentElement.scrollTop; };
1716: }
1717: else if (document.body.clientHeight) {
1718: Geometry.getViewportHeight =
1719: function() { return document.body.clientHeight; };
1720: Geometry.getViewportWidth =
1721: function() { return document.body.clientWidth; };
1722: Geometry.getHorizontalScroll =
1723: function() { return document.body.scrollLeft; };
1724: Geometry.getVerticalScroll =
1725: function() { return document.body.scrollTop; };
1726: }
1727: }
1728:
1729: GEOMETRY
1730: }
1731:
1732: =pod
1733:
1.648 raeburn 1734: =item * &viewport_size_js()
1.590 raeburn 1735:
1736: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1737:
1738: =cut
1739:
1740: sub viewport_size_js {
1741: my $geometry = &viewport_geometry_js();
1742: return <<"DIMS";
1743:
1744: $geometry
1745:
1746: function getViewportDims(width,height) {
1747: init_geometry();
1748: width.value = Geometry.getViewportWidth();
1749: height.value = Geometry.getViewportHeight();
1750: return;
1751: }
1752:
1753: DIMS
1754: }
1755:
1756: =pod
1757:
1.648 raeburn 1758: =item * &resize_textarea_js()
1.565 albertel 1759:
1760: emits the needed javascript to resize a textarea to be as big as possible
1761:
1762: creates a function resize_textrea that takes two IDs first should be
1763: the id of the element to resize, second should be the id of a div that
1764: surrounds everything that comes after the textarea, this routine needs
1765: to be attached to the <body> for the onload and onresize events.
1766:
1767: =cut
1768:
1769: sub resize_textarea_js {
1.590 raeburn 1770: my $geometry = &viewport_geometry_js();
1.565 albertel 1771: return <<"RESIZE";
1772: <script type="text/javascript">
1.824 bisitz 1773: // <![CDATA[
1.590 raeburn 1774: $geometry
1.565 albertel 1775:
1.588 albertel 1776: function getX(element) {
1777: var x = 0;
1778: while (element) {
1779: x += element.offsetLeft;
1780: element = element.offsetParent;
1781: }
1782: return x;
1783: }
1784: function getY(element) {
1785: var y = 0;
1786: while (element) {
1787: y += element.offsetTop;
1788: element = element.offsetParent;
1789: }
1790: return y;
1791: }
1792:
1793:
1.565 albertel 1794: function resize_textarea(textarea_id,bottom_id) {
1795: init_geometry();
1796: var textarea = document.getElementById(textarea_id);
1797: //alert(textarea);
1798:
1.588 albertel 1799: var textarea_top = getY(textarea);
1.565 albertel 1800: var textarea_height = textarea.offsetHeight;
1801: var bottom = document.getElementById(bottom_id);
1.588 albertel 1802: var bottom_top = getY(bottom);
1.565 albertel 1803: var bottom_height = bottom.offsetHeight;
1804: var window_height = Geometry.getViewportHeight();
1.588 albertel 1805: var fudge = 23;
1.565 albertel 1806: var new_height = window_height-fudge-textarea_top-bottom_height;
1807: if (new_height < 300) {
1808: new_height = 300;
1809: }
1810: textarea.style.height=new_height+'px';
1811: }
1.824 bisitz 1812: // ]]>
1.565 albertel 1813: </script>
1814: RESIZE
1815:
1816: }
1817:
1.1205 golterma 1818: sub colorfuleditor_js {
1.1248 raeburn 1819: my $browse_or_search;
1820: my $respath;
1821: my ($cnum,$cdom) = &crsauthor_url();
1822: if ($cnum) {
1823: $respath = "/res/$cdom/$cnum/";
1824: my %js_lt = &Apache::lonlocal::texthash(
1825: sunm => 'Sub-directory name',
1826: save => 'Save page to make this permanent',
1827: );
1828: &js_escape(\%js_lt);
1.1400 raeburn 1829: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1830: $browse_or_search = <<"END";
1831:
1.1400 raeburn 1832: $showfile_js
1833:
1.1248 raeburn 1834: function toggleChooser(form,element,titleid,only,search) {
1835: var disp = 'none';
1836: if (document.getElementById('chooser_'+element)) {
1837: var curr = document.getElementById('chooser_'+element).style.display;
1838: if (curr == 'none') {
1839: disp='inline';
1840: if (form.elements['chooser_'+element].length) {
1841: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1842: form.elements['chooser_'+element][i].checked = false;
1843: }
1844: }
1845: toggleResImport(form,element);
1846: }
1847: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1848: var dirsel = '';
1849: var filesel = '';
1850: if (document.getElementById('chooser_'+element+'_crsres')) {
1851: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1852: if (currcrsres == 'none') {
1853: dirsel = 'coursepath_'+element;
1854: var filesel = 'coursefile_'+element;
1855: var include;
1856: if (document.getElementById('crsres_include_'+element)) {
1857: include = document.getElementById('crsres_include_'+element).value;
1858: }
1.1402 raeburn 1859: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1860: }
1861: }
1862: if (document.getElementById('chooser_'+element+'_upload')) {
1863: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1864: if (currcrsupload == 'none') {
1865: dirsel = 'crsauthorpath_'+element;
1866: filesel = '';
1.1402 raeburn 1867: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1868: }
1869: }
1.1248 raeburn 1870: }
1871: }
1872:
1.1400 raeburn 1873: function toggleCrsFile(form,element) {
1.1248 raeburn 1874: if (document.getElementById('chooser_'+element+'_crsres')) {
1875: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1876: if (curr == 'none') {
1.1400 raeburn 1877: if (document.getElementById('coursepath_'+element)) {
1878: var numdirs;
1879: if (document.getElementById('coursepath_'+element).length) {
1880: numdirs = document.getElementById('coursepath_'+element).length;
1881: }
1.1402 raeburn 1882: if ((document.getElementById('hascrsres_'+element)) &&
1883: (document.getElementById('nocrsres_'+element))) {
1884: if (numdirs) {
1885: document.getElementById('hascrsres_'+element).style.display='inline-block';
1886: document.getElementById('nocrsres_'+element).style.display='none';
1887: } else {
1888: document.getElementById('hascrsres_'+element).style.display='none';
1889: document.getElementById('nocrsres_'+element).style.display='inline-block';
1890: }
1891: }
1.1248 raeburn 1892: form.elements['coursepath_'+element].selectedIndex = 0;
1893: if (numdirs > 1) {
1.1400 raeburn 1894: var selelem = form.elements['coursefile_'+element];
1895: var i, len = selelem.options.length -1;
1896: if (len >=0) {
1897: for (i = len; i >= 0; i--) {
1898: selelem.remove(i);
1899: }
1900: selelem.options[0] = new Option('','');
1901: }
1.1248 raeburn 1902: }
1903: }
1.1400 raeburn 1904: }
1.1248 raeburn 1905: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1906: }
1907: if (document.getElementById('chooser_'+element+'_upload')) {
1908: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1909: if (document.getElementById('uploadcrsres_'+element)) {
1910: document.getElementById('uploadcrsres_'+element).value = '';
1911: }
1912: }
1913: return;
1914: }
1915:
1.1400 raeburn 1916: function toggleCrsUpload(form,element) {
1.1248 raeburn 1917: if (document.getElementById('chooser_'+element+'_crsres')) {
1918: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1919: }
1920: if (document.getElementById('chooser_'+element+'_upload')) {
1921: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1922: if (curr == 'none') {
1.1400 raeburn 1923: form.elements['newsubdir_'+element][0].checked = true;
1924: toggleNewsubdir(form,element);
1925: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1926: if (document.getElementById('uploadcrsres_'+element)) {
1927: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1928: }
1929: }
1930: }
1931: return;
1932: }
1933:
1934: function toggleResImport(form,element) {
1935: var choices = new Array('crsres','upload');
1936: for (var i=0; i<choices.length; i++) {
1937: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1938: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1939: }
1940: }
1941: }
1942:
1943: function toggleNewsubdir(form,element) {
1944: var newsub = form.elements['newsubdir_'+element];
1945: if (newsub) {
1946: if (newsub.length) {
1947: for (var j=0; j<newsub.length; j++) {
1948: if (newsub[j].checked) {
1949: if (document.getElementById('newsubdirname_'+element)) {
1950: if (newsub[j].value == '1') {
1951: document.getElementById('newsubdirname_'+element).type = "text";
1952: if (document.getElementById('newsubdir_'+element)) {
1953: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1954: }
1955: } else {
1956: document.getElementById('newsubdirname_'+element).type = "hidden";
1957: document.getElementById('newsubdirname_'+element).value = "";
1958: document.getElementById('newsubdir_'+element).innerHTML = "";
1959: }
1960: }
1961: break;
1962: }
1963: }
1964: }
1965: }
1966: }
1967:
1968: function updateCrsFile(form,element) {
1969: var directory = form.elements['coursepath_'+element];
1970: var filename = form.elements['coursefile_'+element];
1971: var path = directory.options[directory.selectedIndex].value;
1972: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1973: if (file != '') {
1974: form.elements[element].value = '$respath';
1975: if (path == '/') {
1976: form.elements[element].value += file;
1977: } else {
1978: form.elements[element].value += path+'/'+file;
1979: }
1980: unClean();
1981: if (document.getElementById('previewimg_'+element)) {
1982: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1983: var newsrc = document.getElementById('previewimg_'+element).src;
1984: }
1985: if (document.getElementById('showimg_'+element)) {
1986: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1987: }
1.1248 raeburn 1988: }
1989: toggleChooser(form,element);
1990: return;
1991: }
1992:
1993: function uploadDone(suffix,name) {
1994: if (name) {
1995: document.forms["lonhomework"].elements[suffix].value = name;
1996: unClean();
1997: toggleChooser(document.forms["lonhomework"],suffix);
1998: }
1999: }
2000:
2001: \$(document).ready(function(){
2002:
2003: \$(document).delegate('form :submit', 'click', function( event ) {
2004: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2005: var buttonId = this.id;
2006: var suffix = buttonId.toString();
2007: suffix = suffix.replace(/^crsupload_/,'');
2008: event.preventDefault();
2009: document.lonhomework.target = 'crsupload_target_'+suffix;
2010: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2011: \$(this.form).submit();
2012: document.lonhomework.target = '';
2013: if (document.getElementById('crsuploadto_'+suffix)) {
2014: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2015: }
2016: return false;
2017: }
2018: });
2019: });
2020: END
2021: }
1.1205 golterma 2022: return <<"COLORFULEDIT"
2023: <script type="text/javascript">
2024: // <![CDATA[>
2025: function fold_box(curDepth, lastresource){
2026:
2027: // we need a list because there can be several blocks you need to fold in one tag
2028: var block = document.getElementsByName('foldblock_'+curDepth);
2029: // but there is only one folding button per tag
2030: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2031:
2032: if(block.item(0).style.display == 'none'){
2033:
2034: foldbutton.value = '@{[&mt("Hide")]}';
2035: for (i = 0; i < block.length; i++){
2036: block.item(i).style.display = '';
2037: }
2038: }else{
2039:
2040: foldbutton.value = '@{[&mt("Show")]}';
2041: for (i = 0; i < block.length; i++){
2042: // block.item(i).style.visibility = 'collapse';
2043: block.item(i).style.display = 'none';
2044: }
2045: };
2046: saveState(lastresource);
2047: }
2048:
2049: function saveState (lastresource) {
2050:
2051: var tag_list = getTagList();
2052: if(tag_list != null){
2053: var timestamp = new Date().getTime();
2054: var key = lastresource;
2055:
2056: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2057: // starting with timestamp
2058: var value = timestamp+';';
2059:
2060: // building the list of key-value pairs
2061: for(var i = 0; i < tag_list.length; i++){
2062: value += tag_list[i]+',';
2063: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2064: }
2065:
2066: // only iterate whole storage if nothing to override
2067: if(localStorage.getItem(key) == null){
2068:
2069: // prevent storage from growing large
2070: if(localStorage.length > 50){
2071: var regex_getTimestamp = /^(?:\d)+;/;
2072: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2073: var oldest_key;
2074:
2075: for(var i = 1; i < localStorage.length; i++){
2076: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2077: oldest_key = localStorage.key(i);
2078: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2079: }
2080: }
2081: localStorage.removeItem(oldest_key);
2082: }
2083: }
2084: localStorage.setItem(key,value);
2085: }
2086: }
2087:
2088: // restore folding status of blocks (on page load)
2089: function restoreState (lastresource) {
2090: if(localStorage.getItem(lastresource) != null){
2091: var key = lastresource;
2092: var value = localStorage.getItem(key);
2093: var regex_delTimestamp = /^\d+;/;
2094:
2095: value.replace(regex_delTimestamp, '');
2096:
2097: var valueArr = value.split(';');
2098: var pairs;
2099: var elements;
2100: for (var i = 0; i < valueArr.length; i++){
2101: pairs = valueArr[i].split(',');
2102: elements = document.getElementsByName(pairs[0]);
2103:
2104: for (var j = 0; j < elements.length; j++){
2105: elements[j].style.display = pairs[1];
2106: if (pairs[1] == "none"){
2107: var regex_id = /([_\\d]+)\$/;
2108: regex_id.exec(pairs[0]);
2109: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2110: }
2111: }
2112: }
2113: }
2114: }
2115:
2116: function getTagList () {
2117:
2118: var stringToSearch = document.lonhomework.innerHTML;
2119:
2120: var ret = new Array();
2121: var regex_findBlock = /(foldblock_.*?)"/g;
2122: var tag_list = stringToSearch.match(regex_findBlock);
2123:
2124: if(tag_list != null){
2125: for(var i = 0; i < tag_list.length; i++){
2126: ret.push(tag_list[i].replace(/"/, ''));
2127: }
2128: }
2129: return ret;
2130: }
2131:
2132: function saveScrollPosition (resource) {
2133: var tag_list = getTagList();
2134:
2135: // we dont always want to jump to the first block
2136: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2137: if(\$(window).scrollTop() > 170){
2138: if(tag_list != null){
2139: var result;
2140: for(var i = 0; i < tag_list.length; i++){
2141: if(isElementInViewport(tag_list[i])){
2142: result += tag_list[i]+';';
2143: }
2144: }
2145: sessionStorage.setItem('anchor_'+resource, result);
2146: }
2147: } else {
2148: // we dont need to save zero, just delete the item to leave everything tidy
2149: sessionStorage.removeItem('anchor_'+resource);
2150: }
2151: }
2152:
2153: function restoreScrollPosition(resource){
2154:
2155: var elem = sessionStorage.getItem('anchor_'+resource);
2156: if(elem != null){
2157: var tag_list = elem.split(';');
2158: var elem_list;
2159:
2160: for(var i = 0; i < tag_list.length; i++){
2161: elem_list = document.getElementsByName(tag_list[i]);
2162:
2163: if(elem_list.length > 0){
2164: elem = elem_list[0];
2165: break;
2166: }
2167: }
2168: elem.scrollIntoView();
2169: }
2170: }
2171:
2172: function isElementInViewport(el) {
2173:
2174: // change to last element instead of first
2175: var elem = document.getElementsByName(el);
2176: var rect = elem[0].getBoundingClientRect();
2177:
2178: return (
2179: rect.top >= 0 &&
2180: rect.left >= 0 &&
2181: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2182: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2183: );
2184: }
2185:
2186: function autosize(depth){
2187: var cmInst = window['cm'+depth];
2188: var fitsizeButton = document.getElementById('fitsize'+depth);
2189:
2190: // is fixed size, switching to dynamic
2191: if (sessionStorage.getItem("autosized_"+depth) == null) {
2192: cmInst.setSize("","auto");
2193: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2194: sessionStorage.setItem("autosized_"+depth, "yes");
2195:
2196: // is dynamic size, switching to fixed
2197: } else {
2198: cmInst.setSize("","300px");
2199: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2200: sessionStorage.removeItem("autosized_"+depth);
2201: }
2202: }
2203:
1.1248 raeburn 2204: $browse_or_search
1.1205 golterma 2205:
2206: // ]]>
2207: </script>
2208: COLORFULEDIT
2209: }
2210:
2211: sub xmleditor_js {
2212: return <<XMLEDIT
2213: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2214: <script type="text/javascript">
2215: // <![CDATA[>
2216:
2217: function saveScrollPosition (resource) {
2218:
2219: var scrollPos = \$(window).scrollTop();
2220: sessionStorage.setItem(resource,scrollPos);
2221: }
2222:
2223: function restoreScrollPosition(resource){
2224:
2225: var scrollPos = sessionStorage.getItem(resource);
2226: \$(window).scrollTop(scrollPos);
2227: }
2228:
2229: // unless internet explorer
2230: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2231:
2232: \$(document).ready(function() {
2233: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2234: });
2235: }
2236:
2237: // inserts text at cursor position into codemirror (xml editor only)
2238: function insertText(text){
2239: cm.focus();
2240: var curPos = cm.getCursor();
2241: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2242: }
2243: // ]]>
2244: </script>
2245: XMLEDIT
2246: }
2247:
2248: sub insert_folding_button {
2249: my $curDepth = $Apache::lonxml::curdepth;
2250: my $lastresource = $env{'request.ambiguous'};
2251:
2252: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2253: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2254: }
2255:
1.1248 raeburn 2256: sub crsauthor_url {
2257: my ($url) = @_;
2258: if ($url eq '') {
2259: $url = $ENV{'REQUEST_URI'};
2260: }
2261: my ($cnum,$cdom);
2262: if ($env{'request.course.id'}) {
2263: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2264: if ($audom ne '' && $auname ne '') {
2265: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2266: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2267: $cnum = $auname;
2268: $cdom = $audom;
2269: }
2270: }
2271: }
2272: return ($cnum,$cdom);
2273: }
2274:
2275: sub import_crsauthor_form {
1.1400 raeburn 2276: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2277: return (0) unless ($env{'request.course.id'});
2278: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2279: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2280: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2281: return (0) unless (($cnum ne '') && ($cdom ne ''));
2282: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2283: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2284:
1.1248 raeburn 2285: if (grep(/^\Q$crshome\E$/,@ids)) {
2286: $is_home = 1;
2287: }
1.1400 raeburn 2288: $toppath = "/priv/$cdom/$cnum";
2289: my $nonemptydir = 1;
2290: my $js_only;
2291: if ($only) {
2292: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2293: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2294: }
2295: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2296: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2297: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2298: my %lt = &Apache::lonlocal::texthash (
2299: fnam => 'Filename',
2300: dire => 'Directory',
1.1400 raeburn 2301: se => 'Select',
1.1248 raeburn 2302: );
1.1402 raeburn 2303: $output = $lt{'dire'}.': '.
1.1400 raeburn 2304: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2305: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2306: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2307: if ($files{'/'}) {
2308: $output .= '<option value="/">/</option>'."\n";
2309: }
1.1400 raeburn 2310: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2311: next if ($key eq '/');
1.1400 raeburn 2312: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2313: }
2314: $output .= '</select><br />'."\n".
1.1402 raeburn 2315: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2316: '<option value="" selected="selected"></option>'."\n".
1.1402 raeburn 2317: '</select>'."\n".
2318: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2319: return ($numdirs,$output);
2320: }
2321:
2322: sub show_crsfiles_js {
2323: my $excluderef = &Apache::lonnet::priv_exclude();
2324: my $se = &js_escape(&mt('Select'));
2325: my $exclude;
2326: if (ref($excluderef) eq 'HASH') {
2327: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2328: }
2329: my $js = <<"END";
2330:
2331:
1.1402 raeburn 2332: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2333: var relpath = '';
2334: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2335: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2336: if (currdir == '') {
2337: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2338: selelem = form.elements[filesel];
2339: var j, numfiles = selelem.options.length -1;
2340: if (numfiles >=0) {
2341: for (j = numfiles; j >= 0; j--) {
2342: selelem.remove(j);
2343: }
2344: }
2345: if (selelem.options.length == 0) {
2346: selelem.options[selelem.options.length] = new Option('','');
2347: selelem.selectedIndex = 0;
1.1248 raeburn 2348: }
2349: }
1.1400 raeburn 2350: return;
2351: } else {
2352: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2353: }
2354: }
1.1400 raeburn 2355: var http = new XMLHttpRequest();
2356: var url = "/adm/courseauthor";
2357: var crsrole = "$env{'request.role'}";
2358: var exclude = '';
2359: if (exc) {
2360: exclude = '$exclude';
2361: }
1.1402 raeburn 2362: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2363: http.open("POST", url, true);
2364: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2365: http.onreadystatechange = function() {
2366: if (http.readyState == 4 && http.status == 200) {
2367: var data = JSON.parse(http.responseText);
2368: var selelem;
2369: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2370: if (Array.isArray(data.dirs)) {
2371: selelem = form.elements[dirsel];
2372: var i, numdirs = selelem.options.length -1;
2373: if (numdirs >=0) {
2374: for (i = numdirs; i >= 0; i--) {
2375: selelem.remove(i);
2376: }
2377: }
2378: var len = data.dirs.length;
2379: if (len) {
1.1402 raeburn 2380: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2381: var j;
2382: for (j = 0; j < len; j++) {
2383: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2384: }
2385: selelem.selectedIndex = 0;
2386: }
2387: if (!setfile) {
2388: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2389: selelem = form.elements[filesel];
2390: var j, numfiles = selelem.options.length -1;
2391: if (numfiles >=0) {
2392: for (j = numfiles; j >= 0; j--) {
2393: selelem.remove(j);
2394: }
2395: }
2396: if (selelem.options.length == 0) {
2397: selelem.options[selelem.options.length] = new Option('','');
2398: selelem.selectedIndex = 0;
2399: }
2400: }
2401: }
2402: }
2403: }
2404: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2405: selelem = form.elements[filesel];
2406: var i, numfiles = selelem.options.length -1;
2407: if (numfiles >=0) {
2408: for (i = numfiles; i >= 0; i--) {
2409: selelem.remove(i);
2410: }
2411: }
2412: var x;
2413: for (x in data.files) {
2414: if (Array.isArray(data.files[x])) {
2415: if (data.files[x].length > 1) {
2416: selelem.options[selelem.options.length] = new Option('$se','');
2417: }
2418: var len = data.files[x].length;
2419: if (len) {
2420: var k;
2421: for (k = 0; k < len; k++) {
2422: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2423: }
2424: selelem.selectedIndex = 0;
2425: }
2426: }
2427: }
2428: if (selelem.options.length == 0) {
2429: selelem.options[selelem.options.length] = new Option('','');
2430: selelem.selectedIndex = 0;
2431: }
1.1248 raeburn 2432: }
2433: }
2434: }
1.1400 raeburn 2435: http.send(params);
1.1248 raeburn 2436: }
1.1400 raeburn 2437: END
1.1248 raeburn 2438: }
2439:
1.1426 raeburn 2440: sub crsauthor_rights {
2441: my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
2442: my $sourcerights = "$path/$rightsfile";
2443: my $now = time;
2444: if (!-e $sourcerights) {
2445: my $cid = $cdom.'_'.$cnum;
2446: if (!-e "$docroot/priv/$cdom") {
2447: mkdir("$docroot/priv/$cdom",0755);
2448: }
2449: if (!-e "$docroot/priv/$cdom/$cnum") {
2450: mkdir("$docroot/priv/$cdom/$cnum",0755);
2451: }
2452: if (open(my $fh,">$sourcerights")) {
2453: print $fh <<END;
2454: <accessrule effect="deny" realm="" type="course" role="" />
2455: <accessrule effect="allow" realm="$cid" type="course" role="" />
2456: END
2457: close($fh);
2458: }
2459: }
2460: if (!-e "$sourcerights.meta") {
2461: if (open(my $fh,">$sourcerights.meta")) {
2462: my $author=$env{'environment.firstname'}.' '.
2463: $env{'environment.middlename'}.' '.
2464: $env{'environment.lastname'}.' '.
2465: $env{'environment.generation'};
2466: $author =~ s/\s+$//;
2467: print $fh <<"END";
2468:
2469: <abstract></abstract>
2470: <author>$author</author>
2471: <authorspace>$cnum:$cdom</authorspace>
2472: <copyright>private</copyright>
2473: <creationdate>$now</creationdate>
2474: <customdistributionfile></customdistributionfile>
2475: <dependencies></dependencies>
2476: <domain>$cdom</domain>
2477: <highestgradelevel>0</highestgradelevel>
2478: <keywords></keywords>
2479: <language>notset </language>
2480: <lastrevisiondate>$now</lastrevisiondate>
2481: <lowestgradelevel>0</lowestgradelevel>
2482: <mime>rights</mime>
2483: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
2484: <notes></notes>
2485: <obsolete></obsolete>
2486: <obsoletereplacement></obsoletereplacement>
2487: <owner>$cnum:$cdom</owner>
2488: <rule>deny:::course,allow:$cid::course</rule>
2489: <sourceavail></sourceavail>
2490: <standards></standards>
2491: <subject></subject>
2492: <title>Course Authoring Rights</title>
2493: END
2494: close($fh);
2495: }
2496: }
2497: return;
2498: }
2499:
1.565 albertel 2500: =pod
2501:
1.1420 raeburn 2502: =item * &iframe_wrapper_headjs()
2503:
1.1425 raeburn 2504: emits javascript containing two global vars to facilitate handling of resizing
2505: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
2506: with standard LON-CAPA menus.
2507:
2508: =cut
2509:
1.1420 raeburn 2510: #
2511: # Where iframe is in use, if window.onload() executes before the custom resize function
2512: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
2513: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
2514: # do not obscure the Functions menu.
2515: #
2516:
2517: sub iframe_wrapper_headjs {
2518: return <<"ENDJS";
2519: <script type="text/javascript">
2520: // <![CDATA[
2521: var LCnotready = 0;
2522: var LCresizedef = 0;
2523: // ]]>
2524: </script>
2525:
2526: ENDJS
2527:
2528: }
2529:
2530: =pod
2531:
2532: =item * &iframe_wrapper_resizejs()
2533:
1.1425 raeburn 2534: emits javascript used to handle resizing for a page containing
2535: an iframe, to ensure that the iframe does not obscure any
2536: standard LON-CAPA menu items.
2537:
2538: =back
2539:
2540: =cut
2541:
1.1420 raeburn 2542: #
2543: # jQuery to use when iframe is in use and a page resize occurs.
2544: # This script will ensure that the iframe does not obscure any
2545: # standard LON-CAPA inline menus (primary, secondary, and/or
2546: # breadcrumbs and Functions menus. Expects javascript from
2547: # &iframe_wrapper_headjs() to be in head portion of the web page,
2548: # e.g., by inclusion in second arg passed to &start_page().
2549: #
2550:
2551: sub iframe_wrapper_resizejs {
2552: my $offset = 5;
2553: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
2554: if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
2555: $offset = 0;
2556: }
2557: return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
2558: \$(document).ready( function() {
2559: \$(window).unbind('resize').resize(function(){
2560: var header = null;
2561: var offset = $offset;
2562: var height = 0;
2563: var hdrtop = 0;
1.1421 raeburn 2564: if (\$('div.LC_menus_content:first').length) {
2565: if (\$('div.LC_menus_content:first').hasClass ("shown")) {
2566: header = \$('div.LC_menus_content:first');
1.1423 raeburn 2567: offset = 12;
1.1421 raeburn 2568: }
2569: } else if (\$('div.LC_head_subbox:first').length) {
1.1420 raeburn 2570: header = \$('div.LC_head_subbox:first');
2571: offset = 9;
2572: } else {
2573: if (\$('#LC_breadcrumbs').length) {
2574: header = \$('#LC_breadcrumbs');
2575: }
2576: }
2577: if (header != null && header.length) {
2578: height = header.height();
2579: hdrtop = header.position().top;
2580: }
2581: var pos = height + hdrtop + offset;
2582: \$('.LC_iframecontainer').css('top', pos);
2583: });
2584: LCresizedef = 1;
2585: if (LCnotready == 1) {
2586: LCnotready = 0;
2587: \$(window).trigger('resize');
2588: }
2589: });
2590: window.onload = function(){
2591: if (LCresizedef) {
2592: LCnotready = 0;
2593: \$(window).trigger('resize');
2594: } else {
2595: LCnotready = 1;
2596: }
2597: };
2598: SCRIPT
2599:
2600: }
2601:
2602: =pod
2603:
1.256 matthew 2604: =head1 Excel and CSV file utility routines
2605:
2606: =cut
2607:
2608: ###############################################################
2609: ###############################################################
2610:
2611: =pod
2612:
1.1162 raeburn 2613: =over 4
2614:
1.648 raeburn 2615: =item * &csv_translate($text)
1.37 matthew 2616:
1.185 www 2617: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2618: format.
2619:
2620: =cut
2621:
1.180 matthew 2622: ###############################################################
2623: ###############################################################
1.37 matthew 2624: sub csv_translate {
2625: my $text = shift;
2626: $text =~ s/\"/\"\"/g;
1.209 albertel 2627: $text =~ s/\n/ /g;
1.37 matthew 2628: return $text;
2629: }
1.180 matthew 2630:
2631: ###############################################################
2632: ###############################################################
2633:
2634: =pod
2635:
1.648 raeburn 2636: =item * &define_excel_formats()
1.180 matthew 2637:
2638: Define some commonly used Excel cell formats.
2639:
2640: Currently supported formats:
2641:
2642: =over 4
2643:
2644: =item header
2645:
2646: =item bold
2647:
2648: =item h1
2649:
2650: =item h2
2651:
2652: =item h3
2653:
1.256 matthew 2654: =item h4
2655:
2656: =item i
2657:
1.180 matthew 2658: =item date
2659:
2660: =back
2661:
2662: Inputs: $workbook
2663:
2664: Returns: $format, a hash reference.
2665:
1.1057 foxr 2666:
1.180 matthew 2667: =cut
2668:
2669: ###############################################################
2670: ###############################################################
2671: sub define_excel_formats {
2672: my ($workbook) = @_;
2673: my $format;
2674: $format->{'header'} = $workbook->add_format(bold => 1,
2675: bottom => 1,
2676: align => 'center');
2677: $format->{'bold'} = $workbook->add_format(bold=>1);
2678: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2679: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2680: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2681: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2682: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2683: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2684: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2685: return $format;
2686: }
2687:
2688: ###############################################################
2689: ###############################################################
1.113 bowersj2 2690:
2691: =pod
2692:
1.648 raeburn 2693: =item * &create_workbook()
1.255 matthew 2694:
2695: Create an Excel worksheet. If it fails, output message on the
2696: request object and return undefs.
2697:
2698: Inputs: Apache request object
2699:
2700: Returns (undef) on failure,
2701: Excel worksheet object, scalar with filename, and formats
2702: from &Apache::loncommon::define_excel_formats on success
2703:
2704: =cut
2705:
2706: ###############################################################
2707: ###############################################################
2708: sub create_workbook {
2709: my ($r) = @_;
2710: #
2711: # Create the excel spreadsheet
2712: my $filename = '/prtspool/'.
1.258 albertel 2713: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2714: time.'_'.rand(1000000000).'.xls';
2715: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2716: if (! defined($workbook)) {
2717: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2718: $r->print(
2719: '<p class="LC_error">'
2720: .&mt('Problems occurred in creating the new Excel file.')
2721: .' '.&mt('This error has been logged.')
2722: .' '.&mt('Please alert your LON-CAPA administrator.')
2723: .'</p>'
2724: );
1.255 matthew 2725: return (undef);
2726: }
2727: #
1.1014 foxr 2728: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2729: #
2730: my $format = &Apache::loncommon::define_excel_formats($workbook);
2731: return ($workbook,$filename,$format);
2732: }
2733:
2734: ###############################################################
2735: ###############################################################
2736:
2737: =pod
2738:
1.648 raeburn 2739: =item * &create_text_file()
1.113 bowersj2 2740:
1.542 raeburn 2741: Create a file to write to and eventually make available to the user.
1.256 matthew 2742: If file creation fails, outputs an error message on the request object and
2743: return undefs.
1.113 bowersj2 2744:
1.256 matthew 2745: Inputs: Apache request object, and file suffix
1.113 bowersj2 2746:
1.256 matthew 2747: Returns (undef) on failure,
2748: Filehandle and filename on success.
1.113 bowersj2 2749:
2750: =cut
2751:
1.256 matthew 2752: ###############################################################
2753: ###############################################################
2754: sub create_text_file {
2755: my ($r,$suffix) = @_;
2756: if (! defined($suffix)) { $suffix = 'txt'; };
2757: my $fh;
2758: my $filename = '/prtspool/'.
1.258 albertel 2759: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2760: time.'_'.rand(1000000000).'.'.$suffix;
2761: $fh = Apache::File->new('>/home/httpd'.$filename);
2762: if (! defined($fh)) {
2763: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2764: $r->print(
2765: '<p class="LC_error">'
2766: .&mt('Problems occurred in creating the output file.')
2767: .' '.&mt('This error has been logged.')
2768: .' '.&mt('Please alert your LON-CAPA administrator.')
2769: .'</p>'
2770: );
1.113 bowersj2 2771: }
1.256 matthew 2772: return ($fh,$filename)
1.113 bowersj2 2773: }
2774:
2775:
1.256 matthew 2776: =pod
1.113 bowersj2 2777:
2778: =back
2779:
2780: =cut
1.37 matthew 2781:
2782: ###############################################################
1.33 matthew 2783: ## Home server <option> list generating code ##
2784: ###############################################################
1.35 matthew 2785:
1.169 www 2786: # ------------------------------------------
2787:
2788: sub domain_select {
1.1289 raeburn 2789: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2790: my @possdoms;
2791: if (ref($incdoms) eq 'ARRAY') {
2792: @possdoms = @{$incdoms};
2793: } else {
2794: @possdoms = &Apache::lonnet::all_domains();
2795: }
2796:
1.169 www 2797: my %domains=map {
1.514 albertel 2798: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2799: } @possdoms;
2800:
2801: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2802: foreach my $dom (@{$excdoms}) {
2803: delete($domains{$dom});
2804: }
2805: }
2806:
1.169 www 2807: if ($multiple) {
2808: $domains{''}=&mt('Any domain');
1.550 albertel 2809: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2810: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2811: } else {
1.550 albertel 2812: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2813: return &select_form($name,$value,\%domains);
1.169 www 2814: }
2815: }
2816:
1.282 albertel 2817: #-------------------------------------------
2818:
2819: =pod
2820:
1.519 raeburn 2821: =head1 Routines for form select boxes
2822:
2823: =over 4
2824:
1.648 raeburn 2825: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2826:
2827: Returns a string containing a <select> element int multiple mode
2828:
2829:
2830: Args:
2831: $name - name of the <select> element
1.506 raeburn 2832: $value - scalar or array ref of values that should already be selected
1.282 albertel 2833: $size - number of rows long the select element is
1.283 albertel 2834: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2835: (shown text should already have been &mt())
1.506 raeburn 2836: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2837:
1.282 albertel 2838: =cut
2839:
2840: #-------------------------------------------
1.169 www 2841: sub multiple_select_form {
1.284 albertel 2842: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2843: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2844: my $output='';
1.191 matthew 2845: if (! defined($size)) {
2846: $size = 4;
1.283 albertel 2847: if (scalar(keys(%$hash))<4) {
2848: $size = scalar(keys(%$hash));
1.191 matthew 2849: }
2850: }
1.734 bisitz 2851: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2852: my @order;
1.506 raeburn 2853: if (ref($order) eq 'ARRAY') {
2854: @order = @{$order};
2855: } else {
2856: @order = sort(keys(%$hash));
1.501 banghart 2857: }
2858: if (exists($$hash{'select_form_order'})) {
2859: @order = @{$$hash{'select_form_order'}};
2860: }
2861:
1.284 albertel 2862: foreach my $key (@order) {
1.356 albertel 2863: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2864: $output.='selected="selected" ' if ($selected{$key});
2865: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2866: }
2867: $output.="</select>\n";
2868: return $output;
2869: }
2870:
1.88 www 2871: #-------------------------------------------
2872:
2873: =pod
2874:
1.1254 raeburn 2875: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2876:
2877: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2878: allow a user to select options from a ref to a hash containing:
2879: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2880: a javascript onchange item, e.g., onchange="this.form.submit();".
2881: An optional arg -- $readonly -- if true will cause the select form
2882: to be disabled, e.g., for the case where an instructor has a section-
2883: specific role, and is viewing/modifying parameters.
1.970 raeburn 2884:
1.88 www 2885: See lonrights.pm for an example invocation and use.
2886:
2887: =cut
2888:
2889: #-------------------------------------------
2890: sub select_form {
1.1228 raeburn 2891: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2892: return unless (ref($hashref) eq 'HASH');
2893: if ($onchange) {
2894: $onchange = ' onchange="'.$onchange.'"';
2895: }
1.1228 raeburn 2896: my $disabled;
2897: if ($readonly) {
2898: $disabled = ' disabled="disabled"';
2899: }
2900: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2901: my @keys;
1.970 raeburn 2902: if (exists($hashref->{'select_form_order'})) {
2903: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2904: } else {
1.970 raeburn 2905: @keys=sort(keys(%{$hashref}));
1.128 albertel 2906: }
1.356 albertel 2907: foreach my $key (@keys) {
2908: $selectform.=
2909: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2910: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2911: ">".$hashref->{$key}."</option>\n";
1.88 www 2912: }
2913: $selectform.="</select>";
2914: return $selectform;
2915: }
2916:
1.475 www 2917: # For display filters
2918:
2919: sub display_filter {
1.1074 raeburn 2920: my ($context) = @_;
1.475 www 2921: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2922: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2923: my $phraseinput = 'hidden';
2924: my $includeinput = 'hidden';
2925: my ($checked,$includetypestext);
2926: if ($env{'form.displayfilter'} eq 'containing') {
2927: $phraseinput = 'text';
2928: if ($context eq 'parmslog') {
2929: $includeinput = 'checkbox';
2930: if ($env{'form.includetypes'}) {
2931: $checked = ' checked="checked"';
2932: }
2933: $includetypestext = &mt('Include parameter types');
2934: }
2935: } else {
2936: $includetypestext = ' ';
2937: }
2938: my ($additional,$secondid,$thirdid);
2939: if ($context eq 'parmslog') {
2940: $additional =
2941: '<label><input type="'.$includeinput.'" name="includetypes"'.
2942: $checked.' name="includetypes" value="1" id="includetypes" />'.
2943: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2944: '</label>';
2945: $secondid = 'includetypes';
2946: $thirdid = 'includetypestext';
2947: }
2948: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2949: '$secondid','$thirdid')";
2950: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2951: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2952: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2953: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2954: &mt('Filter: [_1]',
1.477 www 2955: &select_form($env{'form.displayfilter'},
2956: 'displayfilter',
1.970 raeburn 2957: {'currentfolder' => 'Current folder/page',
1.477 www 2958: 'containing' => 'Containing phrase',
1.1074 raeburn 2959: 'none' => 'None'},$onchange)).' '.
2960: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2961: &HTML::Entities::encode($env{'form.containingphrase'}).
2962: '" />'.$additional;
2963: }
2964:
2965: sub display_filter_js {
2966: my $includetext = &mt('Include parameter types');
2967: return <<"ENDJS";
2968:
2969: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2970: var firstType = 'hidden';
2971: if (setter.options[setter.selectedIndex].value == 'containing') {
2972: firstType = 'text';
2973: }
2974: firstObject = document.getElementById(firstid);
2975: if (typeof(firstObject) == 'object') {
2976: if (firstObject.type != firstType) {
2977: changeInputType(firstObject,firstType);
2978: }
2979: }
2980: if (context == 'parmslog') {
2981: var secondType = 'hidden';
2982: if (firstType == 'text') {
2983: secondType = 'checkbox';
2984: }
2985: secondObject = document.getElementById(secondid);
2986: if (typeof(secondObject) == 'object') {
2987: if (secondObject.type != secondType) {
2988: changeInputType(secondObject,secondType);
2989: }
2990: }
2991: var textItem = document.getElementById(thirdid);
2992: var currtext = textItem.innerHTML;
2993: var newtext;
2994: if (firstType == 'text') {
2995: newtext = '$includetext';
2996: } else {
2997: newtext = ' ';
2998: }
2999: if (currtext != newtext) {
3000: textItem.innerHTML = newtext;
3001: }
3002: }
3003: return;
3004: }
3005:
3006: function changeInputType(oldObject,newType) {
3007: var newObject = document.createElement('input');
3008: newObject.type = newType;
3009: if (oldObject.size) {
3010: newObject.size = oldObject.size;
3011: }
3012: if (oldObject.value) {
3013: newObject.value = oldObject.value;
3014: }
3015: if (oldObject.name) {
3016: newObject.name = oldObject.name;
3017: }
3018: if (oldObject.id) {
3019: newObject.id = oldObject.id;
3020: }
3021: oldObject.parentNode.replaceChild(newObject,oldObject);
3022: return;
3023: }
3024:
3025: ENDJS
1.475 www 3026: }
3027:
1.167 www 3028: sub gradeleveldescription {
3029: my $gradelevel=shift;
3030: my %gradelevels=(0 => 'Not specified',
3031: 1 => 'Grade 1',
3032: 2 => 'Grade 2',
3033: 3 => 'Grade 3',
3034: 4 => 'Grade 4',
3035: 5 => 'Grade 5',
3036: 6 => 'Grade 6',
3037: 7 => 'Grade 7',
3038: 8 => 'Grade 8',
3039: 9 => 'Grade 9',
3040: 10 => 'Grade 10',
3041: 11 => 'Grade 11',
3042: 12 => 'Grade 12',
3043: 13 => 'Grade 13',
3044: 14 => '100 Level',
3045: 15 => '200 Level',
3046: 16 => '300 Level',
3047: 17 => '400 Level',
3048: 18 => 'Graduate Level');
3049: return &mt($gradelevels{$gradelevel});
3050: }
3051:
1.163 www 3052: sub select_level_form {
3053: my ($deflevel,$name)=@_;
3054: unless ($deflevel) { $deflevel=0; }
1.167 www 3055: my $selectform = "<select name=\"$name\" size=\"1\">\n";
3056: for (my $i=0; $i<=18; $i++) {
3057: $selectform.="<option value=\"$i\" ".
1.253 albertel 3058: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 3059: ">".&gradeleveldescription($i)."</option>\n";
3060: }
3061: $selectform.="</select>";
3062: return $selectform;
1.163 www 3063: }
1.167 www 3064:
1.35 matthew 3065: #-------------------------------------------
3066:
1.45 matthew 3067: =pod
3068:
1.1256 raeburn 3069: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 3070:
3071: Returns a string containing a <select name='$name' size='1'> form to
3072: allow a user to select the domain to preform an operation in.
3073: See loncreateuser.pm for an example invocation and use.
3074:
1.90 www 3075: If the $includeempty flag is set, it also includes an empty choice ("no domain
3076: selected");
3077:
1.743 raeburn 3078: If the $showdomdesc flag is set, the domain name is followed by the domain description.
3079:
1.910 raeburn 3080: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
3081:
1.1121 raeburn 3082: The optional $incdoms is a reference to an array of domains which will be the only available options.
3083:
3084: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 3085:
1.1256 raeburn 3086: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
3087:
1.35 matthew 3088: =cut
3089:
3090: #-------------------------------------------
1.34 matthew 3091: sub select_dom_form {
1.1256 raeburn 3092: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 3093: if ($onchange) {
1.874 raeburn 3094: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 3095: }
1.1256 raeburn 3096: if ($disabled) {
3097: $disabled = ' disabled="disabled"';
3098: }
1.1121 raeburn 3099: my (@domains,%exclude);
1.910 raeburn 3100: if (ref($incdoms) eq 'ARRAY') {
3101: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
3102: } else {
3103: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
3104: }
1.90 www 3105: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 3106: if (ref($excdoms) eq 'ARRAY') {
3107: map { $exclude{$_} = 1; } @{$excdoms};
3108: }
1.1256 raeburn 3109: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 3110: foreach my $dom (@domains) {
1.1121 raeburn 3111: next if ($exclude{$dom});
1.356 albertel 3112: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 3113: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
3114: if ($showdomdesc) {
3115: if ($dom ne '') {
3116: my $domdesc = &Apache::lonnet::domain($dom,'description');
3117: if ($domdesc ne '') {
3118: $selectdomain .= ' ('.$domdesc.')';
3119: }
3120: }
3121: }
3122: $selectdomain .= "</option>\n";
1.34 matthew 3123: }
3124: $selectdomain.="</select>";
3125: return $selectdomain;
3126: }
3127:
1.35 matthew 3128: #-------------------------------------------
3129:
1.45 matthew 3130: =pod
3131:
1.648 raeburn 3132: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 3133:
1.586 raeburn 3134: input: 4 arguments (two required, two optional) -
3135: $domain - domain of new user
3136: $name - name of form element
3137: $default - Value of 'default' causes a default item to be first
3138: option, and selected by default.
3139: $hide - Value of 'hide' causes hiding of the name of the server,
3140: if 1 server found, or default, if 0 found.
1.594 raeburn 3141: output: returns 2 items:
1.586 raeburn 3142: (a) form element which contains either:
3143: (i) <select name="$name">
3144: <option value="$hostid1">$hostid $servers{$hostid}</option>
3145: <option value="$hostid2">$hostid $servers{$hostid}</option>
3146: </select>
3147: form item if there are multiple library servers in $domain, or
3148: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
3149: if there is only one library server in $domain.
3150:
3151: (b) number of library servers found.
3152:
3153: See loncreateuser.pm for example of use.
1.35 matthew 3154:
3155: =cut
3156:
3157: #-------------------------------------------
1.586 raeburn 3158: sub home_server_form_item {
3159: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 3160: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 3161: my $result;
3162: my $numlib = keys(%servers);
3163: if ($numlib > 1) {
3164: $result .= '<select name="'.$name.'" />'."\n";
3165: if ($default) {
1.804 bisitz 3166: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3167: '</option>'."\n";
3168: }
3169: foreach my $hostid (sort(keys(%servers))) {
3170: $result.= '<option value="'.$hostid.'">'.
3171: $hostid.' '.$servers{$hostid}."</option>\n";
3172: }
3173: $result .= '</select>'."\n";
3174: } elsif ($numlib == 1) {
3175: my $hostid;
3176: foreach my $item (keys(%servers)) {
3177: $hostid = $item;
3178: }
3179: $result .= '<input type="hidden" name="'.$name.'" value="'.
3180: $hostid.'" />';
3181: if (!$hide) {
3182: $result .= $hostid.' '.$servers{$hostid};
3183: }
3184: $result .= "\n";
3185: } elsif ($default) {
3186: $result .= '<input type="hidden" name="'.$name.
3187: '" value="default" />';
3188: if (!$hide) {
3189: $result .= &mt('default');
3190: }
3191: $result .= "\n";
1.33 matthew 3192: }
1.586 raeburn 3193: return ($result,$numlib);
1.33 matthew 3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.534 albertel 3198: =back
3199:
1.112 bowersj2 3200: =cut
1.87 matthew 3201:
3202: ###############################################################
1.112 bowersj2 3203: ## Decoding User Agent ##
1.87 matthew 3204: ###############################################################
3205:
3206: =pod
3207:
1.112 bowersj2 3208: =head1 Decoding the User Agent
3209:
3210: =over 4
3211:
3212: =item * &decode_user_agent()
1.87 matthew 3213:
3214: Inputs: $r
3215:
3216: Outputs:
3217:
3218: =over 4
3219:
1.112 bowersj2 3220: =item * $httpbrowser
1.87 matthew 3221:
1.112 bowersj2 3222: =item * $clientbrowser
1.87 matthew 3223:
1.112 bowersj2 3224: =item * $clientversion
1.87 matthew 3225:
1.112 bowersj2 3226: =item * $clientmathml
1.87 matthew 3227:
1.112 bowersj2 3228: =item * $clientunicode
1.87 matthew 3229:
1.112 bowersj2 3230: =item * $clientos
1.87 matthew 3231:
1.1137 raeburn 3232: =item * $clientmobile
3233:
1.1141 raeburn 3234: =item * $clientinfo
3235:
1.1194 raeburn 3236: =item * $clientosversion
3237:
1.87 matthew 3238: =back
3239:
1.157 matthew 3240: =back
3241:
1.87 matthew 3242: =cut
3243:
3244: ###############################################################
3245: ###############################################################
3246: sub decode_user_agent {
1.247 albertel 3247: my ($r)=@_;
1.87 matthew 3248: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3249: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3250: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3251: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3252: my $clientbrowser='unknown';
3253: my $clientversion='0';
3254: my $clientmathml='';
3255: my $clientunicode='0';
1.1137 raeburn 3256: my $clientmobile=0;
1.1194 raeburn 3257: my $clientosversion='';
1.87 matthew 3258: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3259: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3260: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3261: $clientbrowser=$bname;
3262: $httpbrowser=~/$vreg/i;
3263: $clientversion=$1;
3264: $clientmathml=($clientversion>=$minv);
3265: $clientunicode=($clientversion>=$univ);
3266: }
3267: }
3268: my $clientos='unknown';
1.1141 raeburn 3269: my $clientinfo;
1.87 matthew 3270: if (($httpbrowser=~/linux/i) ||
3271: ($httpbrowser=~/unix/i) ||
3272: ($httpbrowser=~/ux/i) ||
3273: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3274: if (($httpbrowser=~/vax/i) ||
3275: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3276: if ($httpbrowser=~/next/i) { $clientos='next'; }
3277: if (($httpbrowser=~/mac/i) ||
3278: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3279: if ($httpbrowser=~/win/i) {
3280: $clientos='win';
3281: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3282: $clientosversion = $1;
3283: }
3284: }
1.87 matthew 3285: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3286: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3287: $clientmobile=lc($1);
3288: }
1.1141 raeburn 3289: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3290: $clientinfo = 'firefox-'.$1;
3291: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3292: $clientinfo = 'chromeframe-'.$1;
3293: }
1.87 matthew 3294: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3295: $clientunicode,$clientos,$clientmobile,$clientinfo,
3296: $clientosversion);
1.87 matthew 3297: }
3298:
1.32 matthew 3299: ###############################################################
3300: ## Authentication changing form generation subroutines ##
3301: ###############################################################
3302: ##
3303: ## All of the authform_xxxxxxx subroutines take their inputs in a
3304: ## hash, and have reasonable default values.
3305: ##
3306: ## formname = the name given in the <form> tag.
1.35 matthew 3307: #-------------------------------------------
3308:
1.45 matthew 3309: =pod
3310:
1.112 bowersj2 3311: =head1 Authentication Routines
3312:
3313: =over 4
3314:
1.648 raeburn 3315: =item * &authform_xxxxxx()
1.35 matthew 3316:
3317: The authform_xxxxxx subroutines provide javascript and html forms which
3318: handle some of the conveniences required for authentication forms.
3319: This is not an optimal method, but it works.
3320:
3321: =over 4
3322:
1.112 bowersj2 3323: =item * authform_header
1.35 matthew 3324:
1.112 bowersj2 3325: =item * authform_authorwarning
1.35 matthew 3326:
1.112 bowersj2 3327: =item * authform_nochange
1.35 matthew 3328:
1.112 bowersj2 3329: =item * authform_kerberos
1.35 matthew 3330:
1.112 bowersj2 3331: =item * authform_internal
1.35 matthew 3332:
1.112 bowersj2 3333: =item * authform_filesystem
1.35 matthew 3334:
1.1310 raeburn 3335: =item * authform_lti
3336:
1.35 matthew 3337: =back
3338:
1.648 raeburn 3339: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3340:
1.35 matthew 3341: =cut
3342:
3343: #-------------------------------------------
1.32 matthew 3344: sub authform_header{
3345: my %in = (
3346: formname => 'cu',
1.80 albertel 3347: kerb_def_dom => '',
1.32 matthew 3348: @_,
3349: );
3350: $in{'formname'} = 'document.' . $in{'formname'};
3351: my $result='';
1.80 albertel 3352:
3353: #---------------------------------------------- Code for upper case translation
3354: my $Javascript_toUpperCase;
3355: unless ($in{kerb_def_dom}) {
3356: $Javascript_toUpperCase =<<"END";
3357: switch (choice) {
3358: case 'krb': currentform.elements[choicearg].value =
3359: currentform.elements[choicearg].value.toUpperCase();
3360: break;
3361: default:
3362: }
3363: END
3364: } else {
3365: $Javascript_toUpperCase = "";
3366: }
3367:
1.165 raeburn 3368: my $radioval = "'nochange'";
1.591 raeburn 3369: if (defined($in{'curr_authtype'})) {
3370: if ($in{'curr_authtype'} ne '') {
3371: $radioval = "'".$in{'curr_authtype'}."arg'";
3372: }
1.174 matthew 3373: }
1.165 raeburn 3374: my $argfield = 'null';
1.591 raeburn 3375: if (defined($in{'mode'})) {
1.165 raeburn 3376: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3377: if (defined($in{'curr_autharg'})) {
3378: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3379: $argfield = "'$in{'curr_autharg'}'";
3380: }
3381: }
3382: }
3383: }
3384:
1.32 matthew 3385: $result.=<<"END";
3386: var current = new Object();
1.165 raeburn 3387: current.radiovalue = $radioval;
3388: current.argfield = $argfield;
1.32 matthew 3389:
3390: function changed_radio(choice,currentform) {
3391: var choicearg = choice + 'arg';
3392: // If a radio button in changed, we need to change the argfield
3393: if (current.radiovalue != choice) {
3394: current.radiovalue = choice;
3395: if (current.argfield != null) {
3396: currentform.elements[current.argfield].value = '';
3397: }
3398: if (choice == 'nochange') {
3399: current.argfield = null;
3400: } else {
3401: current.argfield = choicearg;
3402: switch(choice) {
3403: case 'krb':
3404: currentform.elements[current.argfield].value =
3405: "$in{'kerb_def_dom'}";
3406: break;
3407: default:
3408: break;
3409: }
3410: }
3411: }
3412: return;
3413: }
1.22 www 3414:
1.32 matthew 3415: function changed_text(choice,currentform) {
3416: var choicearg = choice + 'arg';
3417: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3418: $Javascript_toUpperCase
1.32 matthew 3419: // clear old field
3420: if ((current.argfield != choicearg) && (current.argfield != null)) {
3421: currentform.elements[current.argfield].value = '';
3422: }
3423: current.argfield = choicearg;
3424: }
3425: set_auth_radio_buttons(choice,currentform);
3426: return;
1.20 www 3427: }
1.32 matthew 3428:
3429: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3430: var numauthchoices = currentform.login.length;
3431: if (typeof numauthchoices == "undefined") {
3432: return;
3433: }
1.32 matthew 3434: var i=0;
1.986 raeburn 3435: while (i < numauthchoices) {
1.32 matthew 3436: if (currentform.login[i].value == newvalue) { break; }
3437: i++;
3438: }
1.986 raeburn 3439: if (i == numauthchoices) {
1.32 matthew 3440: return;
3441: }
3442: current.radiovalue = newvalue;
3443: currentform.login[i].checked = true;
3444: return;
3445: }
3446: END
3447: return $result;
3448: }
3449:
1.1106 raeburn 3450: sub authform_authorwarning {
1.32 matthew 3451: my $result='';
1.144 matthew 3452: $result='<i>'.
3453: &mt('As a general rule, only authors or co-authors should be '.
3454: 'filesystem authenticated '.
3455: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3456: return $result;
3457: }
3458:
1.1106 raeburn 3459: sub authform_nochange {
1.32 matthew 3460: my %in = (
3461: formname => 'document.cu',
3462: kerb_def_dom => 'MSU.EDU',
3463: @_,
3464: );
1.1106 raeburn 3465: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3466: my $result;
1.1104 raeburn 3467: if (!$authnum) {
1.1105 raeburn 3468: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3469: } else {
3470: $result = '<label>'.&mt('[_1] Do not change login data',
3471: '<input type="radio" name="login" value="nochange" '.
3472: 'checked="checked" onclick="'.
1.281 albertel 3473: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3474: '</label>';
1.586 raeburn 3475: }
1.32 matthew 3476: return $result;
3477: }
3478:
1.591 raeburn 3479: sub authform_kerberos {
1.32 matthew 3480: my %in = (
3481: formname => 'document.cu',
3482: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3483: kerb_def_auth => 'krb4',
1.32 matthew 3484: @_,
3485: );
1.586 raeburn 3486: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3487: $autharg,$jscall,$disabled);
1.1106 raeburn 3488: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3489: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3490: $check5 = ' checked="checked"';
1.80 albertel 3491: } else {
1.772 bisitz 3492: $check4 = ' checked="checked"';
1.80 albertel 3493: }
1.1259 raeburn 3494: if ($in{'readonly'}) {
3495: $disabled = ' disabled="disabled"';
3496: }
1.165 raeburn 3497: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3498: if (defined($in{'curr_authtype'})) {
3499: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3500: $krbcheck = ' checked="checked"';
1.623 raeburn 3501: if (defined($in{'mode'})) {
3502: if ($in{'mode'} eq 'modifyuser') {
3503: $krbcheck = '';
3504: }
3505: }
1.591 raeburn 3506: if (defined($in{'curr_kerb_ver'})) {
3507: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3508: $check5 = ' checked="checked"';
1.591 raeburn 3509: $check4 = '';
3510: } else {
1.772 bisitz 3511: $check4 = ' checked="checked"';
1.591 raeburn 3512: $check5 = '';
3513: }
1.586 raeburn 3514: }
1.591 raeburn 3515: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3516: $krbarg = $in{'curr_autharg'};
3517: }
1.586 raeburn 3518: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3519: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3520: $result =
3521: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3522: $in{'curr_autharg'},$krbver);
3523: } else {
3524: $result =
3525: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3526: }
3527: return $result;
3528: }
3529: }
3530: } else {
3531: if ($authnum == 1) {
1.784 bisitz 3532: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3533: }
3534: }
1.586 raeburn 3535: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3536: return;
1.587 raeburn 3537: } elsif ($authtype eq '') {
1.591 raeburn 3538: if (defined($in{'mode'})) {
1.587 raeburn 3539: if ($in{'mode'} eq 'modifycourse') {
3540: if ($authnum == 1) {
1.1259 raeburn 3541: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3542: }
3543: }
3544: }
1.586 raeburn 3545: }
3546: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3547: if ($authtype eq '') {
3548: $authtype = '<input type="radio" name="login" value="krb" '.
3549: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3550: $krbcheck.$disabled.' />';
1.586 raeburn 3551: }
3552: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3553: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3554: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3555: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3556: $in{'curr_authtype'} eq 'krb4')) {
3557: $result .= &mt
1.144 matthew 3558: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3559: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3560: '<label>'.$authtype,
1.281 albertel 3561: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3562: 'value="'.$krbarg.'" '.
1.1259 raeburn 3563: 'onchange="'.$jscall.'"'.$disabled.' />',
3564: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3565: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3566: '</label>');
1.586 raeburn 3567: } elsif ($can_assign{'krb4'}) {
3568: $result .= &mt
3569: ('[_1] Kerberos authenticated with domain [_2] '.
3570: '[_3] Version 4 [_4]',
3571: '<label>'.$authtype,
3572: '</label><input type="text" size="10" name="krbarg" '.
3573: 'value="'.$krbarg.'" '.
1.1259 raeburn 3574: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3575: '<label><input type="hidden" name="krbver" value="4" />',
3576: '</label>');
3577: } elsif ($can_assign{'krb5'}) {
3578: $result .= &mt
3579: ('[_1] Kerberos authenticated with domain [_2] '.
3580: '[_3] Version 5 [_4]',
3581: '<label>'.$authtype,
3582: '</label><input type="text" size="10" name="krbarg" '.
3583: 'value="'.$krbarg.'" '.
1.1259 raeburn 3584: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3585: '<label><input type="hidden" name="krbver" value="5" />',
3586: '</label>');
3587: }
1.32 matthew 3588: return $result;
3589: }
3590:
1.1106 raeburn 3591: sub authform_internal {
1.586 raeburn 3592: my %in = (
1.32 matthew 3593: formname => 'document.cu',
3594: kerb_def_dom => 'MSU.EDU',
3595: @_,
3596: );
1.1259 raeburn 3597: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3598: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3599: if ($in{'readonly'}) {
3600: $disabled = ' disabled="disabled"';
3601: }
1.591 raeburn 3602: if (defined($in{'curr_authtype'})) {
3603: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3604: if ($can_assign{'int'}) {
1.772 bisitz 3605: $intcheck = 'checked="checked" ';
1.623 raeburn 3606: if (defined($in{'mode'})) {
3607: if ($in{'mode'} eq 'modifyuser') {
3608: $intcheck = '';
3609: }
3610: }
1.591 raeburn 3611: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3612: $intarg = $in{'curr_autharg'};
3613: }
3614: } else {
3615: $result = &mt('Currently internally authenticated.');
3616: return $result;
1.165 raeburn 3617: }
3618: }
1.586 raeburn 3619: } else {
3620: if ($authnum == 1) {
1.784 bisitz 3621: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3622: }
3623: }
3624: if (!$can_assign{'int'}) {
3625: return;
1.587 raeburn 3626: } elsif ($authtype eq '') {
1.591 raeburn 3627: if (defined($in{'mode'})) {
1.587 raeburn 3628: if ($in{'mode'} eq 'modifycourse') {
3629: if ($authnum == 1) {
1.1259 raeburn 3630: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3631: }
3632: }
3633: }
1.165 raeburn 3634: }
1.586 raeburn 3635: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3636: if ($authtype eq '') {
3637: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3638: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3639: }
1.605 bisitz 3640: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3641: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3642: $result = &mt
1.144 matthew 3643: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3644: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3645: $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32 matthew 3646: return $result;
3647: }
3648:
1.1104 raeburn 3649: sub authform_local {
1.32 matthew 3650: my %in = (
3651: formname => 'document.cu',
3652: kerb_def_dom => 'MSU.EDU',
3653: @_,
3654: );
1.1259 raeburn 3655: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3656: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3657: if ($in{'readonly'}) {
3658: $disabled = ' disabled="disabled"';
3659: }
1.591 raeburn 3660: if (defined($in{'curr_authtype'})) {
3661: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3662: if ($can_assign{'loc'}) {
1.772 bisitz 3663: $loccheck = 'checked="checked" ';
1.623 raeburn 3664: if (defined($in{'mode'})) {
3665: if ($in{'mode'} eq 'modifyuser') {
3666: $loccheck = '';
3667: }
3668: }
1.591 raeburn 3669: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3670: $locarg = $in{'curr_autharg'};
3671: }
3672: } else {
3673: $result = &mt('Currently using local (institutional) authentication.');
3674: return $result;
1.165 raeburn 3675: }
3676: }
1.586 raeburn 3677: } else {
3678: if ($authnum == 1) {
1.784 bisitz 3679: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3680: }
3681: }
3682: if (!$can_assign{'loc'}) {
3683: return;
1.587 raeburn 3684: } elsif ($authtype eq '') {
1.591 raeburn 3685: if (defined($in{'mode'})) {
1.587 raeburn 3686: if ($in{'mode'} eq 'modifycourse') {
3687: if ($authnum == 1) {
1.1259 raeburn 3688: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3689: }
3690: }
3691: }
1.165 raeburn 3692: }
1.586 raeburn 3693: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3694: if ($authtype eq '') {
3695: $authtype = '<input type="radio" name="login" value="loc" '.
3696: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3697: $jscall.'"'.$disabled.' />';
1.586 raeburn 3698: }
3699: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3700: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3701: $result = &mt('[_1] Local Authentication with argument [_2]',
3702: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3703: return $result;
3704: }
3705:
1.1106 raeburn 3706: sub authform_filesystem {
1.32 matthew 3707: my %in = (
3708: formname => 'document.cu',
3709: kerb_def_dom => 'MSU.EDU',
3710: @_,
3711: );
1.1259 raeburn 3712: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3713: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3714: if ($in{'readonly'}) {
3715: $disabled = ' disabled="disabled"';
3716: }
1.591 raeburn 3717: if (defined($in{'curr_authtype'})) {
3718: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3719: if ($can_assign{'fsys'}) {
1.772 bisitz 3720: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3721: if (defined($in{'mode'})) {
3722: if ($in{'mode'} eq 'modifyuser') {
3723: $fsyscheck = '';
3724: }
3725: }
1.586 raeburn 3726: } else {
3727: $result = &mt('Currently Filesystem Authenticated.');
3728: return $result;
1.1259 raeburn 3729: }
1.586 raeburn 3730: }
3731: } else {
3732: if ($authnum == 1) {
1.784 bisitz 3733: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3734: }
3735: }
3736: if (!$can_assign{'fsys'}) {
3737: return;
1.587 raeburn 3738: } elsif ($authtype eq '') {
1.591 raeburn 3739: if (defined($in{'mode'})) {
1.587 raeburn 3740: if ($in{'mode'} eq 'modifycourse') {
3741: if ($authnum == 1) {
1.1259 raeburn 3742: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3743: }
3744: }
3745: }
1.586 raeburn 3746: }
3747: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3748: if ($authtype eq '') {
3749: $authtype = '<input type="radio" name="login" value="fsys" '.
3750: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3751: $jscall.'"'.$disabled.' />';
1.586 raeburn 3752: }
1.1310 raeburn 3753: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3754: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3755: $result = &mt
1.144 matthew 3756: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3757: '<label>'.$authtype,'</label>'.$autharg);
3758: return $result;
3759: }
3760:
3761: sub authform_lti {
3762: my %in = (
3763: formname => 'document.cu',
3764: kerb_def_dom => 'MSU.EDU',
3765: @_,
3766: );
3767: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3768: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3769: if ($in{'readonly'}) {
3770: $disabled = ' disabled="disabled"';
3771: }
3772: if (defined($in{'curr_authtype'})) {
3773: if ($in{'curr_authtype'} eq 'lti') {
3774: if ($can_assign{'lti'}) {
3775: $lticheck = 'checked="checked" ';
3776: if (defined($in{'mode'})) {
3777: if ($in{'mode'} eq 'modifyuser') {
3778: $lticheck = '';
3779: }
3780: }
3781: } else {
3782: $result = &mt('Currently LTI Authenticated.');
3783: return $result;
3784: }
3785: }
3786: } else {
3787: if ($authnum == 1) {
3788: $authtype = '<input type="hidden" name="login" value="lti" />';
3789: }
3790: }
3791: if (!$can_assign{'lti'}) {
3792: return;
3793: } elsif ($authtype eq '') {
3794: if (defined($in{'mode'})) {
3795: if ($in{'mode'} eq 'modifycourse') {
3796: if ($authnum == 1) {
3797: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3798: }
3799: }
3800: }
3801: }
3802: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3803: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3804: $authtype = '<input type="radio" name="login" value="lti" '.
3805: $lticheck.' onchange="'.$jscall.'" onclick="'.
3806: $jscall.'"'.$disabled.' />';
3807: }
3808: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3809: if ($authtype) {
3810: $result = &mt('[_1] LTI Authenticated',
3811: '<label>'.$authtype.'</label>'.$autharg);
3812: } else {
3813: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3814: $autharg;
3815: }
1.32 matthew 3816: return $result;
3817: }
3818:
1.586 raeburn 3819: sub get_assignable_auth {
3820: my ($dom) = @_;
3821: if ($dom eq '') {
3822: $dom = $env{'request.role.domain'};
3823: }
3824: my %can_assign = (
3825: krb4 => 1,
3826: krb5 => 1,
3827: int => 1,
3828: loc => 1,
1.1310 raeburn 3829: lti => 1,
1.586 raeburn 3830: );
3831: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3832: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3833: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3834: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3835: my $context;
3836: if ($env{'request.role'} =~ /^au/) {
3837: $context = 'author';
1.1259 raeburn 3838: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3839: $context = 'domain';
3840: } elsif ($env{'request.course.id'}) {
3841: $context = 'course';
3842: }
3843: if ($context) {
3844: if (ref($authhash->{$context}) eq 'HASH') {
3845: %can_assign = %{$authhash->{$context}};
3846: }
3847: }
3848: }
3849: }
3850: my $authnum = 0;
3851: foreach my $key (keys(%can_assign)) {
3852: if ($can_assign{$key}) {
3853: $authnum ++;
3854: }
3855: }
3856: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3857: $authnum --;
3858: }
3859: return ($authnum,%can_assign);
3860: }
3861:
1.1331 raeburn 3862: sub check_passwd_rules {
3863: my ($domain,$plainpass) = @_;
3864: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3865: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3866: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3867: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3868: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3869: if ($passwdconf{'min'} > $min) {
3870: $min = $passwdconf{'min'};
3871: }
1.1331 raeburn 3872: }
3873: if ($passwdconf{'max'} =~ /^\d+$/) {
3874: $max = $passwdconf{'max'};
3875: }
3876: @chars = @{$passwdconf{'chars'}};
3877: }
3878: if (($min) && (length($plainpass) < $min)) {
3879: push(@brokerule,'min');
3880: }
3881: if (($max) && (length($plainpass) > $max)) {
3882: push(@brokerule,'max');
3883: }
3884: if (@chars) {
3885: my %rules;
3886: map { $rules{$_} = 1; } @chars;
3887: if ($rules{'uc'}) {
3888: unless ($plainpass =~ /[A-Z]/) {
3889: push(@brokerule,'uc');
3890: }
3891: }
3892: if ($rules{'lc'}) {
1.1332 raeburn 3893: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3894: push(@brokerule,'lc');
3895: }
3896: }
3897: if ($rules{'num'}) {
3898: unless ($plainpass =~ /\d/) {
3899: push(@brokerule,'num');
3900: }
3901: }
3902: if ($rules{'spec'}) {
3903: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3904: push(@brokerule,'spec');
3905: }
3906: }
3907: }
3908: if (@brokerule) {
3909: my %rulenames = &Apache::lonlocal::texthash(
3910: uc => 'At least one upper case letter',
3911: lc => 'At least one lower case letter',
3912: num => 'At least one number',
3913: spec => 'At least one non-alphanumeric',
3914: );
3915: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3916: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3917: $rulenames{'num'} .= ': 0123456789';
3918: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3919: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3920: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3921: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3922: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3923: if (grep(/^$rule$/,@brokerule)) {
3924: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3925: }
3926: }
3927: $warning .= '</ul>';
3928: }
1.1332 raeburn 3929: if (wantarray) {
3930: return @brokerule;
3931: }
1.1331 raeburn 3932: return $warning;
3933: }
3934:
1.1376 raeburn 3935: sub passwd_validation_js {
1.1377 raeburn 3936: my ($currpasswdval,$domain,$context,$id) = @_;
3937: my (%passwdconf,$alertmsg);
3938: if ($context eq 'linkprot') {
3939: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3940: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3941: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3942: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3943: }
3944: }
3945: if ($id eq 'add') {
3946: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3947: } elsif ($id =~ /^\d+$/) {
3948: my $pos = $id+1;
3949: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3950: } else {
3951: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3952: }
1.1434 raeburn 3953: } elsif ($context eq 'ltitools') {
3954: my %domconfig = &Apache::lonnet::get_dom('configuration',['toolsec'],$domain);
3955: if (ref($domconfig{'toolsec'}) eq 'HASH') {
3956: if (ref($domconfig{'toolsec'}{'rules'}) eq 'HASH') {
3957: %passwdconf = %{$domconfig{'toolsec'}{'rules'}};
3958: }
3959: }
3960: if ($id eq 'add') {
3961: $alertmsg = &mt('Secret for added external tool did not satisfy requirement(s):').'\n\n';
3962: } elsif ($id =~ /^\d+$/) {
3963: my $pos = $id+1;
3964: $alertmsg = &mt('Secret for external tool [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3965: } else {
3966: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3967: }
1.1377 raeburn 3968: } else {
3969: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3970: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3971: }
1.1376 raeburn 3972: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3973: $numrules = 0;
3974: $min = $Apache::lonnet::passwdmin;
3975: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3976: if ($passwdconf{'min'} =~ /^\d+$/) {
3977: if ($passwdconf{'min'} > $min) {
3978: $min = $passwdconf{'min'};
3979: }
3980: }
3981: if ($passwdconf{'max'} =~ /^\d+$/) {
3982: $max = $passwdconf{'max'};
3983: $numrules ++;
3984: }
3985: @chars = @{$passwdconf{'chars'}};
3986: if (@chars) {
3987: $numrules ++;
3988: }
3989: }
3990: if ($min > 0) {
3991: $numrules ++;
3992: }
3993: if (($min > 0) || ($max ne '') || (@chars > 0)) {
3994: if ($min) {
3995: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3996: }
3997: if ($max) {
3998: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3999: }
4000: my (@charalerts,@charrules);
4001: if (@chars) {
4002: if (grep(/^uc$/,@chars)) {
4003: push(@charalerts,&mt('contain at least one upper case letter'));
4004: push(@charrules,'uc');
4005: }
4006: if (grep(/^lc$/,@chars)) {
4007: push(@charalerts,&mt('contain at least one lower case letter'));
4008: push(@charrules,'lc');
4009: }
4010: if (grep(/^num$/,@chars)) {
4011: push(@charalerts,&mt('contain at least one number'));
4012: push(@charrules,'num');
4013: }
4014: if (grep(/^spec$/,@chars)) {
4015: push(@charalerts,&mt('contain at least one non-alphanumeric'));
4016: push(@charrules,'spec');
4017: }
4018: }
4019: $intargjs = qq| var rulesmsg = '';\n|.
4020: qq| var currpwval = $currpasswdval;\n|;
4021: if ($min) {
4022: $intargjs .= qq|
4023: if (currpwval.length < $min) {
4024: rulesmsg += ' - $alert{min}';
4025: }
4026: |;
4027: }
4028: if ($max) {
4029: $intargjs .= qq|
4030: if (currpwval.length > $max) {
4031: rulesmsg += ' - $alert{max}';
4032: }
4033: |;
4034: }
4035: if (@chars > 0) {
4036: my $charrulestr = '"'.join('","',@charrules).'"';
4037: my $charalertstr = '"'.join('","',@charalerts).'"';
4038: $intargjs .= qq| var brokerules = new Array();\n|.
4039: qq| var charrules = new Array($charrulestr);\n|.
4040: qq| var charalerts = new Array($charalertstr);\n|;
4041: my %rules;
4042: map { $rules{$_} = 1; } @chars;
4043: if ($rules{'uc'}) {
4044: $intargjs .= qq|
4045: var ucRegExp = /[A-Z]/;
4046: if (!ucRegExp.test(currpwval)) {
4047: brokerules.push('uc');
4048: }
4049: |;
4050: }
4051: if ($rules{'lc'}) {
4052: $intargjs .= qq|
4053: var lcRegExp = /[a-z]/;
4054: if (!lcRegExp.test(currpwval)) {
4055: brokerules.push('lc');
4056: }
4057: |;
4058: }
4059: if ($rules{'num'}) {
4060: $intargjs .= qq|
4061: var numRegExp = /[0-9]/;
4062: if (!numRegExp.test(currpwval)) {
4063: brokerules.push('num');
4064: }
4065: |;
4066: }
4067: if ($rules{'spec'}) {
4068: $intargjs .= q|
4069: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
4070: if (!specRegExp.test(currpwval)) {
4071: brokerules.push('spec');
4072: }
4073: |;
4074: }
4075: $intargjs .= qq|
4076: if (brokerules.length > 0) {
4077: for (var i=0; i<brokerules.length; i++) {
4078: for (var j=0; j<charrules.length; j++) {
4079: if (brokerules[i] == charrules[j]) {
4080: rulesmsg += ' - '+charalerts[j]+'\\n';
4081: break;
4082: }
4083: }
4084: }
4085: }
4086: |;
4087: }
4088: $intargjs .= qq|
4089: if (rulesmsg != '') {
4090: rulesmsg = '$alertmsg'+rulesmsg;
4091: alert(rulesmsg);
4092: return false;
4093: }
4094: |;
4095: }
4096: return ($numrules,$intargjs);
4097: }
4098:
1.80 albertel 4099: ###############################################################
4100: ## Get Kerberos Defaults for Domain ##
4101: ###############################################################
4102: ##
4103: ## Returns default kerberos version and an associated argument
4104: ## as listed in file domain.tab. If not listed, provides
4105: ## appropriate default domain and kerberos version.
4106: ##
4107: #-------------------------------------------
4108:
4109: =pod
4110:
1.648 raeburn 4111: =item * &get_kerberos_defaults()
1.80 albertel 4112:
4113: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 4114: version and domain. If not found, it defaults to version 4 and the
4115: domain of the server.
1.80 albertel 4116:
1.648 raeburn 4117: =over 4
4118:
1.80 albertel 4119: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
4120:
1.648 raeburn 4121: =back
4122:
4123: =back
4124:
1.80 albertel 4125: =cut
4126:
4127: #-------------------------------------------
4128: sub get_kerberos_defaults {
4129: my $domain=shift;
1.641 raeburn 4130: my ($krbdef,$krbdefdom);
4131: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
4132: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
4133: $krbdef = $domdefaults{'auth_def'};
4134: $krbdefdom = $domdefaults{'auth_arg_def'};
4135: } else {
1.80 albertel 4136: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
4137: my $krbdefdom=$1;
4138: $krbdefdom=~tr/a-z/A-Z/;
4139: $krbdef = "krb4";
4140: }
4141: return ($krbdef,$krbdefdom);
4142: }
1.112 bowersj2 4143:
1.32 matthew 4144:
1.46 matthew 4145: ###############################################################
4146: ## Thesaurus Functions ##
4147: ###############################################################
1.20 www 4148:
1.46 matthew 4149: =pod
1.20 www 4150:
1.112 bowersj2 4151: =head1 Thesaurus Functions
4152:
4153: =over 4
4154:
1.648 raeburn 4155: =item * &initialize_keywords()
1.46 matthew 4156:
4157: Initializes the package variable %Keywords if it is empty. Uses the
4158: package variable $thesaurus_db_file.
4159:
4160: =cut
4161:
4162: ###################################################
4163:
4164: sub initialize_keywords {
4165: return 1 if (scalar keys(%Keywords));
4166: # If we are here, %Keywords is empty, so fill it up
4167: # Make sure the file we need exists...
4168: if (! -e $thesaurus_db_file) {
4169: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
4170: " failed because it does not exist");
4171: return 0;
4172: }
4173: # Set up the hash as a database
4174: my %thesaurus_db;
4175: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4176: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4177: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
4178: $thesaurus_db_file);
4179: return 0;
4180: }
4181: # Get the average number of appearances of a word.
4182: my $avecount = $thesaurus_db{'average.count'};
4183: # Put keywords (those that appear > average) into %Keywords
4184: while (my ($word,$data)=each (%thesaurus_db)) {
4185: my ($count,undef) = split /:/,$data;
4186: $Keywords{$word}++ if ($count > $avecount);
4187: }
4188: untie %thesaurus_db;
4189: # Remove special values from %Keywords.
1.356 albertel 4190: foreach my $value ('total.count','average.count') {
4191: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4192: }
1.46 matthew 4193: return 1;
4194: }
4195:
4196: ###################################################
4197:
4198: =pod
4199:
1.648 raeburn 4200: =item * &keyword($word)
1.46 matthew 4201:
4202: Returns true if $word is a keyword. A keyword is a word that appears more
4203: than the average number of times in the thesaurus database. Calls
4204: &initialize_keywords
4205:
4206: =cut
4207:
4208: ###################################################
1.20 www 4209:
4210: sub keyword {
1.46 matthew 4211: return if (!&initialize_keywords());
4212: my $word=lc(shift());
4213: $word=~s/\W//g;
4214: return exists($Keywords{$word});
1.20 www 4215: }
1.46 matthew 4216:
4217: ###############################################################
4218:
4219: =pod
1.20 www 4220:
1.648 raeburn 4221: =item * &get_related_words()
1.46 matthew 4222:
1.160 matthew 4223: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4224: an array of words. If the keyword is not in the thesaurus, an empty array
4225: will be returned. The order of the words returned is determined by the
4226: database which holds them.
4227:
4228: Uses global $thesaurus_db_file.
4229:
1.1057 foxr 4230:
1.46 matthew 4231: =cut
4232:
4233: ###############################################################
4234: sub get_related_words {
4235: my $keyword = shift;
4236: my %thesaurus_db;
4237: if (! -e $thesaurus_db_file) {
4238: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4239: "failed because the file does not exist");
4240: return ();
4241: }
4242: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4243: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4244: return ();
4245: }
4246: my @Words=();
1.429 www 4247: my $count=0;
1.46 matthew 4248: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4249: # The first element is the number of times
4250: # the word appears. We do not need it now.
1.429 www 4251: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4252: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4253: my $threshold=$mostfrequentcount/10;
4254: foreach my $possibleword (@RelatedWords) {
4255: my ($word,$wordcount)=split(/\,/,$possibleword);
4256: if ($wordcount>$threshold) {
4257: push(@Words,$word);
4258: $count++;
4259: if ($count>10) { last; }
4260: }
1.20 www 4261: }
4262: }
1.46 matthew 4263: untie %thesaurus_db;
4264: return @Words;
1.14 harris41 4265: }
1.1090 foxr 4266: ###############################################################
4267: #
4268: # Spell checking
4269: #
4270:
4271: =pod
4272:
1.1142 raeburn 4273: =back
4274:
1.1090 foxr 4275: =head1 Spell checking
4276:
4277: =over 4
4278:
4279: =item * &check_spelling($wordlist $language)
4280:
4281: Takes a string containing words and feeds it to an external
4282: spellcheck program via a pipeline. Returns a string containing
4283: them mis-spelled words.
4284:
4285: Parameters:
4286:
4287: =over 4
4288:
4289: =item - $wordlist
4290:
4291: String that will be fed into the spellcheck program.
4292:
4293: =item - $language
4294:
4295: Language string that specifies the language for which the spell
4296: check will be performed.
4297:
4298: =back
4299:
4300: =back
4301:
4302: Note: This sub assumes that aspell is installed.
4303:
4304:
4305: =cut
4306:
1.46 matthew 4307:
1.1090 foxr 4308: sub check_spelling {
4309: my ($wordlist, $language) = @_;
1.1091 foxr 4310: my @misspellings;
4311:
4312: # Generate the speller and set the langauge.
4313: # if explicitly selected:
1.1090 foxr 4314:
1.1091 foxr 4315: my $speller = Text::Aspell->new;
1.1090 foxr 4316: if ($language) {
1.1091 foxr 4317: $speller->set_option('lang', $language);
1.1090 foxr 4318: }
4319:
1.1091 foxr 4320: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4321:
1.1091 foxr 4322: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4323:
1.1091 foxr 4324: foreach my $word (@words) {
4325: if(! $speller->check($word)) {
4326: push(@misspellings, $word);
1.1090 foxr 4327: }
4328: }
1.1091 foxr 4329: return join(' ', @misspellings);
4330:
1.1090 foxr 4331: }
4332:
1.61 www 4333: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4334: =pod
4335:
1.112 bowersj2 4336: =head1 User Name Functions
4337:
4338: =over 4
4339:
1.648 raeburn 4340: =item * &plainname($uname,$udom,$first)
1.81 albertel 4341:
1.112 bowersj2 4342: Takes a users logon name and returns it as a string in
1.226 albertel 4343: "first middle last generation" form
4344: if $first is set to 'lastname' then it returns it as
4345: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4346:
4347: =cut
1.61 www 4348:
1.295 www 4349:
1.81 albertel 4350: ###############################################################
1.61 www 4351: sub plainname {
1.226 albertel 4352: my ($uname,$udom,$first)=@_;
1.537 albertel 4353: return if (!defined($uname) || !defined($udom));
1.295 www 4354: my %names=&getnames($uname,$udom);
1.226 albertel 4355: my $name=&Apache::lonnet::format_name($names{'firstname'},
4356: $names{'middlename'},
4357: $names{'lastname'},
4358: $names{'generation'},$first);
4359: $name=~s/^\s+//;
1.62 www 4360: $name=~s/\s+$//;
4361: $name=~s/\s+/ /g;
1.353 albertel 4362: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4363: return $name;
1.61 www 4364: }
1.66 www 4365:
4366: # -------------------------------------------------------------------- Nickname
1.81 albertel 4367: =pod
4368:
1.648 raeburn 4369: =item * &nickname($uname,$udom)
1.81 albertel 4370:
4371: Gets a users name and returns it as a string as
4372:
4373: ""nickname""
1.66 www 4374:
1.81 albertel 4375: if the user has a nickname or
4376:
4377: "first middle last generation"
4378:
4379: if the user does not
4380:
4381: =cut
1.66 www 4382:
4383: sub nickname {
4384: my ($uname,$udom)=@_;
1.537 albertel 4385: return if (!defined($uname) || !defined($udom));
1.295 www 4386: my %names=&getnames($uname,$udom);
1.68 albertel 4387: my $name=$names{'nickname'};
1.66 www 4388: if ($name) {
4389: $name='"'.$name.'"';
4390: } else {
4391: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4392: $names{'lastname'}.' '.$names{'generation'};
4393: $name=~s/\s+$//;
4394: $name=~s/\s+/ /g;
4395: }
4396: return $name;
4397: }
4398:
1.295 www 4399: sub getnames {
4400: my ($uname,$udom)=@_;
1.537 albertel 4401: return if (!defined($uname) || !defined($udom));
1.433 albertel 4402: if ($udom eq 'public' && $uname eq 'public') {
4403: return ('lastname' => &mt('Public'));
4404: }
1.295 www 4405: my $id=$uname.':'.$udom;
4406: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4407: if ($cached) {
4408: return %{$names};
4409: } else {
4410: my %loadnames=&Apache::lonnet::get('environment',
4411: ['firstname','middlename','lastname','generation','nickname'],
4412: $udom,$uname);
4413: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4414: return %loadnames;
4415: }
4416: }
1.61 www 4417:
1.542 raeburn 4418: # -------------------------------------------------------------------- getemails
1.648 raeburn 4419:
1.542 raeburn 4420: =pod
4421:
1.648 raeburn 4422: =item * &getemails($uname,$udom)
1.542 raeburn 4423:
4424: Gets a user's email information and returns it as a hash with keys:
4425: notification, critnotification, permanentemail
4426:
4427: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4428: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4429:
1.648 raeburn 4430:
1.542 raeburn 4431: =cut
4432:
1.648 raeburn 4433:
1.466 albertel 4434: sub getemails {
4435: my ($uname,$udom)=@_;
4436: if ($udom eq 'public' && $uname eq 'public') {
4437: return;
4438: }
1.467 www 4439: if (!$udom) { $udom=$env{'user.domain'}; }
4440: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4441: my $id=$uname.':'.$udom;
4442: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4443: if ($cached) {
4444: return %{$names};
4445: } else {
4446: my %loadnames=&Apache::lonnet::get('environment',
4447: ['notification','critnotification',
4448: 'permanentemail'],
4449: $udom,$uname);
4450: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4451: return %loadnames;
4452: }
4453: }
4454:
1.551 albertel 4455: sub flush_email_cache {
4456: my ($uname,$udom)=@_;
4457: if (!$udom) { $udom =$env{'user.domain'}; }
4458: if (!$uname) { $uname=$env{'user.name'}; }
4459: return if ($udom eq 'public' && $uname eq 'public');
4460: my $id=$uname.':'.$udom;
4461: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4462: }
4463:
1.728 raeburn 4464: # -------------------------------------------------------------------- getlangs
4465:
4466: =pod
4467:
4468: =item * &getlangs($uname,$udom)
4469:
4470: Gets a user's language preference and returns it as a hash with key:
4471: language.
4472:
4473: =cut
4474:
4475:
4476: sub getlangs {
4477: my ($uname,$udom) = @_;
4478: if (!$udom) { $udom =$env{'user.domain'}; }
4479: if (!$uname) { $uname=$env{'user.name'}; }
4480: my $id=$uname.':'.$udom;
4481: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4482: if ($cached) {
4483: return %{$langs};
4484: } else {
4485: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4486: $udom,$uname);
4487: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4488: return %loadlangs;
4489: }
4490: }
4491:
4492: sub flush_langs_cache {
4493: my ($uname,$udom)=@_;
4494: if (!$udom) { $udom =$env{'user.domain'}; }
4495: if (!$uname) { $uname=$env{'user.name'}; }
4496: return if ($udom eq 'public' && $uname eq 'public');
4497: my $id=$uname.':'.$udom;
4498: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4499: }
4500:
1.61 www 4501: # ------------------------------------------------------------------ Screenname
1.81 albertel 4502:
4503: =pod
4504:
1.648 raeburn 4505: =item * &screenname($uname,$udom)
1.81 albertel 4506:
4507: Gets a users screenname and returns it as a string
4508:
4509: =cut
1.61 www 4510:
4511: sub screenname {
4512: my ($uname,$udom)=@_;
1.258 albertel 4513: if ($uname eq $env{'user.name'} &&
4514: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4515: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4516: return $names{'screenname'};
1.62 www 4517: }
4518:
1.212 albertel 4519:
1.802 bisitz 4520: # ------------------------------------------------------------- Confirm Wrapper
4521: =pod
4522:
1.1142 raeburn 4523: =item * &confirmwrapper($message)
1.802 bisitz 4524:
4525: Wrap messages about completion of operation in box
4526:
4527: =cut
4528:
4529: sub confirmwrapper {
4530: my ($message)=@_;
4531: if ($message) {
4532: return "\n".'<div class="LC_confirm_box">'."\n"
4533: .$message."\n"
4534: .'</div>'."\n";
4535: } else {
4536: return $message;
4537: }
4538: }
4539:
1.62 www 4540: # ------------------------------------------------------------- Message Wrapper
4541:
4542: sub messagewrapper {
1.369 www 4543: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4544: return
1.441 albertel 4545: '<a href="/adm/email?compose=individual&'.
4546: 'recname='.$username.'&recdom='.$domain.
4547: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4548: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4549: }
1.802 bisitz 4550:
1.74 www 4551: # --------------------------------------------------------------- Notes Wrapper
4552:
4553: sub noteswrapper {
4554: my ($link,$un,$do)=@_;
4555: return
1.896 amueller 4556: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4557: }
1.802 bisitz 4558:
1.62 www 4559: # ------------------------------------------------------------- Aboutme Wrapper
4560:
4561: sub aboutmewrapper {
1.1070 raeburn 4562: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4563: if (!defined($username) && !defined($domain)) {
4564: return;
4565: }
1.1096 raeburn 4566: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4567: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4568: }
4569:
4570: # ------------------------------------------------------------ Syllabus Wrapper
4571:
4572: sub syllabuswrapper {
1.707 bisitz 4573: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4574: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4575: }
1.14 harris41 4576:
1.1397 raeburn 4577: # -----------------------------------------------------------------------------
4578:
1.1396 raeburn 4579: sub aboutme_on {
4580: my ($uname,$udom)=@_;
4581: unless ($uname) { $uname=$env{'user.name'}; }
4582: unless ($udom) { $udom=$env{'user.domain'}; }
4583: return if ($udom eq 'public' && $uname eq 'public');
4584: my $hashkey=$uname.':'.$udom;
4585: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4586: if ($cached) {
4587: return $aboutme;
4588: }
4589: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4590: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4591: return $aboutme;
4592: }
4593:
4594: sub devalidate_aboutme_cache {
4595: my ($uname,$udom)=@_;
4596: if (!$udom) { $udom =$env{'user.domain'}; }
4597: if (!$uname) { $uname=$env{'user.name'}; }
4598: return if ($udom eq 'public' && $uname eq 'public');
4599: my $id=$uname.':'.$udom;
4600: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4601: }
4602:
1.208 matthew 4603: sub track_student_link {
1.887 raeburn 4604: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4605: my $link ="/adm/trackstudent?";
1.208 matthew 4606: my $title = 'View recent activity';
4607: if (defined($sname) && $sname !~ /^\s*$/ &&
4608: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4609: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4610: $title .= ' of this student';
1.268 albertel 4611: }
1.208 matthew 4612: if (defined($target) && $target !~ /^\s*$/) {
4613: $target = qq{target="$target"};
4614: } else {
4615: $target = '';
4616: }
1.268 albertel 4617: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4618: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4619: $title = &mt($title);
4620: $linktext = &mt($linktext);
1.448 albertel 4621: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4622: &help_open_topic('View_recent_activity');
1.208 matthew 4623: }
4624:
1.781 raeburn 4625: sub slot_reservations_link {
4626: my ($linktext,$sname,$sdom,$target) = @_;
4627: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4628: my $title = 'View slot reservation history';
4629: if (defined($sname) && $sname !~ /^\s*$/ &&
4630: defined($sdom) && $sdom !~ /^\s*$/) {
4631: $link .= "&uname=$sname&udom=$sdom";
4632: $title .= ' of this student';
4633: }
4634: if (defined($target) && $target !~ /^\s*$/) {
4635: $target = qq{target="$target"};
4636: } else {
4637: $target = '';
4638: }
4639: $title = &mt($title);
4640: $linktext = &mt($linktext);
4641: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4642: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4643:
4644: }
4645:
1.508 www 4646: # ===================================================== Display a student photo
4647:
4648:
1.509 albertel 4649: sub student_image_tag {
1.508 www 4650: my ($domain,$user)=@_;
4651: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4652: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4653: return '<img src="'.$imgsrc.'" align="right" />';
4654: } else {
4655: return '';
4656: }
4657: }
4658:
1.112 bowersj2 4659: =pod
4660:
4661: =back
4662:
4663: =head1 Access .tab File Data
4664:
4665: =over 4
4666:
1.648 raeburn 4667: =item * &languageids()
1.112 bowersj2 4668:
4669: returns list of all language ids
4670:
4671: =cut
4672:
1.14 harris41 4673: sub languageids {
1.16 harris41 4674: return sort(keys(%language));
1.14 harris41 4675: }
4676:
1.112 bowersj2 4677: =pod
4678:
1.648 raeburn 4679: =item * &languagedescription()
1.112 bowersj2 4680:
4681: returns description of a specified language id
4682:
4683: =cut
4684:
1.14 harris41 4685: sub languagedescription {
1.125 www 4686: my $code=shift;
4687: return ($supported_language{$code}?'* ':'').
4688: $language{$code}.
1.126 www 4689: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4690: }
4691:
1.1048 foxr 4692: =pod
4693:
4694: =item * &plainlanguagedescription
4695:
4696: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4697: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4698:
4699: =cut
4700:
1.145 www 4701: sub plainlanguagedescription {
4702: my $code=shift;
4703: return $language{$code};
4704: }
4705:
1.1048 foxr 4706: =pod
4707:
4708: =item * &supportedlanguagecode
4709:
4710: Returns the supported language code (e.g. sptutf maps to pt) given a language
4711: code.
4712:
4713: =cut
4714:
1.145 www 4715: sub supportedlanguagecode {
4716: my $code=shift;
4717: return $supported_language{$code};
1.97 www 4718: }
4719:
1.112 bowersj2 4720: =pod
4721:
1.1048 foxr 4722: =item * &latexlanguage()
4723:
4724: Given a language key code returns the correspondnig language to use
4725: to select the correct hyphenation on LaTeX printouts. This is undef if there
4726: is no supported hyphenation for the language code.
4727:
4728: =cut
4729:
4730: sub latexlanguage {
4731: my $code = shift;
4732: return $latex_language{$code};
4733: }
4734:
4735: =pod
4736:
4737: =item * &latexhyphenation()
4738:
4739: Same as above but what's supplied is the language as it might be stored
4740: in the metadata.
4741:
4742: =cut
4743:
4744: sub latexhyphenation {
4745: my $key = shift;
4746: return $latex_language_bykey{$key};
4747: }
4748:
4749: =pod
4750:
1.648 raeburn 4751: =item * ©rightids()
1.112 bowersj2 4752:
4753: returns list of all copyrights
4754:
4755: =cut
4756:
4757: sub copyrightids {
4758: return sort(keys(%cprtag));
4759: }
4760:
4761: =pod
4762:
1.648 raeburn 4763: =item * ©rightdescription()
1.112 bowersj2 4764:
4765: returns description of a specified copyright id
4766:
4767: =cut
4768:
4769: sub copyrightdescription {
1.166 www 4770: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4771: }
1.197 matthew 4772:
4773: =pod
4774:
1.648 raeburn 4775: =item * &source_copyrightids()
1.192 taceyjo1 4776:
4777: returns list of all source copyrights
4778:
4779: =cut
4780:
4781: sub source_copyrightids {
4782: return sort(keys(%scprtag));
4783: }
4784:
4785: =pod
4786:
1.648 raeburn 4787: =item * &source_copyrightdescription()
1.192 taceyjo1 4788:
4789: returns description of a specified source copyright id
4790:
4791: =cut
4792:
4793: sub source_copyrightdescription {
4794: return &mt($scprtag{shift(@_)});
4795: }
1.112 bowersj2 4796:
4797: =pod
4798:
1.648 raeburn 4799: =item * &filecategories()
1.112 bowersj2 4800:
4801: returns list of all file categories
4802:
4803: =cut
4804:
4805: sub filecategories {
4806: return sort(keys(%category_extensions));
4807: }
4808:
4809: =pod
4810:
1.648 raeburn 4811: =item * &filecategorytypes()
1.112 bowersj2 4812:
4813: returns list of file types belonging to a given file
4814: category
4815:
4816: =cut
4817:
4818: sub filecategorytypes {
1.356 albertel 4819: my ($cat) = @_;
1.1248 raeburn 4820: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4821: return @{$category_extensions{lc($cat)}};
4822: } else {
4823: return ();
4824: }
1.112 bowersj2 4825: }
4826:
4827: =pod
4828:
1.648 raeburn 4829: =item * &fileembstyle()
1.112 bowersj2 4830:
4831: returns embedding style for a specified file type
4832:
4833: =cut
4834:
4835: sub fileembstyle {
4836: return $fe{lc(shift(@_))};
1.169 www 4837: }
4838:
1.351 www 4839: sub filemimetype {
4840: return $fm{lc(shift(@_))};
4841: }
4842:
1.169 www 4843:
4844: sub filecategoryselect {
4845: my ($name,$value)=@_;
1.189 matthew 4846: return &select_form($value,$name,
1.970 raeburn 4847: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4848: }
4849:
4850: =pod
4851:
1.648 raeburn 4852: =item * &filedescription()
1.112 bowersj2 4853:
4854: returns description for a specified file type
4855:
4856: =cut
4857:
4858: sub filedescription {
1.188 matthew 4859: my $file_description = $fd{lc(shift())};
4860: $file_description =~ s:([\[\]]):~$1:g;
4861: return &mt($file_description);
1.112 bowersj2 4862: }
4863:
4864: =pod
4865:
1.648 raeburn 4866: =item * &filedescriptionex()
1.112 bowersj2 4867:
4868: returns description for a specified file type with
4869: extra formatting
4870:
4871: =cut
4872:
4873: sub filedescriptionex {
4874: my $ex=shift;
1.188 matthew 4875: my $file_description = $fd{lc($ex)};
4876: $file_description =~ s:([\[\]]):~$1:g;
4877: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4878: }
4879:
4880: # End of .tab access
4881: =pod
4882:
4883: =back
4884:
4885: =cut
4886:
4887: # ------------------------------------------------------------------ File Types
4888: sub fileextensions {
4889: return sort(keys(%fe));
4890: }
4891:
1.97 www 4892: # ----------------------------------------------------------- Display Languages
4893: # returns a hash with all desired display languages
4894: #
4895:
4896: sub display_languages {
4897: my %languages=();
1.695 raeburn 4898: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4899: $languages{$lang}=1;
1.97 www 4900: }
4901: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4902: if ($env{'form.displaylanguage'}) {
1.356 albertel 4903: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4904: $languages{$lang}=1;
1.97 www 4905: }
4906: }
4907: return %languages;
1.14 harris41 4908: }
4909:
1.582 albertel 4910: sub languages {
4911: my ($possible_langs) = @_;
1.695 raeburn 4912: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4913: if (!ref($possible_langs)) {
4914: if( wantarray ) {
4915: return @preferred_langs;
4916: } else {
4917: return $preferred_langs[0];
4918: }
4919: }
4920: my %possibilities = map { $_ => 1 } (@$possible_langs);
4921: my @preferred_possibilities;
4922: foreach my $preferred_lang (@preferred_langs) {
4923: if (exists($possibilities{$preferred_lang})) {
4924: push(@preferred_possibilities, $preferred_lang);
4925: }
4926: }
4927: if( wantarray ) {
4928: return @preferred_possibilities;
4929: }
4930: return $preferred_possibilities[0];
4931: }
4932:
1.742 raeburn 4933: sub user_lang {
4934: my ($touname,$toudom,$fromcid) = @_;
4935: my @userlangs;
4936: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4937: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4938: $env{'course.'.$fromcid.'.languages'}));
4939: } else {
4940: my %langhash = &getlangs($touname,$toudom);
4941: if ($langhash{'languages'} ne '') {
4942: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4943: } else {
4944: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4945: if ($domdefs{'lang_def'} ne '') {
4946: @userlangs = ($domdefs{'lang_def'});
4947: }
4948: }
4949: }
4950: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4951: my $user_lh = Apache::localize->get_handle(@languages);
4952: return $user_lh;
4953: }
4954:
4955:
1.112 bowersj2 4956: ###############################################################
4957: ## Student Answer Attempts ##
4958: ###############################################################
4959:
4960: =pod
4961:
4962: =head1 Alternate Problem Views
4963:
4964: =over 4
4965:
1.648 raeburn 4966: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4967: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4968:
4969: Return string with previous attempt on problem. Arguments:
4970:
4971: =over 4
4972:
4973: =item * $symb: Problem, including path
4974:
4975: =item * $username: username of the desired student
4976:
4977: =item * $domain: domain of the desired student
1.14 harris41 4978:
1.112 bowersj2 4979: =item * $course: Course ID
1.14 harris41 4980:
1.112 bowersj2 4981: =item * $getattempt: Leave blank for all attempts, otherwise put
4982: something
1.14 harris41 4983:
1.112 bowersj2 4984: =item * $regexp: if string matches this regexp, the string will be
4985: sent to $gradesub
1.14 harris41 4986:
1.112 bowersj2 4987: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4988:
1.1199 raeburn 4989: =item * $usec: section of the desired student
4990:
4991: =item * $identifier: counter for student (multiple students one problem) or
4992: problem (one student; whole sequence).
4993:
1.112 bowersj2 4994: =back
1.14 harris41 4995:
1.112 bowersj2 4996: The output string is a table containing all desired attempts, if any.
1.16 harris41 4997:
1.112 bowersj2 4998: =cut
1.1 albertel 4999:
5000: sub get_previous_attempt {
1.1199 raeburn 5001: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 5002: my $prevattempts='';
1.43 ng 5003: no strict 'refs';
1.1 albertel 5004: if ($symb) {
1.3 albertel 5005: my (%returnhash)=
5006: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 5007: if ($returnhash{'version'}) {
5008: my %lasthash=();
5009: my $version;
5010: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 5011: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
5012: if ($key =~ /\.rawrndseed$/) {
5013: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
5014: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
5015: } else {
5016: $lasthash{$key}=$returnhash{$version.':'.$key};
5017: }
1.19 harris41 5018: }
1.1 albertel 5019: }
1.596 albertel 5020: $prevattempts=&start_data_table().&start_data_table_header_row();
5021: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 5022: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 5023: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 5024: foreach my $key (sort(keys(%lasthash))) {
5025: my ($ign,@parts) = split(/\./,$key);
1.41 ng 5026: if ($#parts > 0) {
1.31 albertel 5027: my $data=$parts[-1];
1.989 raeburn 5028: next if ($data eq 'foilorder');
1.31 albertel 5029: pop(@parts);
1.1010 www 5030: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 5031: if ($data eq 'type') {
5032: unless ($showsurv) {
5033: my $id = join(',',@parts);
5034: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 5035: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
5036: $lasthidden{$ign.'.'.$id} = 1;
5037: }
1.945 raeburn 5038: }
1.1199 raeburn 5039: if ($identifier ne '') {
5040: my $id = join(',',@parts);
5041: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
5042: $domain,$username,$usec,undef,$course) =~ /^no/) {
5043: $hidestatus{$ign.'.'.$id} = 1;
5044: }
5045: }
5046: } elsif ($data eq 'regrader') {
5047: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 5048: my $id = join(',',@parts);
5049: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 5050: }
1.1010 www 5051: }
1.31 albertel 5052: } else {
1.41 ng 5053: if ($#parts == 0) {
5054: $prevattempts.='<th>'.$parts[0].'</th>';
5055: } else {
5056: $prevattempts.='<th>'.$ign.'</th>';
5057: }
1.31 albertel 5058: }
1.16 harris41 5059: }
1.596 albertel 5060: $prevattempts.=&end_data_table_header_row();
1.40 ng 5061: if ($getattempt eq '') {
1.1199 raeburn 5062: my (%solved,%resets,%probstatus);
1.1200 raeburn 5063: if (($identifier ne '') && (keys(%regraded) > 0)) {
5064: for ($version=1;$version<=$returnhash{'version'};$version++) {
5065: foreach my $id (keys(%regraded)) {
5066: if (($returnhash{$version.':'.$id.'.regrader'}) &&
5067: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
5068: ($returnhash{$version.':'.$id.'.award'} eq '')) {
5069: push(@{$resets{$id}},$version);
1.1199 raeburn 5070: }
5071: }
5072: }
1.1200 raeburn 5073: }
5074: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 5075: my (@hidden,@unsolved);
1.945 raeburn 5076: if (%typeparts) {
5077: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 5078: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
5079: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 5080: push(@hidden,$id);
1.1199 raeburn 5081: } elsif ($identifier ne '') {
5082: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
5083: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
5084: ($hidestatus{$id})) {
1.1200 raeburn 5085: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 5086: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
5087: push(@{$solved{$id}},$version);
5088: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
5089: (ref($solved{$id}) eq 'ARRAY')) {
5090: my $skip;
5091: if (ref($resets{$id}) eq 'ARRAY') {
5092: foreach my $reset (@{$resets{$id}}) {
5093: if ($reset > $solved{$id}[-1]) {
5094: $skip=1;
5095: last;
5096: }
5097: }
5098: }
5099: unless ($skip) {
5100: my ($ign,$partslist) = split(/\./,$id,2);
5101: push(@unsolved,$partslist);
5102: }
5103: }
5104: }
1.945 raeburn 5105: }
5106: }
5107: }
5108: $prevattempts.=&start_data_table_row().
1.1199 raeburn 5109: '<td>'.&mt('Transaction [_1]',$version);
5110: if (@unsolved) {
5111: $prevattempts .= '<span class="LC_nobreak"><label>'.
5112: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
5113: &mt('Hide').'</label></span>';
5114: }
5115: $prevattempts .= '</td>';
1.945 raeburn 5116: if (@hidden) {
5117: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5118: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5119: my $hide;
5120: foreach my $id (@hidden) {
5121: if ($key =~ /^\Q$id\E/) {
5122: $hide = 1;
5123: last;
5124: }
5125: }
5126: if ($hide) {
5127: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5128: if (($data eq 'award') || ($data eq 'awarddetail')) {
5129: my $value = &format_previous_attempt_value($key,
5130: $returnhash{$version.':'.$key});
1.1173 kruse 5131: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5132: } else {
5133: $prevattempts.='<td> </td>';
5134: }
5135: } else {
5136: if ($key =~ /\./) {
1.1212 raeburn 5137: my $value = $returnhash{$version.':'.$key};
5138: if ($key =~ /\.rndseed$/) {
5139: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5140: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5141: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5142: }
5143: }
5144: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5145: ' </td>';
1.945 raeburn 5146: } else {
5147: $prevattempts.='<td> </td>';
5148: }
5149: }
5150: }
5151: } else {
5152: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5153: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 5154: my $value = $returnhash{$version.':'.$key};
5155: if ($key =~ /\.rndseed$/) {
5156: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5157: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5158: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5159: }
5160: }
5161: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5162: ' </td>';
1.945 raeburn 5163: }
5164: }
5165: $prevattempts.=&end_data_table_row();
1.40 ng 5166: }
1.1 albertel 5167: }
1.945 raeburn 5168: my @currhidden = keys(%lasthidden);
1.596 albertel 5169: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 5170: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5171: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5172: if (%typeparts) {
5173: my $hidden;
5174: foreach my $id (@currhidden) {
5175: if ($key =~ /^\Q$id\E/) {
5176: $hidden = 1;
5177: last;
5178: }
5179: }
5180: if ($hidden) {
5181: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5182: if (($data eq 'award') || ($data eq 'awarddetail')) {
5183: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5184: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5185: $value = &$gradesub($value);
5186: }
1.1173 kruse 5187: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5188: } else {
5189: $prevattempts.='<td> </td>';
5190: }
5191: } else {
5192: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5193: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5194: $value = &$gradesub($value);
5195: }
1.1173 kruse 5196: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5197: }
5198: } else {
5199: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5200: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5201: $value = &$gradesub($value);
5202: }
1.1173 kruse 5203: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5204: }
1.16 harris41 5205: }
1.596 albertel 5206: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5207: } else {
1.1305 raeburn 5208: my $msg;
5209: if ($symb =~ /ext\.tool$/) {
5210: $msg = &mt('No grade passed back.');
5211: } else {
5212: $msg = &mt('Nothing submitted - no attempts.');
5213: }
1.596 albertel 5214: $prevattempts=
5215: &start_data_table().&start_data_table_row().
1.1305 raeburn 5216: '<td>'.$msg.'</td>'.
1.596 albertel 5217: &end_data_table_row().&end_data_table();
1.1 albertel 5218: }
5219: } else {
1.596 albertel 5220: $prevattempts=
5221: &start_data_table().&start_data_table_row().
5222: '<td>'.&mt('No data.').'</td>'.
5223: &end_data_table_row().&end_data_table();
1.1 albertel 5224: }
1.10 albertel 5225: }
5226:
1.581 albertel 5227: sub format_previous_attempt_value {
5228: my ($key,$value) = @_;
1.1011 www 5229: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5230: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5231: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5232: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5233: } elsif ($key =~ /answerstring$/) {
5234: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5235: my @answer = %answers;
5236: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5237: my @anskeys = sort(keys(%answers));
5238: if (@anskeys == 1) {
5239: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5240: if ($answer =~ m{\0}) {
5241: $answer =~ s{\0}{,}g;
1.988 raeburn 5242: }
5243: my $tag_internal_answer_name = 'INTERNAL';
5244: if ($anskeys[0] eq $tag_internal_answer_name) {
5245: $value = $answer;
5246: } else {
5247: $value = $anskeys[0].'='.$answer;
5248: }
5249: } else {
5250: foreach my $ans (@anskeys) {
5251: my $answer = $answers{$ans};
1.1001 raeburn 5252: if ($answer =~ m{\0}) {
5253: $answer =~ s{\0}{,}g;
1.988 raeburn 5254: }
5255: $value .= $ans.'='.$answer.'<br />';;
5256: }
5257: }
1.581 albertel 5258: } else {
1.1173 kruse 5259: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5260: }
5261: return $value;
5262: }
5263:
5264:
1.107 albertel 5265: sub relative_to_absolute {
5266: my ($url,$output)=@_;
5267: my $parser=HTML::TokeParser->new(\$output);
5268: my $token;
5269: my $thisdir=$url;
5270: my @rlinks=();
5271: while ($token=$parser->get_token) {
5272: if ($token->[0] eq 'S') {
5273: if ($token->[1] eq 'a') {
5274: if ($token->[2]->{'href'}) {
5275: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5276: }
5277: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5278: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5279: } elsif ($token->[1] eq 'base') {
5280: $thisdir=$token->[2]->{'href'};
5281: }
5282: }
5283: }
5284: $thisdir=~s-/[^/]*$--;
1.356 albertel 5285: foreach my $link (@rlinks) {
1.726 raeburn 5286: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5287: ($link=~/^\//) ||
5288: ($link=~/^javascript:/i) ||
5289: ($link=~/^mailto:/i) ||
5290: ($link=~/^\#/)) {
5291: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5292: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5293: }
5294: }
5295: # -------------------------------------------------- Deal with Applet codebases
5296: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5297: return $output;
5298: }
5299:
1.112 bowersj2 5300: =pod
5301:
1.648 raeburn 5302: =item * &get_student_view()
1.112 bowersj2 5303:
5304: show a snapshot of what student was looking at
5305:
5306: =cut
5307:
1.10 albertel 5308: sub get_student_view {
1.186 albertel 5309: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5310: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5311: my (%form);
1.10 albertel 5312: my @elements=('symb','courseid','domain','username');
5313: foreach my $element (@elements) {
1.186 albertel 5314: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5315: }
1.186 albertel 5316: if (defined($moreenv)) {
5317: %form=(%form,%{$moreenv});
5318: }
1.236 albertel 5319: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5320: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5321: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5322: $feedurl =~ s{^/adm/wrapper}{};
5323: }
1.650 www 5324: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5325: $userview=~s/\<body[^\>]*\>//gi;
5326: $userview=~s/\<\/body\>//gi;
5327: $userview=~s/\<html\>//gi;
5328: $userview=~s/\<\/html\>//gi;
5329: $userview=~s/\<head\>//gi;
5330: $userview=~s/\<\/head\>//gi;
5331: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5332: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5333: if (wantarray) {
5334: return ($userview,$response);
5335: } else {
5336: return $userview;
5337: }
5338: }
5339:
5340: sub get_student_view_with_retries {
5341: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5342:
5343: my $ok = 0; # True if we got a good response.
5344: my $content;
5345: my $response;
5346:
5347: # Try to get the student_view done. within the retries count:
5348:
5349: do {
5350: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5351: $ok = $response->is_success;
5352: if (!$ok) {
5353: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5354: }
5355: $retries--;
5356: } while (!$ok && ($retries > 0));
5357:
5358: if (!$ok) {
5359: $content = ''; # On error return an empty content.
5360: }
1.651 www 5361: if (wantarray) {
5362: return ($content, $response);
5363: } else {
5364: return $content;
5365: }
1.11 albertel 5366: }
5367:
1.1349 raeburn 5368: sub css_links {
5369: my ($currsymb,$level) = @_;
5370: my ($links,@symbs,%cssrefs,%httpref);
5371: if ($level eq 'map') {
5372: my $navmap = Apache::lonnavmaps::navmap->new();
5373: if (ref($navmap)) {
5374: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5375: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5376: foreach my $res (@resources) {
5377: if (ref($res) && $res->symb()) {
5378: push(@symbs,$res->symb());
5379: }
5380: }
5381: }
5382: } else {
5383: @symbs = ($currsymb);
5384: }
5385: foreach my $symb (@symbs) {
5386: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5387: if ($css_href =~ /\S/) {
5388: unless ($css_href =~ m{https?://}) {
5389: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5390: my $proburl = &Apache::lonnet::clutter($url);
5391: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5392: unless ($css_href =~ m{^/}) {
5393: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5394: }
5395: if ($css_href =~ m{^/(res|uploaded)/}) {
5396: unless (($httpref{'httpref.'.$css_href}) ||
5397: (&Apache::lonnet::is_on_map($css_href))) {
5398: my $thisurl = $proburl;
5399: if ($env{'httpref.'.$proburl}) {
5400: $thisurl = $env{'httpref.'.$proburl};
5401: }
5402: $httpref{'httpref.'.$css_href} = $thisurl;
5403: }
5404: }
5405: }
5406: $cssrefs{$css_href} = 1;
5407: }
5408: }
5409: if (keys(%httpref)) {
5410: &Apache::lonnet::appenv(\%httpref);
5411: }
5412: if (keys(%cssrefs)) {
5413: foreach my $css_href (keys(%cssrefs)) {
5414: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5415: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5416: }
5417: }
5418: return $links;
5419: }
5420:
1.112 bowersj2 5421: =pod
5422:
1.648 raeburn 5423: =item * &get_student_answers()
1.112 bowersj2 5424:
5425: show a snapshot of how student was answering problem
5426:
5427: =cut
5428:
1.11 albertel 5429: sub get_student_answers {
1.100 sakharuk 5430: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5431: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5432: my (%moreenv);
1.11 albertel 5433: my @elements=('symb','courseid','domain','username');
5434: foreach my $element (@elements) {
1.186 albertel 5435: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5436: }
1.186 albertel 5437: $moreenv{'grade_target'}='answer';
5438: %moreenv=(%form,%moreenv);
1.497 raeburn 5439: $feedurl = &Apache::lonnet::clutter($feedurl);
5440: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5441: return $userview;
1.1 albertel 5442: }
1.116 albertel 5443:
5444: =pod
5445:
5446: =item * &submlink()
5447:
1.242 albertel 5448: Inputs: $text $uname $udom $symb $target
1.116 albertel 5449:
5450: Returns: A link to grades.pm such as to see the SUBM view of a student
5451:
5452: =cut
5453:
5454: ###############################################
5455: sub submlink {
1.242 albertel 5456: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5457: if (!($uname && $udom)) {
5458: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5459: &Apache::lonnet::whichuser($symb);
1.116 albertel 5460: if (!$symb) { $symb=$cursymb; }
5461: }
1.254 matthew 5462: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5463: $symb=&escape($symb);
1.960 bisitz 5464: if ($target) { $target=" target=\"$target\""; }
5465: return
5466: '<a href="/adm/grades?command=submission'.
5467: '&symb='.$symb.
5468: '&student='.$uname.
5469: '&userdom='.$udom.'"'.
5470: $target.'>'.$text.'</a>';
1.242 albertel 5471: }
5472: ##############################################
5473:
5474: =pod
5475:
5476: =item * &pgrdlink()
5477:
5478: Inputs: $text $uname $udom $symb $target
5479:
5480: Returns: A link to grades.pm such as to see the PGRD view of a student
5481:
5482: =cut
5483:
5484: ###############################################
5485: sub pgrdlink {
5486: my $link=&submlink(@_);
5487: $link=~s/(&command=submission)/$1&showgrading=yes/;
5488: return $link;
5489: }
5490: ##############################################
5491:
5492: =pod
5493:
5494: =item * &pprmlink()
5495:
5496: Inputs: $text $uname $udom $symb $target
5497:
5498: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5499: student and a specific resource
1.242 albertel 5500:
5501: =cut
5502:
5503: ###############################################
5504: sub pprmlink {
5505: my ($text,$uname,$udom,$symb,$target)=@_;
5506: if (!($uname && $udom)) {
5507: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5508: &Apache::lonnet::whichuser($symb);
1.242 albertel 5509: if (!$symb) { $symb=$cursymb; }
5510: }
1.254 matthew 5511: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5512: $symb=&escape($symb);
1.242 albertel 5513: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5514: return '<a href="/adm/parmset?command=set&'.
5515: 'symb='.$symb.'&uname='.$uname.
5516: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5517: }
5518: ##############################################
1.37 matthew 5519:
1.112 bowersj2 5520: =pod
5521:
5522: =back
5523:
5524: =cut
5525:
1.37 matthew 5526: ###############################################
1.51 www 5527:
5528:
5529: sub timehash {
1.687 raeburn 5530: my ($thistime) = @_;
5531: my $timezone = &Apache::lonlocal::gettimezone();
5532: my $dt = DateTime->from_epoch(epoch => $thistime)
5533: ->set_time_zone($timezone);
5534: my $wday = $dt->day_of_week();
5535: if ($wday == 7) { $wday = 0; }
5536: return ( 'second' => $dt->second(),
5537: 'minute' => $dt->minute(),
5538: 'hour' => $dt->hour(),
5539: 'day' => $dt->day_of_month(),
5540: 'month' => $dt->month(),
5541: 'year' => $dt->year(),
5542: 'weekday' => $wday,
5543: 'dayyear' => $dt->day_of_year(),
5544: 'dlsav' => $dt->is_dst() );
1.51 www 5545: }
5546:
1.370 www 5547: sub utc_string {
5548: my ($date)=@_;
1.371 www 5549: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5550: }
5551:
1.51 www 5552: sub maketime {
5553: my %th=@_;
1.687 raeburn 5554: my ($epoch_time,$timezone,$dt);
5555: $timezone = &Apache::lonlocal::gettimezone();
5556: eval {
5557: $dt = DateTime->new( year => $th{'year'},
5558: month => $th{'month'},
5559: day => $th{'day'},
5560: hour => $th{'hour'},
5561: minute => $th{'minute'},
5562: second => $th{'second'},
5563: time_zone => $timezone,
5564: );
5565: };
5566: if (!$@) {
5567: $epoch_time = $dt->epoch;
5568: if ($epoch_time) {
5569: return $epoch_time;
5570: }
5571: }
1.51 www 5572: return POSIX::mktime(
5573: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5574: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5575: }
5576:
5577: #########################################
1.51 www 5578:
5579: sub findallcourses {
1.482 raeburn 5580: my ($roles,$uname,$udom) = @_;
1.355 albertel 5581: my %roles;
5582: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5583: my %courses;
1.51 www 5584: my $now=time;
1.482 raeburn 5585: if (!defined($uname)) {
5586: $uname = $env{'user.name'};
5587: }
5588: if (!defined($udom)) {
5589: $udom = $env{'user.domain'};
5590: }
5591: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5592: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5593: if (!%roles) {
5594: %roles = (
5595: cc => 1,
1.907 raeburn 5596: co => 1,
1.482 raeburn 5597: in => 1,
5598: ep => 1,
5599: ta => 1,
5600: cr => 1,
5601: st => 1,
5602: );
5603: }
5604: foreach my $entry (keys(%roleshash)) {
5605: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5606: if ($trole =~ /^cr/) {
5607: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5608: } else {
5609: next if (!exists($roles{$trole}));
5610: }
5611: if ($tend) {
5612: next if ($tend < $now);
5613: }
5614: if ($tstart) {
5615: next if ($tstart > $now);
5616: }
1.1058 raeburn 5617: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5618: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5619: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5620: if ($secpart eq '') {
5621: ($cnum,$role) = split(/_/,$cnumpart);
5622: $sec = 'none';
1.1058 raeburn 5623: $value .= $cnum.'/';
1.482 raeburn 5624: } else {
5625: $cnum = $cnumpart;
5626: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5627: $value .= $cnum.'/'.$sec;
5628: }
5629: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5630: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5631: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5632: }
5633: } else {
5634: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5635: }
1.482 raeburn 5636: }
5637: } else {
5638: foreach my $key (keys(%env)) {
1.483 albertel 5639: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5640: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5641: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5642: next if ($role eq 'ca' || $role eq 'aa');
5643: next if (%roles && !exists($roles{$role}));
5644: my ($starttime,$endtime)=split(/\./,$env{$key});
5645: my $active=1;
5646: if ($starttime) {
5647: if ($now<$starttime) { $active=0; }
5648: }
5649: if ($endtime) {
5650: if ($now>$endtime) { $active=0; }
5651: }
5652: if ($active) {
1.1058 raeburn 5653: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5654: if ($sec eq '') {
5655: $sec = 'none';
1.1058 raeburn 5656: } else {
5657: $value .= $sec;
5658: }
5659: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5660: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5661: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5662: }
5663: } else {
5664: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5665: }
1.474 raeburn 5666: }
5667: }
1.51 www 5668: }
5669: }
1.474 raeburn 5670: return %courses;
1.51 www 5671: }
1.37 matthew 5672:
1.54 www 5673: ###############################################
1.474 raeburn 5674:
5675: sub blockcheck {
1.1372 raeburn 5676: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5677: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5678: my ($has_evb,$check_ipaccess);
5679: my $dom = $env{'user.domain'};
5680: if ($env{'request.course.id'}) {
5681: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5682: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5683: my $checkrole = "cm./$cdom/$cnum";
5684: my $sec = $env{'request.course.sec'};
5685: if ($sec ne '') {
5686: $checkrole .= "/$sec";
5687: }
5688: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5689: ($env{'request.role'} !~ /^st/)) {
5690: $has_evb = 1;
5691: }
5692: unless ($has_evb) {
5693: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
5694: ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
5695: if ($udom eq $cdom) {
5696: $check_ipaccess = 1;
5697: }
5698: }
5699: }
1.1375 raeburn 5700: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5701: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5702: my $checkrole;
5703: if ($env{'request.role.domain'} eq '') {
5704: $checkrole = "cm./$env{'user.domain'}/";
5705: } else {
5706: $checkrole = "cm./$env{'request.role.domain'}/";
5707: }
5708: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5709: $has_evb = 1;
5710: }
1.1372 raeburn 5711: }
5712: unless ($has_evb || $check_ipaccess) {
5713: my @machinedoms = &Apache::lonnet::current_machine_domains();
5714: if (($dom eq 'public') && ($activity eq 'port')) {
5715: $dom = $udom;
5716: }
5717: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5718: $check_ipaccess = 1;
5719: } else {
5720: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5721: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5722: my $prim = &Apache::lonnet::domain($dom,'primary');
5723: my $intdom = &Apache::lonnet::internet_dom($prim);
5724: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5725: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5726: $check_ipaccess = 1;
5727: }
5728: }
5729: }
5730: }
5731: if ($check_ipaccess) {
5732: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5733: unless (defined($cached)) {
5734: my %domconfig =
5735: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5736: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5737: }
5738: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5739: foreach my $id (keys(%{$ipaccessref})) {
5740: if (ref($ipaccessref->{$id}) eq 'HASH') {
5741: my $range = $ipaccessref->{$id}->{'ip'};
5742: if ($range) {
5743: if (&Apache::lonnet::ip_match($clientip,$range)) {
5744: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5745: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5746: return ('','','',$id,$dom);
5747: last;
5748: }
5749: }
5750: }
5751: }
5752: }
5753: }
5754: }
5755: }
1.1373 raeburn 5756: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5757: return ();
5758: }
1.1372 raeburn 5759: }
1.1189 raeburn 5760: if (defined($udom) && defined($uname)) {
5761: # If uname and udom are for a course, check for blocks in the course.
5762: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5763: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5764: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5765: return ($startblock,$endblock,$triggerblock);
5766: }
5767: } else {
1.490 raeburn 5768: $udom = $env{'user.domain'};
5769: $uname = $env{'user.name'};
5770: }
5771:
1.502 raeburn 5772: my $startblock = 0;
5773: my $endblock = 0;
1.1062 raeburn 5774: my $triggerblock = '';
1.1373 raeburn 5775: my %live_courses;
5776: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5777: %live_courses = &findallcourses(undef,$uname,$udom);
5778: }
1.474 raeburn 5779:
1.490 raeburn 5780: # If uname is for a user, and activity is course-specific, i.e.,
5781: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5782:
1.490 raeburn 5783: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5784: $activity eq 'groups' || $activity eq 'printout' ||
1.1346 raeburn 5785: $activity eq 'search' || $activity eq 'reinit' ||
5786: $activity eq 'alert') &&
1.1189 raeburn 5787: ($env{'request.course.id'})) {
1.490 raeburn 5788: foreach my $key (keys(%live_courses)) {
5789: if ($key ne $env{'request.course.id'}) {
5790: delete($live_courses{$key});
5791: }
5792: }
5793: }
5794:
5795: my $otheruser = 0;
5796: my %own_courses;
5797: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5798: # Resource belongs to user other than current user.
5799: $otheruser = 1;
5800: # Gather courses for current user
5801: %own_courses =
5802: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5803: }
5804:
5805: # Gather active course roles - course coordinator, instructor,
5806: # exam proctor, ta, student, or custom role.
1.474 raeburn 5807:
5808: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5809: my ($cdom,$cnum);
5810: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5811: $cdom = $env{'course.'.$course.'.domain'};
5812: $cnum = $env{'course.'.$course.'.num'};
5813: } else {
1.490 raeburn 5814: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5815: }
5816: my $no_ownblock = 0;
5817: my $no_userblock = 0;
1.533 raeburn 5818: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5819: # Check if current user has 'evb' priv for this
5820: if (defined($own_courses{$course})) {
5821: foreach my $sec (keys(%{$own_courses{$course}})) {
5822: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5823: if ($sec ne 'none') {
5824: $checkrole .= '/'.$sec;
5825: }
5826: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5827: $no_ownblock = 1;
5828: last;
5829: }
5830: }
5831: }
5832: # if they have 'evb' priv and are currently not playing student
5833: next if (($no_ownblock) &&
5834: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5835: }
1.474 raeburn 5836: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5837: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5838: if ($sec ne 'none') {
1.482 raeburn 5839: $checkrole .= '/'.$sec;
1.474 raeburn 5840: }
1.490 raeburn 5841: if ($otheruser) {
5842: # Resource belongs to user other than current user.
5843: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5844: my (%allroles,%userroles);
5845: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5846: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5847: my ($trole,$tdom,$tnum,$tsec);
5848: if ($entry =~ /^cr/) {
5849: ($trole,$tdom,$tnum,$tsec) =
5850: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5851: } else {
5852: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5853: }
5854: my ($spec,$area,$trest);
5855: $area = '/'.$tdom.'/'.$tnum;
5856: $trest = $tnum;
5857: if ($tsec ne '') {
5858: $area .= '/'.$tsec;
5859: $trest .= '/'.$tsec;
5860: }
5861: $spec = $trole.'.'.$area;
5862: if ($trole =~ /^cr/) {
5863: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5864: $tdom,$spec,$trest,$area);
5865: } else {
5866: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5867: $tdom,$spec,$trest,$area);
5868: }
5869: }
1.1276 raeburn 5870: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5871: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5872: if ($1) {
5873: $no_userblock = 1;
5874: last;
5875: }
1.486 raeburn 5876: }
5877: }
1.490 raeburn 5878: } else {
5879: # Resource belongs to current user
5880: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5881: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5882: $no_ownblock = 1;
5883: last;
5884: }
1.474 raeburn 5885: }
5886: }
5887: # if they have the evb priv and are currently not playing student
1.482 raeburn 5888: next if (($no_ownblock) &&
1.491 albertel 5889: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5890: next if ($no_userblock);
1.474 raeburn 5891:
1.1303 raeburn 5892: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5893: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5894:
1.1062 raeburn 5895: my ($start,$end,$trigger) =
1.1347 raeburn 5896: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5897: if (($start != 0) &&
5898: (($startblock == 0) || ($startblock > $start))) {
5899: $startblock = $start;
1.1062 raeburn 5900: if ($trigger ne '') {
5901: $triggerblock = $trigger;
5902: }
1.502 raeburn 5903: }
5904: if (($end != 0) &&
5905: (($endblock == 0) || ($endblock < $end))) {
5906: $endblock = $end;
1.1062 raeburn 5907: if ($trigger ne '') {
5908: $triggerblock = $trigger;
5909: }
1.502 raeburn 5910: }
1.490 raeburn 5911: }
1.1062 raeburn 5912: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5913: }
5914:
5915: sub get_blocks {
1.1347 raeburn 5916: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5917: my $startblock = 0;
5918: my $endblock = 0;
1.1062 raeburn 5919: my $triggerblock = '';
1.490 raeburn 5920: my $course = $cdom.'_'.$cnum;
5921: $setters->{$course} = {};
5922: $setters->{$course}{'staff'} = [];
5923: $setters->{$course}{'times'} = [];
1.1062 raeburn 5924: $setters->{$course}{'triggers'} = [];
5925: my (@blockers,%triggered);
5926: my $now = time;
5927: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5928: if ($activity eq 'docs') {
1.1348 raeburn 5929: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5930: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5931: $blocked = 1;
5932: $nosymbcache = 1;
1.1348 raeburn 5933: $noenccheck = 1;
1.1347 raeburn 5934: }
1.1348 raeburn 5935: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5936: foreach my $block (@blockers) {
5937: if ($block =~ /^firstaccess____(.+)$/) {
5938: my $item = $1;
5939: my $type = 'map';
5940: my $timersymb = $item;
5941: if ($item eq 'course') {
5942: $type = 'course';
5943: } elsif ($item =~ /___\d+___/) {
5944: $type = 'resource';
5945: } else {
5946: $timersymb = &Apache::lonnet::symbread($item);
5947: }
5948: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5949: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5950: $triggered{$block} = {
5951: start => $start,
5952: end => $end,
5953: type => $type,
5954: };
5955: }
5956: }
5957: } else {
5958: foreach my $block (keys(%commblocks)) {
5959: if ($block =~ m/^(\d+)____(\d+)$/) {
5960: my ($start,$end) = ($1,$2);
5961: if ($start <= time && $end >= time) {
5962: if (ref($commblocks{$block}) eq 'HASH') {
5963: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5964: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5965: unless(grep(/^\Q$block\E$/,@blockers)) {
5966: push(@blockers,$block);
5967: }
5968: }
5969: }
5970: }
5971: }
5972: } elsif ($block =~ /^firstaccess____(.+)$/) {
5973: my $item = $1;
5974: my $timersymb = $item;
5975: my $type = 'map';
5976: if ($item eq 'course') {
5977: $type = 'course';
5978: } elsif ($item =~ /___\d+___/) {
5979: $type = 'resource';
5980: } else {
5981: $timersymb = &Apache::lonnet::symbread($item);
5982: }
5983: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5984: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5985: if ($start && $end) {
5986: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5987: if (ref($commblocks{$block}) eq 'HASH') {
5988: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5989: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5990: unless(grep(/^\Q$block\E$/,@blockers)) {
5991: push(@blockers,$block);
5992: $triggered{$block} = {
5993: start => $start,
5994: end => $end,
5995: type => $type,
5996: };
5997: }
5998: }
5999: }
1.1062 raeburn 6000: }
6001: }
1.490 raeburn 6002: }
1.1062 raeburn 6003: }
6004: }
6005: }
6006: foreach my $blocker (@blockers) {
6007: my ($staff_name,$staff_dom,$title,$blocks) =
6008: &parse_block_record($commblocks{$blocker});
6009: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
6010: my ($start,$end,$triggertype);
6011: if ($blocker =~ m/^(\d+)____(\d+)$/) {
6012: ($start,$end) = ($1,$2);
6013: } elsif (ref($triggered{$blocker}) eq 'HASH') {
6014: $start = $triggered{$blocker}{'start'};
6015: $end = $triggered{$blocker}{'end'};
6016: $triggertype = $triggered{$blocker}{'type'};
6017: }
6018: if ($start) {
6019: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6020: if ($triggertype) {
6021: push(@{$$setters{$course}{'triggers'}},$triggertype);
6022: } else {
6023: push(@{$$setters{$course}{'triggers'}},0);
6024: }
6025: if ( ($startblock == 0) || ($startblock > $start) ) {
6026: $startblock = $start;
6027: if ($triggertype) {
6028: $triggerblock = $blocker;
1.474 raeburn 6029: }
6030: }
1.1062 raeburn 6031: if ( ($endblock == 0) || ($endblock < $end) ) {
6032: $endblock = $end;
6033: if ($triggertype) {
6034: $triggerblock = $blocker;
6035: }
6036: }
1.474 raeburn 6037: }
6038: }
1.1062 raeburn 6039: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6040: }
6041:
6042: sub parse_block_record {
6043: my ($record) = @_;
6044: my ($setuname,$setudom,$title,$blocks);
6045: if (ref($record) eq 'HASH') {
6046: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6047: $title = &unescape($record->{'event'});
6048: $blocks = $record->{'blocks'};
6049: } else {
6050: my @data = split(/:/,$record,3);
6051: if (scalar(@data) eq 2) {
6052: $title = $data[1];
6053: ($setuname,$setudom) = split(/@/,$data[0]);
6054: } else {
6055: ($setuname,$setudom,$title) = @data;
6056: }
6057: $blocks = { 'com' => 'on' };
6058: }
6059: return ($setuname,$setudom,$title,$blocks);
6060: }
6061:
1.854 kalberla 6062: sub blocking_status {
1.1372 raeburn 6063: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6064: my %setters;
1.890 droeschl 6065:
1.1061 raeburn 6066: # check for active blocking
1.1372 raeburn 6067: if ($clientip eq '') {
6068: $clientip = &Apache::lonnet::get_requestor_ip();
6069: }
6070: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6071: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6072: my $blocked = 0;
1.1372 raeburn 6073: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6074: $blocked = 1;
6075: }
1.890 droeschl 6076:
1.1061 raeburn 6077: # caller just wants to know whether a block is active
6078: if (!wantarray) { return $blocked; }
6079:
6080: # build a link to a popup window containing the details
6081: my $querystring = "?activity=$activity";
1.1351 raeburn 6082: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6083: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6084: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6085: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6086: } elsif ($activity eq 'docs') {
1.1347 raeburn 6087: my $showurl = &Apache::lonenc::check_encrypt($url);
6088: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6089: if ($symb) {
6090: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6091: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6092: }
1.1062 raeburn 6093: }
1.1061 raeburn 6094:
6095: my $output .= <<'END_MYBLOCK';
6096: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6097: var options = "width=" + w + ",height=" + h + ",";
6098: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6099: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6100: var newWin = window.open(url, wdwName, options);
6101: newWin.focus();
6102: }
1.890 droeschl 6103: END_MYBLOCK
1.854 kalberla 6104:
1.1061 raeburn 6105: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6106:
1.1061 raeburn 6107: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6108: my $text = &mt('Communication Blocked');
1.1217 raeburn 6109: my $class = 'LC_comblock';
1.1062 raeburn 6110: if ($activity eq 'docs') {
6111: $text = &mt('Content Access Blocked');
1.1217 raeburn 6112: $class = '';
1.1063 raeburn 6113: } elsif ($activity eq 'printout') {
6114: $text = &mt('Printing Blocked');
1.1232 raeburn 6115: } elsif ($activity eq 'passwd') {
6116: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6117: } elsif ($activity eq 'grades') {
6118: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6119: } elsif ($activity eq 'search') {
6120: $text = &mt('Search Blocked');
1.1282 raeburn 6121: } elsif ($activity eq 'alert') {
6122: $text = &mt('Checking Critical Messages Blocked');
6123: } elsif ($activity eq 'reinit') {
6124: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6125: } elsif ($activity eq 'about') {
6126: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6127: } elsif ($activity eq 'wishlist') {
6128: $text = &mt('Access to Stored Links Blocked');
6129: } elsif ($activity eq 'annotate') {
6130: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6131: }
1.1061 raeburn 6132: $output .= <<"END_BLOCK";
1.1217 raeburn 6133: <div class='$class'>
1.869 kalberla 6134: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6135: title='$text'>
6136: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6137: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6138: title='$text'>$text</a>
1.867 kalberla 6139: </div>
6140:
6141: END_BLOCK
1.474 raeburn 6142:
1.1061 raeburn 6143: return ($blocked, $output);
1.854 kalberla 6144: }
1.490 raeburn 6145:
1.60 matthew 6146: ###############################################
6147:
1.682 raeburn 6148: sub check_ip_acc {
1.1201 raeburn 6149: my ($acc,$clientip)=@_;
1.682 raeburn 6150: &Apache::lonxml::debug("acc is $acc");
6151: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6152: return 1;
6153: }
1.1339 raeburn 6154: my ($ip,$allowed);
6155: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6156: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6157: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6158: } else {
1.1350 raeburn 6159: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6160: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6161: }
1.682 raeburn 6162:
6163: my $name;
1.1219 raeburn 6164: my %access = (
6165: allowfrom => 1,
6166: denyfrom => 0,
6167: );
6168: my @allows;
6169: my @denies;
6170: foreach my $item (split(',',$acc)) {
6171: $item =~ s/^\s*//;
6172: $item =~ s/\s*$//;
6173: my $pattern;
6174: if ($item =~ /^\!(.+)$/) {
6175: push(@denies,$1);
6176: } else {
6177: push(@allows,$item);
6178: }
6179: }
6180: my $numdenies = scalar(@denies);
6181: my $numallows = scalar(@allows);
6182: my $count = 0;
6183: foreach my $pattern (@denies,@allows) {
6184: $count ++;
6185: my $acctype = 'allowfrom';
6186: if ($count <= $numdenies) {
6187: $acctype = 'denyfrom';
6188: }
1.682 raeburn 6189: if ($pattern =~ /\*$/) {
6190: #35.8.*
6191: $pattern=~s/\*//;
1.1219 raeburn 6192: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6193: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6194: #35.8.3.[34-56]
6195: my $low=$2;
6196: my $high=$3;
6197: $pattern=$1;
6198: if ($ip =~ /^\Q$pattern\E/) {
6199: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6200: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6201: }
6202: } elsif ($pattern =~ /^\*/) {
6203: #*.msu.edu
6204: $pattern=~s/\*//;
6205: if (!defined($name)) {
6206: use Socket;
6207: my $netaddr=inet_aton($ip);
6208: ($name)=gethostbyaddr($netaddr,AF_INET);
6209: }
1.1219 raeburn 6210: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6211: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6212: #127.0.0.1
1.1219 raeburn 6213: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6214: } else {
6215: #some.name.com
6216: if (!defined($name)) {
6217: use Socket;
6218: my $netaddr=inet_aton($ip);
6219: ($name)=gethostbyaddr($netaddr,AF_INET);
6220: }
1.1219 raeburn 6221: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6222: }
6223: if ($allowed =~ /^(0|1)$/) { last; }
6224: }
6225: if ($allowed eq '') {
6226: if ($numdenies && !$numallows) {
6227: $allowed = 1;
6228: } else {
6229: $allowed = 0;
1.682 raeburn 6230: }
6231: }
6232: return $allowed;
6233: }
6234:
6235: ###############################################
6236:
1.60 matthew 6237: =pod
6238:
1.112 bowersj2 6239: =head1 Domain Template Functions
6240:
6241: =over 4
6242:
6243: =item * &determinedomain()
1.60 matthew 6244:
6245: Inputs: $domain (usually will be undef)
6246:
1.63 www 6247: Returns: Determines which domain should be used for designs
1.60 matthew 6248:
6249: =cut
1.54 www 6250:
1.60 matthew 6251: ###############################################
1.63 www 6252: sub determinedomain {
6253: my $domain=shift;
1.531 albertel 6254: if (! $domain) {
1.60 matthew 6255: # Determine domain if we have not been given one
1.893 raeburn 6256: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6257: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6258: if ($env{'request.role.domain'}) {
6259: $domain=$env{'request.role.domain'};
1.60 matthew 6260: }
6261: }
1.63 www 6262: return $domain;
6263: }
6264: ###############################################
1.517 raeburn 6265:
1.518 albertel 6266: sub devalidate_domconfig_cache {
6267: my ($udom)=@_;
6268: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6269: }
6270:
6271: # ---------------------- Get domain configuration for a domain
6272: sub get_domainconf {
6273: my ($udom) = @_;
6274: my $cachetime=1800;
6275: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6276: if (defined($cached)) { return %{$result}; }
6277:
6278: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6279: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6280: my (%designhash,%legacy);
1.518 albertel 6281: if (keys(%domconfig) > 0) {
6282: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6283: if (keys(%{$domconfig{'login'}})) {
6284: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6285: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6286: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6287: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6288: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6289: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6290: if ($key eq 'loginvia') {
6291: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6292: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6293: $designhash{$udom.'.login.loginvia'} = $server;
6294: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6295:
6296: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6297: } else {
6298: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6299: }
1.948 raeburn 6300: }
1.1208 raeburn 6301: } elsif ($key eq 'headtag') {
6302: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6303: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6304: }
1.946 raeburn 6305: }
1.1208 raeburn 6306: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6307: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6308: }
1.946 raeburn 6309: }
6310: }
6311: }
1.1366 raeburn 6312: } elsif ($key eq 'saml') {
6313: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6314: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6315: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6316: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6317: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6318: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6319: }
6320: }
6321: }
6322: }
1.946 raeburn 6323: } else {
6324: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6325: $designhash{$udom.'.login.'.$key.'_'.$img} =
6326: $domconfig{'login'}{$key}{$img};
6327: }
1.699 raeburn 6328: }
6329: } else {
6330: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6331: }
1.632 raeburn 6332: }
6333: } else {
6334: $legacy{'login'} = 1;
1.518 albertel 6335: }
1.632 raeburn 6336: } else {
6337: $legacy{'login'} = 1;
1.518 albertel 6338: }
6339: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6340: if (keys(%{$domconfig{'rolecolors'}})) {
6341: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6342: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6343: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6344: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6345: }
1.518 albertel 6346: }
6347: }
1.632 raeburn 6348: } else {
6349: $legacy{'rolecolors'} = 1;
1.518 albertel 6350: }
1.632 raeburn 6351: } else {
6352: $legacy{'rolecolors'} = 1;
1.518 albertel 6353: }
1.948 raeburn 6354: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6355: if ($domconfig{'autoenroll'}{'co-owners'}) {
6356: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6357: }
6358: }
1.632 raeburn 6359: if (keys(%legacy) > 0) {
6360: my %legacyhash = &get_legacy_domconf($udom);
6361: foreach my $item (keys(%legacyhash)) {
6362: if ($item =~ /^\Q$udom\E\.login/) {
6363: if ($legacy{'login'}) {
6364: $designhash{$item} = $legacyhash{$item};
6365: }
6366: } else {
6367: if ($legacy{'rolecolors'}) {
6368: $designhash{$item} = $legacyhash{$item};
6369: }
1.518 albertel 6370: }
6371: }
6372: }
1.632 raeburn 6373: } else {
6374: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6375: }
6376: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6377: $cachetime);
6378: return %designhash;
6379: }
6380:
1.632 raeburn 6381: sub get_legacy_domconf {
6382: my ($udom) = @_;
6383: my %legacyhash;
6384: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6385: my $designfile = $designdir.'/'.$udom.'.tab';
6386: if (-e $designfile) {
1.1317 raeburn 6387: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6388: while (my $line = <$fh>) {
6389: next if ($line =~ /^\#/);
6390: chomp($line);
6391: my ($key,$val)=(split(/\=/,$line));
6392: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6393: }
6394: close($fh);
6395: }
6396: }
1.1026 raeburn 6397: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6398: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6399: }
6400: return %legacyhash;
6401: }
6402:
1.63 www 6403: =pod
6404:
1.112 bowersj2 6405: =item * &domainlogo()
1.63 www 6406:
6407: Inputs: $domain (usually will be undef)
6408:
6409: Returns: A link to a domain logo, if the domain logo exists.
6410: If the domain logo does not exist, a description of the domain.
6411:
6412: =cut
1.112 bowersj2 6413:
1.63 www 6414: ###############################################
6415: sub domainlogo {
1.517 raeburn 6416: my $domain = &determinedomain(shift);
1.518 albertel 6417: my %designhash = &get_domainconf($domain);
1.517 raeburn 6418: # See if there is a logo
6419: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6420: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6421: if ($imgsrc =~ m{^/(adm|res)/}) {
6422: if ($imgsrc =~ m{^/res/}) {
6423: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6424: &Apache::lonnet::repcopy($local_name);
6425: }
6426: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6427: }
6428: my $alttext = $domain;
6429: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6430: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6431: }
6432: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6433: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6434: return &Apache::lonnet::domain($domain,'description');
1.59 www 6435: } else {
1.60 matthew 6436: return '';
1.59 www 6437: }
6438: }
1.63 www 6439: ##############################################
6440:
6441: =pod
6442:
1.112 bowersj2 6443: =item * &designparm()
1.63 www 6444:
6445: Inputs: $which parameter; $domain (usually will be undef)
6446:
6447: Returns: value of designparamter $which
6448:
6449: =cut
1.112 bowersj2 6450:
1.397 albertel 6451:
1.400 albertel 6452: ##############################################
1.397 albertel 6453: sub designparm {
6454: my ($which,$domain)=@_;
6455: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6456: return $env{'environment.color.'.$which};
1.96 www 6457: }
1.63 www 6458: $domain=&determinedomain($domain);
1.1016 raeburn 6459: my %domdesign;
6460: unless ($domain eq 'public') {
6461: %domdesign = &get_domainconf($domain);
6462: }
1.520 raeburn 6463: my $output;
1.517 raeburn 6464: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6465: $output = $domdesign{$domain.'.'.$which};
1.63 www 6466: } else {
1.520 raeburn 6467: $output = $defaultdesign{$which};
6468: }
6469: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6470: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6471: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6472: if ($output =~ m{^/res/}) {
6473: my $local_name = &Apache::lonnet::filelocation('',$output);
6474: &Apache::lonnet::repcopy($local_name);
6475: }
1.520 raeburn 6476: $output = &lonhttpdurl($output);
6477: }
1.63 www 6478: }
1.520 raeburn 6479: return $output;
1.63 www 6480: }
1.59 www 6481:
1.822 bisitz 6482: ##############################################
6483: =pod
6484:
1.832 bisitz 6485: =item * &authorspace()
6486:
1.1028 raeburn 6487: Inputs: $url (usually will be undef).
1.832 bisitz 6488:
1.1132 raeburn 6489: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6490: directory being viewed (or for which action is being taken).
6491: If $url is provided, and begins /priv/<domain>/<uname>
6492: the path will be that portion of the $context argument.
6493: Otherwise the path will be for the author space of the current
6494: user when the current role is author, or for that of the
6495: co-author/assistant co-author space when the current role
6496: is co-author or assistant co-author.
1.832 bisitz 6497:
6498: =cut
6499:
6500: sub authorspace {
1.1028 raeburn 6501: my ($url) = @_;
6502: if ($url ne '') {
6503: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6504: return $1;
6505: }
6506: }
1.832 bisitz 6507: my $caname = '';
1.1024 www 6508: my $cadom = '';
1.1028 raeburn 6509: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6510: ($cadom,$caname) =
1.832 bisitz 6511: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6512: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6513: $caname = $env{'user.name'};
1.1024 www 6514: $cadom = $env{'user.domain'};
1.832 bisitz 6515: }
1.1028 raeburn 6516: if (($caname ne '') && ($cadom ne '')) {
6517: return "/priv/$cadom/$caname/";
6518: }
6519: return;
1.832 bisitz 6520: }
6521:
6522: ##############################################
6523: =pod
6524:
1.822 bisitz 6525: =item * &head_subbox()
6526:
6527: Inputs: $content (contains HTML code with page functions, etc.)
6528:
6529: Returns: HTML div with $content
6530: To be included in page header
6531:
6532: =cut
6533:
6534: sub head_subbox {
6535: my ($content)=@_;
6536: my $output =
1.993 raeburn 6537: '<div class="LC_head_subbox">'
1.822 bisitz 6538: .$content
6539: .'</div>'
6540: }
6541:
6542: ##############################################
6543: =pod
6544:
6545: =item * &CSTR_pageheader()
6546:
1.1026 raeburn 6547: Input: (optional) filename from which breadcrumb trail is built.
6548: In most cases no input as needed, as $env{'request.filename'}
6549: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6550: frameset flag
6551: If page header is being requested for use in a frameset, then
6552: the second (option) argument -- frameset will be true, and
6553: the target attribute set for links should be target="_parent".
1.1433 raeburn 6554: If $title is supplied as the third arg, that will be used to
1.1407 raeburn 6555: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6556:
6557: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6558: To be included on Authoring Space pages
1.822 bisitz 6559:
6560: =cut
6561:
6562: sub CSTR_pageheader {
1.1407 raeburn 6563: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6564: if ($trailfile eq '') {
6565: $trailfile = $env{'request.filename'};
6566: }
6567:
6568: # this is for resources; directories have customtitle, and crumbs
6569: # and select recent are created in lonpubdir.pm
6570:
6571: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6572: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6573: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6574: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6575: $formaction =~ s{/+}{/}g;
1.822 bisitz 6576:
6577: my $parentpath = '';
6578: my $lastitem = '';
6579: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6580: $parentpath = $1;
6581: $lastitem = $2;
6582: } else {
6583: $lastitem = $thisdisfn;
6584: }
1.921 bisitz 6585:
1.1406 raeburn 6586: my $crsauthor;
1.1246 raeburn 6587: if (($env{'request.course.id'}) &&
6588: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6589: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6590: $crsauthor = 1;
1.1406 raeburn 6591: if ($title eq '') {
6592: $title = &mt('Course Authoring Space');
6593: }
6594: } elsif ($title eq '') {
1.1246 raeburn 6595: $title = &mt('Authoring Space');
6596: }
6597:
1.1379 raeburn 6598: my ($target,$crumbtarget) = (' target="_top"','_top');
6599: if ($frameset) {
6600: $target = ' target="_parent"';
6601: $crumbtarget = '_parent';
6602: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6603: $target = '';
6604: $crumbtarget = '';
1.1379 raeburn 6605: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6606: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6607: $crumbtarget = $env{'request.deeplink.target'};
6608: }
1.1313 raeburn 6609:
1.921 bisitz 6610: my $output =
1.1407 raeburn 6611: '<div>'
1.822 bisitz 6612: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6613: .'<b>'.$title.'</b> '
1.1314 raeburn 6614: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6615: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6616:
6617: if ($lastitem) {
6618: $output .=
6619: '<span class="LC_filename">'
6620: .$lastitem
6621: .'</span>';
6622: }
1.1245 raeburn 6623:
1.1246 raeburn 6624: if ($crsauthor) {
1.1379 raeburn 6625: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6626: } else {
6627: $output .=
6628: '<br />'
1.1314 raeburn 6629: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6630: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6631: .'</form>'
1.1379 raeburn 6632: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6633: }
1.1407 raeburn 6634: $output .= '</div>';
1.921 bisitz 6635:
6636: return $output;
1.822 bisitz 6637: }
6638:
1.1419 raeburn 6639: ##############################################
6640: =pod
6641:
6642: =item * &nocodemirror()
6643:
6644: Input: None
6645:
6646: Returns: 1 if CodeMirror is deactivated based on
6647: user's preference, or domain default,
6648: if user indicated use of default.
6649:
6650: =cut
6651:
1.1416 raeburn 6652: sub nocodemirror {
6653: my $nocodem = $env{'environment.nocodemirror'};
6654: unless ($nocodem) {
6655: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6656: if ($domdefs{'nocodemirror'}) {
6657: $nocodem = 'yes';
6658: }
6659: }
1.1417 raeburn 6660: if ($nocodem eq 'yes') {
6661: return 1;
6662: }
6663: return;
1.1416 raeburn 6664: }
6665:
1.1419 raeburn 6666: ##############################################
6667: =pod
6668:
6669: =item * &permitted_editors()
6670:
1.1422 raeburn 6671: Input: $uri (optional)
1.1419 raeburn 6672:
6673: Returns: %editors hash in which keys are editors
1.1429 raeburn 6674: permitted in current Authoring Space,
6675: or in current course for web pages
6676: created in a course.
6677:
1.1419 raeburn 6678: Value for each key is 1. Possible keys
1.1429 raeburn 6679: are: edit, xml, and daxe.
6680:
6681: For a regular Authoring Space, if no specific
1.1419 raeburn 6682: set of editors has been set for the Author
6683: who owns the Authoring Space, then the
6684: domain default will be used. If no domain
6685: default has been set, then the keys will be
6686: edit and xml.
6687:
1.1429 raeburn 6688: For a course author, or for web pages created
6689: in a course, if no specific set of editors has
6690: been set for the course, then the domain
6691: course default will be used. If no domain
6692: course default has been set, then the keys
6693: will be edit and xml.
6694:
1.1419 raeburn 6695: =cut
6696:
1.1418 raeburn 6697: sub permitted_editors {
1.1422 raeburn 6698: my ($uri) = @_;
1.1429 raeburn 6699: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6700: if ($env{'request.role'} =~ m{^au\./}) {
6701: $is_author = 1;
6702: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6703: ($audom,$auname) = ($1,$2);
6704: if (($audom ne '') && ($auname ne '')) {
6705: if (($env{'user.domain'} eq $audom) &&
6706: ($env{'user.name'} eq $auname)) {
6707: $is_author = 1;
6708: } else {
6709: $is_coauthor = 1;
6710: }
6711: }
6712: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6713: my ($cdom,$cnum);
6714: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6715: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6716: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6717: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6718: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6719: $is_course = 1;
6720: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6721: ($audom,$auname) = ($1,$2);
6722: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6723: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6724: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6725: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6726: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6727: $is_course = 1;
6728: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6729: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6730: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6731: }
1.1429 raeburn 6732: unless ($is_course) {
6733: if (($audom ne '') && ($auname ne '')) {
6734: if (($env{'user.domain'} eq $audom) &&
6735: ($env{'user.name'} eq $auname)) {
6736: $is_author = 1;
6737: } else {
6738: $is_coauthor = 1;
6739: }
1.1418 raeburn 6740: }
6741: }
6742: }
6743: if ($is_author) {
6744: if (exists($env{'environment.editors'})) {
6745: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6746: } else {
6747: %editors = ( edit => 1,
6748: xml => 1,
6749: );
6750: }
6751: } elsif ($is_coauthor) {
6752: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6753: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6754: } else {
6755: %editors = ( edit => 1,
6756: xml => 1,
6757: );
6758: }
1.1429 raeburn 6759: } elsif ($is_course) {
6760: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6761: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6762: } else {
6763: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6764: if (exists($domdefaults{'crseditors'})) {
6765: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6766: } else {
6767: %editors = ( edit => 1,
6768: xml => 1,
6769: );
6770: }
6771: }
1.1418 raeburn 6772: } else {
6773: %editors = ( edit => 1,
6774: xml => 1,
6775: );
6776: }
6777: return %editors;
6778: }
6779:
1.60 matthew 6780: ###############################################
6781: ###############################################
6782:
6783: =pod
6784:
1.112 bowersj2 6785: =back
6786:
1.549 albertel 6787: =head1 HTML Helpers
1.112 bowersj2 6788:
6789: =over 4
6790:
6791: =item * &bodytag()
1.60 matthew 6792:
6793: Returns a uniform header for LON-CAPA web pages.
6794:
6795: Inputs:
6796:
1.112 bowersj2 6797: =over 4
6798:
6799: =item * $title, A title to be displayed on the page.
6800:
6801: =item * $function, the current role (can be undef).
6802:
6803: =item * $addentries, extra parameters for the <body> tag.
6804:
6805: =item * $bodyonly, if defined, only return the <body> tag.
6806:
6807: =item * $domain, if defined, force a given domain.
6808:
6809: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6810: text interface only)
1.60 matthew 6811:
1.814 bisitz 6812: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6813: navigational links
1.317 albertel 6814:
1.338 albertel 6815: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6816:
1.460 albertel 6817: =item * $args, optional argument valid values are
6818: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6819: use_absolute -> for external resource or syllabus, this will
6820: contain https://<hostname> if server uses
6821: https (as per hosts.tab), but request is for http
6822: hostname -> hostname, from $r->hostname().
1.460 albertel 6823:
1.1096 raeburn 6824: =item * $advtoolsref, optional argument, ref to an array containing
6825: inlineremote items to be added in "Functions" menu below
6826: breadcrumbs.
6827:
1.1316 raeburn 6828: =item * $ltiscope, optional argument, will be one of: resource, map or
6829: course, if LON-CAPA is in LTI Provider context. Value is
6830: the scope of use, i.e., launch was for access to a single, a map
6831: or the entire course.
6832:
6833: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6834: context, this will contain the URL for the landing item in
6835: the course, after launch from an LTI Consumer
6836:
1.1318 raeburn 6837: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6838: context, this will contain a reference to hash of items
6839: to be included in the page header and/or inline menu.
6840:
1.1385 raeburn 6841: =item * $menucoll, optional argument, if specific menu collection is in
6842: effect, either set as the default for the course, or set for
6843: the deeplink paramater for $env{'request.deeplink.login'}
6844: then $menucoll will be the number of that collection.
6845:
6846: =item * $menuref, optional argument, reference to a hash, containing the
6847: menu options included for the menu in effect, based on the
6848: configuration for the numbered menu collection in use.
6849:
6850: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6851: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6852: if so, $showncrumbsref is set there to 1, and will propagate back
6853: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6854: being called a second time.
6855:
1.112 bowersj2 6856: =back
6857:
1.60 matthew 6858: Returns: A uniform header for LON-CAPA web pages.
6859: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6860: If $bodyonly is undef or zero, an html string containing a <body> tag and
6861: other decorations will be returned.
6862:
6863: =cut
6864:
1.54 www 6865: sub bodytag {
1.831 bisitz 6866: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6867: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6868: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6869:
1.954 raeburn 6870: my $public;
6871: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6872: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6873: $public = 1;
6874: }
1.460 albertel 6875: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6876: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6877: my $hostname = $args->{'hostname'};
1.339 albertel 6878:
1.183 matthew 6879: $function = &get_users_function() if (!$function);
1.339 albertel 6880: my $font = &designparm($function.'.font',$domain);
6881: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6882:
1.803 bisitz 6883: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6884: 'bgcolor' => $pgbg,
1.339 albertel 6885: 'text' => $font,
6886: 'alink' => &designparm($function.'.alink',$domain),
6887: 'vlink' => &designparm($function.'.vlink',$domain),
6888: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6889: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6890:
1.63 www 6891: # role and realm
1.1178 raeburn 6892: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6893: if ($realm) {
6894: $realm = '/'.$realm;
6895: }
1.1357 raeburn 6896: if ($role eq 'ca') {
1.479 albertel 6897: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6898: $realm = &plainname($rname,$rdom);
1.378 raeburn 6899: }
1.55 www 6900: # realm
1.1357 raeburn 6901: my ($cid,$sec);
1.258 albertel 6902: if ($env{'request.course.id'}) {
1.1357 raeburn 6903: $cid = $env{'request.course.id'};
6904: if ($env{'request.course.sec'}) {
6905: $sec = $env{'request.course.sec'};
6906: }
6907: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6908: if (&Apache::lonnet::is_course($1,$2)) {
6909: $cid = $1.'_'.$2;
6910: $sec = $3;
6911: }
6912: }
6913: if ($cid) {
1.378 raeburn 6914: if ($env{'request.role'} !~ /^cr/) {
6915: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6916: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6917: if ($env{'request.role.desc'}) {
6918: $role = $env{'request.role.desc'};
6919: } else {
6920: $role = &mt('Helpdesk[_1]',' '.$2);
6921: }
1.1257 raeburn 6922: } else {
6923: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6924: }
1.1357 raeburn 6925: if ($sec) {
6926: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6927: }
1.1357 raeburn 6928: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6929: } else {
6930: $role = &Apache::lonnet::plaintext($role);
1.54 www 6931: }
1.433 albertel 6932:
1.359 albertel 6933: if (!$realm) { $realm=' '; }
1.330 albertel 6934:
1.438 albertel 6935: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6936:
1.101 www 6937: # construct main body tag
1.359 albertel 6938: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6939: &Apache::lontexconvert::init_math_support();
1.252 albertel 6940:
1.1131 raeburn 6941: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6942:
1.1130 raeburn 6943: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6944: return $bodytag;
1.1130 raeburn 6945: }
1.359 albertel 6946:
1.954 raeburn 6947: if ($public) {
1.433 albertel 6948: undef($role);
6949: }
1.1318 raeburn 6950:
1.1359 raeburn 6951: my $showcrstitle = 1;
1.1357 raeburn 6952: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6953: if (ref($ltimenu) eq 'HASH') {
6954: unless ($ltimenu->{'role'}) {
6955: undef($role);
6956: }
6957: unless ($ltimenu->{'coursetitle'}) {
6958: $realm=' ';
1.1359 raeburn 6959: $showcrstitle = 0;
6960: }
6961: }
6962: } elsif (($cid) && ($menucoll)) {
6963: if (ref($menuref) eq 'HASH') {
6964: unless ($menuref->{'role'}) {
6965: undef($role);
6966: }
6967: unless ($menuref->{'crs'}) {
6968: $realm=' ';
6969: $showcrstitle = 0;
1.1318 raeburn 6970: }
6971: }
6972: }
6973:
1.762 bisitz 6974: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6975: #
6976: # Extra info if you are the DC
6977: my $dc_info = '';
1.1359 raeburn 6978: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6979: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6980: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6981: $dc_info =~ s/\s+$//;
1.359 albertel 6982: }
6983:
1.1237 raeburn 6984: my $crstype;
1.1357 raeburn 6985: if ($cid) {
6986: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6987: } elsif ($args->{'crstype'}) {
6988: $crstype = $args->{'crstype'};
6989: }
6990: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6991: undef($role);
6992: } else {
1.1242 raeburn 6993: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6994: }
1.853 droeschl 6995:
1.903 droeschl 6996: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6997:
6998: # if ($env{'request.state'} eq 'construct') {
6999: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7000: # }
7001:
1.1440 raeburn 7002: my $need_endlcint;
7003: unless ($args->{'switchserver'}) {
7004: $bodytag .= Apache::lonhtmlcommon::scripttag(
7005: Apache::lonmenu::utilityfunctions($httphost), 'start');
7006: $need_endlcint = 1;
7007: }
1.359 albertel 7008:
1.1427 raeburn 7009: my $collapsible;
1.1423 raeburn 7010: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7011: $collapsible = 1;
7012: my ($menustate,$tiptext,$divclass);
7013: if ($args->{'start_collapsed'}) {
7014: $menustate = 'collapsed';
7015: $tiptext = 'display';
7016: $divclass = 'hidden';
7017: } else {
7018: $menustate = 'expanded';
7019: $tiptext = 'hide';
7020: $divclass = 'shown';
7021: }
7022: my $alttext = &mt('menu state: '.$menustate);
7023: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7024: $bodytag .= <<"END";
7025: <div id="LC_expandingContainer" style="display:inline;">
7026: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7027: <a href="#" style="text-decoration:none;"><img class="LC_collapsible_indicator" alt="$alttext" title="$tooltip" src="/res/adm/pages/$menustate.png" style="border:0;margin:0;padding:0;max-width:100%;height:auto" /></a></div>
7028: <div class="LC_menus_content $divclass">
1.1421 raeburn 7029: END
7030: }
1.1318 raeburn 7031: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7032: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7033: $args->{'links_disabled'},
1.1421 raeburn 7034: $args->{'links_target'},
1.1427 raeburn 7035: $collapsible);
1.359 albertel 7036:
1.1318 raeburn 7037: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7038: if ($dc_info) {
7039: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7040: }
7041: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7042: <em>$realm</em> $dc_info</div>|;
1.1440 raeburn 7043: if ($need_endlcint) {
7044: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7045: }
1.1318 raeburn 7046: return $bodytag;
7047: }
1.894 droeschl 7048:
1.1318 raeburn 7049: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7050: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7051: }
1.916 droeschl 7052:
1.1318 raeburn 7053: $bodytag .= $right;
1.852 droeschl 7054:
1.1318 raeburn 7055: if ($dc_info) {
7056: $dc_info = &dc_courseid_toggle($dc_info);
7057: }
7058: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7059: }
1.916 droeschl 7060:
1.1169 raeburn 7061: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7062: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7063: if ($need_endlcint) {
7064: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7065: }
1.1168 raeburn 7066: return $bodytag;
7067: }
1.1169 raeburn 7068: #don't show menus for public users
1.954 raeburn 7069: if (!$public){
1.1318 raeburn 7070: unless ($args->{'no_inline_menu'}) {
7071: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7072: $args->{'no_primary_menu'},
1.1369 raeburn 7073: $menucoll,$menuref,
1.1380 raeburn 7074: $args->{'links_disabled'},
7075: $args->{'links_target'});
1.1318 raeburn 7076: }
1.903 droeschl 7077: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7078: if ($need_endlcint) {
7079: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7080: }
1.920 raeburn 7081: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7082: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7083: $args->{'bread_crumbs'},'','',$hostname,
7084: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7085: } elsif ($forcereg) {
7086: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7087: $args->{'group'},$args->{'hide_buttons'},
7088: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7089: } else {
7090: $bodytag .=
7091: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7092: $forcereg,$args->{'group'},
7093: $args->{'bread_crumbs'},
1.1274 raeburn 7094: $advtoolsref,'',$hostname);
1.920 raeburn 7095: }
1.1440 raeburn 7096: } else {
7097: # this is to separate menu from content when there's no secondary
1.1441 raeburn 7098: # menu. Especially needed for publicly accessible resources.
1.903 droeschl 7099: $bodytag .= '<hr style="clear:both" />';
1.1440 raeburn 7100: if ($need_endlcint) {
7101: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7102: }
1.235 raeburn 7103: }
1.1423 raeburn 7104: if ($args->{'collapsible_header'} ne '') {
7105: $bodytag .= $args->{'collapsible_header'}.
7106: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7107: '</div></div>';
7108: }
1.235 raeburn 7109: return $bodytag;
1.182 matthew 7110: }
7111:
1.917 raeburn 7112: sub dc_courseid_toggle {
7113: my ($dc_info) = @_;
1.980 raeburn 7114: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7115: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7116: &mt('(More ...)').'</a></span>'.
7117: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7118: }
7119:
1.330 albertel 7120: sub make_attr_string {
7121: my ($register,$attr_ref) = @_;
7122:
7123: if ($attr_ref && !ref($attr_ref)) {
7124: die("addentries Must be a hash ref ".
7125: join(':',caller(1))." ".
7126: join(':',caller(0))." ");
7127: }
7128:
7129: if ($register) {
1.339 albertel 7130: my ($on_load,$on_unload);
7131: foreach my $key (keys(%{$attr_ref})) {
7132: if (lc($key) eq 'onload') {
7133: $on_load.=$attr_ref->{$key}.';';
7134: delete($attr_ref->{$key});
7135:
7136: } elsif (lc($key) eq 'onunload') {
7137: $on_unload.=$attr_ref->{$key}.';';
7138: delete($attr_ref->{$key});
7139: }
7140: }
1.953 droeschl 7141: $attr_ref->{'onload'} = $on_load;
7142: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7143: }
1.339 albertel 7144:
1.330 albertel 7145: my $attr_string;
1.1159 raeburn 7146: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7147: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7148: }
7149: return $attr_string;
7150: }
7151:
7152:
1.182 matthew 7153: ###############################################
1.251 albertel 7154: ###############################################
7155:
7156: =pod
7157:
7158: =item * &endbodytag()
7159:
7160: Returns a uniform footer for LON-CAPA web pages.
7161:
1.635 raeburn 7162: Inputs: 1 - optional reference to an args hash
7163: If in the hash, key for noredirectlink has a value which evaluates to true,
7164: a 'Continue' link is not displayed if the page contains an
7165: internal redirect in the <head></head> section,
7166: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7167:
7168: =cut
7169:
7170: sub endbodytag {
1.635 raeburn 7171: my ($args) = @_;
1.1080 raeburn 7172: my $endbodytag;
7173: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7174: $endbodytag='</body>';
7175: }
1.315 albertel 7176: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7177: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7178: my ($endbodyjs,$idattr);
7179: if ($env{'internal.head.to_opener'}) {
7180: my $linkid = 'LC_continue_link';
7181: $idattr = ' id="'.$linkid.'"';
7182: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7183: $endbodyjs=<<ENDJS;
7184: <script type="text/javascript">
7185: // <![CDATA[
7186: function ebFunction(evt) {
7187: evt.preventDefault();
7188: var dest = '$redirect_for_js';
7189: if (window.opener != null && !window.opener.closed) {
7190: window.opener.location.href=dest;
7191: window.close();
7192: } else {
7193: window.location.href=dest;
7194: }
7195: return false;
7196: }
7197:
7198: \$(document).ready(function () {
7199: if (document.getElementById('$linkid')) {
7200: var clickelem = document.getElementById('$linkid');
7201: clickelem.addEventListener('click',ebFunction,false);
7202: }
7203: });
7204: // ]]>
7205: </script>
7206: ENDJS
7207: }
1.635 raeburn 7208: $endbodytag=
1.1386 raeburn 7209: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7210: &mt('Continue').'</a>'.
7211: $endbodytag;
7212: }
1.315 albertel 7213: }
1.1411 raeburn 7214: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7215: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7216: }
1.251 albertel 7217: return $endbodytag;
7218: }
7219:
1.352 albertel 7220: =pod
7221:
7222: =item * &standard_css()
7223:
7224: Returns a style sheet
7225:
7226: Inputs: (all optional)
7227: domain -> force to color decorate a page for a specific
7228: domain
7229: function -> force usage of a specific rolish color scheme
7230: bgcolor -> override the default page bgcolor
7231:
7232: =cut
7233:
1.343 albertel 7234: sub standard_css {
1.345 albertel 7235: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7236: $function = &get_users_function() if (!$function);
7237: my $tabbg = &designparm($function.'.tabbg', $domain);
7238: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7239: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7240: #second colour for later usage
1.345 albertel 7241: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7242: my $pgbg_or_bgcolor =
7243: $bgcolor ||
1.352 albertel 7244: &designparm($function.'.pgbg', $domain);
1.382 albertel 7245: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7246: my $alink = &designparm($function.'.alink', $domain);
7247: my $vlink = &designparm($function.'.vlink', $domain);
7248: my $link = &designparm($function.'.link', $domain);
7249:
1.602 albertel 7250: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7251: my $mono = 'monospace';
1.850 bisitz 7252: my $data_table_head = $sidebg;
7253: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7254: my $data_table_dark = '#E0E0E0';
1.470 banghart 7255: my $data_table_darker = '#CCCCCC';
1.349 albertel 7256: my $data_table_highlight = '#FFFF00';
1.352 albertel 7257: my $mail_new = '#FFBB77';
7258: my $mail_new_hover = '#DD9955';
7259: my $mail_read = '#BBBB77';
7260: my $mail_read_hover = '#999944';
7261: my $mail_replied = '#AAAA88';
7262: my $mail_replied_hover = '#888855';
7263: my $mail_other = '#99BBBB';
7264: my $mail_other_hover = '#669999';
1.391 albertel 7265: my $table_header = '#DDDDDD';
1.489 raeburn 7266: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7267: my $lg_border_color = '#C8C8C8';
1.952 onken 7268: my $button_hover = '#BF2317';
1.392 albertel 7269:
1.608 albertel 7270: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7271: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7272: : '0 3px 0 4px';
1.448 albertel 7273:
1.523 albertel 7274:
1.343 albertel 7275: return <<END;
1.947 droeschl 7276:
7277: /* needed for iframe to allow 100% height in FF */
7278: body, html {
7279: margin: 0;
7280: padding: 0 0.5%;
7281: height: 99%; /* to avoid scrollbars */
7282: }
7283:
1.795 www 7284: body {
1.911 bisitz 7285: font-family: $sans;
7286: line-height:130%;
7287: font-size:0.83em;
7288: color:$font;
1.1436 raeburn 7289: background-color: $pgbg_or_bgcolor;
1.795 www 7290: }
7291:
1.959 onken 7292: a:focus,
7293: a:focus img {
1.795 www 7294: color: red;
7295: }
1.698 harmsja 7296:
1.911 bisitz 7297: form, .inline {
7298: display: inline;
1.795 www 7299: }
1.721 harmsja 7300:
1.1421 raeburn 7301: .LC_menus_content.shown{
1.1428 raeburn 7302: display: block;
1.1421 raeburn 7303: }
7304:
7305: .LC_menus_content.hidden {
7306: display: none;
7307: }
7308:
1.795 www 7309: .LC_right {
1.911 bisitz 7310: text-align:right;
1.795 www 7311: }
7312:
7313: .LC_middle {
1.911 bisitz 7314: vertical-align:middle;
1.795 www 7315: }
1.721 harmsja 7316:
1.1130 raeburn 7317: .LC_floatleft {
7318: float: left;
7319: }
7320:
7321: .LC_floatright {
7322: float: right;
7323: }
7324:
1.911 bisitz 7325: .LC_400Box {
7326: width:400px;
7327: }
1.721 harmsja 7328:
1.1421 raeburn 7329: #LC_collapsible_separator {
7330: border: 1px solid black;
7331: width: 99.9%;
7332: height: 0px;
7333: }
7334:
1.947 droeschl 7335: .LC_iframecontainer {
7336: width: 98%;
7337: margin: 0;
7338: position: fixed;
7339: top: 8.5em;
7340: bottom: 0;
7341: }
7342:
7343: .LC_iframecontainer iframe{
7344: border: none;
7345: width: 100%;
7346: height: 100%;
7347: }
7348:
1.778 bisitz 7349: .LC_filename {
7350: font-family: $mono;
7351: white-space:pre;
1.921 bisitz 7352: font-size: 120%;
1.778 bisitz 7353: }
7354:
7355: .LC_fileicon {
7356: border: none;
7357: height: 1.3em;
7358: vertical-align: text-bottom;
7359: margin-right: 0.3em;
7360: text-decoration:none;
7361: }
7362:
1.1008 www 7363: .LC_setting {
7364: text-decoration:underline;
7365: }
7366:
1.350 albertel 7367: .LC_error {
7368: color: red;
7369: }
1.795 www 7370:
1.1097 bisitz 7371: .LC_warning {
7372: color: darkorange;
7373: }
7374:
1.457 albertel 7375: .LC_diff_removed {
1.733 bisitz 7376: color: red;
1.394 albertel 7377: }
1.532 albertel 7378:
7379: .LC_info,
1.457 albertel 7380: .LC_success,
7381: .LC_diff_added {
1.350 albertel 7382: color: green;
7383: }
1.795 www 7384:
1.802 bisitz 7385: div.LC_confirm_box {
7386: background-color: #FAFAFA;
7387: border: 1px solid $lg_border_color;
7388: margin-right: 0;
7389: padding: 5px;
7390: }
7391:
7392: div.LC_confirm_box .LC_error img,
7393: div.LC_confirm_box .LC_success img {
7394: vertical-align: middle;
7395: }
7396:
1.1242 raeburn 7397: .LC_maxwidth {
7398: max-width: 100%;
7399: height: auto;
7400: }
7401:
1.1243 raeburn 7402: .LC_textsize_mobile {
7403: \@media only screen and (max-device-width: 480px) {
7404: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7405: }
7406: }
7407:
1.440 albertel 7408: .LC_icon {
1.771 droeschl 7409: border: none;
1.790 droeschl 7410: vertical-align: middle;
1.771 droeschl 7411: }
7412:
1.543 albertel 7413: .LC_docs_spacer {
7414: width: 25px;
7415: height: 1px;
1.771 droeschl 7416: border: none;
1.543 albertel 7417: }
1.346 albertel 7418:
1.532 albertel 7419: .LC_internal_info {
1.735 bisitz 7420: color: #999999;
1.532 albertel 7421: }
7422:
1.794 www 7423: .LC_discussion {
1.1050 www 7424: background: $data_table_dark;
1.911 bisitz 7425: border: 1px solid black;
7426: margin: 2px;
1.794 www 7427: }
7428:
7429: .LC_disc_action_left {
1.1050 www 7430: background: $sidebg;
1.911 bisitz 7431: text-align: left;
1.1050 www 7432: padding: 4px;
7433: margin: 2px;
1.794 www 7434: }
7435:
7436: .LC_disc_action_right {
1.1050 www 7437: background: $sidebg;
1.911 bisitz 7438: text-align: right;
1.1050 www 7439: padding: 4px;
7440: margin: 2px;
1.794 www 7441: }
7442:
7443: .LC_disc_new_item {
1.911 bisitz 7444: background: white;
7445: border: 2px solid red;
1.1050 www 7446: margin: 4px;
7447: padding: 4px;
1.794 www 7448: }
7449:
7450: .LC_disc_old_item {
1.911 bisitz 7451: background: white;
1.1050 www 7452: margin: 4px;
7453: padding: 4px;
1.794 www 7454: }
7455:
1.458 albertel 7456: table.LC_pastsubmission {
7457: border: 1px solid black;
7458: margin: 2px;
7459: }
7460:
1.924 bisitz 7461: table#LC_menubuttons {
1.345 albertel 7462: width: 100%;
7463: background: $pgbg;
1.392 albertel 7464: border: 2px;
1.402 albertel 7465: border-collapse: separate;
1.803 bisitz 7466: padding: 0;
1.345 albertel 7467: }
1.392 albertel 7468:
1.801 tempelho 7469: table#LC_title_bar a {
7470: color: $fontmenu;
7471: }
1.836 bisitz 7472:
1.807 droeschl 7473: table#LC_title_bar {
1.819 tempelho 7474: clear: both;
1.836 bisitz 7475: display: none;
1.807 droeschl 7476: }
7477:
1.795 www 7478: table#LC_title_bar,
1.933 droeschl 7479: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7480: table#LC_title_bar.LC_with_remote {
1.359 albertel 7481: width: 100%;
1.392 albertel 7482: border-color: $pgbg;
7483: border-style: solid;
7484: border-width: $border;
1.379 albertel 7485: background: $pgbg;
1.801 tempelho 7486: color: $fontmenu;
1.392 albertel 7487: border-collapse: collapse;
1.803 bisitz 7488: padding: 0;
1.819 tempelho 7489: margin: 0;
1.359 albertel 7490: }
1.795 www 7491:
1.933 droeschl 7492: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7493: margin: 0;
7494: padding: 0;
1.933 droeschl 7495: position: relative;
7496: list-style: none;
1.913 droeschl 7497: }
1.933 droeschl 7498: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7499: display: inline;
7500: }
1.933 droeschl 7501:
7502: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7503: padding: 0;
1.933 droeschl 7504: margin: 0;
7505: float: left;
1.913 droeschl 7506: }
1.933 droeschl 7507: .LC_breadcrumb_tools_tools {
7508: padding: 0;
7509: margin: 0;
1.913 droeschl 7510: float: right;
7511: }
7512:
1.1240 raeburn 7513: .LC_placement_prog {
7514: padding-right: 20px;
7515: font-weight: bold;
7516: font-size: 90%;
7517: }
7518:
1.359 albertel 7519: table#LC_title_bar td {
7520: background: $tabbg;
7521: }
1.795 www 7522:
1.911 bisitz 7523: table#LC_menubuttons img {
1.803 bisitz 7524: border: none;
1.346 albertel 7525: }
1.795 www 7526:
1.842 droeschl 7527: .LC_breadcrumbs_component {
1.911 bisitz 7528: float: right;
7529: margin: 0 1em;
1.357 albertel 7530: }
1.842 droeschl 7531: .LC_breadcrumbs_component img {
1.911 bisitz 7532: vertical-align: middle;
1.777 tempelho 7533: }
1.795 www 7534:
1.1243 raeburn 7535: .LC_breadcrumbs_hoverable {
7536: background: $sidebg;
7537: }
7538:
1.383 albertel 7539: td.LC_table_cell_checkbox {
7540: text-align: center;
7541: }
1.795 www 7542:
7543: .LC_fontsize_small {
1.911 bisitz 7544: font-size: 70%;
1.705 tempelho 7545: }
7546:
1.844 bisitz 7547: #LC_breadcrumbs {
1.911 bisitz 7548: clear:both;
7549: background: $sidebg;
7550: border-bottom: 1px solid $lg_border_color;
7551: line-height: 2.5em;
1.933 droeschl 7552: overflow: hidden;
1.911 bisitz 7553: margin: 0;
7554: padding: 0;
1.995 raeburn 7555: text-align: left;
1.819 tempelho 7556: }
1.862 bisitz 7557:
1.1098 bisitz 7558: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7559: clear:both;
7560: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7561: border: 1px solid $sidebg;
1.1098 bisitz 7562: margin: 0 0 10px 0;
1.966 bisitz 7563: padding: 3px;
1.995 raeburn 7564: text-align: left;
1.822 bisitz 7565: }
7566:
1.795 www 7567: .LC_fontsize_medium {
1.911 bisitz 7568: font-size: 85%;
1.705 tempelho 7569: }
7570:
1.795 www 7571: .LC_fontsize_large {
1.911 bisitz 7572: font-size: 120%;
1.705 tempelho 7573: }
7574:
1.346 albertel 7575: .LC_menubuttons_inline_text {
7576: color: $font;
1.698 harmsja 7577: font-size: 90%;
1.701 harmsja 7578: padding-left:3px;
1.346 albertel 7579: }
7580:
1.934 droeschl 7581: .LC_menubuttons_inline_text img{
7582: vertical-align: middle;
7583: }
7584:
1.1051 www 7585: li.LC_menubuttons_inline_text img {
1.951 onken 7586: cursor:pointer;
1.1002 droeschl 7587: text-decoration: none;
1.951 onken 7588: }
7589:
1.526 www 7590: .LC_menubuttons_link {
7591: text-decoration: none;
7592: }
1.795 www 7593:
1.522 albertel 7594: .LC_menubuttons_category {
1.521 www 7595: color: $font;
1.526 www 7596: background: $pgbg;
1.521 www 7597: font-size: larger;
7598: font-weight: bold;
7599: }
7600:
1.346 albertel 7601: td.LC_menubuttons_text {
1.911 bisitz 7602: color: $font;
1.346 albertel 7603: }
1.706 harmsja 7604:
1.346 albertel 7605: .LC_current_location {
7606: background: $tabbg;
7607: }
1.795 www 7608:
1.1286 raeburn 7609: td.LC_zero_height {
7610: line-height: 0;
7611: cellpadding: 0;
7612: }
7613:
1.938 bisitz 7614: table.LC_data_table {
1.347 albertel 7615: border: 1px solid #000000;
1.402 albertel 7616: border-collapse: separate;
1.426 albertel 7617: border-spacing: 1px;
1.610 albertel 7618: background: $pgbg;
1.347 albertel 7619: }
1.795 www 7620:
1.422 albertel 7621: .LC_data_table_dense {
7622: font-size: small;
7623: }
1.795 www 7624:
1.507 raeburn 7625: table.LC_nested_outer {
7626: border: 1px solid #000000;
1.589 raeburn 7627: border-collapse: collapse;
1.803 bisitz 7628: border-spacing: 0;
1.507 raeburn 7629: width: 100%;
7630: }
1.795 www 7631:
1.879 raeburn 7632: table.LC_innerpickbox,
1.507 raeburn 7633: table.LC_nested {
1.803 bisitz 7634: border: none;
1.589 raeburn 7635: border-collapse: collapse;
1.803 bisitz 7636: border-spacing: 0;
1.507 raeburn 7637: width: 100%;
7638: }
1.795 www 7639:
1.911 bisitz 7640: table.LC_data_table tr th,
7641: table.LC_calendar tr th,
1.879 raeburn 7642: table.LC_prior_tries tr th,
7643: table.LC_innerpickbox tr th {
1.349 albertel 7644: font-weight: bold;
7645: background-color: $data_table_head;
1.801 tempelho 7646: color:$fontmenu;
1.701 harmsja 7647: font-size:90%;
1.347 albertel 7648: }
1.795 www 7649:
1.879 raeburn 7650: table.LC_innerpickbox tr th,
7651: table.LC_innerpickbox tr td {
7652: vertical-align: top;
7653: }
7654:
1.711 raeburn 7655: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7656: background-color: #CCCCCC;
1.711 raeburn 7657: font-weight: bold;
7658: text-align: left;
7659: }
1.795 www 7660:
1.912 bisitz 7661: table.LC_data_table tr.LC_odd_row > td {
7662: background-color: $data_table_light;
7663: padding: 2px;
7664: vertical-align: top;
7665: }
7666:
1.809 bisitz 7667: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7668: background-color: $data_table_light;
1.912 bisitz 7669: vertical-align: top;
7670: }
7671:
7672: table.LC_data_table tr.LC_even_row > td {
7673: background-color: $data_table_dark;
1.425 albertel 7674: padding: 2px;
1.900 bisitz 7675: vertical-align: top;
1.347 albertel 7676: }
1.795 www 7677:
1.809 bisitz 7678: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7679: background-color: $data_table_dark;
1.900 bisitz 7680: vertical-align: top;
1.347 albertel 7681: }
1.795 www 7682:
1.425 albertel 7683: table.LC_data_table tr.LC_data_table_highlight td {
7684: background-color: $data_table_darker;
7685: }
1.795 www 7686:
1.639 raeburn 7687: table.LC_data_table tr td.LC_leftcol_header {
7688: background-color: $data_table_head;
7689: font-weight: bold;
7690: }
1.795 www 7691:
1.451 albertel 7692: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7693: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7694: font-weight: bold;
7695: font-style: italic;
7696: text-align: center;
7697: padding: 8px;
1.347 albertel 7698: }
1.795 www 7699:
1.1114 raeburn 7700: table.LC_data_table tr.LC_empty_row td,
7701: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7702: background-color: $sidebg;
7703: }
7704:
7705: table.LC_nested tr.LC_empty_row td {
7706: background-color: #FFFFFF;
7707: }
7708:
1.890 droeschl 7709: table.LC_caption {
7710: }
7711:
1.507 raeburn 7712: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7713: padding: 4ex
7714: }
1.795 www 7715:
1.507 raeburn 7716: table.LC_nested_outer tr th {
7717: font-weight: bold;
1.801 tempelho 7718: color:$fontmenu;
1.507 raeburn 7719: background-color: $data_table_head;
1.701 harmsja 7720: font-size: small;
1.507 raeburn 7721: border-bottom: 1px solid #000000;
7722: }
1.795 www 7723:
1.507 raeburn 7724: table.LC_nested_outer tr td.LC_subheader {
7725: background-color: $data_table_head;
7726: font-weight: bold;
7727: font-size: small;
7728: border-bottom: 1px solid #000000;
7729: text-align: right;
1.451 albertel 7730: }
1.795 www 7731:
1.507 raeburn 7732: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7733: background-color: #CCCCCC;
1.451 albertel 7734: font-weight: bold;
7735: font-size: small;
1.507 raeburn 7736: text-align: center;
7737: }
1.795 www 7738:
1.589 raeburn 7739: table.LC_nested tr.LC_info_row td.LC_left_item,
7740: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7741: text-align: left;
1.451 albertel 7742: }
1.795 www 7743:
1.507 raeburn 7744: table.LC_nested td {
1.735 bisitz 7745: background-color: #FFFFFF;
1.451 albertel 7746: font-size: small;
1.507 raeburn 7747: }
1.795 www 7748:
1.507 raeburn 7749: table.LC_nested_outer tr th.LC_right_item,
7750: table.LC_nested tr.LC_info_row td.LC_right_item,
7751: table.LC_nested tr.LC_odd_row td.LC_right_item,
7752: table.LC_nested tr td.LC_right_item {
1.451 albertel 7753: text-align: right;
7754: }
7755:
1.507 raeburn 7756: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7757: background-color: #EEEEEE;
1.451 albertel 7758: }
7759:
1.473 raeburn 7760: table.LC_createuser {
7761: }
7762:
7763: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7764: font-size: small;
1.473 raeburn 7765: }
7766:
7767: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7768: background-color: #CCCCCC;
1.473 raeburn 7769: font-weight: bold;
7770: text-align: center;
7771: }
7772:
1.349 albertel 7773: table.LC_calendar {
7774: border: 1px solid #000000;
7775: border-collapse: collapse;
1.917 raeburn 7776: width: 98%;
1.349 albertel 7777: }
1.795 www 7778:
1.349 albertel 7779: table.LC_calendar_pickdate {
7780: font-size: xx-small;
7781: }
1.795 www 7782:
1.349 albertel 7783: table.LC_calendar tr td {
7784: border: 1px solid #000000;
7785: vertical-align: top;
1.917 raeburn 7786: width: 14%;
1.349 albertel 7787: }
1.795 www 7788:
1.349 albertel 7789: table.LC_calendar tr td.LC_calendar_day_empty {
7790: background-color: $data_table_dark;
7791: }
1.795 www 7792:
1.779 bisitz 7793: table.LC_calendar tr td.LC_calendar_day_current {
7794: background-color: $data_table_highlight;
1.777 tempelho 7795: }
1.795 www 7796:
1.938 bisitz 7797: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7798: background-color: $mail_new;
7799: }
1.795 www 7800:
1.938 bisitz 7801: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7802: background-color: $mail_new_hover;
7803: }
1.795 www 7804:
1.938 bisitz 7805: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7806: background-color: $mail_read;
7807: }
1.795 www 7808:
1.938 bisitz 7809: /*
7810: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7811: background-color: $mail_read_hover;
7812: }
1.938 bisitz 7813: */
1.795 www 7814:
1.938 bisitz 7815: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7816: background-color: $mail_replied;
7817: }
1.795 www 7818:
1.938 bisitz 7819: /*
7820: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7821: background-color: $mail_replied_hover;
7822: }
1.938 bisitz 7823: */
1.795 www 7824:
1.938 bisitz 7825: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7826: background-color: $mail_other;
7827: }
1.795 www 7828:
1.938 bisitz 7829: /*
7830: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7831: background-color: $mail_other_hover;
7832: }
1.938 bisitz 7833: */
1.494 raeburn 7834:
1.777 tempelho 7835: table.LC_data_table tr > td.LC_browser_file,
7836: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7837: background: #AAEE77;
1.389 albertel 7838: }
1.795 www 7839:
1.777 tempelho 7840: table.LC_data_table tr > td.LC_browser_file_locked,
7841: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7842: background: #FFAA99;
1.387 albertel 7843: }
1.795 www 7844:
1.777 tempelho 7845: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7846: background: #888888;
1.779 bisitz 7847: }
1.795 www 7848:
1.777 tempelho 7849: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7850: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7851: background: #F8F866;
1.777 tempelho 7852: }
1.795 www 7853:
1.696 bisitz 7854: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7855: background: #E0E8FF;
1.387 albertel 7856: }
1.696 bisitz 7857:
1.707 bisitz 7858: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7859: /* background: #77FF77; */
1.707 bisitz 7860: }
1.795 www 7861:
1.707 bisitz 7862: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7863: border-right: 8px solid #FFFF77;
1.707 bisitz 7864: }
1.795 www 7865:
1.707 bisitz 7866: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7867: border-right: 8px solid #FFAA77;
1.707 bisitz 7868: }
1.795 www 7869:
1.707 bisitz 7870: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7871: border-right: 8px solid #FF7777;
1.707 bisitz 7872: }
1.795 www 7873:
1.707 bisitz 7874: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7875: border-right: 8px solid #AAFF77;
1.707 bisitz 7876: }
1.795 www 7877:
1.707 bisitz 7878: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7879: border-right: 8px solid #11CC55;
1.707 bisitz 7880: }
7881:
1.388 albertel 7882: span.LC_current_location {
1.701 harmsja 7883: font-size:larger;
1.388 albertel 7884: background: $pgbg;
7885: }
1.387 albertel 7886:
1.1029 www 7887: span.LC_current_nav_location {
7888: font-weight:bold;
7889: background: $sidebg;
7890: }
7891:
1.395 albertel 7892: span.LC_parm_menu_item {
7893: font-size: larger;
7894: }
1.795 www 7895:
1.395 albertel 7896: span.LC_parm_scope_all {
7897: color: red;
7898: }
1.795 www 7899:
1.395 albertel 7900: span.LC_parm_scope_folder {
7901: color: green;
7902: }
1.795 www 7903:
1.395 albertel 7904: span.LC_parm_scope_resource {
7905: color: orange;
7906: }
1.795 www 7907:
1.395 albertel 7908: span.LC_parm_part {
7909: color: blue;
7910: }
1.795 www 7911:
1.911 bisitz 7912: span.LC_parm_folder,
7913: span.LC_parm_symb {
1.395 albertel 7914: font-size: x-small;
7915: font-family: $mono;
7916: color: #AAAAAA;
7917: }
7918:
1.977 bisitz 7919: ul.LC_parm_parmlist li {
7920: display: inline-block;
7921: padding: 0.3em 0.8em;
7922: vertical-align: top;
7923: width: 150px;
7924: border-top:1px solid $lg_border_color;
7925: }
7926:
1.795 www 7927: td.LC_parm_overview_level_menu,
7928: td.LC_parm_overview_map_menu,
7929: td.LC_parm_overview_parm_selectors,
7930: td.LC_parm_overview_restrictions {
1.396 albertel 7931: border: 1px solid black;
7932: border-collapse: collapse;
7933: }
1.795 www 7934:
1.1285 raeburn 7935: span.LC_parm_recursive,
7936: td.LC_parm_recursive {
7937: font-weight: bold;
7938: font-size: smaller;
7939: }
7940:
1.396 albertel 7941: table.LC_parm_overview_restrictions td {
7942: border-width: 1px 4px 1px 4px;
7943: border-style: solid;
7944: border-color: $pgbg;
7945: text-align: center;
7946: }
1.795 www 7947:
1.396 albertel 7948: table.LC_parm_overview_restrictions th {
7949: background: $tabbg;
7950: border-width: 1px 4px 1px 4px;
7951: border-style: solid;
7952: border-color: $pgbg;
7953: }
1.795 www 7954:
1.398 albertel 7955: table#LC_helpmenu {
1.803 bisitz 7956: border: none;
1.398 albertel 7957: height: 55px;
1.803 bisitz 7958: border-spacing: 0;
1.398 albertel 7959: }
7960:
7961: table#LC_helpmenu fieldset legend {
7962: font-size: larger;
7963: }
1.795 www 7964:
1.397 albertel 7965: table#LC_helpmenu_links {
7966: width: 100%;
7967: border: 1px solid black;
7968: background: $pgbg;
1.803 bisitz 7969: padding: 0;
1.397 albertel 7970: border-spacing: 1px;
7971: }
1.795 www 7972:
1.397 albertel 7973: table#LC_helpmenu_links tr td {
7974: padding: 1px;
7975: background: $tabbg;
1.399 albertel 7976: text-align: center;
7977: font-weight: bold;
1.397 albertel 7978: }
1.396 albertel 7979:
1.795 www 7980: table#LC_helpmenu_links a:link,
7981: table#LC_helpmenu_links a:visited,
1.397 albertel 7982: table#LC_helpmenu_links a:active {
7983: text-decoration: none;
7984: color: $font;
7985: }
1.795 www 7986:
1.397 albertel 7987: table#LC_helpmenu_links a:hover {
7988: text-decoration: underline;
7989: color: $vlink;
7990: }
1.396 albertel 7991:
1.417 albertel 7992: .LC_chrt_popup_exists {
7993: border: 1px solid #339933;
7994: margin: -1px;
7995: }
1.795 www 7996:
1.417 albertel 7997: .LC_chrt_popup_up {
7998: border: 1px solid yellow;
7999: margin: -1px;
8000: }
1.795 www 8001:
1.417 albertel 8002: .LC_chrt_popup {
8003: border: 1px solid #8888FF;
8004: background: #CCCCFF;
8005: }
1.795 www 8006:
1.421 albertel 8007: table.LC_pick_box {
8008: border-collapse: separate;
8009: background: white;
8010: border: 1px solid black;
8011: border-spacing: 1px;
8012: }
1.795 www 8013:
1.421 albertel 8014: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8015: background: $sidebg;
1.421 albertel 8016: font-weight: bold;
1.900 bisitz 8017: text-align: left;
1.740 bisitz 8018: vertical-align: top;
1.421 albertel 8019: width: 184px;
8020: padding: 8px;
8021: }
1.795 www 8022:
1.579 raeburn 8023: table.LC_pick_box td.LC_pick_box_value {
8024: text-align: left;
8025: padding: 8px;
8026: }
1.795 www 8027:
1.579 raeburn 8028: table.LC_pick_box td.LC_pick_box_select {
8029: text-align: left;
8030: padding: 8px;
8031: }
1.795 www 8032:
1.424 albertel 8033: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8034: padding: 0;
1.421 albertel 8035: height: 1px;
8036: background: black;
8037: }
1.795 www 8038:
1.421 albertel 8039: table.LC_pick_box td.LC_pick_box_submit {
8040: text-align: right;
8041: }
1.795 www 8042:
1.579 raeburn 8043: table.LC_pick_box td.LC_evenrow_value {
8044: text-align: left;
8045: padding: 8px;
8046: background-color: $data_table_light;
8047: }
1.795 www 8048:
1.579 raeburn 8049: table.LC_pick_box td.LC_oddrow_value {
8050: text-align: left;
8051: padding: 8px;
8052: background-color: $data_table_light;
8053: }
1.795 www 8054:
1.579 raeburn 8055: span.LC_helpform_receipt_cat {
8056: font-weight: bold;
8057: }
1.795 www 8058:
1.424 albertel 8059: table.LC_group_priv_box {
8060: background: white;
8061: border: 1px solid black;
8062: border-spacing: 1px;
8063: }
1.795 www 8064:
1.424 albertel 8065: table.LC_group_priv_box td.LC_pick_box_title {
8066: background: $tabbg;
8067: font-weight: bold;
8068: text-align: right;
8069: width: 184px;
8070: }
1.795 www 8071:
1.424 albertel 8072: table.LC_group_priv_box td.LC_groups_fixed {
8073: background: $data_table_light;
8074: text-align: center;
8075: }
1.795 www 8076:
1.424 albertel 8077: table.LC_group_priv_box td.LC_groups_optional {
8078: background: $data_table_dark;
8079: text-align: center;
8080: }
1.795 www 8081:
1.424 albertel 8082: table.LC_group_priv_box td.LC_groups_functionality {
8083: background: $data_table_darker;
8084: text-align: center;
8085: font-weight: bold;
8086: }
1.795 www 8087:
1.424 albertel 8088: table.LC_group_priv td {
8089: text-align: left;
1.803 bisitz 8090: padding: 0;
1.424 albertel 8091: }
8092:
8093: .LC_navbuttons {
8094: margin: 2ex 0ex 2ex 0ex;
8095: }
1.795 www 8096:
1.423 albertel 8097: .LC_topic_bar {
8098: font-weight: bold;
8099: background: $tabbg;
1.918 wenzelju 8100: margin: 1em 0em 1em 2em;
1.805 bisitz 8101: padding: 3px;
1.918 wenzelju 8102: font-size: 1.2em;
1.423 albertel 8103: }
1.795 www 8104:
1.423 albertel 8105: .LC_topic_bar span {
1.918 wenzelju 8106: left: 0.5em;
8107: position: absolute;
1.423 albertel 8108: vertical-align: middle;
1.918 wenzelju 8109: font-size: 1.2em;
1.423 albertel 8110: }
1.795 www 8111:
1.423 albertel 8112: table.LC_course_group_status {
8113: margin: 20px;
8114: }
1.795 www 8115:
1.423 albertel 8116: table.LC_status_selector td {
8117: vertical-align: top;
8118: text-align: center;
1.424 albertel 8119: padding: 4px;
8120: }
1.795 www 8121:
1.599 albertel 8122: div.LC_feedback_link {
1.616 albertel 8123: clear: both;
1.829 kalberla 8124: background: $sidebg;
1.779 bisitz 8125: width: 100%;
1.829 kalberla 8126: padding-bottom: 10px;
8127: border: 1px $tabbg solid;
1.833 kalberla 8128: height: 22px;
8129: line-height: 22px;
8130: padding-top: 5px;
8131: }
8132:
8133: div.LC_feedback_link img {
8134: height: 22px;
1.867 kalberla 8135: vertical-align:middle;
1.829 kalberla 8136: }
8137:
1.911 bisitz 8138: div.LC_feedback_link a {
1.829 kalberla 8139: text-decoration: none;
1.489 raeburn 8140: }
1.795 www 8141:
1.867 kalberla 8142: div.LC_comblock {
1.911 bisitz 8143: display:inline;
1.867 kalberla 8144: color:$font;
8145: font-size:90%;
8146: }
8147:
8148: div.LC_feedback_link div.LC_comblock {
8149: padding-left:5px;
8150: }
8151:
8152: div.LC_feedback_link div.LC_comblock a {
8153: color:$font;
8154: }
8155:
1.489 raeburn 8156: span.LC_feedback_link {
1.858 bisitz 8157: /* background: $feedback_link_bg; */
1.599 albertel 8158: font-size: larger;
8159: }
1.795 www 8160:
1.599 albertel 8161: span.LC_message_link {
1.858 bisitz 8162: /* background: $feedback_link_bg; */
1.599 albertel 8163: font-size: larger;
8164: position: absolute;
8165: right: 1em;
1.489 raeburn 8166: }
1.421 albertel 8167:
1.515 albertel 8168: table.LC_prior_tries {
1.524 albertel 8169: border: 1px solid #000000;
8170: border-collapse: separate;
8171: border-spacing: 1px;
1.515 albertel 8172: }
1.523 albertel 8173:
1.515 albertel 8174: table.LC_prior_tries td {
1.524 albertel 8175: padding: 2px;
1.515 albertel 8176: }
1.523 albertel 8177:
8178: .LC_answer_correct {
1.795 www 8179: background: lightgreen;
8180: color: darkgreen;
8181: padding: 6px;
1.523 albertel 8182: }
1.795 www 8183:
1.523 albertel 8184: .LC_answer_charged_try {
1.797 www 8185: background: #FFAAAA;
1.795 www 8186: color: darkred;
8187: padding: 6px;
1.523 albertel 8188: }
1.795 www 8189:
1.779 bisitz 8190: .LC_answer_not_charged_try,
1.523 albertel 8191: .LC_answer_no_grade,
8192: .LC_answer_late {
1.795 www 8193: background: lightyellow;
1.523 albertel 8194: color: black;
1.795 www 8195: padding: 6px;
1.523 albertel 8196: }
1.795 www 8197:
1.523 albertel 8198: .LC_answer_previous {
1.795 www 8199: background: lightblue;
8200: color: darkblue;
8201: padding: 6px;
1.523 albertel 8202: }
1.795 www 8203:
1.779 bisitz 8204: .LC_answer_no_message {
1.777 tempelho 8205: background: #FFFFFF;
8206: color: black;
1.795 www 8207: padding: 6px;
1.779 bisitz 8208: }
1.795 www 8209:
1.1334 raeburn 8210: .LC_answer_unknown,
8211: .LC_answer_warning {
1.779 bisitz 8212: background: orange;
8213: color: black;
1.795 www 8214: padding: 6px;
1.777 tempelho 8215: }
1.795 www 8216:
1.529 albertel 8217: span.LC_prior_numerical,
8218: span.LC_prior_string,
8219: span.LC_prior_custom,
8220: span.LC_prior_reaction,
8221: span.LC_prior_math {
1.925 bisitz 8222: font-family: $mono;
1.523 albertel 8223: white-space: pre;
8224: }
8225:
1.525 albertel 8226: span.LC_prior_string {
1.925 bisitz 8227: font-family: $mono;
1.525 albertel 8228: white-space: pre;
8229: }
8230:
1.523 albertel 8231: table.LC_prior_option {
8232: width: 100%;
8233: border-collapse: collapse;
8234: }
1.795 www 8235:
1.911 bisitz 8236: table.LC_prior_rank,
1.795 www 8237: table.LC_prior_match {
1.528 albertel 8238: border-collapse: collapse;
8239: }
1.795 www 8240:
1.528 albertel 8241: table.LC_prior_option tr td,
8242: table.LC_prior_rank tr td,
8243: table.LC_prior_match tr td {
1.524 albertel 8244: border: 1px solid #000000;
1.515 albertel 8245: }
8246:
1.855 bisitz 8247: .LC_nobreak {
1.544 albertel 8248: white-space: nowrap;
1.519 raeburn 8249: }
8250:
1.576 raeburn 8251: span.LC_cusr_emph {
8252: font-style: italic;
8253: }
8254:
1.633 raeburn 8255: span.LC_cusr_subheading {
8256: font-weight: normal;
8257: font-size: 85%;
8258: }
8259:
1.861 bisitz 8260: div.LC_docs_entry_move {
1.859 bisitz 8261: border: 1px solid #BBBBBB;
1.545 albertel 8262: background: #DDDDDD;
1.861 bisitz 8263: width: 22px;
1.859 bisitz 8264: padding: 1px;
8265: margin: 0;
1.545 albertel 8266: }
8267:
1.861 bisitz 8268: table.LC_data_table tr > td.LC_docs_entry_commands,
8269: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8270: font-size: x-small;
8271: }
1.795 www 8272:
1.861 bisitz 8273: .LC_docs_entry_parameter {
8274: white-space: nowrap;
8275: }
8276:
1.544 albertel 8277: .LC_docs_copy {
1.545 albertel 8278: color: #000099;
1.544 albertel 8279: }
1.795 www 8280:
1.544 albertel 8281: .LC_docs_cut {
1.545 albertel 8282: color: #550044;
1.544 albertel 8283: }
1.795 www 8284:
1.544 albertel 8285: .LC_docs_rename {
1.545 albertel 8286: color: #009900;
1.544 albertel 8287: }
1.795 www 8288:
1.544 albertel 8289: .LC_docs_remove {
1.545 albertel 8290: color: #990000;
8291: }
8292:
1.1284 raeburn 8293: .LC_docs_alias {
8294: color: #440055;
8295: }
8296:
1.1286 raeburn 8297: .LC_domprefs_email,
1.1284 raeburn 8298: .LC_docs_alias_name,
1.547 albertel 8299: .LC_docs_reinit_warn,
8300: .LC_docs_ext_edit {
8301: font-size: x-small;
8302: }
8303:
1.545 albertel 8304: table.LC_docs_adddocs td,
8305: table.LC_docs_adddocs th {
8306: border: 1px solid #BBBBBB;
8307: padding: 4px;
8308: background: #DDDDDD;
1.543 albertel 8309: }
8310:
1.584 albertel 8311: table.LC_sty_begin {
8312: background: #BBFFBB;
8313: }
1.795 www 8314:
1.584 albertel 8315: table.LC_sty_end {
8316: background: #FFBBBB;
8317: }
8318:
1.589 raeburn 8319: table.LC_double_column {
1.803 bisitz 8320: border-width: 0;
1.589 raeburn 8321: border-collapse: collapse;
8322: width: 100%;
8323: padding: 2px;
8324: }
8325:
8326: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8327: top: 2px;
1.589 raeburn 8328: left: 2px;
8329: width: 47%;
8330: vertical-align: top;
8331: }
8332:
8333: table.LC_double_column tr td.LC_right_col {
8334: top: 2px;
1.779 bisitz 8335: right: 2px;
1.589 raeburn 8336: width: 47%;
8337: vertical-align: top;
8338: }
8339:
1.591 raeburn 8340: div.LC_left_float {
8341: float: left;
8342: padding-right: 5%;
1.597 albertel 8343: padding-bottom: 4px;
1.591 raeburn 8344: }
8345:
8346: div.LC_clear_float_header {
1.597 albertel 8347: padding-bottom: 2px;
1.591 raeburn 8348: }
8349:
8350: div.LC_clear_float_footer {
1.597 albertel 8351: padding-top: 10px;
1.591 raeburn 8352: clear: both;
8353: }
8354:
1.597 albertel 8355: div.LC_grade_show_user {
1.941 bisitz 8356: /* border-left: 5px solid $sidebg; */
8357: border-top: 5px solid #000000;
8358: margin: 50px 0 0 0;
1.936 bisitz 8359: padding: 15px 0 5px 10px;
1.597 albertel 8360: }
1.795 www 8361:
1.936 bisitz 8362: div.LC_grade_show_user_odd_row {
1.941 bisitz 8363: /* border-left: 5px solid #000000; */
8364: }
8365:
8366: div.LC_grade_show_user div.LC_Box {
8367: margin-right: 50px;
1.597 albertel 8368: }
8369:
8370: div.LC_grade_submissions,
8371: div.LC_grade_message_center,
1.936 bisitz 8372: div.LC_grade_info_links {
1.597 albertel 8373: margin: 5px;
8374: width: 99%;
8375: background: #FFFFFF;
8376: }
1.795 www 8377:
1.597 albertel 8378: div.LC_grade_submissions_header,
1.936 bisitz 8379: div.LC_grade_message_center_header {
1.705 tempelho 8380: font-weight: bold;
8381: font-size: large;
1.597 albertel 8382: }
1.795 www 8383:
1.597 albertel 8384: div.LC_grade_submissions_body,
1.936 bisitz 8385: div.LC_grade_message_center_body {
1.597 albertel 8386: border: 1px solid black;
8387: width: 99%;
8388: background: #FFFFFF;
8389: }
1.795 www 8390:
1.613 albertel 8391: table.LC_scantron_action {
8392: width: 100%;
8393: }
1.795 www 8394:
1.613 albertel 8395: table.LC_scantron_action tr th {
1.698 harmsja 8396: font-weight:bold;
8397: font-style:normal;
1.613 albertel 8398: }
1.795 www 8399:
1.779 bisitz 8400: .LC_edit_problem_header,
1.614 albertel 8401: div.LC_edit_problem_footer {
1.705 tempelho 8402: font-weight: normal;
8403: font-size: medium;
1.602 albertel 8404: margin: 2px;
1.1060 bisitz 8405: background-color: $sidebg;
1.600 albertel 8406: }
1.795 www 8407:
1.600 albertel 8408: div.LC_edit_problem_header,
1.602 albertel 8409: div.LC_edit_problem_header div,
1.614 albertel 8410: div.LC_edit_problem_footer,
8411: div.LC_edit_problem_footer div,
1.602 albertel 8412: div.LC_edit_problem_editxml_header,
8413: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8414: z-index: 100;
1.600 albertel 8415: }
1.795 www 8416:
1.600 albertel 8417: div.LC_edit_problem_header_title {
1.705 tempelho 8418: font-weight: bold;
8419: font-size: larger;
1.602 albertel 8420: background: $tabbg;
8421: padding: 3px;
1.1060 bisitz 8422: margin: 0 0 5px 0;
1.602 albertel 8423: }
1.795 www 8424:
1.602 albertel 8425: table.LC_edit_problem_header_title {
8426: width: 100%;
1.600 albertel 8427: background: $tabbg;
1.602 albertel 8428: }
8429:
1.1205 golterma 8430: div.LC_edit_actionbar {
8431: background-color: $sidebg;
1.1218 droeschl 8432: margin: 0;
8433: padding: 0;
8434: line-height: 200%;
1.602 albertel 8435: }
1.795 www 8436:
1.1218 droeschl 8437: div.LC_edit_actionbar div{
8438: padding: 0;
8439: margin: 0;
8440: display: inline-block;
1.600 albertel 8441: }
1.795 www 8442:
1.1124 bisitz 8443: .LC_edit_opt {
8444: padding-left: 1em;
8445: white-space: nowrap;
8446: }
8447:
1.1152 golterma 8448: .LC_edit_problem_latexhelper{
8449: text-align: right;
8450: }
8451:
8452: #LC_edit_problem_colorful div{
8453: margin-left: 40px;
8454: }
8455:
1.1205 golterma 8456: #LC_edit_problem_codemirror div{
8457: margin-left: 0px;
8458: }
8459:
1.911 bisitz 8460: img.stift {
1.803 bisitz 8461: border-width: 0;
8462: vertical-align: middle;
1.677 riegler 8463: }
1.680 riegler 8464:
1.923 bisitz 8465: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8466: vertical-align: top;
1.777 tempelho 8467: }
1.795 www 8468:
1.716 raeburn 8469: div.LC_createcourse {
1.911 bisitz 8470: margin: 10px 10px 10px 10px;
1.716 raeburn 8471: }
8472:
1.917 raeburn 8473: .LC_dccid {
1.1130 raeburn 8474: float: right;
1.917 raeburn 8475: margin: 0.2em 0 0 0;
8476: padding: 0;
8477: font-size: 90%;
8478: display:none;
8479: }
8480:
1.897 wenzelju 8481: ol.LC_primary_menu a:hover,
1.721 harmsja 8482: ol#LC_MenuBreadcrumbs a:hover,
8483: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8484: ul#LC_secondary_menu a:hover,
1.721 harmsja 8485: .LC_FormSectionClearButton input:hover
1.795 www 8486: ul.LC_TabContent li:hover a {
1.952 onken 8487: color:$button_hover;
1.911 bisitz 8488: text-decoration:none;
1.693 droeschl 8489: }
8490:
1.779 bisitz 8491: h1 {
1.911 bisitz 8492: padding: 0;
8493: line-height:130%;
1.693 droeschl 8494: }
1.698 harmsja 8495:
1.911 bisitz 8496: h2,
8497: h3,
8498: h4,
8499: h5,
8500: h6 {
8501: margin: 5px 0 5px 0;
8502: padding: 0;
8503: line-height:130%;
1.693 droeschl 8504: }
1.795 www 8505:
8506: .LC_hcell {
1.911 bisitz 8507: padding:3px 15px 3px 15px;
8508: margin: 0;
8509: background-color:$tabbg;
8510: color:$fontmenu;
8511: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8512: }
1.795 www 8513:
1.840 bisitz 8514: .LC_Box > .LC_hcell {
1.911 bisitz 8515: margin: 0 -10px 10px -10px;
1.835 bisitz 8516: }
8517:
1.721 harmsja 8518: .LC_noBorder {
1.911 bisitz 8519: border: 0;
1.698 harmsja 8520: }
1.693 droeschl 8521:
1.721 harmsja 8522: .LC_FormSectionClearButton input {
1.911 bisitz 8523: background-color:transparent;
8524: border: none;
8525: cursor:pointer;
8526: text-decoration:underline;
1.693 droeschl 8527: }
1.763 bisitz 8528:
8529: .LC_help_open_topic {
1.911 bisitz 8530: color: #FFFFFF;
8531: background-color: #EEEEFF;
8532: margin: 1px;
8533: padding: 4px;
8534: border: 1px solid #000033;
8535: white-space: nowrap;
8536: /* vertical-align: middle; */
1.759 neumanie 8537: }
1.693 droeschl 8538:
1.911 bisitz 8539: dl,
8540: ul,
8541: div,
8542: fieldset {
8543: margin: 10px 10px 10px 0;
8544: /* overflow: hidden; */
1.693 droeschl 8545: }
1.795 www 8546:
1.1404 raeburn 8547: fieldset#LC_selectuser {
8548: margin: 0;
8549: padding: 0;
8550: }
8551:
1.1211 raeburn 8552: article.geogebraweb div {
8553: margin: 0;
8554: }
8555:
1.838 bisitz 8556: fieldset > legend {
1.911 bisitz 8557: font-weight: bold;
8558: padding: 0 5px 0 5px;
1.838 bisitz 8559: }
8560:
1.813 bisitz 8561: #LC_nav_bar {
1.911 bisitz 8562: float: left;
1.995 raeburn 8563: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8564: margin: 0 0 2px 0;
1.807 droeschl 8565: }
8566:
1.916 droeschl 8567: #LC_realm {
8568: margin: 0.2em 0 0 0;
8569: padding: 0;
8570: font-weight: bold;
8571: text-align: center;
1.995 raeburn 8572: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8573: }
8574:
1.911 bisitz 8575: #LC_nav_bar em {
8576: font-weight: bold;
8577: font-style: normal;
1.807 droeschl 8578: }
8579:
1.897 wenzelju 8580: ol.LC_primary_menu {
1.934 droeschl 8581: margin: 0;
1.1076 raeburn 8582: padding: 0;
1.807 droeschl 8583: }
8584:
1.852 droeschl 8585: ol#LC_PathBreadcrumbs {
1.911 bisitz 8586: margin: 0;
1.693 droeschl 8587: }
8588:
1.897 wenzelju 8589: ol.LC_primary_menu li {
1.1076 raeburn 8590: color: RGB(80, 80, 80);
8591: vertical-align: middle;
8592: text-align: left;
8593: list-style: none;
1.1205 golterma 8594: position: relative;
1.1076 raeburn 8595: float: left;
1.1205 golterma 8596: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8597: line-height: 1.5em;
1.1076 raeburn 8598: }
8599:
1.1205 golterma 8600: ol.LC_primary_menu li a,
8601: ol.LC_primary_menu li p {
1.1076 raeburn 8602: display: block;
8603: margin: 0;
8604: padding: 0 5px 0 10px;
8605: text-decoration: none;
8606: }
8607:
1.1205 golterma 8608: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8609: display: inline-block;
8610: width: 95%;
8611: text-align: left;
8612: }
8613:
8614: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8615: display: inline-block;
8616: width: 5%;
8617: float: right;
8618: text-align: right;
8619: font-size: 70%;
8620: }
8621:
8622: ol.LC_primary_menu ul {
1.1076 raeburn 8623: display: none;
1.1205 golterma 8624: width: 15em;
1.1076 raeburn 8625: background-color: $data_table_light;
1.1205 golterma 8626: position: absolute;
8627: top: 100%;
1.1076 raeburn 8628: }
8629:
1.1205 golterma 8630: ol.LC_primary_menu ul ul {
8631: left: 100%;
8632: top: 0;
8633: }
8634:
8635: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8636: display: block;
8637: position: absolute;
8638: margin: 0;
8639: padding: 0;
1.1078 raeburn 8640: z-index: 2;
1.1076 raeburn 8641: }
8642:
8643: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8644: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8645: font-size: 90%;
1.911 bisitz 8646: vertical-align: top;
1.1076 raeburn 8647: float: none;
1.1079 raeburn 8648: border-left: 1px solid black;
8649: border-right: 1px solid black;
1.1205 golterma 8650: /* A dark bottom border to visualize different menu options;
8651: overwritten in the create_submenu routine for the last border-bottom of the menu */
8652: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8653: }
8654:
1.1205 golterma 8655: ol.LC_primary_menu li li p:hover {
8656: color:$button_hover;
8657: text-decoration:none;
8658: background-color:$data_table_dark;
1.1076 raeburn 8659: }
8660:
8661: ol.LC_primary_menu li li a:hover {
8662: color:$button_hover;
8663: background-color:$data_table_dark;
1.693 droeschl 8664: }
8665:
1.1205 golterma 8666: /* Font-size equal to the size of the predecessors*/
8667: ol.LC_primary_menu li:hover li li {
8668: font-size: 100%;
8669: }
8670:
1.897 wenzelju 8671: ol.LC_primary_menu li img {
1.911 bisitz 8672: vertical-align: bottom;
1.934 droeschl 8673: height: 1.1em;
1.1077 raeburn 8674: margin: 0.2em 0 0 0;
1.693 droeschl 8675: }
8676:
1.897 wenzelju 8677: ol.LC_primary_menu a {
1.911 bisitz 8678: color: RGB(80, 80, 80);
8679: text-decoration: none;
1.693 droeschl 8680: }
1.795 www 8681:
1.949 droeschl 8682: ol.LC_primary_menu a.LC_new_message {
8683: font-weight:bold;
8684: color: darkred;
8685: }
8686:
1.975 raeburn 8687: ol.LC_docs_parameters {
8688: margin-left: 0;
8689: padding: 0;
8690: list-style: none;
8691: }
8692:
8693: ol.LC_docs_parameters li {
8694: margin: 0;
8695: padding-right: 20px;
8696: display: inline;
8697: }
8698:
1.976 raeburn 8699: ol.LC_docs_parameters li:before {
8700: content: "\\002022 \\0020";
8701: }
8702:
8703: li.LC_docs_parameters_title {
8704: font-weight: bold;
8705: }
8706:
8707: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8708: content: "";
8709: }
8710:
1.897 wenzelju 8711: ul#LC_secondary_menu {
1.1107 raeburn 8712: clear: right;
1.911 bisitz 8713: color: $fontmenu;
8714: background: $tabbg;
8715: list-style: none;
8716: padding: 0;
8717: margin: 0;
8718: width: 100%;
1.995 raeburn 8719: text-align: left;
1.1107 raeburn 8720: float: left;
1.808 droeschl 8721: }
8722:
1.897 wenzelju 8723: ul#LC_secondary_menu li {
1.911 bisitz 8724: font-weight: bold;
8725: line-height: 1.8em;
1.1107 raeburn 8726: border-right: 1px solid black;
8727: float: left;
8728: }
8729:
8730: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8731: background-color: $data_table_light;
8732: }
8733:
8734: ul#LC_secondary_menu li a {
1.911 bisitz 8735: padding: 0 0.8em;
1.1107 raeburn 8736: }
8737:
8738: ul#LC_secondary_menu li ul {
8739: display: none;
8740: }
8741:
8742: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8743: display: block;
8744: position: absolute;
8745: margin: 0;
8746: padding: 0;
8747: list-style:none;
8748: float: none;
8749: background-color: $data_table_light;
8750: z-index: 2;
8751: margin-left: -1px;
8752: }
8753:
8754: ul#LC_secondary_menu li ul li {
8755: font-size: 90%;
8756: vertical-align: top;
8757: border-left: 1px solid black;
1.911 bisitz 8758: border-right: 1px solid black;
1.1119 raeburn 8759: background-color: $data_table_light;
1.1107 raeburn 8760: list-style:none;
8761: float: none;
8762: }
8763:
8764: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8765: background-color: $data_table_dark;
1.807 droeschl 8766: }
8767:
1.847 tempelho 8768: ul.LC_TabContent {
1.911 bisitz 8769: display:block;
8770: background: $sidebg;
8771: border-bottom: solid 1px $lg_border_color;
8772: list-style:none;
1.1020 raeburn 8773: margin: -1px -10px 0 -10px;
1.911 bisitz 8774: padding: 0;
1.693 droeschl 8775: }
8776:
1.795 www 8777: ul.LC_TabContent li,
8778: ul.LC_TabContentBigger li {
1.911 bisitz 8779: float:left;
1.741 harmsja 8780: }
1.795 www 8781:
1.897 wenzelju 8782: ul#LC_secondary_menu li a {
1.911 bisitz 8783: color: $fontmenu;
8784: text-decoration: none;
1.693 droeschl 8785: }
1.795 www 8786:
1.721 harmsja 8787: ul.LC_TabContent {
1.952 onken 8788: min-height:20px;
1.721 harmsja 8789: }
1.795 www 8790:
8791: ul.LC_TabContent li {
1.911 bisitz 8792: vertical-align:middle;
1.959 onken 8793: padding: 0 16px 0 10px;
1.911 bisitz 8794: background-color:$tabbg;
8795: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8796: border-left: solid 1px $font;
1.721 harmsja 8797: }
1.795 www 8798:
1.847 tempelho 8799: ul.LC_TabContent .right {
1.911 bisitz 8800: float:right;
1.847 tempelho 8801: }
8802:
1.911 bisitz 8803: ul.LC_TabContent li a,
8804: ul.LC_TabContent li {
8805: color:rgb(47,47,47);
8806: text-decoration:none;
8807: font-size:95%;
8808: font-weight:bold;
1.952 onken 8809: min-height:20px;
8810: }
8811:
1.959 onken 8812: ul.LC_TabContent li a:hover,
8813: ul.LC_TabContent li a:focus {
1.952 onken 8814: color: $button_hover;
1.959 onken 8815: background:none;
8816: outline:none;
1.952 onken 8817: }
8818:
8819: ul.LC_TabContent li:hover {
8820: color: $button_hover;
8821: cursor:pointer;
1.721 harmsja 8822: }
1.795 www 8823:
1.911 bisitz 8824: ul.LC_TabContent li.active {
1.952 onken 8825: color: $font;
1.911 bisitz 8826: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8827: border-bottom:solid 1px #FFFFFF;
8828: cursor: default;
1.744 ehlerst 8829: }
1.795 www 8830:
1.959 onken 8831: ul.LC_TabContent li.active a {
8832: color:$font;
8833: background:#FFFFFF;
8834: outline: none;
8835: }
1.1047 raeburn 8836:
8837: ul.LC_TabContent li.goback {
8838: float: left;
8839: border-left: none;
8840: }
8841:
1.870 tempelho 8842: #maincoursedoc {
1.911 bisitz 8843: clear:both;
1.870 tempelho 8844: }
8845:
8846: ul.LC_TabContentBigger {
1.911 bisitz 8847: display:block;
8848: list-style:none;
8849: padding: 0;
1.870 tempelho 8850: }
8851:
1.795 www 8852: ul.LC_TabContentBigger li {
1.911 bisitz 8853: vertical-align:bottom;
8854: height: 30px;
8855: font-size:110%;
8856: font-weight:bold;
8857: color: #737373;
1.841 tempelho 8858: }
8859:
1.957 onken 8860: ul.LC_TabContentBigger li.active {
8861: position: relative;
8862: top: 1px;
8863: }
8864:
1.870 tempelho 8865: ul.LC_TabContentBigger li a {
1.911 bisitz 8866: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8867: height: 30px;
8868: line-height: 30px;
8869: text-align: center;
8870: display: block;
8871: text-decoration: none;
1.958 onken 8872: outline: none;
1.741 harmsja 8873: }
1.795 www 8874:
1.870 tempelho 8875: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8876: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8877: color:$font;
1.744 ehlerst 8878: }
1.795 www 8879:
1.870 tempelho 8880: ul.LC_TabContentBigger li b {
1.911 bisitz 8881: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8882: display: block;
8883: float: left;
8884: padding: 0 30px;
1.957 onken 8885: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8886: }
8887:
1.956 onken 8888: ul.LC_TabContentBigger li:hover b {
8889: color:$button_hover;
8890: }
8891:
1.870 tempelho 8892: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8893: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8894: color:$font;
1.957 onken 8895: border: 0;
1.741 harmsja 8896: }
1.693 droeschl 8897:
1.870 tempelho 8898:
1.862 bisitz 8899: ul.LC_CourseBreadcrumbs {
8900: background: $sidebg;
1.1020 raeburn 8901: height: 2em;
1.862 bisitz 8902: padding-left: 10px;
1.1020 raeburn 8903: margin: 0;
1.862 bisitz 8904: list-style-position: inside;
8905: }
8906:
1.911 bisitz 8907: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8908: ol#LC_PathBreadcrumbs {
1.911 bisitz 8909: padding-left: 10px;
8910: margin: 0;
1.933 droeschl 8911: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8912: }
8913:
1.911 bisitz 8914: ol#LC_MenuBreadcrumbs li,
8915: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8916: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8917: display: inline;
1.933 droeschl 8918: white-space: normal;
1.693 droeschl 8919: }
8920:
1.823 bisitz 8921: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8922: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8923: text-decoration: none;
8924: font-size:90%;
1.693 droeschl 8925: }
1.795 www 8926:
1.969 droeschl 8927: ol#LC_MenuBreadcrumbs h1 {
8928: display: inline;
8929: font-size: 90%;
8930: line-height: 2.5em;
8931: margin: 0;
8932: padding: 0;
8933: }
8934:
1.795 www 8935: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8936: text-decoration:none;
8937: font-size:100%;
8938: font-weight:bold;
1.693 droeschl 8939: }
1.795 www 8940:
1.840 bisitz 8941: .LC_Box {
1.911 bisitz 8942: border: solid 1px $lg_border_color;
8943: padding: 0 10px 10px 10px;
1.746 neumanie 8944: }
1.795 www 8945:
1.1020 raeburn 8946: .LC_DocsBox {
8947: border: solid 1px $lg_border_color;
8948: padding: 0 0 10px 10px;
8949: }
8950:
1.795 www 8951: .LC_AboutMe_Image {
1.911 bisitz 8952: float:left;
8953: margin-right:10px;
1.747 neumanie 8954: }
1.795 www 8955:
8956: .LC_Clear_AboutMe_Image {
1.911 bisitz 8957: clear:left;
1.747 neumanie 8958: }
1.795 www 8959:
1.721 harmsja 8960: dl.LC_ListStyleClean dt {
1.911 bisitz 8961: padding-right: 5px;
8962: display: table-header-group;
1.693 droeschl 8963: }
8964:
1.721 harmsja 8965: dl.LC_ListStyleClean dd {
1.911 bisitz 8966: display: table-row;
1.693 droeschl 8967: }
8968:
1.721 harmsja 8969: .LC_ListStyleClean,
8970: .LC_ListStyleSimple,
8971: .LC_ListStyleNormal,
1.795 www 8972: .LC_ListStyleSpecial {
1.911 bisitz 8973: /* display:block; */
8974: list-style-position: inside;
8975: list-style-type: none;
8976: overflow: hidden;
8977: padding: 0;
1.693 droeschl 8978: }
8979:
1.721 harmsja 8980: .LC_ListStyleSimple li,
8981: .LC_ListStyleSimple dd,
8982: .LC_ListStyleNormal li,
8983: .LC_ListStyleNormal dd,
8984: .LC_ListStyleSpecial li,
1.795 www 8985: .LC_ListStyleSpecial dd {
1.911 bisitz 8986: margin: 0;
8987: padding: 5px 5px 5px 10px;
8988: clear: both;
1.693 droeschl 8989: }
8990:
1.721 harmsja 8991: .LC_ListStyleClean li,
8992: .LC_ListStyleClean dd {
1.911 bisitz 8993: padding-top: 0;
8994: padding-bottom: 0;
1.693 droeschl 8995: }
8996:
1.721 harmsja 8997: .LC_ListStyleSimple dd,
1.795 www 8998: .LC_ListStyleSimple li {
1.911 bisitz 8999: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9000: }
9001:
1.721 harmsja 9002: .LC_ListStyleSpecial li,
9003: .LC_ListStyleSpecial dd {
1.911 bisitz 9004: list-style-type: none;
9005: background-color: RGB(220, 220, 220);
9006: margin-bottom: 4px;
1.693 droeschl 9007: }
9008:
1.721 harmsja 9009: table.LC_SimpleTable {
1.911 bisitz 9010: margin:5px;
9011: border:solid 1px $lg_border_color;
1.795 www 9012: }
1.693 droeschl 9013:
1.721 harmsja 9014: table.LC_SimpleTable tr {
1.911 bisitz 9015: padding: 0;
9016: border:solid 1px $lg_border_color;
1.693 droeschl 9017: }
1.795 www 9018:
9019: table.LC_SimpleTable thead {
1.911 bisitz 9020: background:rgb(220,220,220);
1.693 droeschl 9021: }
9022:
1.721 harmsja 9023: div.LC_columnSection {
1.911 bisitz 9024: display: block;
9025: clear: both;
9026: overflow: hidden;
9027: margin: 0;
1.693 droeschl 9028: }
9029:
1.721 harmsja 9030: div.LC_columnSection>* {
1.911 bisitz 9031: float: left;
9032: margin: 10px 20px 10px 0;
9033: overflow:hidden;
1.693 droeschl 9034: }
1.721 harmsja 9035:
1.795 www 9036: table em {
1.911 bisitz 9037: font-weight: bold;
9038: font-style: normal;
1.748 schulted 9039: }
1.795 www 9040:
1.779 bisitz 9041: table.LC_tableBrowseRes,
1.795 www 9042: table.LC_tableOfContent {
1.911 bisitz 9043: border:none;
9044: border-spacing: 1px;
9045: padding: 3px;
9046: background-color: #FFFFFF;
9047: font-size: 90%;
1.753 droeschl 9048: }
1.789 droeschl 9049:
1.911 bisitz 9050: table.LC_tableOfContent {
9051: border-collapse: collapse;
1.789 droeschl 9052: }
9053:
1.771 droeschl 9054: table.LC_tableBrowseRes a,
1.768 schulted 9055: table.LC_tableOfContent a {
1.911 bisitz 9056: background-color: transparent;
9057: text-decoration: none;
1.753 droeschl 9058: }
9059:
1.795 www 9060: table.LC_tableOfContent img {
1.911 bisitz 9061: border: none;
9062: height: 1.3em;
9063: vertical-align: text-bottom;
9064: margin-right: 0.3em;
1.753 droeschl 9065: }
1.757 schulted 9066:
1.795 www 9067: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9068: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9069: }
9070:
1.795 www 9071: a#LC_content_toolbar_everything {
1.911 bisitz 9072: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9073: }
9074:
1.795 www 9075: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9076: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9077: }
9078:
1.795 www 9079: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9080: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9081: }
9082:
1.795 www 9083: a#LC_content_toolbar_changefolder {
1.911 bisitz 9084: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9085: }
9086:
1.795 www 9087: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9088: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9089: }
9090:
1.1043 raeburn 9091: a#LC_content_toolbar_edittoplevel {
9092: background-image:url(/res/adm/pages/edittoplevel.gif);
9093: }
9094:
1.1384 raeburn 9095: a#LC_content_toolbar_printout {
9096: background-image:url(/res/adm/pages/printout.gif);
9097: }
9098:
1.795 www 9099: ul#LC_toolbar li a:hover {
1.911 bisitz 9100: background-position: bottom center;
1.757 schulted 9101: }
9102:
1.795 www 9103: ul#LC_toolbar {
1.911 bisitz 9104: padding: 0;
9105: margin: 2px;
9106: list-style:none;
9107: position:relative;
9108: background-color:white;
1.1082 raeburn 9109: overflow: auto;
1.757 schulted 9110: }
9111:
1.795 www 9112: ul#LC_toolbar li {
1.911 bisitz 9113: border:1px solid white;
9114: padding: 0;
9115: margin: 0;
9116: float: left;
9117: display:inline;
9118: vertical-align:middle;
1.1082 raeburn 9119: white-space: nowrap;
1.911 bisitz 9120: }
1.757 schulted 9121:
1.783 amueller 9122:
1.795 www 9123: a.LC_toolbarItem {
1.911 bisitz 9124: display:block;
9125: padding: 0;
9126: margin: 0;
9127: height: 32px;
9128: width: 32px;
9129: color:white;
9130: border: none;
9131: background-repeat:no-repeat;
9132: background-color:transparent;
1.757 schulted 9133: }
9134:
1.915 droeschl 9135: ul.LC_funclist {
9136: margin: 0;
9137: padding: 0.5em 1em 0.5em 0;
9138: }
9139:
1.933 droeschl 9140: ul.LC_funclist > li:first-child {
9141: font-weight:bold;
9142: margin-left:0.8em;
9143: }
9144:
1.915 droeschl 9145: ul.LC_funclist + ul.LC_funclist {
9146: /*
9147: left border as a seperator if we have more than
9148: one list
9149: */
9150: border-left: 1px solid $sidebg;
9151: /*
9152: this hides the left border behind the border of the
9153: outer box if element is wrapped to the next 'line'
9154: */
9155: margin-left: -1px;
9156: }
9157:
1.843 bisitz 9158: ul.LC_funclist li {
1.915 droeschl 9159: display: inline;
1.782 bisitz 9160: white-space: nowrap;
1.915 droeschl 9161: margin: 0 0 0 25px;
9162: line-height: 150%;
1.782 bisitz 9163: }
9164:
1.974 wenzelju 9165: .LC_hidden {
9166: display: none;
9167: }
9168:
1.1030 www 9169: .LCmodal-overlay {
9170: position:fixed;
9171: top:0;
9172: right:0;
9173: bottom:0;
9174: left:0;
9175: height:100%;
9176: width:100%;
9177: margin:0;
9178: padding:0;
9179: background:#999;
9180: opacity:.75;
9181: filter: alpha(opacity=75);
9182: -moz-opacity: 0.75;
9183: z-index:101;
9184: }
9185:
9186: * html .LCmodal-overlay {
9187: position: absolute;
9188: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9189: }
9190:
9191: .LCmodal-window {
9192: position:fixed;
9193: top:50%;
9194: left:50%;
9195: margin:0;
9196: padding:0;
9197: z-index:102;
9198: }
9199:
9200: * html .LCmodal-window {
9201: position:absolute;
9202: }
9203:
9204: .LCclose-window {
9205: position:absolute;
9206: width:32px;
9207: height:32px;
9208: right:8px;
9209: top:8px;
9210: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9211: text-indent:-99999px;
9212: overflow:hidden;
9213: cursor:pointer;
9214: }
9215:
1.1369 raeburn 9216: .LCisDisabled {
9217: cursor: not-allowed;
9218: opacity: 0.5;
9219: }
9220:
9221: a[aria-disabled="true"] {
9222: color: currentColor;
9223: display: inline-block; /* For IE11/ MS Edge bug */
9224: pointer-events: none;
9225: text-decoration: none;
9226: }
9227:
1.1335 raeburn 9228: pre.LC_wordwrap {
9229: white-space: pre-wrap;
9230: white-space: -moz-pre-wrap;
9231: white-space: -pre-wrap;
9232: white-space: -o-pre-wrap;
9233: word-wrap: break-word;
9234: }
9235:
1.1100 raeburn 9236: /*
1.1231 damieng 9237: styles used for response display
9238: */
9239: div.LC_radiofoil, div.LC_rankfoil {
9240: margin: .5em 0em .5em 0em;
9241: }
9242: table.LC_itemgroup {
9243: margin-top: 1em;
9244: }
9245:
9246: /*
1.1100 raeburn 9247: styles used by TTH when "Default set of options to pass to tth/m
9248: when converting TeX" in course settings has been set
9249:
9250: option passed: -t
9251:
9252: */
9253:
9254: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9255: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9256: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9257: td div.norm {line-height:normal;}
9258:
9259: /*
9260: option passed -y3
9261: */
9262:
9263: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9264: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9265: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9266:
1.1230 damieng 9267: /*
9268: sections with roles, for content only
9269: */
9270: section[class^="role-"] {
9271: padding-left: 10px;
9272: padding-right: 5px;
9273: margin-top: 8px;
9274: margin-bottom: 8px;
9275: border: 1px solid #2A4;
9276: border-radius: 5px;
9277: box-shadow: 0px 1px 1px #BBB;
9278: }
9279: section[class^="role-"]>h1 {
9280: position: relative;
9281: margin: 0px;
9282: padding-top: 10px;
9283: padding-left: 40px;
9284: }
9285: section[class^="role-"]>h1:before {
9286: position: absolute;
9287: left: -5px;
9288: top: 5px;
9289: }
9290: section.role-activity>h1:before {
9291: content:url('/adm/daxe/images/section_icons/activity.png');
9292: }
9293: section.role-advice>h1:before {
9294: content:url('/adm/daxe/images/section_icons/advice.png');
9295: }
9296: section.role-bibliography>h1:before {
9297: content:url('/adm/daxe/images/section_icons/bibliography.png');
9298: }
9299: section.role-citation>h1:before {
9300: content:url('/adm/daxe/images/section_icons/citation.png');
9301: }
9302: section.role-conclusion>h1:before {
9303: content:url('/adm/daxe/images/section_icons/conclusion.png');
9304: }
9305: section.role-definition>h1:before {
9306: content:url('/adm/daxe/images/section_icons/definition.png');
9307: }
9308: section.role-demonstration>h1:before {
9309: content:url('/adm/daxe/images/section_icons/demonstration.png');
9310: }
9311: section.role-example>h1:before {
9312: content:url('/adm/daxe/images/section_icons/example.png');
9313: }
9314: section.role-explanation>h1:before {
9315: content:url('/adm/daxe/images/section_icons/explanation.png');
9316: }
9317: section.role-introduction>h1:before {
9318: content:url('/adm/daxe/images/section_icons/introduction.png');
9319: }
9320: section.role-method>h1:before {
9321: content:url('/adm/daxe/images/section_icons/method.png');
9322: }
9323: section.role-more_information>h1:before {
9324: content:url('/adm/daxe/images/section_icons/more_information.png');
9325: }
9326: section.role-objectives>h1:before {
9327: content:url('/adm/daxe/images/section_icons/objectives.png');
9328: }
9329: section.role-prerequisites>h1:before {
9330: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9331: }
9332: section.role-remark>h1:before {
9333: content:url('/adm/daxe/images/section_icons/remark.png');
9334: }
9335: section.role-reminder>h1:before {
9336: content:url('/adm/daxe/images/section_icons/reminder.png');
9337: }
9338: section.role-summary>h1:before {
9339: content:url('/adm/daxe/images/section_icons/summary.png');
9340: }
9341: section.role-syntax>h1:before {
9342: content:url('/adm/daxe/images/section_icons/syntax.png');
9343: }
9344: section.role-warning>h1:before {
9345: content:url('/adm/daxe/images/section_icons/warning.png');
9346: }
9347:
1.1269 raeburn 9348: #LC_minitab_header {
9349: float:left;
9350: width:100%;
9351: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9352: font-size:93%;
9353: line-height:normal;
9354: margin: 0.5em 0 0.5em 0;
9355: }
9356: #LC_minitab_header ul {
9357: margin:0;
9358: padding:10px 10px 0;
9359: list-style:none;
9360: }
9361: #LC_minitab_header li {
9362: float:left;
9363: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9364: margin:0;
9365: padding:0 0 0 9px;
9366: }
9367: #LC_minitab_header a {
9368: display:block;
9369: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9370: padding:5px 15px 4px 6px;
9371: }
9372: #LC_minitab_header #LC_current_minitab {
9373: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9374: }
9375: #LC_minitab_header #LC_current_minitab a {
9376: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9377: padding-bottom:5px;
9378: }
9379:
9380:
1.343 albertel 9381: END
9382: }
9383:
1.306 albertel 9384: =pod
9385:
9386: =item * &headtag()
9387:
9388: Returns a uniform footer for LON-CAPA web pages.
9389:
1.307 albertel 9390: Inputs: $title - optional title for the head
9391: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9392: $args - optional arguments
1.319 albertel 9393: force_register - if is true call registerurl so the remote is
9394: informed
1.415 albertel 9395: redirect -> array ref of
9396: 1- seconds before redirect occurs
9397: 2- url to redirect to
9398: 3- whether the side effect should occur
1.315 albertel 9399: (side effect of setting
9400: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9401: redirected to)
9402: 4- whether the redirect target should be
9403: the opener of the current (pop-up)
9404: window (side effect of setting
9405: $env{'internal.head.to_opener'} to
9406: 1, if true.
1.1388 raeburn 9407: 5- whether encrypt check should be skipped
1.352 albertel 9408: domain -> force to color decorate a page for a specific
9409: domain
9410: function -> force usage of a specific rolish color scheme
9411: bgcolor -> override the default page bgcolor
1.460 albertel 9412: no_auto_mt_title
9413: -> prevent &mt()ing the title arg
1.464 albertel 9414:
1.306 albertel 9415: =cut
9416:
9417: sub headtag {
1.313 albertel 9418: my ($title,$head_extra,$args) = @_;
1.306 albertel 9419:
1.363 albertel 9420: my $function = $args->{'function'} || &get_users_function();
9421: my $domain = $args->{'domain'} || &determinedomain();
9422: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9423: my $httphost = $args->{'use_absolute'};
1.418 albertel 9424: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9425: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9426: #time(),
1.418 albertel 9427: $env{'environment.color.timestamp'},
1.363 albertel 9428: $function,$domain,$bgcolor);
9429:
1.369 www 9430: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9431:
1.308 albertel 9432: my $result =
9433: '<head>'.
1.1160 raeburn 9434: &font_settings($args);
1.319 albertel 9435:
1.1188 raeburn 9436: my $inhibitprint;
9437: if ($args->{'print_suppress'}) {
9438: $inhibitprint = &print_suppression();
9439: }
1.1064 raeburn 9440:
1.1439 raeburn 9441: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9442: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9443: }
1.962 droeschl 9444: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9445: $result .= Apache::lonxml::display_title();
1.319 albertel 9446: }
1.436 albertel 9447: if (!$args->{'no_nav_bar'}
9448: && !$args->{'only_body'}
1.1438 raeburn 9449: && !$args->{'frameset'}
9450: && !$args->{'switchserver'}) {
1.1154 raeburn 9451: $result .= &help_menu_js($httphost);
1.1032 www 9452: $result.=&modal_window();
1.1038 www 9453: $result.=&togglebox_script();
1.1034 www 9454: $result.=&wishlist_window();
1.1041 www 9455: $result.=&LCprogressbarUpdate_script();
1.1034 www 9456: } else {
9457: if ($args->{'add_modal'}) {
9458: $result.=&modal_window();
9459: }
9460: if ($args->{'add_wishlist'}) {
9461: $result.=&wishlist_window();
9462: }
1.1038 www 9463: if ($args->{'add_togglebox'}) {
9464: $result.=&togglebox_script();
9465: }
1.1041 www 9466: if ($args->{'add_progressbar'}) {
9467: $result.=&LCprogressbarUpdate_script();
9468: }
1.436 albertel 9469: }
1.314 albertel 9470: if (ref($args->{'redirect'})) {
1.1388 raeburn 9471: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9472: if (!$skip_enc_check) {
9473: $url = &Apache::lonenc::check_encrypt($url);
9474: }
1.414 albertel 9475: if (!$inhibit_continue) {
9476: $env{'internal.head.redirect'} = $url;
9477: }
1.1386 raeburn 9478: $result.=<<"ADDMETA";
1.313 albertel 9479: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9480: ADDMETA
9481: if ($to_opener) {
9482: $env{'internal.head.to_opener'} = 1;
9483: my $dest = &js_escape($url);
9484: my $timeout = int($time * 1000);
9485: $result .=<<"ENDJS";
9486: <script type="text/javascript">
9487: // <![CDATA[
9488: function LC_To_Opener() {
9489: var dest = '$dest';
9490: if (dest != '') {
9491: if (window.opener != null && !window.opener.closed) {
9492: window.opener.location.href=dest;
9493: window.close();
9494: } else {
9495: window.location.href=dest;
9496: }
9497: }
9498: }
9499: \$(document).ready(function () {
9500: setTimeout('LC_To_Opener()',$timeout);
9501: });
9502: // ]]>
9503: </script>
9504: ENDJS
9505: } else {
9506: $result.=<<"ADDMETA";
1.344 albertel 9507: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9508: ADDMETA
1.1386 raeburn 9509: }
1.1210 raeburn 9510: } else {
9511: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9512: my $requrl = $env{'request.uri'};
9513: if ($requrl eq '') {
9514: $requrl = $ENV{'REQUEST_URI'};
9515: $requrl =~ s/\?.+$//;
9516: }
9517: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9518: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9519: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9520: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9521: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9522: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9523: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9524: my ($offload,$offloadoth);
1.1210 raeburn 9525: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9526: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9527: $offload = 1;
1.1353 raeburn 9528: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9529: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9530: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9531: $offloadoth = 1;
9532: $dom_in_use = $env{'user.domain'};
9533: }
9534: }
1.1340 raeburn 9535: }
9536: }
9537: unless ($offload) {
9538: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9539: if ($domdefs{'offloadoth'}{$lonhost}) {
9540: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9541: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9542: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9543: $offload = 1;
1.1352 raeburn 9544: $offloadoth = 1;
1.1340 raeburn 9545: $dom_in_use = $env{'user.domain'};
9546: }
1.1210 raeburn 9547: }
1.1340 raeburn 9548: }
9549: }
9550: }
9551: if ($offload) {
1.1358 raeburn 9552: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9553: if (($newserver eq '') && ($offloadoth)) {
9554: my @domains = &Apache::lonnet::current_machine_domains();
9555: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9556: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9557: }
9558: }
1.1340 raeburn 9559: if (($newserver) && ($newserver ne $lonhost)) {
9560: my $numsec = 5;
9561: my $timeout = $numsec * 1000;
9562: my ($newurl,$locknum,%locks,$msg);
9563: if ($env{'request.role.adv'}) {
9564: ($locknum,%locks) = &Apache::lonnet::get_locks();
9565: }
9566: my $disable_submit = 0;
9567: if ($requrl =~ /$LONCAPA::assess_re/) {
9568: $disable_submit = 1;
9569: }
9570: if ($locknum) {
9571: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9572: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9573: join(", ",sort(values(%locks)))."\n";
9574: if (&show_course()) {
9575: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9576: } else {
9577: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9578: }
1.1340 raeburn 9579: } else {
9580: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9581: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9582: }
9583: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9584: $newurl = '/adm/switchserver?otherserver='.$newserver;
9585: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9586: $newurl .= '&role='.$env{'request.role'};
9587: }
9588: if ($env{'request.symb'}) {
9589: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9590: if ($shownsymb =~ m{^/enc/}) {
9591: my $reqdmajor = 2;
9592: my $reqdminor = 11;
9593: my $reqdsubminor = 3;
9594: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9595: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9596: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9597: if (($major eq '' && $minor eq '') ||
9598: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9599: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9600: ($reqdsubminor > $subminor))))) {
9601: undef($shownsymb);
9602: }
1.1210 raeburn 9603: }
1.1340 raeburn 9604: if ($shownsymb) {
9605: &js_escape(\$shownsymb);
9606: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9607: }
1.1340 raeburn 9608: } else {
9609: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9610: &js_escape(\$shownurl);
9611: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9612: }
1.1340 raeburn 9613: }
9614: &js_escape(\$msg);
9615: $result.=<<OFFLOAD
1.1210 raeburn 9616: <meta http-equiv="pragma" content="no-cache" />
9617: <script type="text/javascript">
1.1215 raeburn 9618: // <![CDATA[
1.1210 raeburn 9619: function LC_Offload_Now() {
9620: var dest = "$newurl";
9621: if (dest != '') {
9622: window.location.href="$newurl";
9623: }
9624: }
1.1214 raeburn 9625: \$(document).ready(function () {
9626: window.alert('$msg');
9627: if ($disable_submit) {
1.1210 raeburn 9628: \$(".LC_hwk_submit").prop("disabled", true);
9629: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9630: }
9631: setTimeout('LC_Offload_Now()', $timeout);
9632: });
1.1215 raeburn 9633: // ]]>
1.1210 raeburn 9634: </script>
9635: OFFLOAD
9636: }
9637: }
9638: }
9639: }
9640: }
1.313 albertel 9641: }
1.306 albertel 9642: if (!defined($title)) {
9643: $title = 'The LearningOnline Network with CAPA';
9644: }
1.460 albertel 9645: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9646: if ($title =~ /^LON-CAPA\s+/) {
9647: $result .= '<title> '.$title.'</title>';
9648: } else {
9649: $result .= '<title> LON-CAPA '.$title.'</title>';
9650: }
9651: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9652: if (!$args->{'frameset'}) {
9653: $result .= ' /';
9654: }
9655: $result .= '>'
1.1064 raeburn 9656: .$inhibitprint
1.414 albertel 9657: .$head_extra;
1.1242 raeburn 9658: my $clientmobile;
9659: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9660: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9661: } else {
9662: $clientmobile = $env{'browser.mobile'};
9663: }
9664: if ($clientmobile) {
1.1137 raeburn 9665: $result .= '
1.1435 raeburn 9666: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9667: <meta name="apple-mobile-web-app-capable" content="yes" />';
9668: }
1.1278 raeburn 9669: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9670: return $result.'</head>';
1.306 albertel 9671: }
9672:
9673: =pod
9674:
1.340 albertel 9675: =item * &font_settings()
9676:
9677: Returns neccessary <meta> to set the proper encoding
9678:
1.1160 raeburn 9679: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9680:
9681: =cut
9682:
9683: sub font_settings {
1.1160 raeburn 9684: my ($args) = @_;
1.340 albertel 9685: my $headerstring='';
1.1160 raeburn 9686: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9687: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9688: $headerstring.=
9689: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9690: if (!$args->{'frameset'}) {
9691: $headerstring.= ' /';
9692: }
9693: $headerstring .= '>'."\n";
1.340 albertel 9694: }
9695: return $headerstring;
9696: }
9697:
1.341 albertel 9698: =pod
9699:
1.1064 raeburn 9700: =item * &print_suppression()
9701:
9702: In course context returns css which causes the body to be blank when media="print",
9703: if printout generation is unavailable for the current resource.
9704:
9705: This could be because:
9706:
9707: (a) printstartdate is in the future
9708:
9709: (b) printenddate is in the past
9710:
9711: (c) there is an active exam block with "printout"
9712: functionality blocked
9713:
9714: Users with pav, pfo or evb privileges are exempt.
9715:
9716: Inputs: none
9717:
9718: =cut
9719:
9720:
9721: sub print_suppression {
9722: my $noprint;
9723: if ($env{'request.course.id'}) {
9724: my $scope = $env{'request.course.id'};
9725: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9726: (&Apache::lonnet::allowed('pfo',$scope))) {
9727: return;
9728: }
9729: if ($env{'request.course.sec'} ne '') {
9730: $scope .= "/$env{'request.course.sec'}";
9731: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9732: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9733: return;
1.1064 raeburn 9734: }
9735: }
9736: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9737: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9738: my $clientip = &Apache::lonnet::get_requestor_ip();
9739: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9740: if ($blocked) {
9741: my $checkrole = "cm./$cdom/$cnum";
9742: if ($env{'request.course.sec'} ne '') {
9743: $checkrole .= "/$env{'request.course.sec'}";
9744: }
9745: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9746: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9747: $noprint = 1;
9748: }
9749: }
9750: unless ($noprint) {
9751: my $symb = &Apache::lonnet::symbread();
9752: if ($symb ne '') {
9753: my $navmap = Apache::lonnavmaps::navmap->new();
9754: if (ref($navmap)) {
9755: my $res = $navmap->getBySymb($symb);
9756: if (ref($res)) {
9757: if (!$res->resprintable()) {
9758: $noprint = 1;
9759: }
9760: }
9761: }
9762: }
9763: }
9764: if ($noprint) {
9765: return <<"ENDSTYLE";
9766: <style type="text/css" media="print">
9767: body { display:none }
9768: </style>
9769: ENDSTYLE
9770: }
9771: }
9772: return;
9773: }
9774:
9775: =pod
9776:
1.341 albertel 9777: =item * &xml_begin()
9778:
9779: Returns the needed doctype and <html>
9780:
9781: Inputs: none
9782:
9783: =cut
9784:
9785: sub xml_begin {
1.1168 raeburn 9786: my ($is_frameset) = @_;
1.341 albertel 9787: my $output='';
9788:
9789: if ($env{'browser.mathml'}) {
9790: $output='<?xml version="1.0"?>'
9791: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9792: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9793:
9794: # .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
9795: .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
9796: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9797: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9798: } elsif ($is_frameset) {
9799: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9800: '<html>'."\n";
1.341 albertel 9801: } else {
1.1168 raeburn 9802: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9803: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9804: }
9805: return $output;
9806: }
1.340 albertel 9807:
9808: =pod
9809:
1.306 albertel 9810: =item * &start_page()
9811:
9812: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9813:
1.648 raeburn 9814: Inputs:
9815:
9816: =over 4
9817:
9818: $title - optional title for the page
9819:
9820: $head_extra - optional extra HTML to incude inside the <head>
9821:
9822: $args - additional optional args supported are:
9823:
9824: =over 8
9825:
9826: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9827: arg on
1.814 bisitz 9828: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9829: add_entries -> additional attributes to add to the <body>
9830: domain -> force to color decorate a page for a
1.317 albertel 9831: specific domain
1.648 raeburn 9832: function -> force usage of a specific rolish color
1.317 albertel 9833: scheme
1.648 raeburn 9834: redirect -> see &headtag()
9835: bgcolor -> override the default page bg color
9836: js_ready -> return a string ready for being used in
1.317 albertel 9837: a javascript writeln
1.648 raeburn 9838: html_encode -> return a string ready for being used in
1.320 albertel 9839: a html attribute
1.648 raeburn 9840: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9841: $forcereg arg
1.648 raeburn 9842: frameset -> if true will start with a <frameset>
1.330 albertel 9843: rather than <body>
1.648 raeburn 9844: skip_phases -> hash ref of
1.338 albertel 9845: head -> skip the <html><head> generation
9846: body -> skip all <body> generation
1.648 raeburn 9847: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9848: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9849: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9850: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9851: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9852: to override those values, or add to them, specify the value to
9853: include in the style attribute to include in the div tag by using
9854: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9855: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9856: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9857: group -> includes the current group, if page is for a
1.1274 raeburn 9858: specific group
9859: use_absolute -> for request for external resource or syllabus, this
9860: will contain https://<hostname> if server uses
9861: https (as per hosts.tab), but request is for http
9862: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9863: links_disabled -> Links in primary and secondary menus are disabled
9864: (Can enable them once page has loaded - see lonroles.pm
9865: for an example).
1.1380 raeburn 9866: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9867:
1.648 raeburn 9868: =back
1.460 albertel 9869:
1.648 raeburn 9870: =back
1.562 albertel 9871:
1.306 albertel 9872: =cut
9873:
9874: sub start_page {
1.309 albertel 9875: my ($title,$head_extra,$args) = @_;
1.318 albertel 9876: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9877:
1.315 albertel 9878: $env{'internal.start_page'}++;
1.1359 raeburn 9879: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9880:
1.338 albertel 9881: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9882: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9883: }
1.1316 raeburn 9884:
9885: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9886: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9887: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9888: $args->{'no_primary_menu'} = 1;
9889: }
9890: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9891: $args->{'no_inline_menu'} = 1;
9892: }
9893: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9894: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9895: }
9896: } else {
9897: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9898: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9899: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9900: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9901: $args->{'no_primary_menu'} = 1;
9902: }
9903: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9904: $args->{'no_inline_menu'} = 1;
9905: }
9906: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9907: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9908: }
9909: }
9910: }
1.1316 raeburn 9911: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9912: $env{'course.'.$env{'request.course.id'}.'.domain'},
9913: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9914: } elsif ($env{'request.course.id'}) {
9915: my $expiretime=600;
9916: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9917: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9918: }
9919: my ($deeplinkmenu,$menuref);
9920: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9921: if ($menucoll) {
9922: if (ref($menuref) eq 'HASH') {
9923: %menu = %{$menuref};
9924: }
9925: if ($menu{'top'} eq 'n') {
9926: $args->{'no_primary_menu'} = 1;
9927: }
9928: if ($menu{'inline'} eq 'n') {
9929: unless (&Apache::lonnet::allowed('opa')) {
9930: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9931: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9932: my $crstype = &course_type();
9933: my $now = time;
9934: my $ccrole;
9935: if ($crstype eq 'Community') {
9936: $ccrole = 'co';
9937: } else {
9938: $ccrole = 'cc';
9939: }
9940: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9941: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9942: if ((($start) && ($start<0)) ||
9943: (($end) && ($end<$now)) ||
9944: (($start) && ($now<$start))) {
9945: $args->{'no_inline_menu'} = 1;
9946: }
9947: } else {
9948: $args->{'no_inline_menu'} = 1;
9949: }
9950: }
9951: }
9952: }
1.1316 raeburn 9953: }
1.1359 raeburn 9954:
1.1385 raeburn 9955: my $showncrumbs;
1.338 albertel 9956: if (! exists($args->{'skip_phases'}{'body'}) ) {
9957: if ($args->{'frameset'}) {
9958: my $attr_string = &make_attr_string($args->{'force_register'},
9959: $args->{'add_entries'});
9960: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9961: } else {
9962: $result .=
9963: &bodytag($title,
9964: $args->{'function'}, $args->{'add_entries'},
9965: $args->{'only_body'}, $args->{'domain'},
9966: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9967: $args->{'bgcolor'}, $args,
1.1385 raeburn 9968: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9969: \%menu,\$showncrumbs);
1.831 bisitz 9970: }
1.330 albertel 9971: }
1.338 albertel 9972:
1.315 albertel 9973: if ($args->{'js_ready'}) {
1.713 kaisler 9974: $result = &js_ready($result);
1.315 albertel 9975: }
1.320 albertel 9976: if ($args->{'html_encode'}) {
1.713 kaisler 9977: $result = &html_encode($result);
9978: }
9979:
1.813 bisitz 9980: # Preparation for new and consistent functionlist at top of screen
9981: # if ($args->{'functionlist'}) {
9982: # $result .= &build_functionlist();
9983: #}
9984:
1.964 droeschl 9985: # Don't add anything more if only_body wanted or in const space
9986: return $result if $args->{'only_body'}
9987: || $env{'request.state'} eq 'construct';
1.813 bisitz 9988:
9989: #Breadcrumbs
1.758 kaisler 9990: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 9991: unless ($showncrumbs) {
1.758 kaisler 9992: &Apache::lonhtmlcommon::clear_breadcrumbs();
9993: #if any br links exists, add them to the breadcrumbs
9994: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9995: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9996: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9997: }
9998: }
1.1096 raeburn 9999: # if @advtools array contains items add then to the breadcrumbs
10000: if (@advtools > 0) {
10001: &Apache::lonmenu::advtools_crumbs(@advtools);
10002: }
1.1272 raeburn 10003: my $menulink;
10004: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10005: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10006: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10007: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10008: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10009: (!$env{'request.role.adv'}))) {
10010: $menulink = 0;
10011: } else {
10012: undef($menulink);
10013: }
1.1385 raeburn 10014: my $linkprotout;
10015: if ($env{'request.deeplink.login'}) {
10016: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10017: if ($linkprotout) {
10018: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10019: }
10020: }
1.758 kaisler 10021: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10022: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10023: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10024: '',$menulink,'',
10025: $args->{'bread_crumbs_style'});
1.1237 raeburn 10026: } else {
1.1437 raeburn 10027: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10028: $args->{'bread_crumbs_style'});
1.758 kaisler 10029: }
1.1385 raeburn 10030: }
1.320 albertel 10031: }
1.315 albertel 10032: return $result;
1.306 albertel 10033: }
10034:
10035: sub end_page {
1.315 albertel 10036: my ($args) = @_;
10037: $env{'internal.end_page'}++;
1.330 albertel 10038: my $result;
1.335 albertel 10039: if ($args->{'discussion'}) {
10040: my ($target,$parser);
10041: if (ref($args->{'discussion'})) {
10042: ($target,$parser) =($args->{'discussion'}{'target'},
10043: $args->{'discussion'}{'parser'});
10044: }
10045: $result .= &Apache::lonxml::xmlend($target,$parser);
10046: }
1.330 albertel 10047: if ($args->{'frameset'}) {
10048: $result .= '</frameset>';
10049: } else {
1.635 raeburn 10050: $result .= &endbodytag($args);
1.330 albertel 10051: }
1.1080 raeburn 10052: unless ($args->{'notbody'}) {
10053: $result .= "\n</html>";
10054: }
1.330 albertel 10055:
1.315 albertel 10056: if ($args->{'js_ready'}) {
1.317 albertel 10057: $result = &js_ready($result);
1.315 albertel 10058: }
1.335 albertel 10059:
1.320 albertel 10060: if ($args->{'html_encode'}) {
10061: $result = &html_encode($result);
10062: }
1.335 albertel 10063:
1.315 albertel 10064: return $result;
10065: }
10066:
1.1359 raeburn 10067: sub menucoll_in_effect {
10068: my ($menucoll,$deeplinkmenu,%menu);
10069: if ($env{'request.course.id'}) {
10070: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10071: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10072: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10073: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10074: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10075: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10076: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10077: my $navmap = Apache::lonnavmaps::navmap->new();
10078: if (ref($navmap)) {
10079: $deeplink = $navmap->get_mapparam(undef,
10080: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10081: '0.deeplink');
1.1370 raeburn 10082: } else {
10083: $check_login_symb = 1;
1.1362 raeburn 10084: }
10085: } else {
1.1370 raeburn 10086: my $symb = &Apache::lonnet::symbread();
10087: if ($symb) {
10088: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10089: } else {
10090: $check_login_symb = 1;
10091: }
1.1362 raeburn 10092: }
10093: } else {
1.1370 raeburn 10094: $check_login_symb = 1;
10095: }
10096: if ($check_login_symb) {
1.1362 raeburn 10097: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10098: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10099: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10100: my $navmap = Apache::lonnavmaps::navmap->new();
10101: if (ref($navmap)) {
10102: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10103: }
10104: } else {
10105: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10106: }
10107: }
1.1359 raeburn 10108: if ($deeplink ne '') {
1.1378 raeburn 10109: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10110: if ($display =~ /^\d+$/) {
10111: $deeplinkmenu = 1;
10112: $menucoll = $display;
10113: }
10114: }
10115: }
10116: if ($menucoll) {
10117: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10118: }
10119: }
10120: return ($menucoll,$deeplinkmenu,\%menu);
10121: }
10122:
1.1362 raeburn 10123: sub deeplink_login_symb {
10124: my ($cnum,$cdom) = @_;
10125: my $login_symb;
10126: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10127: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10128: }
10129: return $login_symb;
10130: }
10131:
10132: sub symb_from_tinyurl {
10133: my ($url,$cnum,$cdom) = @_;
10134: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10135: my $key = $1;
10136: my ($tinyurl,$login);
10137: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10138: if (defined($cached)) {
10139: $tinyurl = $result;
10140: } else {
10141: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10142: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10143: if ($currtiny{$key} ne '') {
10144: $tinyurl = $currtiny{$key};
10145: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10146: }
1.1364 raeburn 10147: }
10148: if ($tinyurl ne '') {
10149: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10150: if (wantarray) {
10151: return ($cnumreq,$symb);
10152: } elsif ($cnumreq eq $cnum) {
10153: return $symb;
1.1362 raeburn 10154: }
10155: }
10156: }
1.1364 raeburn 10157: if (wantarray) {
10158: return ();
10159: } else {
10160: return;
10161: }
1.1362 raeburn 10162: }
10163:
1.1405 raeburn 10164: sub usable_exttools {
10165: my %tooltypes;
10166: if ($env{'request.course.id'}) {
10167: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10168: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10169: %tooltypes = (
10170: crs => 1,
10171: dom => 1,
10172: );
10173: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10174: $tooltypes{'crs'} = 1;
10175: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10176: $tooltypes{'dom'} = 1;
10177: }
10178: } else {
10179: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10180: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10181: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10182: if ($crstype eq '') {
10183: $crstype = 'course';
10184: }
10185: if ($crstype eq 'course') {
10186: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10187: $crstype = 'official';
10188: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10189: $crstype = 'textbook';
10190: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10191: $crstype = 'lti';
10192: } else {
10193: $crstype = 'unofficial';
10194: }
10195: }
10196: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10197: if ($domdefaults{$crstype.'domexttool'}) {
10198: $tooltypes{'dom'} = 1;
10199: }
10200: if ($domdefaults{$crstype.'exttool'}) {
10201: $tooltypes{'crs'} = 1;
10202: }
10203: }
10204: }
10205: return %tooltypes;
10206: }
10207:
1.1034 www 10208: sub wishlist_window {
10209: return(<<'ENDWISHLIST');
1.1046 raeburn 10210: <script type="text/javascript">
1.1034 www 10211: // <![CDATA[
10212: // <!-- BEGIN LON-CAPA Internal
10213: function set_wishlistlink(title, path) {
10214: if (!title) {
10215: title = document.title;
10216: title = title.replace(/^LON-CAPA /,'');
10217: }
1.1175 raeburn 10218: title = encodeURIComponent(title);
1.1203 raeburn 10219: title = title.replace("'","\\\'");
1.1034 www 10220: if (!path) {
10221: path = location.pathname;
10222: }
1.1175 raeburn 10223: path = encodeURIComponent(path);
1.1203 raeburn 10224: path = path.replace("'","\\\'");
1.1034 www 10225: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10226: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10227: }
10228: // END LON-CAPA Internal -->
10229: // ]]>
10230: </script>
10231: ENDWISHLIST
10232: }
10233:
1.1030 www 10234: sub modal_window {
10235: return(<<'ENDMODAL');
1.1046 raeburn 10236: <script type="text/javascript">
1.1030 www 10237: // <![CDATA[
10238: // <!-- BEGIN LON-CAPA Internal
10239: var modalWindow = {
10240: parent:"body",
10241: windowId:null,
10242: content:null,
10243: width:null,
10244: height:null,
10245: close:function()
10246: {
10247: $(".LCmodal-window").remove();
10248: $(".LCmodal-overlay").remove();
10249: },
10250: open:function()
10251: {
10252: var modal = "";
10253: modal += "<div class=\"LCmodal-overlay\"></div>";
10254: modal += "<div id=\"" + this.windowId + "\" class=\"LCmodal-window\" style=\"width:" + this.width + "px; height:" + this.height + "px; margin-top:-" + (this.height / 2) + "px; margin-left:-" + (this.width / 2) + "px;\">";
10255: modal += this.content;
10256: modal += "</div>";
10257:
10258: $(this.parent).append(modal);
10259:
10260: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10261: $(".LCclose-window").click(function(){modalWindow.close();});
10262: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10263: }
10264: };
1.1140 raeburn 10265: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10266: {
1.1266 raeburn 10267: source = source.replace(/'/g,"'");
1.1030 www 10268: modalWindow.windowId = "myModal";
10269: modalWindow.width = width;
10270: modalWindow.height = height;
1.1196 raeburn 10271: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10272: modalWindow.open();
1.1208 raeburn 10273: };
1.1030 www 10274: // END LON-CAPA Internal -->
10275: // ]]>
10276: </script>
10277: ENDMODAL
10278: }
10279:
10280: sub modal_link {
1.1140 raeburn 10281: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10282: unless ($width) { $width=480; }
10283: unless ($height) { $height=400; }
1.1031 www 10284: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10285: unless ($transparency) { $transparency='true'; }
10286:
1.1074 raeburn 10287: my $target_attr;
10288: if (defined($target)) {
10289: $target_attr = 'target="'.$target.'"';
10290: }
10291: return <<"ENDLINK";
1.1336 raeburn 10292: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10293: ENDLINK
1.1030 www 10294: }
10295:
1.1032 www 10296: sub modal_adhoc_script {
1.1365 raeburn 10297: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10298: my $mathjax;
10299: if ($possmathjax) {
10300: $mathjax = <<'ENDJAX';
10301: if (typeof MathJax == 'object') {
10302: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10303: }
10304: ENDJAX
10305: }
1.1032 www 10306: return (<<ENDADHOC);
1.1046 raeburn 10307: <script type="text/javascript">
1.1032 www 10308: // <![CDATA[
10309: var $funcname = function()
10310: {
10311: modalWindow.windowId = "myModal";
10312: modalWindow.width = $width;
10313: modalWindow.height = $height;
10314: modalWindow.content = '$content';
10315: modalWindow.open();
1.1365 raeburn 10316: $mathjax
1.1032 www 10317: };
10318: // ]]>
10319: </script>
10320: ENDADHOC
10321: }
10322:
1.1041 www 10323: sub modal_adhoc_inner {
1.1365 raeburn 10324: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10325: my $innerwidth=$width-20;
10326: $content=&js_ready(
1.1140 raeburn 10327: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10328: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10329: $content.
1.1041 www 10330: &end_scrollbox().
1.1140 raeburn 10331: &end_page()
1.1041 www 10332: );
1.1365 raeburn 10333: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10334: }
10335:
10336: sub modal_adhoc_window {
1.1365 raeburn 10337: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10338: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10339: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10340: }
10341:
10342: sub modal_adhoc_launch {
10343: my ($funcname,$width,$height,$content)=@_;
10344: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10345: <script type="text/javascript">
10346: // <![CDATA[
10347: $funcname();
10348: // ]]>
10349: </script>
10350: ENDLAUNCH
10351: }
10352:
10353: sub modal_adhoc_close {
10354: return (<<ENDCLOSE);
10355: <script type="text/javascript">
10356: // <![CDATA[
10357: modalWindow.close();
10358: // ]]>
10359: </script>
10360: ENDCLOSE
10361: }
10362:
1.1038 www 10363: sub togglebox_script {
10364: return(<<ENDTOGGLE);
10365: <script type="text/javascript">
10366: // <![CDATA[
10367: function LCtoggleDisplay(id,hidetext,showtext) {
10368: link = document.getElementById(id + "link").childNodes[0];
10369: with (document.getElementById(id).style) {
10370: if (display == "none" ) {
10371: display = "inline";
10372: link.nodeValue = hidetext;
10373: } else {
10374: display = "none";
10375: link.nodeValue = showtext;
10376: }
10377: }
10378: }
10379: // ]]>
10380: </script>
10381: ENDTOGGLE
10382: }
10383:
1.1039 www 10384: sub start_togglebox {
10385: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10386: unless ($heading) { $heading=''; } else { $heading.=' '; }
10387: unless ($showtext) { $showtext=&mt('show'); }
10388: unless ($hidetext) { $hidetext=&mt('hide'); }
10389: unless ($headerbg) { $headerbg='#FFFFFF'; }
10390: return &start_data_table().
10391: &start_data_table_header_row().
10392: '<td bgcolor="'.$headerbg.'">'.$heading.
10393: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10394: $showtext.'\')">'.$showtext.'</a>]</td>'.
10395: &end_data_table_header_row().
10396: '<tr id="'.$id.'" style="display:none""><td>';
10397: }
10398:
10399: sub end_togglebox {
10400: return '</td></tr>'.&end_data_table();
10401: }
10402:
1.1041 www 10403: sub LCprogressbar_script {
1.1302 raeburn 10404: my ($id,$number_to_do)=@_;
10405: if ($number_to_do) {
10406: return(<<ENDPROGRESS);
1.1041 www 10407: <script type="text/javascript">
10408: // <![CDATA[
1.1045 www 10409: \$('#progressbar$id').progressbar({
1.1041 www 10410: value: 0,
10411: change: function(event, ui) {
10412: var newVal = \$(this).progressbar('option', 'value');
10413: \$('.pblabel', this).text(LCprogressTxt);
10414: }
10415: });
10416: // ]]>
10417: </script>
10418: ENDPROGRESS
1.1302 raeburn 10419: } else {
10420: return(<<ENDPROGRESS);
10421: <script type="text/javascript">
10422: // <![CDATA[
10423: \$('#progressbar$id').progressbar({
10424: value: false,
10425: create: function(event, ui) {
10426: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10427: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10428: }
10429: });
10430: // ]]>
10431: </script>
10432: ENDPROGRESS
10433: }
1.1041 www 10434: }
10435:
10436: sub LCprogressbarUpdate_script {
10437: return(<<ENDPROGRESSUPDATE);
10438: <style type="text/css">
10439: .ui-progressbar { position:relative; }
1.1302 raeburn 10440: .progress-label {position: absolute; width: 100%; text-align: center; top: 1px; font-weight: bold; text-shadow: 1px 1px 0 #fff;margin: 0; line-height: 200%; }
1.1041 www 10441: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10442: </style>
10443: <script type="text/javascript">
10444: // <![CDATA[
1.1045 www 10445: var LCprogressTxt='---';
10446:
1.1302 raeburn 10447: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10448: LCprogressTxt=progresstext;
1.1302 raeburn 10449: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10450: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10451: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10452: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10453: } else {
10454: \$('#progressbar'+id).progressbar('value',percent);
10455: }
1.1041 www 10456: }
10457: // ]]>
10458: </script>
10459: ENDPROGRESSUPDATE
10460: }
10461:
1.1042 www 10462: my $LClastpercent;
1.1045 www 10463: my $LCidcnt;
10464: my $LCcurrentid;
1.1042 www 10465:
1.1041 www 10466: sub LCprogressbar {
1.1302 raeburn 10467: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10468: $LClastpercent=0;
1.1045 www 10469: $LCidcnt++;
10470: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10471: my ($starting,$content);
10472: if ($number_to_do) {
10473: $starting=&mt('Starting');
10474: $content=(<<ENDPROGBAR);
10475: $preamble
1.1045 www 10476: <div id="progressbar$LCcurrentid">
1.1041 www 10477: <span class="pblabel">$starting</span>
10478: </div>
10479: ENDPROGBAR
1.1302 raeburn 10480: } else {
10481: $starting=&mt('Loading...');
10482: $LClastpercent='false';
10483: $content=(<<ENDPROGBAR);
10484: $preamble
10485: <div id="progressbar$LCcurrentid">
10486: <div class="progress-label">$starting</div>
10487: </div>
10488: ENDPROGBAR
10489: }
10490: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10491: }
10492:
10493: sub LCprogressbarUpdate {
1.1302 raeburn 10494: my ($r,$val,$text,$number_to_do)=@_;
10495: if ($number_to_do) {
10496: unless ($val) {
10497: if ($LClastpercent) {
10498: $val=$LClastpercent;
10499: } else {
10500: $val=0;
10501: }
10502: }
10503: if ($val<0) { $val=0; }
10504: if ($val>100) { $val=0; }
10505: $LClastpercent=$val;
10506: unless ($text) { $text=$val.'%'; }
10507: } else {
10508: $val = 'false';
1.1042 www 10509: }
1.1041 www 10510: $text=&js_ready($text);
1.1044 www 10511: &r_print($r,<<ENDUPDATE);
1.1041 www 10512: <script type="text/javascript">
10513: // <![CDATA[
1.1302 raeburn 10514: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10515: // ]]>
10516: </script>
10517: ENDUPDATE
1.1035 www 10518: }
10519:
1.1042 www 10520: sub LCprogressbarClose {
10521: my ($r)=@_;
10522: $LClastpercent=0;
1.1044 www 10523: &r_print($r,<<ENDCLOSE);
1.1042 www 10524: <script type="text/javascript">
10525: // <![CDATA[
1.1045 www 10526: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10527: // ]]>
10528: </script>
10529: ENDCLOSE
1.1044 www 10530: }
10531:
10532: sub r_print {
10533: my ($r,$to_print)=@_;
10534: if ($r) {
10535: $r->print($to_print);
10536: $r->rflush();
10537: } else {
10538: print($to_print);
10539: }
1.1042 www 10540: }
10541:
1.320 albertel 10542: sub html_encode {
10543: my ($result) = @_;
10544:
1.322 albertel 10545: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10546:
10547: return $result;
10548: }
1.1044 www 10549:
1.317 albertel 10550: sub js_ready {
10551: my ($result) = @_;
10552:
1.323 albertel 10553: $result =~ s/[\n\r]/ /xmsg;
10554: $result =~ s/\\/\\\\/xmsg;
10555: $result =~ s/'/\\'/xmsg;
1.372 albertel 10556: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10557:
10558: return $result;
10559: }
10560:
1.315 albertel 10561: sub validate_page {
10562: if ( exists($env{'internal.start_page'})
1.316 albertel 10563: && $env{'internal.start_page'} > 1) {
10564: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10565: $env{'internal.start_page'}.' '.
1.316 albertel 10566: $ENV{'request.filename'});
1.315 albertel 10567: }
10568: if ( exists($env{'internal.end_page'})
1.316 albertel 10569: && $env{'internal.end_page'} > 1) {
10570: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10571: $env{'internal.end_page'}.' '.
1.316 albertel 10572: $env{'request.filename'});
1.315 albertel 10573: }
10574: if ( exists($env{'internal.start_page'})
10575: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10576: &Apache::lonnet::logthis('start_page called without end_page '.
10577: $env{'request.filename'});
1.315 albertel 10578: }
10579: if ( ! exists($env{'internal.start_page'})
10580: && exists($env{'internal.end_page'})) {
1.316 albertel 10581: &Apache::lonnet::logthis('end_page called without start_page'.
10582: $env{'request.filename'});
1.315 albertel 10583: }
1.306 albertel 10584: }
1.315 albertel 10585:
1.996 www 10586:
10587: sub start_scrollbox {
1.1140 raeburn 10588: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10589: unless ($outerwidth) { $outerwidth='520px'; }
10590: unless ($width) { $width='500px'; }
10591: unless ($height) { $height='200px'; }
1.1075 raeburn 10592: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10593: if ($id ne '') {
1.1140 raeburn 10594: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10595: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10596: }
1.1075 raeburn 10597: if ($bgcolor ne '') {
10598: $tdcol = "background-color: $bgcolor;";
10599: }
1.1137 raeburn 10600: my $nicescroll_js;
10601: if ($env{'browser.mobile'}) {
1.1140 raeburn 10602: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10603: }
10604: return <<"END";
10605: $nicescroll_js
10606:
10607: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10608: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10609: END
10610: }
10611:
10612: sub end_scrollbox {
10613: return '</div></td></tr></table>';
10614: }
10615:
10616: sub nicescroll_javascript {
10617: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10618: my %options;
10619: if (ref($cursor) eq 'HASH') {
10620: %options = %{$cursor};
10621: }
10622: unless ($options{'railalign'} =~ /^left|right$/) {
10623: $options{'railalign'} = 'left';
10624: }
10625: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10626: my $function = &get_users_function();
10627: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10628: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10629: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10630: }
1.1140 raeburn 10631: }
10632: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10633: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10634: $options{'cursoropacity'}='1.0';
10635: }
1.1140 raeburn 10636: } else {
10637: $options{'cursoropacity'}='1.0';
10638: }
10639: if ($options{'cursorfixedheight'} eq 'none') {
10640: delete($options{'cursorfixedheight'});
10641: } else {
10642: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10643: }
10644: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10645: delete($options{'railoffset'});
10646: }
10647: my @niceoptions;
10648: while (my($key,$value) = each(%options)) {
10649: if ($value =~ /^\{.+\}$/) {
10650: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10651: } else {
1.1140 raeburn 10652: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10653: }
1.1140 raeburn 10654: }
10655: my $nicescroll_js = '
1.1137 raeburn 10656: $(document).ready(
1.1140 raeburn 10657: function() {
10658: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10659: }
1.1137 raeburn 10660: );
10661: ';
1.1140 raeburn 10662: if ($framecheck) {
10663: $nicescroll_js .= '
10664: function expand_div(caller) {
10665: if (top === self) {
10666: document.getElementById("'.$id.'").style.width = "auto";
10667: document.getElementById("'.$id.'").style.height = "auto";
10668: } else {
10669: try {
10670: if (parent.frames) {
10671: if (parent.frames.length > 1) {
10672: var framesrc = parent.frames[1].location.href;
10673: var currsrc = framesrc.replace(/\#.*$/,"");
10674: if ((caller == "search") || (currsrc == "'.$location.'")) {
10675: document.getElementById("'.$id.'").style.width = "auto";
10676: document.getElementById("'.$id.'").style.height = "auto";
10677: }
10678: }
10679: }
10680: } catch (e) {
10681: return;
10682: }
1.1137 raeburn 10683: }
1.1140 raeburn 10684: return;
1.996 www 10685: }
1.1140 raeburn 10686: ';
10687: }
10688: if ($needjsready) {
10689: $nicescroll_js = '
10690: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10691: } else {
10692: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10693: }
10694: return $nicescroll_js;
1.996 www 10695: }
10696:
1.318 albertel 10697: sub simple_error_page {
1.1150 bisitz 10698: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10699: my %displayargs;
1.1151 raeburn 10700: if (ref($args) eq 'HASH') {
10701: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10702: if ($args->{'only_body'}) {
10703: $displayargs{'only_body'} = 1;
10704: }
10705: if ($args->{'no_nav_bar'}) {
10706: $displayargs{'no_nav_bar'} = 1;
10707: }
1.1151 raeburn 10708: } else {
10709: $msg = &mt($msg);
10710: }
1.1150 bisitz 10711:
1.318 albertel 10712: my $page =
1.1304 raeburn 10713: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10714: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10715: &Apache::loncommon::end_page();
10716: if (ref($r)) {
10717: $r->print($page);
1.327 albertel 10718: return;
1.318 albertel 10719: }
10720: return $page;
10721: }
1.347 albertel 10722:
10723: {
1.610 albertel 10724: my @row_count;
1.961 onken 10725:
10726: sub start_data_table_count {
10727: unshift(@row_count, 0);
10728: return;
10729: }
10730:
10731: sub end_data_table_count {
10732: shift(@row_count);
10733: return;
10734: }
10735:
1.347 albertel 10736: sub start_data_table {
1.1018 raeburn 10737: my ($add_class,$id) = @_;
1.422 albertel 10738: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10739: my $table_id;
10740: if (defined($id)) {
10741: $table_id = ' id="'.$id.'"';
10742: }
1.961 onken 10743: &start_data_table_count();
1.1018 raeburn 10744: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10745: }
10746:
10747: sub end_data_table {
1.961 onken 10748: &end_data_table_count();
1.389 albertel 10749: return '</table>'."\n";;
1.347 albertel 10750: }
10751:
10752: sub start_data_table_row {
1.974 wenzelju 10753: my ($add_class, $id) = @_;
1.610 albertel 10754: $row_count[0]++;
10755: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10756: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10757: $id = (' id="'.$id.'"') unless ($id eq '');
10758: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10759: }
1.471 banghart 10760:
10761: sub continue_data_table_row {
1.974 wenzelju 10762: my ($add_class, $id) = @_;
1.610 albertel 10763: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10764: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10765: $id = (' id="'.$id.'"') unless ($id eq '');
10766: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10767: }
1.347 albertel 10768:
10769: sub end_data_table_row {
1.389 albertel 10770: return '</tr>'."\n";;
1.347 albertel 10771: }
1.367 www 10772:
1.421 albertel 10773: sub start_data_table_empty_row {
1.707 bisitz 10774: # $row_count[0]++;
1.421 albertel 10775: return '<tr class="LC_empty_row" >'."\n";;
10776: }
10777:
10778: sub end_data_table_empty_row {
10779: return '</tr>'."\n";;
10780: }
10781:
1.367 www 10782: sub start_data_table_header_row {
1.389 albertel 10783: return '<tr class="LC_header_row">'."\n";;
1.367 www 10784: }
10785:
10786: sub end_data_table_header_row {
1.389 albertel 10787: return '</tr>'."\n";;
1.367 www 10788: }
1.890 droeschl 10789:
10790: sub data_table_caption {
10791: my $caption = shift;
10792: return "<caption class=\"LC_caption\">$caption</caption>";
10793: }
1.347 albertel 10794: }
10795:
1.548 albertel 10796: =pod
10797:
10798: =item * &inhibit_menu_check($arg)
10799:
10800: Checks for a inhibitmenu state and generates output to preserve it
10801:
10802: Inputs: $arg - can be any of
10803: - undef - in which case the return value is a string
10804: to add into arguments list of a uri
10805: - 'input' - in which case the return value is a HTML
10806: <form> <input> field of type hidden to
10807: preserve the value
10808: - a url - in which case the return value is the url with
10809: the neccesary cgi args added to preserve the
10810: inhibitmenu state
10811: - a ref to a url - no return value, but the string is
10812: updated to include the neccessary cgi
10813: args to preserve the inhibitmenu state
10814:
10815: =cut
10816:
10817: sub inhibit_menu_check {
10818: my ($arg) = @_;
10819: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10820: if ($arg eq 'input') {
10821: if ($env{'form.inhibitmenu'}) {
10822: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10823: } else {
10824: return
10825: }
10826: }
10827: if ($env{'form.inhibitmenu'}) {
10828: if (ref($arg)) {
10829: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10830: } elsif ($arg eq '') {
10831: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10832: } else {
10833: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10834: }
10835: }
10836: if (!ref($arg)) {
10837: return $arg;
10838: }
10839: }
10840:
1.251 albertel 10841: ###############################################
1.182 matthew 10842:
10843: =pod
10844:
1.549 albertel 10845: =back
10846:
10847: =head1 User Information Routines
10848:
10849: =over 4
10850:
1.405 albertel 10851: =item * &get_users_function()
1.182 matthew 10852:
10853: Used by &bodytag to determine the current users primary role.
10854: Returns either 'student','coordinator','admin', or 'author'.
10855:
10856: =cut
10857:
10858: ###############################################
10859: sub get_users_function {
1.815 tempelho 10860: my $function = 'norole';
1.818 tempelho 10861: if ($env{'request.role'}=~/^(st)/) {
10862: $function='student';
10863: }
1.907 raeburn 10864: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10865: $function='coordinator';
10866: }
1.258 albertel 10867: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10868: $function='admin';
10869: }
1.826 bisitz 10870: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10871: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10872: $function='author';
10873: }
10874: return $function;
1.54 www 10875: }
1.99 www 10876:
10877: ###############################################
10878:
1.233 raeburn 10879: =pod
10880:
1.821 raeburn 10881: =item * &show_course()
10882:
10883: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10884: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10885:
10886: Inputs:
10887: None
10888:
10889: Outputs:
10890: Scalar: 1 if 'Course' to be used, 0 otherwise.
10891:
10892: =cut
10893:
10894: ###############################################
10895: sub show_course {
1.1408 raeburn 10896: my ($udom,$uname) = @_;
10897: if (($udom ne '') && ($uname ne '')) {
10898: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10899: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10900: return 0;
10901: } else {
10902: return 1;
10903: }
10904: }
10905: }
1.821 raeburn 10906: my $course = !$env{'user.adv'};
10907: if (!$env{'user.adv'}) {
10908: foreach my $env (keys(%env)) {
10909: next if ($env !~ m/^user\.priv\./);
10910: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10911: $course = 0;
10912: last;
10913: }
10914: }
10915: }
10916: return $course;
10917: }
10918:
10919: ###############################################
10920:
10921: =pod
10922:
1.542 raeburn 10923: =item * &check_user_status()
1.274 raeburn 10924:
10925: Determines current status of supplied role for a
10926: specific user. Roles can be active, previous or future.
10927:
10928: Inputs:
10929: user's domain, user's username, course's domain,
1.375 raeburn 10930: course's number, optional section ID.
1.274 raeburn 10931:
10932: Outputs:
10933: role status: active, previous or future.
10934:
10935: =cut
10936:
10937: sub check_user_status {
1.412 raeburn 10938: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10939: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10940: my @uroles = keys(%userinfo);
1.274 raeburn 10941: my $srchstr;
10942: my $active_chk = 'none';
1.412 raeburn 10943: my $now = time;
1.274 raeburn 10944: if (@uroles > 0) {
1.908 raeburn 10945: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10946: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10947: } else {
1.412 raeburn 10948: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10949: }
10950: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10951: my $role_end = 0;
10952: my $role_start = 0;
10953: $active_chk = 'active';
1.412 raeburn 10954: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10955: $role_end = $1;
10956: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10957: $role_start = $1;
1.274 raeburn 10958: }
10959: }
10960: if ($role_start > 0) {
1.412 raeburn 10961: if ($now < $role_start) {
1.274 raeburn 10962: $active_chk = 'future';
10963: }
10964: }
10965: if ($role_end > 0) {
1.412 raeburn 10966: if ($now > $role_end) {
1.274 raeburn 10967: $active_chk = 'previous';
10968: }
10969: }
10970: }
10971: }
10972: return $active_chk;
10973: }
10974:
10975: ###############################################
10976:
10977: =pod
10978:
1.405 albertel 10979: =item * &get_sections()
1.233 raeburn 10980:
10981: Determines all the sections for a course including
10982: sections with students and sections containing other roles.
1.419 raeburn 10983: Incoming parameters:
10984:
10985: 1. domain
10986: 2. course number
10987: 3. reference to array containing roles for which sections should
10988: be gathered (optional).
10989: 4. reference to array containing status types for which sections
10990: should be gathered (optional).
10991:
10992: If the third argument is undefined, sections are gathered for any role.
10993: If the fourth argument is undefined, sections are gathered for any status.
10994: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10995:
1.374 raeburn 10996: Returns section hash (keys are section IDs, values are
10997: number of users in each section), subject to the
1.419 raeburn 10998: optional roles filter, optional status filter
1.233 raeburn 10999:
11000: =cut
11001:
11002: ###############################################
11003: sub get_sections {
1.419 raeburn 11004: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11005: if (!defined($cdom) || !defined($cnum)) {
11006: my $cid = $env{'request.course.id'};
11007:
11008: return if (!defined($cid));
11009:
11010: $cdom = $env{'course.'.$cid.'.domain'};
11011: $cnum = $env{'course.'.$cid.'.num'};
11012: }
11013:
11014: my %sectioncount;
1.419 raeburn 11015: my $now = time;
1.240 albertel 11016:
1.1118 raeburn 11017: my $check_students = 1;
11018: my $only_students = 0;
11019: if (ref($possible_roles) eq 'ARRAY') {
11020: if (grep(/^st$/,@{$possible_roles})) {
11021: if (@{$possible_roles} == 1) {
11022: $only_students = 1;
11023: }
11024: } else {
11025: $check_students = 0;
11026: }
11027: }
11028:
11029: if ($check_students) {
1.276 albertel 11030: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11031: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11032: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11033: my $start_index = &Apache::loncoursedata::CL_START();
11034: my $end_index = &Apache::loncoursedata::CL_END();
11035: my $status;
1.366 albertel 11036: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11037: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11038: $data->[$status_index],
11039: $data->[$start_index],
11040: $data->[$end_index]);
11041: if ($stu_status eq 'Active') {
11042: $status = 'active';
11043: } elsif ($end < $now) {
11044: $status = 'previous';
11045: } elsif ($start > $now) {
11046: $status = 'future';
11047: }
11048: if ($section ne '-1' && $section !~ /^\s*$/) {
11049: if ((!defined($possible_status)) || (($status ne '') &&
11050: (grep/^\Q$status\E$/,@{$possible_status}))) {
11051: $sectioncount{$section}++;
11052: }
1.240 albertel 11053: }
11054: }
11055: }
1.1118 raeburn 11056: if ($only_students) {
11057: return %sectioncount;
11058: }
1.240 albertel 11059: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11060: foreach my $user (sort(keys(%courseroles))) {
11061: if ($user !~ /^(\w{2})/) { next; }
11062: my ($role) = ($user =~ /^(\w{2})/);
11063: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11064: my ($section,$status);
1.240 albertel 11065: if ($role eq 'cr' &&
11066: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11067: $section=$1;
11068: }
11069: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11070: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11071: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11072: if ($end == -1 && $start == -1) {
11073: next; #deleted role
11074: }
11075: if (!defined($possible_status)) {
11076: $sectioncount{$section}++;
11077: } else {
11078: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11079: $status = 'active';
11080: } elsif ($end < $now) {
11081: $status = 'future';
11082: } elsif ($start > $now) {
11083: $status = 'previous';
11084: }
11085: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11086: $sectioncount{$section}++;
11087: }
11088: }
1.233 raeburn 11089: }
1.366 albertel 11090: return %sectioncount;
1.233 raeburn 11091: }
11092:
1.274 raeburn 11093: ###############################################
1.294 raeburn 11094:
11095: =pod
1.405 albertel 11096:
11097: =item * &get_course_users()
11098:
1.275 raeburn 11099: Retrieves usernames:domains for users in the specified course
11100: with specific role(s), and access status.
11101:
11102: Incoming parameters:
1.277 albertel 11103: 1. course domain
11104: 2. course number
11105: 3. access status: users must have - either active,
1.275 raeburn 11106: previous, future, or all.
1.277 albertel 11107: 4. reference to array of permissible roles
1.288 raeburn 11108: 5. reference to array of section restrictions (optional)
11109: 6. reference to results object (hash of hashes).
11110: 7. reference to optional userdata hash
1.609 raeburn 11111: 8. reference to optional statushash
1.630 raeburn 11112: 9. flag if privileged users (except those set to unhide in
11113: course settings) should be excluded
1.609 raeburn 11114: Keys of top level results hash are roles.
1.275 raeburn 11115: Keys of inner hashes are username:domain, with
11116: values set to access type.
1.288 raeburn 11117: Optional userdata hash returns an array with arguments in the
11118: same order as loncoursedata::get_classlist() for student data.
11119:
1.609 raeburn 11120: Optional statushash returns
11121:
1.288 raeburn 11122: Entries for end, start, section and status are blank because
11123: of the possibility of multiple values for non-student roles.
11124:
1.275 raeburn 11125: =cut
1.405 albertel 11126:
1.275 raeburn 11127: ###############################################
1.405 albertel 11128:
1.275 raeburn 11129: sub get_course_users {
1.630 raeburn 11130: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11131: my %idx = ();
1.419 raeburn 11132: my %seclists;
1.288 raeburn 11133:
11134: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11135: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11136: $idx{end} = &Apache::loncoursedata::CL_END();
11137: $idx{start} = &Apache::loncoursedata::CL_START();
11138: $idx{id} = &Apache::loncoursedata::CL_ID();
11139: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11140: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11141: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11142:
1.290 albertel 11143: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11144: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11145: my $now = time;
1.277 albertel 11146: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11147: my $match = 0;
1.412 raeburn 11148: my $secmatch = 0;
1.419 raeburn 11149: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11150: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11151: if ($section eq '') {
11152: $section = 'none';
11153: }
1.291 albertel 11154: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11155: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11156: $secmatch = 1;
11157: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11158: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11159: $secmatch = 1;
11160: }
11161: } else {
1.419 raeburn 11162: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11163: $secmatch = 1;
11164: }
1.290 albertel 11165: }
1.412 raeburn 11166: if (!$secmatch) {
11167: next;
11168: }
1.419 raeburn 11169: }
1.275 raeburn 11170: if (defined($$types{'active'})) {
1.288 raeburn 11171: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11172: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11173: $match = 1;
1.275 raeburn 11174: }
11175: }
11176: if (defined($$types{'previous'})) {
1.609 raeburn 11177: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11178: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11179: $match = 1;
1.275 raeburn 11180: }
11181: }
11182: if (defined($$types{'future'})) {
1.609 raeburn 11183: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11184: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11185: $match = 1;
1.275 raeburn 11186: }
11187: }
1.609 raeburn 11188: if ($match) {
11189: push(@{$seclists{$student}},$section);
11190: if (ref($userdata) eq 'HASH') {
11191: $$userdata{$student} = $$classlist{$student};
11192: }
11193: if (ref($statushash) eq 'HASH') {
11194: $statushash->{$student}{'st'}{$section} = $status;
11195: }
1.288 raeburn 11196: }
1.275 raeburn 11197: }
11198: }
1.412 raeburn 11199: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11200: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11201: my $now = time;
1.609 raeburn 11202: my %displaystatus = ( previous => 'Expired',
11203: active => 'Active',
11204: future => 'Future',
11205: );
1.1121 raeburn 11206: my (%nothide,@possdoms);
1.630 raeburn 11207: if ($hidepriv) {
11208: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11209: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11210: if ($user !~ /:/) {
11211: $nothide{join(':',split(/[\@]/,$user))}=1;
11212: } else {
11213: $nothide{$user} = 1;
11214: }
11215: }
1.1121 raeburn 11216: my @possdoms = ($cdom);
11217: if ($coursehash{'checkforpriv'}) {
11218: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11219: }
1.630 raeburn 11220: }
1.439 raeburn 11221: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11222: my $match = 0;
1.412 raeburn 11223: my $secmatch = 0;
1.439 raeburn 11224: my $status;
1.412 raeburn 11225: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11226: $user =~ s/:$//;
1.439 raeburn 11227: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11228: if ($end == -1 || $start == -1) {
11229: next;
11230: }
11231: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11232: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11233: my ($uname,$udom) = split(/:/,$user);
11234: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11235: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11236: $secmatch = 1;
11237: } elsif ($usec eq '') {
1.420 albertel 11238: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11239: $secmatch = 1;
11240: }
11241: } else {
11242: if (grep(/^\Q$usec\E$/,@{$sections})) {
11243: $secmatch = 1;
11244: }
11245: }
11246: if (!$secmatch) {
11247: next;
11248: }
1.288 raeburn 11249: }
1.419 raeburn 11250: if ($usec eq '') {
11251: $usec = 'none';
11252: }
1.275 raeburn 11253: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11254: if ($hidepriv) {
1.1121 raeburn 11255: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11256: (!$nothide{$uname.':'.$udom})) {
11257: next;
11258: }
11259: }
1.503 raeburn 11260: if ($end > 0 && $end < $now) {
1.439 raeburn 11261: $status = 'previous';
11262: } elsif ($start > $now) {
11263: $status = 'future';
11264: } else {
11265: $status = 'active';
11266: }
1.277 albertel 11267: foreach my $type (keys(%{$types})) {
1.275 raeburn 11268: if ($status eq $type) {
1.420 albertel 11269: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11270: push(@{$$users{$role}{$user}},$type);
11271: }
1.288 raeburn 11272: $match = 1;
11273: }
11274: }
1.419 raeburn 11275: if (($match) && (ref($userdata) eq 'HASH')) {
11276: if (!exists($$userdata{$uname.':'.$udom})) {
11277: &get_user_info($udom,$uname,\%idx,$userdata);
11278: }
1.420 albertel 11279: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11280: push(@{$seclists{$uname.':'.$udom}},$usec);
11281: }
1.609 raeburn 11282: if (ref($statushash) eq 'HASH') {
11283: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11284: }
1.275 raeburn 11285: }
11286: }
11287: }
11288: }
1.290 albertel 11289: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11290: if ((defined($cdom)) && (defined($cnum))) {
11291: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11292: if ( defined($csettings{'internal.courseowner'}) ) {
11293: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11294: next if ($owner eq '');
11295: my ($ownername,$ownerdom);
11296: if ($owner =~ /^([^:]+):([^:]+)$/) {
11297: $ownername = $1;
11298: $ownerdom = $2;
11299: } else {
11300: $ownername = $owner;
11301: $ownerdom = $cdom;
11302: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11303: }
11304: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11305: if (defined($userdata) &&
1.609 raeburn 11306: !exists($$userdata{$owner})) {
11307: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11308: if (!grep(/^none$/,@{$seclists{$owner}})) {
11309: push(@{$seclists{$owner}},'none');
11310: }
11311: if (ref($statushash) eq 'HASH') {
11312: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11313: }
1.290 albertel 11314: }
1.279 raeburn 11315: }
11316: }
11317: }
1.419 raeburn 11318: foreach my $user (keys(%seclists)) {
11319: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11320: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11321: }
1.275 raeburn 11322: }
11323: return;
11324: }
11325:
1.288 raeburn 11326: sub get_user_info {
11327: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11328: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11329: &plainname($uname,$udom,'lastname');
1.291 albertel 11330: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11331: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11332: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11333: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11334: return;
11335: }
1.275 raeburn 11336:
1.472 raeburn 11337: ###############################################
11338:
11339: =pod
11340:
11341: =item * &get_user_quota()
11342:
1.1134 raeburn 11343: Retrieves quota assigned for storage of user files.
11344: Default is to report quota for portfolio files.
1.472 raeburn 11345:
11346: Incoming parameters:
11347: 1. user's username
11348: 2. user's domain
1.1134 raeburn 11349: 3. quota name - portfolio, author, or course
1.1136 raeburn 11350: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11351: 4. crstype - official, unofficial, textbook, placement or community,
11352: if quota name is course
1.472 raeburn 11353:
11354: Returns:
1.1163 raeburn 11355: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11356: 2. (Optional) Type of setting: custom or default
11357: (individually assigned or default for user's
11358: institutional status).
11359: 3. (Optional) - User's institutional status (e.g., faculty, staff
11360: or student - types as defined in localenroll::inst_usertypes
11361: for user's domain, which determines default quota for user.
11362: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11363:
11364: If a value has been stored in the user's environment,
1.536 raeburn 11365: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11366: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11367:
11368: =cut
11369:
11370: ###############################################
11371:
11372:
11373: sub get_user_quota {
1.1136 raeburn 11374: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11375: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11376: if (!defined($udom)) {
11377: $udom = $env{'user.domain'};
11378: }
11379: if (!defined($uname)) {
11380: $uname = $env{'user.name'};
11381: }
11382: if (($udom eq '' || $uname eq '') ||
11383: ($udom eq 'public') && ($uname eq 'public')) {
11384: $quota = 0;
1.536 raeburn 11385: $quotatype = 'default';
11386: $defquota = 0;
1.472 raeburn 11387: } else {
1.536 raeburn 11388: my $inststatus;
1.1134 raeburn 11389: if ($quotaname eq 'course') {
11390: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11391: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11392: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11393: } else {
11394: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11395: $quota = $cenv{'internal.uploadquota'};
11396: }
1.536 raeburn 11397: } else {
1.1134 raeburn 11398: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11399: if ($quotaname eq 'author') {
11400: $quota = $env{'environment.authorquota'};
11401: } else {
11402: $quota = $env{'environment.portfolioquota'};
11403: }
11404: $inststatus = $env{'environment.inststatus'};
11405: } else {
11406: my %userenv =
11407: &Apache::lonnet::get('environment',['portfolioquota',
11408: 'authorquota','inststatus'],$udom,$uname);
11409: my ($tmp) = keys(%userenv);
11410: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11411: if ($quotaname eq 'author') {
11412: $quota = $userenv{'authorquota'};
11413: } else {
11414: $quota = $userenv{'portfolioquota'};
11415: }
11416: $inststatus = $userenv{'inststatus'};
11417: } else {
11418: undef(%userenv);
11419: }
11420: }
11421: }
11422: if ($quota eq '' || wantarray) {
11423: if ($quotaname eq 'course') {
11424: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11425: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11426: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11427: ($crstype eq 'placement')) {
1.1136 raeburn 11428: $defquota = $domdefs{$crstype.'quota'};
11429: }
11430: if ($defquota eq '') {
11431: $defquota = 500;
11432: }
1.1134 raeburn 11433: } else {
11434: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11435: }
11436: if ($quota eq '') {
11437: $quota = $defquota;
11438: $quotatype = 'default';
11439: } else {
11440: $quotatype = 'custom';
11441: }
1.472 raeburn 11442: }
11443: }
1.536 raeburn 11444: if (wantarray) {
11445: return ($quota,$quotatype,$settingstatus,$defquota);
11446: } else {
11447: return $quota;
11448: }
1.472 raeburn 11449: }
11450:
11451: ###############################################
11452:
11453: =pod
11454:
11455: =item * &default_quota()
11456:
1.536 raeburn 11457: Retrieves default quota assigned for storage of user portfolio files,
11458: given an (optional) user's institutional status.
1.472 raeburn 11459:
11460: Incoming parameters:
1.1142 raeburn 11461:
1.472 raeburn 11462: 1. domain
1.536 raeburn 11463: 2. (Optional) institutional status(es). This is a : separated list of
11464: status types (e.g., faculty, staff, student etc.)
11465: which apply to the user for whom the default is being retrieved.
11466: If the institutional status string in undefined, the domain
1.1134 raeburn 11467: default quota will be returned.
11468: 3. quota name - portfolio, author, or course
11469: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11470:
11471: Returns:
1.1142 raeburn 11472:
1.1163 raeburn 11473: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11474: 2. (Optional) institutional type which determined the value of the
11475: default quota.
1.472 raeburn 11476:
11477: If a value has been stored in the domain's configuration db,
11478: it will return that, otherwise it returns 20 (for backwards
11479: compatibility with domains which have not set up a configuration
1.1163 raeburn 11480: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11481:
1.536 raeburn 11482: If the user's status includes multiple types (e.g., staff and student),
11483: the largest default quota which applies to the user determines the
11484: default quota returned.
11485:
1.472 raeburn 11486: =cut
11487:
11488: ###############################################
11489:
11490:
11491: sub default_quota {
1.1134 raeburn 11492: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11493: my ($defquota,$settingstatus);
11494: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11495: ['quotas'],$udom);
1.1134 raeburn 11496: my $key = 'defaultquota';
11497: if ($quotaname eq 'author') {
11498: $key = 'authorquota';
11499: }
1.622 raeburn 11500: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11501: if ($inststatus ne '') {
1.765 raeburn 11502: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11503: foreach my $item (@statuses) {
1.1134 raeburn 11504: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11505: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11506: if ($defquota eq '') {
1.1134 raeburn 11507: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11508: $settingstatus = $item;
1.1134 raeburn 11509: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11510: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11511: $settingstatus = $item;
11512: }
11513: }
1.1134 raeburn 11514: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11515: if ($quotahash{'quotas'}{$item} ne '') {
11516: if ($defquota eq '') {
11517: $defquota = $quotahash{'quotas'}{$item};
11518: $settingstatus = $item;
11519: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11520: $defquota = $quotahash{'quotas'}{$item};
11521: $settingstatus = $item;
11522: }
1.536 raeburn 11523: }
11524: }
11525: }
11526: }
11527: if ($defquota eq '') {
1.1134 raeburn 11528: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11529: $defquota = $quotahash{'quotas'}{$key}{'default'};
11530: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11531: $defquota = $quotahash{'quotas'}{'default'};
11532: }
1.536 raeburn 11533: $settingstatus = 'default';
1.1139 raeburn 11534: if ($defquota eq '') {
11535: if ($quotaname eq 'author') {
11536: $defquota = 500;
11537: }
11538: }
1.536 raeburn 11539: }
11540: } else {
11541: $settingstatus = 'default';
1.1134 raeburn 11542: if ($quotaname eq 'author') {
11543: $defquota = 500;
11544: } else {
11545: $defquota = 20;
11546: }
1.536 raeburn 11547: }
11548: if (wantarray) {
11549: return ($defquota,$settingstatus);
1.472 raeburn 11550: } else {
1.536 raeburn 11551: return $defquota;
1.472 raeburn 11552: }
11553: }
11554:
1.1135 raeburn 11555: ###############################################
11556:
11557: =pod
11558:
1.1136 raeburn 11559: =item * &excess_filesize_warning()
1.1135 raeburn 11560:
11561: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11562: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11563: space to be exceeded.
1.1136 raeburn 11564:
11565: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11566: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11567:
1.1165 raeburn 11568: Inputs: 7
1.1136 raeburn 11569: 1. username or coursenum
1.1135 raeburn 11570: 2. domain
1.1136 raeburn 11571: 3. context ('author' or 'course')
1.1135 raeburn 11572: 4. filename of file for which action is being requested
11573: 5. filesize (kB) of file
11574: 6. action being taken: copy or upload.
1.1237 raeburn 11575: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11576:
11577: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11578: otherwise return null.
11579:
11580: =back
1.1135 raeburn 11581:
11582: =cut
11583:
1.1136 raeburn 11584: sub excess_filesize_warning {
1.1165 raeburn 11585: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11586: my $current_disk_usage = 0;
1.1165 raeburn 11587: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11588: if ($context eq 'author') {
11589: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11590: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11591: } else {
11592: foreach my $subdir ('docs','supplemental') {
11593: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11594: }
11595: }
1.1135 raeburn 11596: $disk_quota = int($disk_quota * 1000);
11597: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11598: return '<p class="LC_warning">'.
1.1135 raeburn 11599: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11600: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11601: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11602: $disk_quota,$current_disk_usage).
11603: '</p>';
11604: }
11605: return;
11606: }
11607:
11608: ###############################################
11609:
11610:
1.1136 raeburn 11611:
11612:
1.384 raeburn 11613: sub get_secgrprole_info {
11614: my ($cdom,$cnum,$needroles,$type) = @_;
11615: my %sections_count = &get_sections($cdom,$cnum);
11616: my @sections = (sort {$a <=> $b} keys(%sections_count));
11617: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11618: my @groups = sort(keys(%curr_groups));
11619: my $allroles = [];
11620: my $rolehash;
11621: my $accesshash = {
11622: active => 'Currently has access',
11623: future => 'Will have future access',
11624: previous => 'Previously had access',
11625: };
11626: if ($needroles) {
11627: $rolehash = {'all' => 'all'};
1.385 albertel 11628: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11629: if (&Apache::lonnet::error(%user_roles)) {
11630: undef(%user_roles);
11631: }
11632: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11633: my ($role)=split(/\:/,$item,2);
11634: if ($role eq 'cr') { next; }
11635: if ($role =~ /^cr/) {
11636: $$rolehash{$role} = (split('/',$role))[3];
11637: } else {
11638: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11639: }
11640: }
11641: foreach my $key (sort(keys(%{$rolehash}))) {
11642: push(@{$allroles},$key);
11643: }
11644: push (@{$allroles},'st');
11645: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11646: }
11647: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11648: }
11649:
1.555 raeburn 11650: sub user_picker {
1.1279 raeburn 11651: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11652: my $currdom = $dom;
1.1253 raeburn 11653: my @alldoms = &Apache::lonnet::all_domains();
11654: if (@alldoms == 1) {
11655: my %domsrch = &Apache::lonnet::get_dom('configuration',
11656: ['directorysrch'],$alldoms[0]);
11657: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11658: my $showdom = $domdesc;
11659: if ($showdom eq '') {
11660: $showdom = $dom;
11661: }
11662: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11663: if ((!$domsrch{'directorysrch'}{'available'}) &&
11664: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11665: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11666: }
11667: }
11668: }
1.555 raeburn 11669: my %curr_selected = (
11670: srchin => 'dom',
1.580 raeburn 11671: srchby => 'lastname',
1.555 raeburn 11672: );
11673: my $srchterm;
1.625 raeburn 11674: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11675: if ($srch->{'srchby'} ne '') {
11676: $curr_selected{'srchby'} = $srch->{'srchby'};
11677: }
11678: if ($srch->{'srchin'} ne '') {
11679: $curr_selected{'srchin'} = $srch->{'srchin'};
11680: }
11681: if ($srch->{'srchtype'} ne '') {
11682: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11683: }
11684: if ($srch->{'srchdomain'} ne '') {
11685: $currdom = $srch->{'srchdomain'};
11686: }
11687: $srchterm = $srch->{'srchterm'};
11688: }
1.1222 damieng 11689: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11690: 'usr' => 'Search criteria',
1.563 raeburn 11691: 'doma' => 'Domain/institution to search',
1.558 albertel 11692: 'uname' => 'username',
11693: 'lastname' => 'last name',
1.555 raeburn 11694: 'lastfirst' => 'last name, first name',
1.558 albertel 11695: 'crs' => 'in this course',
1.576 raeburn 11696: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11697: 'alc' => 'all LON-CAPA',
1.573 raeburn 11698: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11699: 'exact' => 'is',
11700: 'contains' => 'contains',
1.569 raeburn 11701: 'begins' => 'begins with',
1.1222 damieng 11702: );
11703: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11704: 'youm' => "You must include some text to search for.",
11705: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11706: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11707: 'yomc' => "You must choose a domain when using an institutional directory search.",
11708: 'ymcd' => "You must choose a domain when using a domain search.",
11709: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11710: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11711: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11712: );
1.1222 damieng 11713: &html_escape(\%html_lt);
11714: &js_escape(\%js_lt);
1.1255 raeburn 11715: my $domform;
1.1277 raeburn 11716: my $allow_blank = 1;
1.1255 raeburn 11717: if ($fixeddom) {
1.1277 raeburn 11718: $allow_blank = 0;
11719: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11720: } else {
1.1287 raeburn 11721: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11722: my ($trusted,$untrusted);
1.1287 raeburn 11723: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11724: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11725: } elsif ($context eq 'author') {
1.1288 raeburn 11726: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11727: } elsif ($context eq 'domain') {
1.1288 raeburn 11728: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11729: }
1.1288 raeburn 11730: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11731: }
1.563 raeburn 11732: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11733:
11734: my @srchins = ('crs','dom','alc','instd');
11735:
11736: foreach my $option (@srchins) {
11737: # FIXME 'alc' option unavailable until
11738: # loncreateuser::print_user_query_page()
11739: # has been completed.
11740: next if ($option eq 'alc');
1.880 raeburn 11741: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11742: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11743: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11744: if ($curr_selected{'srchin'} eq $option) {
11745: $srchinsel .= '
1.1222 damieng 11746: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11747: } else {
11748: $srchinsel .= '
1.1222 damieng 11749: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11750: }
1.555 raeburn 11751: }
1.563 raeburn 11752: $srchinsel .= "\n </select>\n";
1.555 raeburn 11753:
11754: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11755: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11756: if ($curr_selected{'srchby'} eq $option) {
11757: $srchbysel .= '
1.1222 damieng 11758: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11759: } else {
11760: $srchbysel .= '
1.1222 damieng 11761: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11762: }
11763: }
11764: $srchbysel .= "\n </select>\n";
11765:
11766: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11767: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11768: if ($curr_selected{'srchtype'} eq $option) {
11769: $srchtypesel .= '
1.1222 damieng 11770: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11771: } else {
11772: $srchtypesel .= '
1.1222 damieng 11773: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11774: }
11775: }
11776: $srchtypesel .= "\n </select>\n";
11777:
1.558 albertel 11778: my ($newuserscript,$new_user_create);
1.994 raeburn 11779: my $context_dom = $env{'request.role.domain'};
11780: if ($context eq 'requestcrs') {
11781: if ($env{'form.coursedom'} ne '') {
11782: $context_dom = $env{'form.coursedom'};
11783: }
11784: }
1.556 raeburn 11785: if ($forcenewuser) {
1.576 raeburn 11786: if (ref($srch) eq 'HASH') {
1.994 raeburn 11787: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11788: if ($cancreate) {
11789: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
11790: } else {
1.799 bisitz 11791: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11792: my %usertypetext = (
11793: official => 'institutional',
11794: unofficial => 'non-institutional',
11795: );
1.799 bisitz 11796: $new_user_create = '<p class="LC_warning">'
11797: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11798: .' '
11799: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11800: ,'<a href="'.$helplink.'">','</a>')
11801: .'</p><br />';
1.627 raeburn 11802: }
1.576 raeburn 11803: }
11804: }
11805:
1.556 raeburn 11806: $newuserscript = <<"ENDSCRIPT";
11807:
1.570 raeburn 11808: function setSearch(createnew,callingForm) {
1.556 raeburn 11809: if (createnew == 1) {
1.570 raeburn 11810: for (var i=0; i<callingForm.srchby.length; i++) {
11811: if (callingForm.srchby.options[i].value == 'uname') {
11812: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11813: }
11814: }
1.570 raeburn 11815: for (var i=0; i<callingForm.srchin.length; i++) {
11816: if ( callingForm.srchin.options[i].value == 'dom') {
11817: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11818: }
11819: }
1.570 raeburn 11820: for (var i=0; i<callingForm.srchtype.length; i++) {
11821: if (callingForm.srchtype.options[i].value == 'exact') {
11822: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11823: }
11824: }
1.570 raeburn 11825: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11826: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11827: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11828: }
11829: }
11830: }
11831: }
11832: ENDSCRIPT
1.558 albertel 11833:
1.556 raeburn 11834: }
11835:
1.555 raeburn 11836: my $output = <<"END_BLOCK";
1.556 raeburn 11837: <script type="text/javascript">
1.824 bisitz 11838: // <![CDATA[
1.570 raeburn 11839: function validateEntry(callingForm) {
1.558 albertel 11840:
1.556 raeburn 11841: var checkok = 1;
1.558 albertel 11842: var srchin;
1.570 raeburn 11843: for (var i=0; i<callingForm.srchin.length; i++) {
11844: if ( callingForm.srchin[i].checked ) {
11845: srchin = callingForm.srchin[i].value;
1.558 albertel 11846: }
11847: }
11848:
1.570 raeburn 11849: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11850: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11851: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11852: var srchterm = callingForm.srchterm.value;
11853: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11854: var msg = "";
11855:
11856: if (srchterm == "") {
11857: checkok = 0;
1.1222 damieng 11858: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11859: }
11860:
1.569 raeburn 11861: if (srchtype== 'begins') {
11862: if (srchterm.length < 2) {
11863: checkok = 0;
1.1222 damieng 11864: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11865: }
11866: }
11867:
1.556 raeburn 11868: if (srchtype== 'contains') {
11869: if (srchterm.length < 3) {
11870: checkok = 0;
1.1222 damieng 11871: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11872: }
11873: }
11874: if (srchin == 'instd') {
11875: if (srchdomain == '') {
11876: checkok = 0;
1.1222 damieng 11877: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11878: }
11879: }
11880: if (srchin == 'dom') {
11881: if (srchdomain == '') {
11882: checkok = 0;
1.1222 damieng 11883: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11884: }
11885: }
11886: if (srchby == 'lastfirst') {
11887: if (srchterm.indexOf(",") == -1) {
11888: checkok = 0;
1.1222 damieng 11889: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11890: }
11891: if (srchterm.indexOf(",") == srchterm.length -1) {
11892: checkok = 0;
1.1222 damieng 11893: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11894: }
11895: }
11896: if (checkok == 0) {
1.1222 damieng 11897: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11898: return;
11899: }
11900: if (checkok == 1) {
1.570 raeburn 11901: callingForm.submit();
1.556 raeburn 11902: }
11903: }
11904:
11905: $newuserscript
11906:
1.824 bisitz 11907: // ]]>
1.556 raeburn 11908: </script>
1.558 albertel 11909:
11910: $new_user_create
11911:
1.555 raeburn 11912: END_BLOCK
1.558 albertel 11913:
1.876 raeburn 11914: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11915: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11916: $domform.
11917: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11918: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11919: $srchbysel.
11920: $srchtypesel.
11921: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11922: $srchinsel.
11923: &Apache::lonhtmlcommon::row_closure(1).
11924: &Apache::lonhtmlcommon::end_pick_box().
11925: '<br />';
1.1253 raeburn 11926: return ($output,1);
1.555 raeburn 11927: }
11928:
1.612 raeburn 11929: sub user_rule_check {
1.615 raeburn 11930: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11931: my ($response,%inst_response);
1.612 raeburn 11932: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11933: if (keys(%{$usershash}) > 1) {
11934: my (%by_username,%by_id,%userdoms);
11935: my $checkid;
11936: if (ref($checks) eq 'HASH') {
11937: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11938: $checkid = 1;
11939: }
11940: }
11941: foreach my $user (keys(%{$usershash})) {
11942: my ($uname,$udom) = split(/:/,$user);
11943: if ($checkid) {
11944: if (ref($usershash->{$user}) eq 'HASH') {
11945: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11946: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11947: $userdoms{$udom} = 1;
1.1227 raeburn 11948: if (ref($inst_results) eq 'HASH') {
11949: $inst_results->{$uname.':'.$udom} = {};
11950: }
1.1226 raeburn 11951: }
11952: }
11953: } else {
11954: $by_username{$udom}{$uname} = 1;
11955: $userdoms{$udom} = 1;
1.1227 raeburn 11956: if (ref($inst_results) eq 'HASH') {
11957: $inst_results->{$uname.':'.$udom} = {};
11958: }
1.1226 raeburn 11959: }
11960: }
11961: foreach my $udom (keys(%userdoms)) {
11962: if (!$got_rules->{$udom}) {
11963: my %domconfig = &Apache::lonnet::get_dom('configuration',
11964: ['usercreation'],$udom);
11965: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11966: foreach my $item ('username','id') {
11967: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11968: $$curr_rules{$udom}{$item} =
11969: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11970: }
11971: }
11972: }
11973: $got_rules->{$udom} = 1;
11974: }
1.612 raeburn 11975: }
1.1226 raeburn 11976: if ($checkid) {
11977: foreach my $udom (keys(%by_id)) {
11978: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11979: if ($outcome eq 'ok') {
1.1227 raeburn 11980: foreach my $id (keys(%{$by_id{$udom}})) {
11981: my $uname = $by_id{$udom}{$id};
11982: $inst_response{$uname.':'.$udom} = $outcome;
11983: }
1.1226 raeburn 11984: if (ref($results) eq 'HASH') {
11985: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11986: if (exists($inst_response{$uname.':'.$udom})) {
11987: $inst_response{$uname.':'.$udom} = $outcome;
11988: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11989: }
1.1226 raeburn 11990: }
11991: }
11992: }
1.612 raeburn 11993: }
1.615 raeburn 11994: } else {
1.1226 raeburn 11995: foreach my $udom (keys(%by_username)) {
11996: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11997: if ($outcome eq 'ok') {
1.1227 raeburn 11998: foreach my $uname (keys(%{$by_username{$udom}})) {
11999: $inst_response{$uname.':'.$udom} = $outcome;
12000: }
1.1226 raeburn 12001: if (ref($results) eq 'HASH') {
12002: foreach my $uname (keys(%{$results})) {
12003: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12004: }
12005: }
12006: }
12007: }
1.612 raeburn 12008: }
1.1226 raeburn 12009: } elsif (keys(%{$usershash}) == 1) {
12010: my $user = (keys(%{$usershash}))[0];
12011: my ($uname,$udom) = split(/:/,$user);
12012: if (($udom ne '') && ($uname ne '')) {
12013: if (ref($usershash->{$user}) eq 'HASH') {
12014: if (ref($checks) eq 'HASH') {
12015: if (defined($checks->{'username'})) {
12016: ($inst_response{$user},%{$inst_results->{$user}}) =
12017: &Apache::lonnet::get_instuser($udom,$uname);
12018: } elsif (defined($checks->{'id'})) {
12019: if ($usershash->{$user}->{'id'} ne '') {
12020: ($inst_response{$user},%{$inst_results->{$user}}) =
12021: &Apache::lonnet::get_instuser($udom,undef,
12022: $usershash->{$user}->{'id'});
12023: } else {
12024: ($inst_response{$user},%{$inst_results->{$user}}) =
12025: &Apache::lonnet::get_instuser($udom,$uname);
12026: }
1.585 raeburn 12027: }
1.1226 raeburn 12028: } else {
12029: ($inst_response{$user},%{$inst_results->{$user}}) =
12030: &Apache::lonnet::get_instuser($udom,$uname);
12031: return;
12032: }
12033: if (!$got_rules->{$udom}) {
12034: my %domconfig = &Apache::lonnet::get_dom('configuration',
12035: ['usercreation'],$udom);
12036: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12037: foreach my $item ('username','id') {
12038: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12039: $$curr_rules{$udom}{$item} =
12040: $domconfig{'usercreation'}{$item.'_rule'};
12041: }
12042: }
12043: }
12044: $got_rules->{$udom} = 1;
1.585 raeburn 12045: }
12046: }
1.1226 raeburn 12047: } else {
12048: return;
12049: }
12050: } else {
12051: return;
12052: }
12053: foreach my $user (keys(%{$usershash})) {
12054: my ($uname,$udom) = split(/:/,$user);
12055: next if (($udom eq '') || ($uname eq ''));
12056: my $id;
1.1227 raeburn 12057: if (ref($inst_results) eq 'HASH') {
12058: if (ref($inst_results->{$user}) eq 'HASH') {
12059: $id = $inst_results->{$user}->{'id'};
12060: }
12061: }
12062: if ($id eq '') {
12063: if (ref($usershash->{$user})) {
12064: $id = $usershash->{$user}->{'id'};
12065: }
1.585 raeburn 12066: }
1.612 raeburn 12067: foreach my $item (keys(%{$checks})) {
12068: if (ref($$curr_rules{$udom}) eq 'HASH') {
12069: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12070: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12071: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12072: $$curr_rules{$udom}{$item});
1.612 raeburn 12073: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12074: if ($rule_check{$rule}) {
12075: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12076: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12077: if (ref($inst_results) eq 'HASH') {
12078: if (ref($inst_results->{$user}) eq 'HASH') {
12079: if (keys(%{$inst_results->{$user}}) == 0) {
12080: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12081: } elsif ($item eq 'id') {
12082: if ($inst_results->{$user}->{'id'} eq '') {
12083: $$alerts{$item}{$udom}{$uname} = 1;
12084: }
1.615 raeburn 12085: }
1.612 raeburn 12086: }
12087: }
1.615 raeburn 12088: }
12089: last;
1.585 raeburn 12090: }
12091: }
12092: }
12093: }
12094: }
12095: }
12096: }
12097: }
1.612 raeburn 12098: return;
12099: }
12100:
12101: sub user_rule_formats {
12102: my ($domain,$domdesc,$curr_rules,$check) = @_;
12103: my %text = (
12104: 'username' => 'Usernames',
12105: 'id' => 'IDs',
12106: );
12107: my $output;
12108: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12109: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12110: if (@{$ruleorder} > 0) {
1.1102 raeburn 12111: $output = '<br />'.
12112: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12113: '<span class="LC_cusr_emph">','</span>',$domdesc).
12114: ' <ul>';
1.612 raeburn 12115: foreach my $rule (@{$ruleorder}) {
12116: if (ref($curr_rules) eq 'ARRAY') {
12117: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12118: if (ref($rules->{$rule}) eq 'HASH') {
12119: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12120: $rules->{$rule}{'desc'}.'</li>';
12121: }
12122: }
12123: }
12124: }
12125: $output .= '</ul>';
12126: }
12127: }
12128: return $output;
12129: }
12130:
12131: sub instrule_disallow_msg {
1.615 raeburn 12132: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12133: my $response;
12134: my %text = (
12135: item => 'username',
12136: items => 'usernames',
12137: match => 'matches',
12138: do => 'does',
12139: action => 'a username',
12140: one => 'one',
12141: );
12142: if ($count > 1) {
12143: $text{'item'} = 'usernames';
12144: $text{'match'} ='match';
12145: $text{'do'} = 'do';
12146: $text{'action'} = 'usernames',
12147: $text{'one'} = 'ones';
12148: }
12149: if ($checkitem eq 'id') {
12150: $text{'items'} = 'IDs';
12151: $text{'item'} = 'ID';
12152: $text{'action'} = 'an ID';
1.615 raeburn 12153: if ($count > 1) {
12154: $text{'item'} = 'IDs';
12155: $text{'action'} = 'IDs';
12156: }
1.612 raeburn 12157: }
1.674 bisitz 12158: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615 raeburn 12159: if ($mode eq 'upload') {
12160: if ($checkitem eq 'username') {
12161: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12162: } elsif ($checkitem eq 'id') {
1.674 bisitz 12163: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615 raeburn 12164: }
1.669 raeburn 12165: } elsif ($mode eq 'selfcreate') {
12166: if ($checkitem eq 'id') {
12167: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
12168: }
1.615 raeburn 12169: } else {
12170: if ($checkitem eq 'username') {
12171: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12172: } elsif ($checkitem eq 'id') {
12173: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
12174: }
1.612 raeburn 12175: }
12176: return $response;
1.585 raeburn 12177: }
12178:
1.624 raeburn 12179: sub personal_data_fieldtitles {
12180: my %fieldtitles = &Apache::lonlocal::texthash (
12181: id => 'Student/Employee ID',
12182: permanentemail => 'E-mail address',
12183: lastname => 'Last Name',
12184: firstname => 'First Name',
12185: middlename => 'Middle Name',
12186: generation => 'Generation',
12187: gen => 'Generation',
1.765 raeburn 12188: inststatus => 'Affiliation',
1.624 raeburn 12189: );
12190: return %fieldtitles;
12191: }
12192:
1.642 raeburn 12193: sub sorted_inst_types {
12194: my ($dom) = @_;
1.1185 raeburn 12195: my ($usertypes,$order);
12196: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12197: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12198: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12199: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12200: } else {
12201: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12202: }
1.642 raeburn 12203: my $othertitle = &mt('All users');
12204: if ($env{'request.course.id'}) {
1.668 raeburn 12205: $othertitle = &mt('Any users');
1.642 raeburn 12206: }
12207: my @types;
12208: if (ref($order) eq 'ARRAY') {
12209: @types = @{$order};
12210: }
12211: if (@types == 0) {
12212: if (ref($usertypes) eq 'HASH') {
12213: @types = sort(keys(%{$usertypes}));
12214: }
12215: }
12216: if (keys(%{$usertypes}) > 0) {
12217: $othertitle = &mt('Other users');
12218: }
12219: return ($othertitle,$usertypes,\@types);
12220: }
12221:
1.645 raeburn 12222: sub get_institutional_codes {
1.1361 raeburn 12223: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12224: # Get complete list of course sections to update
12225: my @currsections = ();
12226: my @currxlists = ();
1.1361 raeburn 12227: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12228: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12229: my $crskey = $crs.':'.$coursecode;
12230: @{$unclutteredsec{$crskey}} = ();
12231: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12232:
12233: if ($$settings{'internal.sectionnums'} ne '') {
12234: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12235: }
12236:
12237: if ($$settings{'internal.crosslistings'} ne '') {
12238: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12239: }
12240:
12241: if (@currxlists > 0) {
1.1361 raeburn 12242: foreach my $xl (@currxlists) {
12243: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12244: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12245: push(@{$allcourses},$1);
1.645 raeburn 12246: $$LC_code{$1} = $2;
12247: }
12248: }
12249: }
12250: }
1.1361 raeburn 12251:
1.645 raeburn 12252: if (@currsections > 0) {
1.1361 raeburn 12253: foreach my $sec (@currsections) {
12254: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12255: my $instsec = $1;
1.645 raeburn 12256: my $lc_sec = $2;
1.1361 raeburn 12257: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12258: push(@{$unclutteredsec{$crskey}},$instsec);
12259: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12260: }
12261: }
12262: }
12263: }
12264:
12265: if (@{$unclutteredsec{$crskey}} > 0) {
12266: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12267: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12268: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12269: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12270: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12271: push(@{$allcourses},$sec);
1.1361 raeburn 12272: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12273: }
12274: }
12275: }
12276: }
12277: return;
12278: }
12279:
1.971 raeburn 12280: sub get_standard_codeitems {
12281: return ('Year','Semester','Department','Number','Section');
12282: }
12283:
1.112 bowersj2 12284: =pod
12285:
1.780 raeburn 12286: =head1 Slot Helpers
12287:
12288: =over 4
12289:
12290: =item * sorted_slots()
12291:
1.1040 raeburn 12292: Sorts an array of slot names in order of an optional sort key,
12293: default sort is by slot start time (earliest first).
1.780 raeburn 12294:
12295: Inputs:
12296:
12297: =over 4
12298:
12299: slotsarr - Reference to array of unsorted slot names.
12300:
12301: slots - Reference to hash of hash, where outer hash keys are slot names.
12302:
1.1040 raeburn 12303: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12304:
1.549 albertel 12305: =back
12306:
1.780 raeburn 12307: Returns:
12308:
12309: =over 4
12310:
1.1040 raeburn 12311: sorted - An array of slot names sorted by a specified sort key
12312: (default sort key is start time of the slot).
1.780 raeburn 12313:
12314: =back
12315:
12316: =cut
12317:
12318:
12319: sub sorted_slots {
1.1040 raeburn 12320: my ($slotsarr,$slots,$sortkey) = @_;
12321: if ($sortkey eq '') {
12322: $sortkey = 'starttime';
12323: }
1.780 raeburn 12324: my @sorted;
12325: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12326: @sorted =
12327: sort {
12328: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12329: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12330: }
12331: if (ref($slots->{$a})) { return -1;}
12332: if (ref($slots->{$b})) { return 1;}
12333: return 0;
12334: } @{$slotsarr};
12335: }
12336: return @sorted;
12337: }
12338:
1.1040 raeburn 12339: =pod
12340:
12341: =item * get_future_slots()
12342:
12343: Inputs:
12344:
12345: =over 4
12346:
12347: cnum - course number
12348:
12349: cdom - course domain
12350:
12351: now - current UNIX time
12352:
12353: symb - optional symb
12354:
12355: =back
12356:
12357: Returns:
12358:
12359: =over 4
12360:
12361: sorted_reservable - ref to array of student_schedulable slots currently
12362: reservable, ordered by end date of reservation period.
12363:
12364: reservable_now - ref to hash of student_schedulable slots currently
12365: reservable.
12366:
12367: Keys in inner hash are:
12368: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12369: (b) endreserve: end date of reservation period.
12370: (c) uniqueperiod: start,end dates when slot is to be uniquely
12371: selected.
1.1040 raeburn 12372:
12373: sorted_future - ref to array of student_schedulable slots reservable in
12374: the future, ordered by start date of reservation period.
12375:
12376: future_reservable - ref to hash of student_schedulable slots reservable
12377: in the future.
12378:
12379: Keys in inner hash are:
12380: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12381: (b) startreserve: start date of reservation period.
12382: (c) uniqueperiod: start,end dates when slot is to be uniquely
12383: selected.
1.1040 raeburn 12384:
12385: =back
12386:
12387: =cut
12388:
12389: sub get_future_slots {
12390: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12391: my $map;
12392: if ($symb) {
12393: ($map) = &Apache::lonnet::decode_symb($symb);
12394: }
1.1040 raeburn 12395: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12396: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12397: foreach my $slot (keys(%slots)) {
12398: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12399: if ($symb) {
1.1229 raeburn 12400: if ($slots{$slot}->{'symb'} ne '') {
12401: my $canuse;
12402: my %oksymbs;
12403: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12404: map { $oksymbs{$_} = 1; } @slotsymbs;
12405: if ($oksymbs{$symb}) {
12406: $canuse = 1;
12407: } else {
12408: foreach my $item (@slotsymbs) {
12409: if ($item =~ /\.(page|sequence)$/) {
12410: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12411: if (($map ne '') && ($map eq $sloturl)) {
12412: $canuse = 1;
12413: last;
12414: }
12415: }
12416: }
12417: }
12418: next unless ($canuse);
12419: }
1.1040 raeburn 12420: }
12421: if (($slots{$slot}->{'starttime'} > $now) &&
12422: ($slots{$slot}->{'endtime'} > $now)) {
12423: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12424: my $userallowed = 0;
12425: if ($slots{$slot}->{'allowedsections'}) {
12426: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12427: if (!defined($env{'request.role.sec'})
12428: && grep(/^No section assigned$/,@allowed_sec)) {
12429: $userallowed=1;
12430: } else {
12431: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12432: $userallowed=1;
12433: }
12434: }
12435: unless ($userallowed) {
12436: if (defined($env{'request.course.groups'})) {
12437: my @groups = split(/:/,$env{'request.course.groups'});
12438: foreach my $group (@groups) {
12439: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12440: $userallowed=1;
12441: last;
12442: }
12443: }
12444: }
12445: }
12446: }
12447: if ($slots{$slot}->{'allowedusers'}) {
12448: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12449: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12450: if (grep(/^\Q$user\E$/,@allowed_users)) {
12451: $userallowed = 1;
12452: }
12453: }
12454: next unless($userallowed);
12455: }
12456: my $startreserve = $slots{$slot}->{'startreserve'};
12457: my $endreserve = $slots{$slot}->{'endreserve'};
12458: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12459: my $uniqueperiod;
12460: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12461: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12462: }
1.1040 raeburn 12463: if (($startreserve < $now) &&
12464: (!$endreserve || $endreserve > $now)) {
12465: my $lastres = $endreserve;
12466: if (!$lastres) {
12467: $lastres = $slots{$slot}->{'starttime'};
12468: }
12469: $reservable_now{$slot} = {
12470: symb => $symb,
1.1250 raeburn 12471: endreserve => $lastres,
12472: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12473: };
12474: } elsif (($startreserve > $now) &&
12475: (!$endreserve || $endreserve > $startreserve)) {
12476: $future_reservable{$slot} = {
12477: symb => $symb,
1.1250 raeburn 12478: startreserve => $startreserve,
12479: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12480: };
12481: }
12482: }
12483: }
12484: my @unsorted_reservable = keys(%reservable_now);
12485: if (@unsorted_reservable > 0) {
12486: @sorted_reservable =
12487: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12488: }
12489: my @unsorted_future = keys(%future_reservable);
12490: if (@unsorted_future > 0) {
12491: @sorted_future =
12492: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12493: }
12494: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12495: }
1.780 raeburn 12496:
12497: =pod
12498:
1.1057 foxr 12499: =back
12500:
1.549 albertel 12501: =head1 HTTP Helpers
12502:
12503: =over 4
12504:
1.648 raeburn 12505: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12506:
1.258 albertel 12507: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12508: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12509: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12510:
12511: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12512: $possible_names is an ref to an array of form element names. As an example:
12513: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12514: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12515:
12516: =cut
1.1 albertel 12517:
1.6 albertel 12518: sub get_unprocessed_cgi {
1.25 albertel 12519: my ($query,$possible_names)= @_;
1.26 matthew 12520: # $Apache::lonxml::debug=1;
1.356 albertel 12521: foreach my $pair (split(/&/,$query)) {
12522: my ($name, $value) = split(/=/,$pair);
1.369 www 12523: $name = &unescape($name);
1.25 albertel 12524: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12525: $value =~ tr/+/ /;
12526: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12527: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12528: }
1.16 harris41 12529: }
1.6 albertel 12530: }
12531:
1.112 bowersj2 12532: =pod
12533:
1.648 raeburn 12534: =item * &cacheheader()
1.112 bowersj2 12535:
12536: returns cache-controlling header code
12537:
12538: =cut
12539:
1.7 albertel 12540: sub cacheheader {
1.258 albertel 12541: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12542: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12543: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12544: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12545: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12546: return $output;
1.7 albertel 12547: }
12548:
1.112 bowersj2 12549: =pod
12550:
1.648 raeburn 12551: =item * &no_cache($r)
1.112 bowersj2 12552:
12553: specifies header code to not have cache
12554:
12555: =cut
12556:
1.9 albertel 12557: sub no_cache {
1.216 albertel 12558: my ($r) = @_;
12559: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12560: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12561: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12562: $r->no_cache(1);
12563: $r->header_out("Expires" => $date);
12564: $r->header_out("Pragma" => "no-cache");
1.123 www 12565: }
12566:
12567: sub content_type {
1.181 albertel 12568: my ($r,$type,$charset) = @_;
1.299 foxr 12569: if ($r) {
12570: # Note that printout.pl calls this with undef for $r.
12571: &no_cache($r);
12572: }
1.258 albertel 12573: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12574: unless ($charset) {
12575: $charset=&Apache::lonlocal::current_encoding;
12576: }
12577: if ($charset) { $type.='; charset='.$charset; }
12578: if ($r) {
12579: $r->content_type($type);
12580: } else {
12581: print("Content-type: $type\n\n");
12582: }
1.9 albertel 12583: }
1.25 albertel 12584:
1.112 bowersj2 12585: =pod
12586:
1.648 raeburn 12587: =item * &add_to_env($name,$value)
1.112 bowersj2 12588:
1.258 albertel 12589: adds $name to the %env hash with value
1.112 bowersj2 12590: $value, if $name already exists, the entry is converted to an array
12591: reference and $value is added to the array.
12592:
12593: =cut
12594:
1.25 albertel 12595: sub add_to_env {
12596: my ($name,$value)=@_;
1.258 albertel 12597: if (defined($env{$name})) {
12598: if (ref($env{$name})) {
1.25 albertel 12599: #already have multiple values
1.258 albertel 12600: push(@{ $env{$name} },$value);
1.25 albertel 12601: } else {
12602: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12603: my $first=$env{$name};
12604: undef($env{$name});
12605: push(@{ $env{$name} },$first,$value);
1.25 albertel 12606: }
12607: } else {
1.258 albertel 12608: $env{$name}=$value;
1.25 albertel 12609: }
1.31 albertel 12610: }
1.149 albertel 12611:
12612: =pod
12613:
1.648 raeburn 12614: =item * &get_env_multiple($name)
1.149 albertel 12615:
1.258 albertel 12616: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12617: values may be defined and end up as an array ref.
12618:
12619: returns an array of values
12620:
12621: =cut
12622:
12623: sub get_env_multiple {
12624: my ($name) = @_;
12625: my @values;
1.258 albertel 12626: if (defined($env{$name})) {
1.149 albertel 12627: # exists is it an array
1.258 albertel 12628: if (ref($env{$name})) {
12629: @values=@{ $env{$name} };
1.149 albertel 12630: } else {
1.258 albertel 12631: $values[0]=$env{$name};
1.149 albertel 12632: }
12633: }
12634: return(@values);
12635: }
12636:
1.1249 damieng 12637: # Looks at given dependencies, and returns something depending on the context.
12638: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12639: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12640: # For all other contexts, returns ($output, $counter, $numpathchg).
12641: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12642: # $counter: integer with the number of existing dependencies when no HTML output is returned, and the number of missing dependencies when an HTML output is returned.
12643: # $numpathchg: integer with the number of cleaned up dependency paths.
12644: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12645: # \%mapping: hash reference clean path -> original path for all dependencies.
12646: # @param {string} actionurl - The path to the handler, indicative of the context.
12647: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12648: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12649: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12650: # @param {hash reference} args - More parameters ! Possible keys: error_on_invalid_names (boolean), ignore_remote_references (boolean), current_path (string), docs_url (string), docs_title (string), context (string)
12651: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12652: sub ask_for_embedded_content {
1.1249 damieng 12653: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12654: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12655: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12656: %currsubfile,%unused,$rem);
1.1071 raeburn 12657: my $counter = 0;
12658: my $numnew = 0;
1.987 raeburn 12659: my $numremref = 0;
12660: my $numinvalid = 0;
12661: my $numpathchg = 0;
12662: my $numexisting = 0;
1.1071 raeburn 12663: my $numunused = 0;
12664: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12665: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12666: my $heading = &mt('Upload embedded files');
12667: my $buttontext = &mt('Upload');
12668:
1.1249 damieng 12669: # fills these variables based on the context:
12670: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12671: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12672: if ($env{'request.course.id'}) {
1.1123 raeburn 12673: if ($actionurl eq '/adm/dependencies') {
12674: $navmap = Apache::lonnavmaps::navmap->new();
12675: }
12676: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12677: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12678: }
1.1123 raeburn 12679: if (($actionurl eq '/adm/portfolio') ||
12680: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12681: my $current_path='/';
12682: if ($env{'form.currentpath'}) {
12683: $current_path = $env{'form.currentpath'};
12684: }
12685: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12686: $udom = $cdom;
12687: $uname = $cnum;
1.984 raeburn 12688: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12689: } else {
12690: $udom = $env{'user.domain'};
12691: $uname = $env{'user.name'};
12692: $url = '/userfiles/portfolio';
12693: }
1.987 raeburn 12694: $toplevel = $url.'/';
1.984 raeburn 12695: $url .= $current_path;
12696: $getpropath = 1;
1.987 raeburn 12697: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12698: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12699: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12700: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12701: $toplevel = $url;
1.984 raeburn 12702: if ($rest ne '') {
1.987 raeburn 12703: $url .= $rest;
12704: }
12705: } elsif ($actionurl eq '/adm/coursedocs') {
12706: if (ref($args) eq 'HASH') {
1.1071 raeburn 12707: $url = $args->{'docs_url'};
12708: $toplevel = $url;
1.1084 raeburn 12709: if ($args->{'context'} eq 'paste') {
12710: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12711: ($path) =
12712: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12713: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12714: $fileloc =~ s{^/}{};
12715: }
1.1071 raeburn 12716: }
1.1084 raeburn 12717: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12718: if ($env{'request.course.id'} ne '') {
12719: if (ref($args) eq 'HASH') {
12720: $url = $args->{'docs_url'};
12721: $title = $args->{'docs_title'};
1.1126 raeburn 12722: $toplevel = $url;
12723: unless ($toplevel =~ m{^/}) {
12724: $toplevel = "/$url";
12725: }
1.1085 raeburn 12726: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12727: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12728: $path = $1;
12729: } else {
12730: ($path) =
12731: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12732: }
1.1195 raeburn 12733: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12734: $fileloc = $toplevel;
12735: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12736: my ($udom,$uname,$fname) =
12737: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12738: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12739: } else {
12740: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12741: }
1.1071 raeburn 12742: $fileloc =~ s{^/}{};
12743: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12744: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12745: }
1.987 raeburn 12746: }
1.1123 raeburn 12747: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12748: $udom = $cdom;
12749: $uname = $cnum;
12750: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12751: $toplevel = $url;
12752: $path = $url;
12753: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12754: $fileloc =~ s{^/}{};
1.987 raeburn 12755: }
1.1249 damieng 12756:
12757: # parses the dependency paths to get some info
12758: # fills $newfiles, $mapping, $subdependencies, $dependencies
12759: # $newfiles: hash URL -> 1 for new files or external URLs
12760: # (will be completed later)
12761: # $mapping:
12762: # for external URLs: external URL -> external URL
12763: # for relative paths: clean path -> original path
12764: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12765: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12766: foreach my $file (keys(%{$allfiles})) {
12767: my $embed_file;
12768: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12769: $embed_file = $1;
12770: } else {
12771: $embed_file = $file;
12772: }
1.1158 raeburn 12773: my ($absolutepath,$cleaned_file);
12774: if ($embed_file =~ m{^\w+://}) {
12775: $cleaned_file = $embed_file;
1.1147 raeburn 12776: $newfiles{$cleaned_file} = 1;
12777: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12778: } else {
1.1158 raeburn 12779: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12780: if ($embed_file =~ m{^/}) {
12781: $absolutepath = $embed_file;
12782: }
1.1147 raeburn 12783: if ($cleaned_file =~ m{/}) {
12784: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12785: $path = &check_for_traversal($path,$url,$toplevel);
12786: my $item = $fname;
12787: if ($path ne '') {
12788: $item = $path.'/'.$fname;
12789: $subdependencies{$path}{$fname} = 1;
12790: } else {
12791: $dependencies{$item} = 1;
12792: }
12793: if ($absolutepath) {
12794: $mapping{$item} = $absolutepath;
12795: } else {
12796: $mapping{$item} = $embed_file;
12797: }
12798: } else {
12799: $dependencies{$embed_file} = 1;
12800: if ($absolutepath) {
1.1147 raeburn 12801: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12802: } else {
1.1147 raeburn 12803: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12804: }
12805: }
1.984 raeburn 12806: }
12807: }
1.1249 damieng 12808:
12809: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12810: # and lists
12811: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12812: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12813: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12814: # the path had to be cleaned up
12815: # $existing: hash clean path -> 1 if the file exists
12816: # $numexisting: number of keys in $existing
12817: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12818: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12819: # dependency subdirectories that are
12820: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12821: my $dirptr = 16384;
1.984 raeburn 12822: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12823: $currsubfile{$path} = {};
1.1123 raeburn 12824: if (($actionurl eq '/adm/portfolio') ||
12825: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12826: my ($sublistref,$listerror) =
12827: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12828: if (ref($sublistref) eq 'ARRAY') {
12829: foreach my $line (@{$sublistref}) {
12830: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12831: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12832: }
1.984 raeburn 12833: }
1.987 raeburn 12834: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12835: if (opendir(my $dir,$url.'/'.$path)) {
12836: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12837: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12838: }
1.1084 raeburn 12839: } elsif (($actionurl eq '/adm/dependencies') ||
12840: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12841: ($args->{'context'} eq 'paste')) ||
12842: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12843: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12844: my $dir;
12845: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12846: $dir = $fileloc;
12847: } else {
12848: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12849: }
1.1071 raeburn 12850: if ($dir ne '') {
12851: my ($sublistref,$listerror) =
12852: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12853: if (ref($sublistref) eq 'ARRAY') {
12854: foreach my $line (@{$sublistref}) {
12855: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12856: undef,$mtime)=split(/\&/,$line,12);
12857: unless (($testdir&$dirptr) ||
12858: ($file_name =~ /^\.\.?$/)) {
12859: $currsubfile{$path}{$file_name} = [$size,$mtime];
12860: }
12861: }
12862: }
12863: }
1.984 raeburn 12864: }
12865: }
12866: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12867: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12868: my $item = $path.'/'.$file;
12869: unless ($mapping{$item} eq $item) {
12870: $pathchanges{$item} = 1;
12871: }
12872: $existing{$item} = 1;
12873: $numexisting ++;
12874: } else {
12875: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12876: }
12877: }
1.1071 raeburn 12878: if ($actionurl eq '/adm/dependencies') {
12879: foreach my $path (keys(%currsubfile)) {
12880: if (ref($currsubfile{$path}) eq 'HASH') {
12881: foreach my $file (keys(%{$currsubfile{$path}})) {
12882: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12883: next if (($rem ne '') &&
12884: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12885: (ref($navmap) &&
12886: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12887: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12888: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12889: $unused{$path.'/'.$file} = 1;
12890: }
12891: }
12892: }
12893: }
12894: }
1.984 raeburn 12895: }
1.1249 damieng 12896:
12897: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12898: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12899: my %currfile;
1.1123 raeburn 12900: if (($actionurl eq '/adm/portfolio') ||
12901: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12902: my ($dirlistref,$listerror) =
12903: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12904: if (ref($dirlistref) eq 'ARRAY') {
12905: foreach my $line (@{$dirlistref}) {
12906: my ($file_name,$rest) = split(/\&/,$line,2);
12907: $currfile{$file_name} = 1;
12908: }
1.984 raeburn 12909: }
1.987 raeburn 12910: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12911: if (opendir(my $dir,$url)) {
1.987 raeburn 12912: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12913: map {$currfile{$_} = 1;} @dir_list;
12914: }
1.1084 raeburn 12915: } elsif (($actionurl eq '/adm/dependencies') ||
12916: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12917: ($args->{'context'} eq 'paste')) ||
12918: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12919: if ($env{'request.course.id'} ne '') {
12920: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12921: if ($dir ne '') {
12922: my ($dirlistref,$listerror) =
12923: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12924: if (ref($dirlistref) eq 'ARRAY') {
12925: foreach my $line (@{$dirlistref}) {
12926: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12927: $size,undef,$mtime)=split(/\&/,$line,12);
12928: unless (($testdir&$dirptr) ||
12929: ($file_name =~ /^\.\.?$/)) {
12930: $currfile{$file_name} = [$size,$mtime];
12931: }
12932: }
12933: }
12934: }
12935: }
1.984 raeburn 12936: }
1.1249 damieng 12937: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12938: # are not in subdirectories, using $currfile
1.984 raeburn 12939: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12940: if (exists($currfile{$file})) {
1.987 raeburn 12941: unless ($mapping{$file} eq $file) {
12942: $pathchanges{$file} = 1;
12943: }
12944: $existing{$file} = 1;
12945: $numexisting ++;
12946: } else {
1.984 raeburn 12947: $newfiles{$file} = 1;
12948: }
12949: }
1.1071 raeburn 12950: foreach my $file (keys(%currfile)) {
12951: unless (($file eq $filename) ||
12952: ($file eq $filename.'.bak') ||
12953: ($dependencies{$file})) {
1.1085 raeburn 12954: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12955: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12956: next if (($rem ne '') &&
12957: (($env{"httpref.$rem".$file} ne '') ||
12958: (ref($navmap) &&
12959: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12960: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12961: ($navmap->getResourceByUrl($rem.$1)))))));
12962: }
1.1085 raeburn 12963: }
1.1071 raeburn 12964: $unused{$file} = 1;
12965: }
12966: }
1.1249 damieng 12967:
12968: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12969: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12970: ($args->{'context'} eq 'paste')) {
12971: $counter = scalar(keys(%existing));
12972: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12973: return ($output,$counter,$numpathchg,\%existing);
12974: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12975: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12976: $counter = scalar(keys(%existing));
12977: $numpathchg = scalar(keys(%pathchanges));
12978: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12979: }
1.1249 damieng 12980:
12981: # returns HTML otherwise, with dependency results and to ask for more uploads
12982:
12983: # $upload_output: missing dependencies (with upload form)
12984: # $modify_output: uploaded dependencies (in use)
12985: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12986: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12987: if ($actionurl eq '/adm/dependencies') {
12988: next if ($embed_file =~ m{^\w+://});
12989: }
1.660 raeburn 12990: $upload_output .= &start_data_table_row().
1.1123 raeburn 12991: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12992: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12993: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12994: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12995: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12996: }
1.1123 raeburn 12997: $upload_output .= '</td>';
1.1071 raeburn 12998: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 12999: $upload_output.='<td align="right">'.
13000: '<span class="LC_info LC_fontsize_medium">'.
13001: &mt("URL points to web address").'</span>';
1.987 raeburn 13002: $numremref++;
1.660 raeburn 13003: } elsif ($args->{'error_on_invalid_names'}
13004: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13005: $upload_output.='<td align="right"><span class="LC_warning">'.
13006: &mt('Invalid characters').'</span>';
1.987 raeburn 13007: $numinvalid++;
1.660 raeburn 13008: } else {
1.1123 raeburn 13009: $upload_output .= '<td>'.
13010: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13011: $embed_file,\%mapping,
1.1071 raeburn 13012: $allfiles,$codebase,'upload');
13013: $counter ++;
13014: $numnew ++;
1.987 raeburn 13015: }
13016: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13017: }
13018: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13019: if ($actionurl eq '/adm/dependencies') {
13020: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13021: $modify_output .= &start_data_table_row().
13022: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13023: '<img src="'.&icon($embed_file).'" border="0" />'.
13024: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13025: '<td>'.$size.'</td>'.
13026: '<td>'.$mtime.'</td>'.
13027: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13028: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13029: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13030: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13031: &embedded_file_element('upload_embedded',$counter,
13032: $embed_file,\%mapping,
13033: $allfiles,$codebase,'modify').
13034: '</div></td>'.
13035: &end_data_table_row()."\n";
13036: $counter ++;
13037: } else {
13038: $upload_output .= &start_data_table_row().
1.1123 raeburn 13039: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13040: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13041: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13042: &Apache::loncommon::end_data_table_row()."\n";
13043: }
13044: }
13045: my $delidx = $counter;
13046: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13047: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13048: $delete_output .= &start_data_table_row().
13049: '<td><img src="'.&icon($oldfile).'" />'.
13050: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13051: '<td>'.$size.'</td>'.
13052: '<td>'.$mtime.'</td>'.
13053: '<td><label><input type="checkbox" name="del_upload_dep" '.
13054: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13055: &embedded_file_element('upload_embedded',$delidx,
13056: $oldfile,\%mapping,$allfiles,
13057: $codebase,'delete').'</td>'.
13058: &end_data_table_row()."\n";
13059: $numunused ++;
13060: $delidx ++;
1.987 raeburn 13061: }
13062: if ($upload_output) {
13063: $upload_output = &start_data_table().
13064: $upload_output.
13065: &end_data_table()."\n";
13066: }
1.1071 raeburn 13067: if ($modify_output) {
13068: $modify_output = &start_data_table().
13069: &start_data_table_header_row().
13070: '<th>'.&mt('File').'</th>'.
13071: '<th>'.&mt('Size (KB)').'</th>'.
13072: '<th>'.&mt('Modified').'</th>'.
13073: '<th>'.&mt('Upload replacement?').'</th>'.
13074: &end_data_table_header_row().
13075: $modify_output.
13076: &end_data_table()."\n";
13077: }
13078: if ($delete_output) {
13079: $delete_output = &start_data_table().
13080: &start_data_table_header_row().
13081: '<th>'.&mt('File').'</th>'.
13082: '<th>'.&mt('Size (KB)').'</th>'.
13083: '<th>'.&mt('Modified').'</th>'.
13084: '<th>'.&mt('Delete?').'</th>'.
13085: &end_data_table_header_row().
13086: $delete_output.
13087: &end_data_table()."\n";
13088: }
1.987 raeburn 13089: my $applies = 0;
13090: if ($numremref) {
13091: $applies ++;
13092: }
13093: if ($numinvalid) {
13094: $applies ++;
13095: }
13096: if ($numexisting) {
13097: $applies ++;
13098: }
1.1071 raeburn 13099: if ($counter || $numunused) {
1.987 raeburn 13100: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13101: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13102: $state.'<h3>'.$heading.'</h3>';
13103: if ($actionurl eq '/adm/dependencies') {
13104: if ($numnew) {
13105: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13106: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13107: $upload_output.'<br />'."\n";
13108: }
13109: if ($numexisting) {
13110: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13111: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13112: $modify_output.'<br />'."\n";
13113: $buttontext = &mt('Save changes');
13114: }
13115: if ($numunused) {
13116: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13117: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13118: $delete_output.'<br />'."\n";
13119: $buttontext = &mt('Save changes');
13120: }
13121: } else {
13122: $output .= $upload_output.'<br />'."\n";
13123: }
13124: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13125: $counter.'" />'."\n";
13126: if ($actionurl eq '/adm/dependencies') {
13127: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13128: $numnew.'" />'."\n";
13129: } elsif ($actionurl eq '') {
1.987 raeburn 13130: $output .= '<input type="hidden" name="phase" value="three" />';
13131: }
13132: } elsif ($applies) {
13133: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13134: if ($applies > 1) {
13135: $output .=
1.1123 raeburn 13136: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13137: if ($numremref) {
13138: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13139: }
13140: if ($numinvalid) {
13141: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13142: }
13143: if ($numexisting) {
13144: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13145: }
13146: $output .= '</ul><br />';
13147: } elsif ($numremref) {
13148: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13149: } elsif ($numinvalid) {
13150: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13151: } elsif ($numexisting) {
13152: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13153: }
13154: $output .= $upload_output.'<br />';
13155: }
13156: my ($pathchange_output,$chgcount);
1.1071 raeburn 13157: $chgcount = $counter;
1.987 raeburn 13158: if (keys(%pathchanges) > 0) {
13159: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13160: if ($counter) {
1.987 raeburn 13161: $output .= &embedded_file_element('pathchange',$chgcount,
13162: $embed_file,\%mapping,
1.1071 raeburn 13163: $allfiles,$codebase,'change');
1.987 raeburn 13164: } else {
13165: $pathchange_output .=
13166: &start_data_table_row().
13167: '<td><input type ="checkbox" name="namechange" value="'.
13168: $chgcount.'" checked="checked" /></td>'.
13169: '<td>'.$mapping{$embed_file}.'</td>'.
13170: '<td>'.$embed_file.
13171: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13172: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13173: '</td>'.&end_data_table_row();
1.660 raeburn 13174: }
1.987 raeburn 13175: $numpathchg ++;
13176: $chgcount ++;
1.660 raeburn 13177: }
13178: }
1.1127 raeburn 13179: if (($counter) || ($numunused)) {
1.987 raeburn 13180: if ($numpathchg) {
13181: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13182: $numpathchg.'" />'."\n";
13183: }
13184: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13185: ($actionurl eq '/adm/imsimport')) {
13186: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13187: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13188: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13189: } elsif ($actionurl eq '/adm/dependencies') {
13190: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13191: }
1.1123 raeburn 13192: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13193: } elsif ($numpathchg) {
13194: my %pathchange = ();
13195: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13196: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13197: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13198: }
1.987 raeburn 13199: }
1.1071 raeburn 13200: return ($output,$counter,$numpathchg);
1.987 raeburn 13201: }
13202:
1.1147 raeburn 13203: =pod
13204:
13205: =item * clean_path($name)
13206:
13207: Performs clean-up of directories, subdirectories and filename in an
13208: embedded object, referenced in an HTML file which is being uploaded
13209: to a course or portfolio, where
13210: "Upload embedded images/multimedia files if HTML file" checkbox was
13211: checked.
13212:
13213: Clean-up is similar to replacements in lonnet::clean_filename()
13214: except each / between sub-directory and next level is preserved.
13215:
13216: =cut
13217:
13218: sub clean_path {
13219: my ($embed_file) = @_;
13220: $embed_file =~s{^/+}{};
13221: my @contents;
13222: if ($embed_file =~ m{/}) {
13223: @contents = split(/\//,$embed_file);
13224: } else {
13225: @contents = ($embed_file);
13226: }
13227: my $lastidx = scalar(@contents)-1;
13228: for (my $i=0; $i<=$lastidx; $i++) {
13229: $contents[$i]=~s{\\}{/}g;
13230: $contents[$i]=~s/\s+/\_/g;
13231: $contents[$i]=~s{[^/\w\.\-]}{}g;
13232: if ($i == $lastidx) {
13233: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13234: }
13235: }
13236: if ($lastidx > 0) {
13237: return join('/',@contents);
13238: } else {
13239: return $contents[0];
13240: }
13241: }
13242:
1.987 raeburn 13243: sub embedded_file_element {
1.1071 raeburn 13244: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13245: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13246: (ref($codebase) eq 'HASH'));
13247: my $output;
1.1071 raeburn 13248: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13249: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13250: }
13251: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13252: &escape($embed_file).'" />';
13253: unless (($context eq 'upload_embedded') &&
13254: ($mapping->{$embed_file} eq $embed_file)) {
13255: $output .='
13256: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13257: }
13258: my $attrib;
13259: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13260: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13261: }
13262: $output .=
13263: "\n\t\t".
13264: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13265: $attrib.'" />';
13266: if (exists($codebase->{$mapping->{$embed_file}})) {
13267: $output .=
13268: "\n\t\t".
13269: '<input name="codebase_'.$num.'" type="hidden" value="'.
13270: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13271: }
1.987 raeburn 13272: return $output;
1.660 raeburn 13273: }
13274:
1.1071 raeburn 13275: sub get_dependency_details {
13276: my ($currfile,$currsubfile,$embed_file) = @_;
13277: my ($size,$mtime,$showsize,$showmtime);
13278: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13279: if ($embed_file =~ m{/}) {
13280: my ($path,$fname) = split(/\//,$embed_file);
13281: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13282: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13283: }
13284: } else {
13285: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13286: ($size,$mtime) = @{$currfile->{$embed_file}};
13287: }
13288: }
13289: $showsize = $size/1024.0;
13290: $showsize = sprintf("%.1f",$showsize);
13291: if ($mtime > 0) {
13292: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13293: }
13294: }
13295: return ($showsize,$showmtime);
13296: }
13297:
13298: sub ask_embedded_js {
13299: return <<"END";
13300: <script type="text/javascript"">
13301: // <![CDATA[
13302: function toggleBrowse(counter) {
13303: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13304: var fileid = document.getElementById('embedded_item_'+counter);
13305: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13306: if (chkboxid.checked == true) {
13307: uploaddivid.style.display='block';
13308: } else {
13309: uploaddivid.style.display='none';
13310: fileid.value = '';
13311: }
13312: }
13313: // ]]>
13314: </script>
13315:
13316: END
13317: }
13318:
1.661 raeburn 13319: sub upload_embedded {
13320: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13321: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13322: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13323: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13324: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13325: my $orig_uploaded_filename =
13326: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13327: foreach my $type ('orig','ref','attrib','codebase') {
13328: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13329: $env{'form.embedded_'.$type.'_'.$i} =
13330: &unescape($env{'form.embedded_'.$type.'_'.$i});
13331: }
13332: }
1.661 raeburn 13333: my ($path,$fname) =
13334: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13335: # no path, whole string is fname
13336: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13337: $fname = &Apache::lonnet::clean_filename($fname);
13338: # See if there is anything left
13339: next if ($fname eq '');
13340:
13341: # Check if file already exists as a file or directory.
13342: my ($state,$msg);
13343: if ($context eq 'portfolio') {
13344: my $port_path = $dirpath;
13345: if ($group ne '') {
13346: $port_path = "groups/$group/$port_path";
13347: }
1.987 raeburn 13348: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13349: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13350: $dir_root,$port_path,$disk_quota,
13351: $current_disk_usage,$uname,$udom);
13352: if ($state eq 'will_exceed_quota'
1.984 raeburn 13353: || $state eq 'file_locked') {
1.661 raeburn 13354: $output .= $msg;
13355: next;
13356: }
13357: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13358: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13359: if ($state eq 'exists') {
13360: $output .= $msg;
13361: next;
13362: }
13363: }
13364: # Check if extension is valid
13365: if (($fname =~ /\.(\w+)$/) &&
13366: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13367: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13368: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13369: next;
13370: } elsif (($fname =~ /\.(\w+)$/) &&
13371: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13372: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13373: next;
13374: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13375: $output .= &mt('Filename not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 13376: next;
13377: }
13378: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13379: my $subdir = $path;
13380: $subdir =~ s{/+$}{};
1.661 raeburn 13381: if ($context eq 'portfolio') {
1.984 raeburn 13382: my $result;
13383: if ($state eq 'existingfile') {
13384: $result=
13385: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13386: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13387: } else {
1.984 raeburn 13388: $result=
13389: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13390: $dirpath.
1.1123 raeburn 13391: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13392: if ($result !~ m|^/uploaded/|) {
13393: $output .= '<span class="LC_error">'
13394: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13395: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13396: .'</span><br />';
13397: next;
13398: } else {
1.987 raeburn 13399: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13400: $path.$fname.'</span>').'<br />';
1.984 raeburn 13401: }
1.661 raeburn 13402: }
1.1123 raeburn 13403: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13404: my $extendedsubdir = $dirpath.'/'.$subdir;
13405: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13406: my $result =
1.1126 raeburn 13407: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13408: if ($result !~ m|^/uploaded/|) {
13409: $output .= '<span class="LC_error">'
13410: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13411: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13412: .'</span><br />';
13413: next;
13414: } else {
13415: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13416: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13417: if ($context eq 'syllabus') {
13418: &Apache::lonnet::make_public_indefinitely($result);
13419: }
1.987 raeburn 13420: }
1.661 raeburn 13421: } else {
13422: # Save the file
13423: my $target = $env{'form.embedded_item_'.$i};
13424: my $fullpath = $dir_root.$dirpath.'/'.$path;
13425: my $dest = $fullpath.$fname;
13426: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13427: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13428: my $count;
13429: my $filepath = $dir_root;
1.1027 raeburn 13430: foreach my $subdir (@parts) {
13431: $filepath .= "/$subdir";
13432: if (!-e $filepath) {
1.661 raeburn 13433: mkdir($filepath,0770);
13434: }
13435: }
13436: my $fh;
13437: if (!open($fh,'>'.$dest)) {
13438: &Apache::lonnet::logthis('Failed to create '.$dest);
13439: $output .= '<span class="LC_error">'.
1.1071 raeburn 13440: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13441: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13442: '</span><br />';
13443: } else {
13444: if (!print $fh $env{'form.embedded_item_'.$i}) {
13445: &Apache::lonnet::logthis('Failed to write to '.$dest);
13446: $output .= '<span class="LC_error">'.
1.1071 raeburn 13447: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13448: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13449: '</span><br />';
13450: } else {
1.987 raeburn 13451: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13452: $url.'</span>').'<br />';
13453: unless ($context eq 'testbank') {
13454: $footer .= &mt('View embedded file: [_1]',
13455: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13456: }
13457: }
13458: close($fh);
13459: }
13460: }
13461: if ($env{'form.embedded_ref_'.$i}) {
13462: $pathchange{$i} = 1;
13463: }
13464: }
13465: if ($output) {
13466: $output = '<p>'.$output.'</p>';
13467: }
13468: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13469: $returnflag = 'ok';
1.1071 raeburn 13470: my $numpathchgs = scalar(keys(%pathchange));
13471: if ($numpathchgs > 0) {
1.987 raeburn 13472: if ($context eq 'portfolio') {
13473: $output .= '<p>'.&mt('or').'</p>';
13474: } elsif ($context eq 'testbank') {
1.1071 raeburn 13475: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13476: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13477: $returnflag = 'modify_orightml';
13478: }
13479: }
1.1071 raeburn 13480: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13481: }
13482:
13483: sub modify_html_form {
13484: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13485: my $end = 0;
13486: my $modifyform;
13487: if ($context eq 'upload_embedded') {
13488: return unless (ref($pathchange) eq 'HASH');
13489: if ($env{'form.number_embedded_items'}) {
13490: $end += $env{'form.number_embedded_items'};
13491: }
13492: if ($env{'form.number_pathchange_items'}) {
13493: $end += $env{'form.number_pathchange_items'};
13494: }
13495: if ($end) {
13496: for (my $i=0; $i<$end; $i++) {
13497: if ($i < $env{'form.number_embedded_items'}) {
13498: next unless($pathchange->{$i});
13499: }
13500: $modifyform .=
13501: &start_data_table_row().
13502: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13503: 'checked="checked" /></td>'.
13504: '<td>'.$env{'form.embedded_ref_'.$i}.
13505: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13506: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13507: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13508: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13509: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13510: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13511: '<td>'.$env{'form.embedded_orig_'.$i}.
13512: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13513: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13514: &end_data_table_row();
1.1071 raeburn 13515: }
1.987 raeburn 13516: }
13517: } else {
13518: $modifyform = $pathchgtable;
13519: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13520: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13521: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13522: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13523: }
13524: }
13525: if ($modifyform) {
1.1071 raeburn 13526: if ($actionurl eq '/adm/dependencies') {
13527: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13528: }
1.987 raeburn 13529: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13530: '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
13531: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13532: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13533: '</ol></p>'."\n".'<p>'.
13534: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13535: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13536: &start_data_table()."\n".
13537: &start_data_table_header_row().
13538: '<th>'.&mt('Change?').'</th>'.
13539: '<th>'.&mt('Current reference').'</th>'.
13540: '<th>'.&mt('Required reference').'</th>'.
13541: &end_data_table_header_row()."\n".
13542: $modifyform.
13543: &end_data_table().'<br />'."\n".$hiddenstate.
13544: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13545: '</form>'."\n";
13546: }
13547: return;
13548: }
13549:
13550: sub modify_html_refs {
1.1123 raeburn 13551: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13552: my $container;
13553: if ($context eq 'portfolio') {
13554: $container = $env{'form.container'};
13555: } elsif ($context eq 'coursedoc') {
13556: $container = $env{'form.primaryurl'};
1.1071 raeburn 13557: } elsif ($context eq 'manage_dependencies') {
13558: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13559: $container = "/$container";
1.1123 raeburn 13560: } elsif ($context eq 'syllabus') {
13561: $container = $url;
1.987 raeburn 13562: } else {
1.1027 raeburn 13563: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13564: }
13565: my (%allfiles,%codebase,$output,$content);
13566: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13567: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13568: if (wantarray) {
13569: return ('',0,0);
13570: } else {
13571: return;
13572: }
13573: }
13574: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13575: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13576: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13577: if (wantarray) {
13578: return ('',0,0);
13579: } else {
13580: return;
13581: }
13582: }
1.987 raeburn 13583: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13584: if ($content eq '-1') {
13585: if (wantarray) {
13586: return ('',0,0);
13587: } else {
13588: return;
13589: }
13590: }
1.987 raeburn 13591: } else {
1.1071 raeburn 13592: unless ($container =~ /^\Q$dir_root\E/) {
13593: if (wantarray) {
13594: return ('',0,0);
13595: } else {
13596: return;
13597: }
13598: }
1.1317 raeburn 13599: if (open(my $fh,'<',$container)) {
1.987 raeburn 13600: $content = join('', <$fh>);
13601: close($fh);
13602: } else {
1.1071 raeburn 13603: if (wantarray) {
13604: return ('',0,0);
13605: } else {
13606: return;
13607: }
1.987 raeburn 13608: }
13609: }
13610: my ($count,$codebasecount) = (0,0);
13611: my $mm = new File::MMagic;
13612: my $mime_type = $mm->checktype_contents($content);
13613: if ($mime_type eq 'text/html') {
13614: my $parse_result =
13615: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13616: \%codebase,\$content);
13617: if ($parse_result eq 'ok') {
13618: foreach my $i (@changes) {
13619: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13620: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13621: if ($allfiles{$ref}) {
13622: my $newname = $orig;
13623: my ($attrib_regexp,$codebase);
1.1006 raeburn 13624: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13625: if ($attrib_regexp =~ /:/) {
13626: $attrib_regexp =~ s/\:/|/g;
13627: }
13628: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13629: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13630: $count += $numchg;
1.1123 raeburn 13631: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13632: delete($allfiles{$ref});
1.987 raeburn 13633: }
13634: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13635: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13636: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13637: $codebasecount ++;
13638: }
13639: }
13640: }
1.1123 raeburn 13641: my $skiprewrites;
1.987 raeburn 13642: if ($count || $codebasecount) {
13643: my $saveresult;
1.1071 raeburn 13644: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13645: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13646: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13647: if ($url eq $container) {
13648: my ($fname) = ($container =~ m{/([^/]+)$});
13649: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13650: $count,'<span class="LC_filename">'.
1.1071 raeburn 13651: $fname.'</span>').'</p>';
1.987 raeburn 13652: } else {
13653: $output = '<p class="LC_error">'.
13654: &mt('Error: update failed for: [_1].',
13655: '<span class="LC_filename">'.
13656: $container.'</span>').'</p>';
13657: }
1.1123 raeburn 13658: if ($context eq 'syllabus') {
13659: unless ($saveresult eq 'ok') {
13660: $skiprewrites = 1;
13661: }
13662: }
1.987 raeburn 13663: } else {
1.1317 raeburn 13664: if (open(my $fh,'>',$container)) {
1.987 raeburn 13665: print $fh $content;
13666: close($fh);
13667: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13668: $count,'<span class="LC_filename">'.
13669: $container.'</span>').'</p>';
1.661 raeburn 13670: } else {
1.987 raeburn 13671: $output = '<p class="LC_error">'.
13672: &mt('Error: could not update [_1].',
13673: '<span class="LC_filename">'.
13674: $container.'</span>').'</p>';
1.661 raeburn 13675: }
13676: }
13677: }
1.1123 raeburn 13678: if (($context eq 'syllabus') && (!$skiprewrites)) {
13679: my ($actionurl,$state);
13680: $actionurl = "/public/$udom/$uname/syllabus";
13681: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13682: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13683: \%codebase,
13684: {'context' => 'rewrites',
13685: 'ignore_remote_references' => 1,});
13686: if (ref($mapping) eq 'HASH') {
13687: my $rewrites = 0;
13688: foreach my $key (keys(%{$mapping})) {
13689: next if ($key =~ m{^https?://});
13690: my $ref = $mapping->{$key};
13691: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13692: my $attrib;
13693: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13694: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13695: }
13696: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13697: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13698: $rewrites += $numchg;
13699: }
13700: }
13701: if ($rewrites) {
13702: my $saveresult;
13703: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13704: if ($url eq $container) {
13705: my ($fname) = ($container =~ m{/([^/]+)$});
13706: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13707: $count,'<span class="LC_filename">'.
13708: $fname.'</span>').'</p>';
13709: } else {
13710: $output .= '<p class="LC_error">'.
13711: &mt('Error: could not update links in [_1].',
13712: '<span class="LC_filename">'.
13713: $container.'</span>').'</p>';
13714:
13715: }
13716: }
13717: }
13718: }
1.987 raeburn 13719: } else {
13720: &logthis('Failed to parse '.$container.
13721: ' to modify references: '.$parse_result);
1.661 raeburn 13722: }
13723: }
1.1071 raeburn 13724: if (wantarray) {
13725: return ($output,$count,$codebasecount);
13726: } else {
13727: return $output;
13728: }
1.661 raeburn 13729: }
13730:
13731: sub check_for_existing {
13732: my ($path,$fname,$element) = @_;
13733: my ($state,$msg);
13734: if (-d $path.'/'.$fname) {
13735: $state = 'exists';
13736: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13737: } elsif (-e $path.'/'.$fname) {
13738: $state = 'exists';
13739: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13740: }
13741: if ($state eq 'exists') {
13742: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13743: }
13744: return ($state,$msg);
13745: }
13746:
13747: sub check_for_upload {
13748: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13749: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13750: my $filesize = length($env{'form.'.$element});
13751: if (!$filesize) {
13752: my $msg = '<span class="LC_error">'.
13753: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13754: '<span class="LC_filename">'.$fname.'</span>',
13755: $filesize).'<br />'.
1.1007 raeburn 13756: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13757: '</span>';
13758: return ('zero_bytes',$msg);
13759: }
13760: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13761: my $getpropath = 1;
1.1021 raeburn 13762: my ($dirlistref,$listerror) =
13763: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13764: my $found_file = 0;
13765: my $locked_file = 0;
1.991 raeburn 13766: my @lockers;
13767: my $navmap;
13768: if ($env{'request.course.id'}) {
13769: $navmap = Apache::lonnavmaps::navmap->new();
13770: }
1.1021 raeburn 13771: if (ref($dirlistref) eq 'ARRAY') {
13772: foreach my $line (@{$dirlistref}) {
13773: my ($file_name,$rest)=split(/\&/,$line,2);
13774: if ($file_name eq $fname){
13775: $file_name = $path.$file_name;
13776: if ($group ne '') {
13777: $file_name = $group.$file_name;
13778: }
13779: $found_file = 1;
13780: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13781: foreach my $lock (@lockers) {
13782: if (ref($lock) eq 'ARRAY') {
13783: my ($symb,$crsid) = @{$lock};
13784: if ($crsid eq $env{'request.course.id'}) {
13785: if (ref($navmap)) {
13786: my $res = $navmap->getBySymb($symb);
13787: foreach my $part (@{$res->parts()}) {
13788: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13789: unless (($slot_status == $res->RESERVED) ||
13790: ($slot_status == $res->RESERVED_LOCATION)) {
13791: $locked_file = 1;
13792: }
1.991 raeburn 13793: }
1.1021 raeburn 13794: } else {
13795: $locked_file = 1;
1.991 raeburn 13796: }
13797: } else {
13798: $locked_file = 1;
13799: }
13800: }
1.1021 raeburn 13801: }
13802: } else {
13803: my @info = split(/\&/,$rest);
13804: my $currsize = $info[6]/1000;
13805: if ($currsize < $filesize) {
13806: my $extra = $filesize - $currsize;
13807: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13808: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13809: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
1.1179 bisitz 13810: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13811: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13812: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13813: return ('will_exceed_quota',$msg);
13814: }
1.984 raeburn 13815: }
13816: }
1.661 raeburn 13817: }
13818: }
13819: }
13820: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13821: my $msg = '<p class="LC_warning">'.
13822: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13823: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13824: return ('will_exceed_quota',$msg);
13825: } elsif ($found_file) {
13826: if ($locked_file) {
1.1179 bisitz 13827: my $msg = '<p class="LC_warning">';
1.661 raeburn 13828: $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
1.1179 bisitz 13829: $msg .= '</p>';
1.661 raeburn 13830: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13831: return ('file_locked',$msg);
13832: } else {
1.1179 bisitz 13833: my $msg = '<p class="LC_error">';
1.984 raeburn 13834: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1179 bisitz 13835: $msg .= '</p>';
1.984 raeburn 13836: return ('existingfile',$msg);
1.661 raeburn 13837: }
13838: }
13839: }
13840:
1.987 raeburn 13841: sub check_for_traversal {
13842: my ($path,$url,$toplevel) = @_;
13843: my @parts=split(/\//,$path);
13844: my $cleanpath;
13845: my $fullpath = $url;
13846: for (my $i=0;$i<@parts;$i++) {
13847: next if ($parts[$i] eq '.');
13848: if ($parts[$i] eq '..') {
13849: $fullpath =~ s{([^/]+/)$}{};
13850: } else {
13851: $fullpath .= $parts[$i].'/';
13852: }
13853: }
13854: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13855: $cleanpath = $1;
13856: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13857: my $curr_toprel = $1;
13858: my @parts = split(/\//,$curr_toprel);
13859: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13860: my @urlparts = split(/\//,$url_toprel);
13861: my $doubledots;
13862: my $startdiff = -1;
13863: for (my $i=0; $i<@urlparts; $i++) {
13864: if ($startdiff == -1) {
13865: unless ($urlparts[$i] eq $parts[$i]) {
13866: $startdiff = $i;
13867: $doubledots .= '../';
13868: }
13869: } else {
13870: $doubledots .= '../';
13871: }
13872: }
13873: if ($startdiff > -1) {
13874: $cleanpath = $doubledots;
13875: for (my $i=$startdiff; $i<@parts; $i++) {
13876: $cleanpath .= $parts[$i].'/';
13877: }
13878: }
13879: }
13880: $cleanpath =~ s{(/)$}{};
13881: return $cleanpath;
13882: }
1.31 albertel 13883:
1.1053 raeburn 13884: sub is_archive_file {
13885: my ($mimetype) = @_;
13886: if (($mimetype eq 'application/octet-stream') ||
13887: ($mimetype eq 'application/x-stuffit') ||
13888: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13889: return 1;
13890: }
13891: return;
13892: }
13893:
13894: sub decompress_form {
1.1065 raeburn 13895: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13896: my %lt = &Apache::lonlocal::texthash (
13897: this => 'This file is an archive file.',
1.1067 raeburn 13898: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13899: itsc => 'Its contents are as follows:',
1.1053 raeburn 13900: youm => 'You may wish to extract its contents.',
13901: extr => 'Extract contents',
1.1067 raeburn 13902: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13903: proa => 'Process automatically?',
1.1053 raeburn 13904: yes => 'Yes',
13905: no => 'No',
1.1067 raeburn 13906: fold => 'Title for folder containing movie',
13907: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13908: );
1.1065 raeburn 13909: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13910: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13911: my $info = &list_archive_contents($fileloc,\@paths);
13912: if (@paths) {
13913: foreach my $path (@paths) {
13914: $path =~ s{^/}{};
1.1067 raeburn 13915: if ($path =~ m{^([^/]+)/$}) {
13916: $topdir = $1;
13917: }
1.1065 raeburn 13918: if ($path =~ m{^([^/]+)/}) {
13919: $toplevel{$1} = $path;
13920: } else {
13921: $toplevel{$path} = $path;
13922: }
13923: }
13924: }
1.1067 raeburn 13925: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13926: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13927: "$topdir/media/",
13928: "$topdir/media/$topdir.mp4",
13929: "$topdir/media/FirstFrame.png",
13930: "$topdir/media/player.swf",
13931: "$topdir/media/swfobject.js",
13932: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13933: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13934: "$topdir/$topdir.mp4",
13935: "$topdir/$topdir\_config.xml",
13936: "$topdir/$topdir\_controller.swf",
13937: "$topdir/$topdir\_embed.css",
13938: "$topdir/$topdir\_First_Frame.png",
13939: "$topdir/$topdir\_player.html",
13940: "$topdir/$topdir\_Thumbnails.png",
13941: "$topdir/playerProductInstall.swf",
13942: "$topdir/scripts/",
13943: "$topdir/scripts/config_xml.js",
13944: "$topdir/scripts/handlebars.js",
13945: "$topdir/scripts/jquery-1.7.1.min.js",
13946: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13947: "$topdir/scripts/modernizr.js",
13948: "$topdir/scripts/player-min.js",
13949: "$topdir/scripts/swfobject.js",
13950: "$topdir/skins/",
13951: "$topdir/skins/configuration_express.xml",
13952: "$topdir/skins/express_show/",
13953: "$topdir/skins/express_show/player-min.css",
13954: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13955: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13956: "$topdir/$topdir.mp4",
13957: "$topdir/$topdir\_config.xml",
13958: "$topdir/$topdir\_controller.swf",
13959: "$topdir/$topdir\_embed.css",
13960: "$topdir/$topdir\_First_Frame.png",
13961: "$topdir/$topdir\_player.html",
13962: "$topdir/$topdir\_Thumbnails.png",
13963: "$topdir/playerProductInstall.swf",
13964: "$topdir/scripts/",
13965: "$topdir/scripts/config_xml.js",
13966: "$topdir/scripts/techsmith-smart-player.min.js",
13967: "$topdir/skins/",
13968: "$topdir/skins/configuration_express.xml",
13969: "$topdir/skins/express_show/",
13970: "$topdir/skins/express_show/spritesheet.min.css",
13971: "$topdir/skins/express_show/spritesheet.png",
13972: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13973: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13974: if (@diffs == 0) {
1.1164 raeburn 13975: $is_camtasia = 6;
13976: } else {
1.1197 raeburn 13977: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13978: if (@diffs == 0) {
13979: $is_camtasia = 8;
1.1197 raeburn 13980: } else {
13981: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13982: if (@diffs == 0) {
13983: $is_camtasia = 8;
13984: }
1.1164 raeburn 13985: }
1.1067 raeburn 13986: }
13987: }
13988: my $output;
13989: if ($is_camtasia) {
13990: $output = <<"ENDCAM";
13991: <script type="text/javascript" language="Javascript">
13992: // <![CDATA[
13993:
13994: function camtasiaToggle() {
13995: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13996: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13997: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 13998: document.getElementById('camtasia_titles').style.display='block';
13999: } else {
14000: document.getElementById('camtasia_titles').style.display='none';
14001: }
14002: }
14003: }
14004: return;
14005: }
14006:
14007: // ]]>
14008: </script>
14009: <p>$lt{'camt'}</p>
14010: ENDCAM
1.1065 raeburn 14011: } else {
1.1067 raeburn 14012: $output = '<p>'.$lt{'this'};
14013: if ($info eq '') {
14014: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14015: } else {
14016: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14017: '<div><pre>'.$info.'</pre></div>';
14018: }
1.1065 raeburn 14019: }
1.1067 raeburn 14020: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14021: my $duplicates;
14022: my $num = 0;
14023: if (ref($dirlist) eq 'ARRAY') {
14024: foreach my $item (@{$dirlist}) {
14025: if (ref($item) eq 'ARRAY') {
14026: if (exists($toplevel{$item->[0]})) {
14027: $duplicates .=
14028: &start_data_table_row().
14029: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14030: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14031: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14032: 'value="1" />'.&mt('Yes').'</label>'.
14033: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14034: '<td>'.$item->[0].'</td>';
14035: if ($item->[2]) {
14036: $duplicates .= '<td>'.&mt('Directory').'</td>';
14037: } else {
14038: $duplicates .= '<td>'.&mt('File').'</td>';
14039: }
14040: $duplicates .= '<td>'.$item->[3].'</td>'.
14041: '<td>'.
14042: &Apache::lonlocal::locallocaltime($item->[4]).
14043: '</td>'.
14044: &end_data_table_row();
14045: $num ++;
14046: }
14047: }
14048: }
14049: }
14050: my $itemcount;
14051: if (@paths > 0) {
14052: $itemcount = scalar(@paths);
14053: } else {
14054: $itemcount = 1;
14055: }
1.1067 raeburn 14056: if ($is_camtasia) {
14057: $output .= $lt{'auto'}.'<br />'.
14058: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14059: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14060: $lt{'yes'}.'</label> <label>'.
14061: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14062: $lt{'no'}.'</label></span><br />'.
14063: '<div id="camtasia_titles" style="display:block">'.
14064: &Apache::lonhtmlcommon::start_pick_box().
14065: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14066: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14067: &Apache::lonhtmlcommon::row_closure().
14068: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14069: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14070: &Apache::lonhtmlcommon::row_closure(1).
14071: &Apache::lonhtmlcommon::end_pick_box().
14072: '</div>';
14073: }
1.1065 raeburn 14074: $output .=
14075: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14076: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14077: "\n";
1.1065 raeburn 14078: if ($duplicates ne '') {
14079: $output .= '<p><span class="LC_warning">'.
14080: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14081: &start_data_table().
14082: &start_data_table_header_row().
14083: '<th>'.&mt('Overwrite?').'</th>'.
14084: '<th>'.&mt('Name').'</th>'.
14085: '<th>'.&mt('Type').'</th>'.
14086: '<th>'.&mt('Size').'</th>'.
14087: '<th>'.&mt('Last modified').'</th>'.
14088: &end_data_table_header_row().
14089: $duplicates.
14090: &end_data_table().
14091: '</p>';
14092: }
1.1067 raeburn 14093: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14094: if (ref($hiddenelements) eq 'HASH') {
14095: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14096: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14097: }
14098: }
14099: $output .= <<"END";
1.1067 raeburn 14100: <br />
1.1053 raeburn 14101: <input type="submit" name="decompress" value="$lt{'extr'}" />
14102: </form>
14103: $noextract
14104: END
14105: return $output;
14106: }
14107:
1.1065 raeburn 14108: sub decompression_utility {
14109: my ($program) = @_;
14110: my @utilities = ('tar','gunzip','bunzip2','unzip');
14111: my $location;
14112: if (grep(/^\Q$program\E$/,@utilities)) {
14113: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14114: '/usr/sbin/') {
14115: if (-x $dir.$program) {
14116: $location = $dir.$program;
14117: last;
14118: }
14119: }
14120: }
14121: return $location;
14122: }
14123:
14124: sub list_archive_contents {
14125: my ($file,$pathsref) = @_;
14126: my (@cmd,$output);
14127: my $needsregexp;
14128: if ($file =~ /\.zip$/) {
14129: @cmd = (&decompression_utility('unzip'),"-l");
14130: $needsregexp = 1;
14131: } elsif (($file =~ m/\.tar\.gz$/) ||
14132: ($file =~ /\.tgz$/)) {
14133: @cmd = (&decompression_utility('tar'),"-ztf");
14134: } elsif ($file =~ /\.tar\.bz2$/) {
14135: @cmd = (&decompression_utility('tar'),"-jtf");
14136: } elsif ($file =~ m|\.tar$|) {
14137: @cmd = (&decompression_utility('tar'),"-tf");
14138: }
14139: if (@cmd) {
14140: undef($!);
14141: undef($@);
14142: if (open(my $fh,"-|", @cmd, $file)) {
14143: while (my $line = <$fh>) {
14144: $output .= $line;
14145: chomp($line);
14146: my $item;
14147: if ($needsregexp) {
14148: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14149: } else {
14150: $item = $line;
14151: }
14152: if ($item ne '') {
14153: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14154: push(@{$pathsref},$item);
14155: }
14156: }
14157: }
14158: close($fh);
14159: }
14160: }
14161: return $output;
14162: }
14163:
1.1053 raeburn 14164: sub decompress_uploaded_file {
14165: my ($file,$dir) = @_;
14166: &Apache::lonnet::appenv({'cgi.file' => $file});
14167: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14168: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14169: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14170: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14171: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14172: my $decompressed = $env{'cgi.decompressed'};
14173: &Apache::lonnet::delenv('cgi.file');
14174: &Apache::lonnet::delenv('cgi.dir');
14175: &Apache::lonnet::delenv('cgi.decompressed');
14176: return ($decompressed,$result);
14177: }
14178:
1.1055 raeburn 14179: sub process_decompression {
14180: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14181: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14182: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14183: &mt('Unexpected file path.').'</p>'."\n";
14184: }
14185: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14186: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14187: &mt('Unexpected course context.').'</p>'."\n";
14188: }
1.1293 raeburn 14189: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14190: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14191: &mt('Filename contained unexpected characters.').'</p>'."\n";
14192: }
1.1055 raeburn 14193: my ($dir,$error,$warning,$output);
1.1180 raeburn 14194: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14195: $error = &mt('Filename not a supported archive file type.').
14196: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14197: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14198: } else {
14199: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14200: if ($docuhome eq 'no_host') {
14201: $error = &mt('Could not determine home server for course.');
14202: } else {
14203: my @ids=&Apache::lonnet::current_machine_ids();
14204: my $currdir = "$dir_root/$destination";
14205: if (grep(/^\Q$docuhome\E$/,@ids)) {
14206: $dir = &LONCAPA::propath($docudom,$docuname).
14207: "$dir_root/$destination";
14208: } else {
14209: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14210: "$dir_root/$docudom/$docuname/$destination";
14211: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14212: $error = &mt('Archive file not found.');
14213: }
14214: }
1.1065 raeburn 14215: my (@to_overwrite,@to_skip);
14216: if ($env{'form.archive_overwrite_total'} > 0) {
14217: my $total = $env{'form.archive_overwrite_total'};
14218: for (my $i=0; $i<$total; $i++) {
14219: if ($env{'form.archive_overwrite_'.$i} == 1) {
14220: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14221: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14222: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14223: }
14224: }
14225: }
14226: my $numskip = scalar(@to_skip);
1.1292 raeburn 14227: my $numoverwrite = scalar(@to_overwrite);
14228: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14229: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14230: } elsif ($dir eq '') {
1.1055 raeburn 14231: $error = &mt('Directory containing archive file unavailable.');
14232: } elsif (!$error) {
1.1065 raeburn 14233: my ($decompressed,$display);
1.1292 raeburn 14234: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14235: my $tempdir = time.'_'.$$.int(rand(10000));
14236: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14237: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14238: ($decompressed,$display) =
14239: &decompress_uploaded_file($file,"$dir/$tempdir");
14240: foreach my $item (@to_skip) {
14241: if (($item ne '') && ($item !~ /\.\./)) {
14242: if (-f "$dir/$tempdir/$item") {
14243: unlink("$dir/$tempdir/$item");
14244: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14245: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14246: }
14247: }
14248: }
14249: foreach my $item (@to_overwrite) {
14250: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14251: if (($item ne '') && ($item !~ /\.\./)) {
14252: if (-f "$dir/$item") {
14253: unlink("$dir/$item");
14254: } elsif (-d "$dir/$item") {
1.1300 raeburn 14255: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14256: }
14257: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14258: }
1.1065 raeburn 14259: }
14260: }
1.1292 raeburn 14261: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14262: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14263: }
1.1065 raeburn 14264: }
14265: } else {
14266: ($decompressed,$display) =
14267: &decompress_uploaded_file($file,$dir);
14268: }
1.1055 raeburn 14269: if ($decompressed eq 'ok') {
1.1065 raeburn 14270: $output = '<p class="LC_info">'.
14271: &mt('Files extracted successfully from archive.').
14272: '</p>'."\n";
1.1055 raeburn 14273: my ($warning,$result,@contents);
14274: my ($newdirlistref,$newlisterror) =
14275: &Apache::lonnet::dirlist($currdir,$docudom,
14276: $docuname,1);
14277: my (%is_dir,%changes,@newitems);
14278: my $dirptr = 16384;
1.1065 raeburn 14279: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14280: foreach my $dir_line (@{$newdirlistref}) {
14281: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14282: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14283: push(@newitems,$item);
14284: if ($dirptr&$testdir) {
14285: $is_dir{$item} = 1;
14286: }
14287: $changes{$item} = 1;
14288: }
14289: }
14290: }
14291: if (keys(%changes) > 0) {
14292: foreach my $item (sort(@newitems)) {
14293: if ($changes{$item}) {
14294: push(@contents,$item);
14295: }
14296: }
14297: }
14298: if (@contents > 0) {
1.1067 raeburn 14299: my $wantform;
14300: unless ($env{'form.autoextract_camtasia'}) {
14301: $wantform = 1;
14302: }
1.1056 raeburn 14303: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14304: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14305: $currdir,\%is_dir,
14306: \%children,\%parent,
1.1056 raeburn 14307: \@contents,\%dirorder,
14308: \%titles,$wantform);
1.1055 raeburn 14309: if ($datatable ne '') {
14310: $output .= &archive_options_form('decompressed',$datatable,
14311: $count,$hiddenelem);
1.1065 raeburn 14312: my $startcount = 6;
1.1055 raeburn 14313: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14314: \%titles,\%children);
1.1055 raeburn 14315: }
1.1067 raeburn 14316: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14317: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14318: my %displayed;
14319: my $total = 1;
14320: $env{'form.archive_directory'} = [];
14321: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14322: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14323: $path =~ s{/$}{};
14324: my $item;
14325: if ($path ne '') {
14326: $item = "$path/$titles{$i}";
14327: } else {
14328: $item = $titles{$i};
14329: }
14330: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14331: if ($item eq $contents[0]) {
14332: push(@{$env{'form.archive_directory'}},$i);
14333: $env{'form.archive_'.$i} = 'display';
14334: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14335: $displayed{'folder'} = $i;
1.1164 raeburn 14336: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14337: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14338: $env{'form.archive_'.$i} = 'display';
14339: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14340: $displayed{'web'} = $i;
14341: } else {
1.1164 raeburn 14342: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14343: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14344: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14345: push(@{$env{'form.archive_directory'}},$i);
14346: }
14347: $env{'form.archive_'.$i} = 'dependency';
14348: }
14349: $total ++;
14350: }
14351: for (my $i=1; $i<$total; $i++) {
14352: next if ($i == $displayed{'web'});
14353: next if ($i == $displayed{'folder'});
14354: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14355: }
14356: $env{'form.phase'} = 'decompress_cleanup';
14357: $env{'form.archivedelete'} = 1;
14358: $env{'form.archive_count'} = $total-1;
14359: $output .=
14360: &process_extracted_files('coursedocs',$docudom,
14361: $docuname,$destination,
14362: $dir_root,$hiddenelem);
14363: }
1.1055 raeburn 14364: } else {
14365: $warning = &mt('No new items extracted from archive file.');
14366: }
14367: } else {
14368: $output = $display;
14369: $error = &mt('An error occurred during extraction from the archive file.');
14370: }
14371: }
14372: }
14373: }
14374: if ($error) {
14375: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14376: $error.'</p>'."\n";
14377: }
14378: if ($warning) {
14379: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14380: }
14381: return $output;
14382: }
14383:
14384: sub get_extracted {
1.1056 raeburn 14385: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14386: $titles,$wantform) = @_;
1.1055 raeburn 14387: my $count = 0;
14388: my $depth = 0;
14389: my $datatable;
1.1056 raeburn 14390: my @hierarchy;
1.1055 raeburn 14391: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14392: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14393: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14394: foreach my $item (@{$contents}) {
14395: $count ++;
1.1056 raeburn 14396: @{$dirorder->{$count}} = @hierarchy;
14397: $titles->{$count} = $item;
1.1055 raeburn 14398: &archive_hierarchy($depth,$count,$parent,$children);
14399: if ($wantform) {
14400: $datatable .= &archive_row($is_dir->{$item},$item,
14401: $currdir,$depth,$count);
14402: }
14403: if ($is_dir->{$item}) {
14404: $depth ++;
1.1056 raeburn 14405: push(@hierarchy,$count);
14406: $parent->{$depth} = $count;
1.1055 raeburn 14407: $datatable .=
14408: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14409: \$depth,\$count,\@hierarchy,$dirorder,
14410: $children,$parent,$titles,$wantform);
1.1055 raeburn 14411: $depth --;
1.1056 raeburn 14412: pop(@hierarchy);
1.1055 raeburn 14413: }
14414: }
14415: return ($count,$datatable);
14416: }
14417:
14418: sub recurse_extracted_archive {
1.1056 raeburn 14419: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14420: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14421: my $result='';
1.1056 raeburn 14422: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14423: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14424: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14425: return $result;
14426: }
14427: my $dirptr = 16384;
14428: my ($newdirlistref,$newlisterror) =
14429: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14430: if (ref($newdirlistref) eq 'ARRAY') {
14431: foreach my $dir_line (@{$newdirlistref}) {
14432: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14433: unless ($item =~ /^\.+$/) {
14434: $$count ++;
1.1056 raeburn 14435: @{$dirorder->{$$count}} = @{$hierarchy};
14436: $titles->{$$count} = $item;
1.1055 raeburn 14437: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14438:
1.1055 raeburn 14439: my $is_dir;
14440: if ($dirptr&$testdir) {
14441: $is_dir = 1;
14442: }
14443: if ($wantform) {
14444: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14445: }
14446: if ($is_dir) {
14447: $$depth ++;
1.1056 raeburn 14448: push(@{$hierarchy},$$count);
14449: $parent->{$$depth} = $$count;
1.1055 raeburn 14450: $result .=
14451: &recurse_extracted_archive("$currdir/$item",$docudom,
14452: $docuname,$depth,$count,
1.1056 raeburn 14453: $hierarchy,$dirorder,$children,
14454: $parent,$titles,$wantform);
1.1055 raeburn 14455: $$depth --;
1.1056 raeburn 14456: pop(@{$hierarchy});
1.1055 raeburn 14457: }
14458: }
14459: }
14460: }
14461: return $result;
14462: }
14463:
14464: sub archive_hierarchy {
14465: my ($depth,$count,$parent,$children) =@_;
14466: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14467: if (exists($parent->{$depth})) {
14468: $children->{$parent->{$depth}} .= $count.':';
14469: }
14470: }
14471: return;
14472: }
14473:
14474: sub archive_row {
14475: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14476: my ($name) = ($item =~ m{([^/]+)$});
14477: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14478: 'display' => 'Add as file',
1.1055 raeburn 14479: 'dependency' => 'Include as dependency',
14480: 'discard' => 'Discard',
14481: );
14482: if ($is_dir) {
1.1059 raeburn 14483: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14484: }
1.1056 raeburn 14485: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14486: my $offset = 0;
1.1055 raeburn 14487: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14488: $offset ++;
1.1065 raeburn 14489: if ($action ne 'display') {
14490: $offset ++;
14491: }
1.1055 raeburn 14492: $output .= '<td><span class="LC_nobreak">'.
14493: '<label><input type="radio" name="archive_'.$count.
14494: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14495: my $text = $choices{$action};
14496: if ($is_dir) {
14497: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14498: if ($action eq 'display') {
1.1059 raeburn 14499: $text = &mt('Add as folder');
1.1055 raeburn 14500: }
1.1056 raeburn 14501: } else {
14502: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14503:
14504: }
14505: $output .= ' /> '.$choices{$action}.'</label></span>';
14506: if ($action eq 'dependency') {
14507: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14508: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14509: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14510: '<option value=""></option>'."\n".
14511: '</select>'."\n".
14512: '</div>';
1.1059 raeburn 14513: } elsif ($action eq 'display') {
14514: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14515: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14516: '</div>';
1.1055 raeburn 14517: }
1.1056 raeburn 14518: $output .= '</td>';
1.1055 raeburn 14519: }
14520: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14521: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14522: for (my $i=0; $i<$depth; $i++) {
14523: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14524: }
14525: if ($is_dir) {
14526: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14527: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14528: } else {
14529: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14530: }
14531: $output .= ' '.$name.'</td>'."\n".
14532: &end_data_table_row();
14533: return $output;
14534: }
14535:
14536: sub archive_options_form {
1.1065 raeburn 14537: my ($form,$display,$count,$hiddenelem) = @_;
14538: my %lt = &Apache::lonlocal::texthash(
14539: perm => 'Permanently remove archive file?',
14540: hows => 'How should each extracted item be incorporated in the course?',
14541: cont => 'Content actions for all',
14542: addf => 'Add as folder/file',
14543: incd => 'Include as dependency for a displayed file',
14544: disc => 'Discard',
14545: no => 'No',
14546: yes => 'Yes',
14547: save => 'Save',
14548: );
14549: my $output = <<"END";
14550: <form name="$form" method="post" action="">
14551: <p><span class="LC_nobreak">$lt{'perm'}
14552: <label>
14553: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14554: </label>
14555:
14556: <label>
14557: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14558: </span>
14559: </p>
14560: <input type="hidden" name="phase" value="decompress_cleanup" />
14561: <br />$lt{'hows'}
14562: <div class="LC_columnSection">
14563: <fieldset>
14564: <legend>$lt{'cont'}</legend>
14565: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14566: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14567: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14568: </fieldset>
14569: </div>
14570: END
14571: return $output.
1.1055 raeburn 14572: &start_data_table()."\n".
1.1065 raeburn 14573: $display."\n".
1.1055 raeburn 14574: &end_data_table()."\n".
14575: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14576: $hiddenelem.
1.1065 raeburn 14577: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14578: '</form>';
14579: }
14580:
14581: sub archive_javascript {
1.1056 raeburn 14582: my ($startcount,$numitems,$titles,$children) = @_;
14583: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14584: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14585: my $scripttag = <<START;
14586: <script type="text/javascript">
14587: // <![CDATA[
14588:
14589: function checkAll(form,prefix) {
14590: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14591: for (var i=0; i < form.elements.length; i++) {
14592: var id = form.elements[i].id;
14593: if ((id != '') && (id != undefined)) {
14594: if (idstr.test(id)) {
14595: if (form.elements[i].type == 'radio') {
14596: form.elements[i].checked = true;
1.1056 raeburn 14597: var nostart = i-$startcount;
1.1059 raeburn 14598: var offset = nostart%7;
14599: var count = (nostart-offset)/7;
1.1056 raeburn 14600: dependencyCheck(form,count,offset);
1.1055 raeburn 14601: }
14602: }
14603: }
14604: }
14605: }
14606:
14607: function propagateCheck(form,count) {
14608: if (count > 0) {
1.1059 raeburn 14609: var startelement = $startcount + ((count-1) * 7);
14610: for (var j=1; j<6; j++) {
14611: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14612: var item = startelement + j;
14613: if (form.elements[item].type == 'radio') {
14614: if (form.elements[item].checked) {
14615: containerCheck(form,count,j);
14616: break;
14617: }
1.1055 raeburn 14618: }
14619: }
14620: }
14621: }
14622: }
14623:
14624: numitems = $numitems
1.1056 raeburn 14625: var titles = new Array(numitems);
14626: var parents = new Array(numitems);
1.1055 raeburn 14627: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14628: parents[i] = new Array;
1.1055 raeburn 14629: }
1.1059 raeburn 14630: var maintitle = '$maintitle';
1.1055 raeburn 14631:
14632: START
14633:
1.1056 raeburn 14634: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14635: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14636: for (my $i=0; $i<@contents; $i ++) {
14637: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14638: }
14639: }
14640:
1.1056 raeburn 14641: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14642: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14643: }
14644:
1.1055 raeburn 14645: $scripttag .= <<END;
14646:
14647: function containerCheck(form,count,offset) {
14648: if (count > 0) {
1.1056 raeburn 14649: dependencyCheck(form,count,offset);
1.1059 raeburn 14650: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14651: form.elements[item].checked = true;
14652: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14653: if (parents[count].length > 0) {
14654: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14655: containerCheck(form,parents[count][j],offset);
14656: }
14657: }
14658: }
14659: }
14660: }
14661:
14662: function dependencyCheck(form,count,offset) {
14663: if (count > 0) {
1.1059 raeburn 14664: var chosen = (offset+$startcount)+7*(count-1);
14665: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14666: var currtype = form.elements[depitem].type;
14667: if (form.elements[chosen].value == 'dependency') {
14668: document.getElementById('arc_depon_'+count).style.display='block';
14669: form.elements[depitem].options.length = 0;
14670: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14671: for (var i=1; i<=numitems; i++) {
14672: if (i == count) {
14673: continue;
14674: }
1.1059 raeburn 14675: var startelement = $startcount + (i-1) * 7;
14676: for (var j=1; j<6; j++) {
14677: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14678: var item = startelement + j;
14679: if (form.elements[item].type == 'radio') {
14680: if (form.elements[item].checked) {
14681: if (form.elements[item].value == 'display') {
14682: var n = form.elements[depitem].options.length;
14683: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14684: }
14685: }
14686: }
14687: }
14688: }
14689: }
14690: } else {
14691: document.getElementById('arc_depon_'+count).style.display='none';
14692: form.elements[depitem].options.length = 0;
14693: form.elements[depitem].options[0] = new Option('Select','',true,true);
14694: }
1.1059 raeburn 14695: titleCheck(form,count,offset);
1.1056 raeburn 14696: }
14697: }
14698:
14699: function propagateSelect(form,count,offset) {
14700: if (count > 0) {
1.1065 raeburn 14701: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14702: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14703: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14704: if (parents[count].length > 0) {
14705: for (var j=0; j<parents[count].length; j++) {
14706: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14707: }
14708: }
14709: }
14710: }
14711: }
1.1056 raeburn 14712:
14713: function containerSelect(form,count,offset,picked) {
14714: if (count > 0) {
1.1065 raeburn 14715: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14716: if (form.elements[item].type == 'radio') {
14717: if (form.elements[item].value == 'dependency') {
14718: if (form.elements[item+1].type == 'select-one') {
14719: for (var i=0; i<form.elements[item+1].options.length; i++) {
14720: if (form.elements[item+1].options[i].value == picked) {
14721: form.elements[item+1].selectedIndex = i;
14722: break;
14723: }
14724: }
14725: }
14726: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14727: if (parents[count].length > 0) {
14728: for (var j=0; j<parents[count].length; j++) {
14729: containerSelect(form,parents[count][j],offset,picked);
14730: }
14731: }
14732: }
14733: }
14734: }
14735: }
14736: }
14737:
1.1059 raeburn 14738: function titleCheck(form,count,offset) {
14739: if (count > 0) {
14740: var chosen = (offset+$startcount)+7*(count-1);
14741: var depitem = $startcount + ((count-1) * 7) + 2;
14742: var currtype = form.elements[depitem].type;
14743: if (form.elements[chosen].value == 'display') {
14744: document.getElementById('arc_title_'+count).style.display='block';
14745: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14746: document.getElementById('archive_title_'+count).value=maintitle;
14747: }
14748: } else {
14749: document.getElementById('arc_title_'+count).style.display='none';
14750: if (currtype == 'text') {
14751: document.getElementById('archive_title_'+count).value='';
14752: }
14753: }
14754: }
14755: return;
14756: }
14757:
1.1055 raeburn 14758: // ]]>
14759: </script>
14760: END
14761: return $scripttag;
14762: }
14763:
14764: sub process_extracted_files {
1.1067 raeburn 14765: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14766: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14767: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14768: my @ids=&Apache::lonnet::current_machine_ids();
14769: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14770: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14771: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14772: if (grep(/^\Q$docuhome\E$/,@ids)) {
14773: $prefix = &LONCAPA::propath($docudom,$docuname);
14774: $pathtocheck = "$dir_root/$destination";
14775: $dir = $dir_root;
14776: $ishome = 1;
14777: } else {
14778: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14779: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14780: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14781: }
14782: my $currdir = "$dir_root/$destination";
14783: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14784: if ($env{'form.folderpath'}) {
14785: my @items = split('&',$env{'form.folderpath'});
14786: $folders{'0'} = $items[-2];
1.1099 raeburn 14787: if ($env{'form.folderpath'} =~ /\:1$/) {
14788: $containers{'0'}='page';
14789: } else {
14790: $containers{'0'}='sequence';
14791: }
1.1055 raeburn 14792: }
14793: my @archdirs = &get_env_multiple('form.archive_directory');
14794: if ($numitems) {
14795: for (my $i=1; $i<=$numitems; $i++) {
14796: my $path = $env{'form.archive_content_'.$i};
14797: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14798: my $item = $1;
14799: $toplevelitems{$item} = $i;
14800: if (grep(/^\Q$i\E$/,@archdirs)) {
14801: $is_dir{$item} = 1;
14802: }
14803: }
14804: }
14805: }
1.1067 raeburn 14806: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14807: if (keys(%toplevelitems) > 0) {
14808: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14809: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14810: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14811: }
1.1066 raeburn 14812: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14813: if ($numitems) {
14814: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14815: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14816: my $path = $env{'form.archive_content_'.$i};
14817: if ($path =~ /^\Q$pathtocheck\E/) {
14818: if ($env{'form.archive_'.$i} eq 'discard') {
14819: if ($prefix ne '' && $path ne '') {
14820: if (-e $prefix.$path) {
1.1066 raeburn 14821: if ((@archdirs > 0) &&
14822: (grep(/^\Q$i\E$/,@archdirs))) {
14823: $todeletedir{$prefix.$path} = 1;
14824: } else {
14825: $todelete{$prefix.$path} = 1;
14826: }
1.1055 raeburn 14827: }
14828: }
14829: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14830: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14831: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14832: $docstitle = $env{'form.archive_title_'.$i};
14833: if ($docstitle eq '') {
14834: $docstitle = $title;
14835: }
1.1055 raeburn 14836: $outer = 0;
1.1056 raeburn 14837: if (ref($dirorder{$i}) eq 'ARRAY') {
14838: if (@{$dirorder{$i}} > 0) {
14839: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14840: if ($env{'form.archive_'.$item} eq 'display') {
14841: $outer = $item;
14842: last;
14843: }
14844: }
14845: }
14846: }
14847: my ($errtext,$fatal) =
14848: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14849: '/'.$folders{$outer}.'.'.
14850: $containers{$outer});
14851: next if ($fatal);
14852: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14853: if ($context eq 'coursedocs') {
1.1056 raeburn 14854: $mapinner{$i} = time;
1.1055 raeburn 14855: $folders{$i} = 'default_'.$mapinner{$i};
14856: $containers{$i} = 'sequence';
14857: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14858: $folders{$i}.'.'.$containers{$i};
14859: my $newidx = &LONCAPA::map::getresidx();
14860: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14861: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14862: push(@LONCAPA::map::order,$newidx);
14863: my ($outtext,$errtext) =
14864: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14865: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14866: '.'.$containers{$outer},1,1);
1.1056 raeburn 14867: $newseqid{$i} = $newidx;
1.1067 raeburn 14868: unless ($errtext) {
1.1294 raeburn 14869: $result .= '<li>'.&mt('Folder: [_1] added to course',
14870: &HTML::Entities::encode($docstitle,'<>&"')).
14871: '</li>'."\n";
1.1067 raeburn 14872: }
1.1055 raeburn 14873: }
14874: } else {
14875: if ($context eq 'coursedocs') {
14876: my $newidx=&LONCAPA::map::getresidx();
14877: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14878: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14879: $title;
1.1392 raeburn 14880: if (($outer !~ /\D/) &&
14881: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14882: ($newidx !~ /\D/)) {
1.1294 raeburn 14883: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14884: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14885: }
14886: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14887: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14888: }
14889: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14890: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14891: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14892: unless ($ishome) {
14893: my $fetch = "$newdest{$i}/$title";
14894: $fetch =~ s/^\Q$prefix$dir\E//;
14895: $prompttofetch{$fetch} = 1;
14896: }
1.1292 raeburn 14897: }
1.1067 raeburn 14898: }
1.1294 raeburn 14899: $LONCAPA::map::resources[$newidx]=
14900: $docstitle.':'.$url.':false:normal:res';
14901: push(@LONCAPA::map::order, $newidx);
14902: my ($outtext,$errtext)=
14903: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14904: $docuname.'/'.$folders{$outer}.
14905: '.'.$containers{$outer},1,1);
14906: unless ($errtext) {
14907: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14908: $result .= '<li>'.&mt('File: [_1] added to course',
14909: &HTML::Entities::encode($docstitle,'<>&"')).
14910: '</li>'."\n";
14911: }
1.1067 raeburn 14912: }
1.1294 raeburn 14913: } else {
14914: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14915: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14916: }
1.1055 raeburn 14917: }
14918: }
1.1086 raeburn 14919: }
14920: } else {
1.1294 raeburn 14921: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14922: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14923: }
14924: }
14925: for (my $i=1; $i<=$numitems; $i++) {
14926: next unless ($env{'form.archive_'.$i} eq 'dependency');
14927: my $path = $env{'form.archive_content_'.$i};
14928: if ($path =~ /^\Q$pathtocheck\E/) {
14929: my ($title) = ($path =~ m{/([^/]+)$});
14930: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14931: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14932: if (ref($dirorder{$i}) eq 'ARRAY') {
14933: my ($itemidx,$fullpath,$relpath);
14934: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14935: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14936: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14937: if ($dirorder{$i}->[$j] eq $container) {
14938: $itemidx = $j;
1.1056 raeburn 14939: }
14940: }
1.1086 raeburn 14941: }
14942: if ($itemidx eq '') {
14943: $itemidx = 0;
14944: }
14945: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14946: if ($mapinner{$referrer{$i}}) {
14947: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14948: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14949: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14950: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14951: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14952: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14953: if (!-e $fullpath) {
14954: mkdir($fullpath,0755);
1.1056 raeburn 14955: }
14956: }
1.1086 raeburn 14957: } else {
14958: last;
1.1056 raeburn 14959: }
1.1086 raeburn 14960: }
14961: }
14962: } elsif ($newdest{$referrer{$i}}) {
14963: $fullpath = $newdest{$referrer{$i}};
14964: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14965: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14966: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14967: last;
14968: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14969: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14970: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14971: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14972: if (!-e $fullpath) {
14973: mkdir($fullpath,0755);
1.1056 raeburn 14974: }
14975: }
1.1086 raeburn 14976: } else {
14977: last;
1.1056 raeburn 14978: }
1.1055 raeburn 14979: }
14980: }
1.1086 raeburn 14981: if ($fullpath ne '') {
14982: if (-e "$prefix$path") {
1.1292 raeburn 14983: unless (rename("$prefix$path","$fullpath/$title")) {
14984: $warning .= &mt('Failed to rename dependency').'<br />';
14985: }
1.1086 raeburn 14986: }
14987: if (-e "$fullpath/$title") {
14988: my $showpath;
14989: if ($relpath ne '') {
14990: $showpath = "$relpath/$title";
14991: } else {
14992: $showpath = "/$title";
14993: }
1.1294 raeburn 14994: $result .= '<li>'.&mt('[_1] included as a dependency',
14995: &HTML::Entities::encode($showpath,'<>&"')).
14996: '</li>'."\n";
1.1292 raeburn 14997: unless ($ishome) {
14998: my $fetch = "$fullpath/$title";
14999: $fetch =~ s/^\Q$prefix$dir\E//;
15000: $prompttofetch{$fetch} = 1;
15001: }
1.1086 raeburn 15002: }
15003: }
1.1055 raeburn 15004: }
1.1086 raeburn 15005: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15006: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15007: &HTML::Entities::encode($path,'<>&"'),
15008: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15009: '<br />';
1.1055 raeburn 15010: }
15011: } else {
1.1294 raeburn 15012: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15013: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15014: }
15015: }
15016: if (keys(%todelete)) {
15017: foreach my $key (keys(%todelete)) {
15018: unlink($key);
1.1066 raeburn 15019: }
15020: }
15021: if (keys(%todeletedir)) {
15022: foreach my $key (keys(%todeletedir)) {
15023: rmdir($key);
15024: }
15025: }
15026: foreach my $dir (sort(keys(%is_dir))) {
15027: if (($pathtocheck ne '') && ($dir ne '')) {
15028: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15029: }
15030: }
1.1067 raeburn 15031: if ($result ne '') {
15032: $output .= '<ul>'."\n".
15033: $result."\n".
15034: '</ul>';
15035: }
15036: unless ($ishome) {
15037: my $replicationfail;
15038: foreach my $item (keys(%prompttofetch)) {
15039: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15040: unless ($fetchresult eq 'ok') {
15041: $replicationfail .= '<li>'.$item.'</li>'."\n";
15042: }
15043: }
15044: if ($replicationfail) {
15045: $output .= '<p class="LC_error">'.
15046: &mt('Course home server failed to retrieve:').'<ul>'.
15047: $replicationfail.
15048: '</ul></p>';
15049: }
15050: }
1.1055 raeburn 15051: } else {
15052: $warning = &mt('No items found in archive.');
15053: }
15054: if ($error) {
15055: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15056: $error.'</p>'."\n";
15057: }
15058: if ($warning) {
15059: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15060: }
15061: return $output;
15062: }
15063:
1.1066 raeburn 15064: sub cleanup_empty_dirs {
15065: my ($path) = @_;
15066: if (($path ne '') && (-d $path)) {
15067: if (opendir(my $dirh,$path)) {
15068: my @dircontents = grep(!/^\./,readdir($dirh));
15069: my $numitems = 0;
15070: foreach my $item (@dircontents) {
15071: if (-d "$path/$item") {
1.1111 raeburn 15072: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15073: if (-e "$path/$item") {
15074: $numitems ++;
15075: }
15076: } else {
15077: $numitems ++;
15078: }
15079: }
15080: if ($numitems == 0) {
15081: rmdir($path);
15082: }
15083: closedir($dirh);
15084: }
15085: }
15086: return;
15087: }
15088:
1.41 ng 15089: =pod
1.45 matthew 15090:
1.1162 raeburn 15091: =item * &get_folder_hierarchy()
1.1068 raeburn 15092:
15093: Provides hierarchy of names of folders/sub-folders containing the current
15094: item,
15095:
15096: Inputs: 3
15097: - $navmap - navmaps object
15098:
15099: - $map - url for map (either the trigger itself, or map containing
15100: the resource, which is the trigger).
15101:
15102: - $showitem - 1 => show title for map itself; 0 => do not show.
15103:
15104: Outputs: 1 @pathitems - array of folder/subfolder names.
15105:
15106: =cut
15107:
15108: sub get_folder_hierarchy {
15109: my ($navmap,$map,$showitem) = @_;
15110: my @pathitems;
15111: if (ref($navmap)) {
15112: my $mapres = $navmap->getResourceByUrl($map);
15113: if (ref($mapres)) {
15114: my $pcslist = $mapres->map_hierarchy();
15115: if ($pcslist ne '') {
15116: my @pcs = split(/,/,$pcslist);
15117: foreach my $pc (@pcs) {
15118: if ($pc == 1) {
1.1129 raeburn 15119: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15120: } else {
15121: my $res = $navmap->getByMapPc($pc);
15122: if (ref($res)) {
15123: my $title = $res->compTitle();
15124: $title =~ s/\W+/_/g;
15125: if ($title ne '') {
15126: push(@pathitems,$title);
15127: }
15128: }
15129: }
15130: }
15131: }
1.1071 raeburn 15132: if ($showitem) {
15133: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15134: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15135: } else {
15136: my $maptitle = $mapres->compTitle();
15137: $maptitle =~ s/\W+/_/g;
15138: if ($maptitle ne '') {
15139: push(@pathitems,$maptitle);
15140: }
1.1068 raeburn 15141: }
15142: }
15143: }
15144: }
15145: return @pathitems;
15146: }
15147:
15148: =pod
15149:
1.1015 raeburn 15150: =item * &get_turnedin_filepath()
15151:
15152: Determines path in a user's portfolio file for storage of files uploaded
15153: to a specific essayresponse or dropbox item.
15154:
15155: Inputs: 3 required + 1 optional.
15156: $symb is symb for resource, $uname and $udom are for current user (required).
15157: $caller is optional (can be "submission", if routine is called when storing
15158: an upoaded file when "Submit Answer" button was pressed).
15159:
15160: Returns array containing $path and $multiresp.
15161: $path is path in portfolio. $multiresp is 1 if this resource contains more
15162: than one file upload item. Callers of routine should append partid as a
15163: subdirectory to $path in cases where $multiresp is 1.
15164:
15165: Called by: homework/essayresponse.pm and homework/structuretags.pm
15166:
15167: =cut
15168:
15169: sub get_turnedin_filepath {
15170: my ($symb,$uname,$udom,$caller) = @_;
15171: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15172: my $turnindir;
15173: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15174: $turnindir = $userhash{'turnindir'};
15175: my ($path,$multiresp);
15176: if ($turnindir eq '') {
15177: if ($caller eq 'submission') {
15178: $turnindir = &mt('turned in');
15179: $turnindir =~ s/\W+/_/g;
15180: my %newhash = (
15181: 'turnindir' => $turnindir,
15182: );
15183: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15184: }
15185: }
15186: if ($turnindir ne '') {
15187: $path = '/'.$turnindir.'/';
15188: my ($multipart,$turnin,@pathitems);
15189: my $navmap = Apache::lonnavmaps::navmap->new();
15190: if (defined($navmap)) {
15191: my $mapres = $navmap->getResourceByUrl($map);
15192: if (ref($mapres)) {
15193: my $pcslist = $mapres->map_hierarchy();
15194: if ($pcslist ne '') {
15195: foreach my $pc (split(/,/,$pcslist)) {
15196: my $res = $navmap->getByMapPc($pc);
15197: if (ref($res)) {
15198: my $title = $res->compTitle();
15199: $title =~ s/\W+/_/g;
15200: if ($title ne '') {
1.1149 raeburn 15201: if (($pc > 1) && (length($title) > 12)) {
15202: $title = substr($title,0,12);
15203: }
1.1015 raeburn 15204: push(@pathitems,$title);
15205: }
15206: }
15207: }
15208: }
15209: my $maptitle = $mapres->compTitle();
15210: $maptitle =~ s/\W+/_/g;
15211: if ($maptitle ne '') {
1.1149 raeburn 15212: if (length($maptitle) > 12) {
15213: $maptitle = substr($maptitle,0,12);
15214: }
1.1015 raeburn 15215: push(@pathitems,$maptitle);
15216: }
15217: unless ($env{'request.state'} eq 'construct') {
15218: my $res = $navmap->getBySymb($symb);
15219: if (ref($res)) {
15220: my $partlist = $res->parts();
15221: my $totaluploads = 0;
15222: if (ref($partlist) eq 'ARRAY') {
15223: foreach my $part (@{$partlist}) {
15224: my @types = $res->responseType($part);
15225: my @ids = $res->responseIds($part);
15226: for (my $i=0; $i < scalar(@ids); $i++) {
15227: if ($types[$i] eq 'essay') {
15228: my $partid = $part.'_'.$ids[$i];
15229: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15230: $totaluploads ++;
15231: }
15232: }
15233: }
15234: }
15235: if ($totaluploads > 1) {
15236: $multiresp = 1;
15237: }
15238: }
15239: }
15240: }
15241: } else {
15242: return;
15243: }
15244: } else {
15245: return;
15246: }
15247: my $restitle=&Apache::lonnet::gettitle($symb);
15248: $restitle =~ s/\W+/_/g;
15249: if ($restitle eq '') {
15250: $restitle = ($resurl =~ m{/[^/]+$});
15251: if ($restitle eq '') {
15252: $restitle = time;
15253: }
15254: }
1.1149 raeburn 15255: if (length($restitle) > 12) {
15256: $restitle = substr($restitle,0,12);
15257: }
1.1015 raeburn 15258: push(@pathitems,$restitle);
15259: $path .= join('/',@pathitems);
15260: }
15261: return ($path,$multiresp);
15262: }
15263:
15264: =pod
15265:
1.464 albertel 15266: =back
1.41 ng 15267:
1.112 bowersj2 15268: =head1 CSV Upload/Handling functions
1.38 albertel 15269:
1.41 ng 15270: =over 4
15271:
1.648 raeburn 15272: =item * &upfile_store($r)
1.41 ng 15273:
15274: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15275: needs $env{'form.upfile'}
1.41 ng 15276: returns $datatoken to be put into hidden field
15277:
15278: =cut
1.31 albertel 15279:
15280: sub upfile_store {
15281: my $r=shift;
1.258 albertel 15282: $env{'form.upfile'}=~s/\r/\n/gs;
15283: $env{'form.upfile'}=~s/\f/\n/gs;
15284: $env{'form.upfile'}=~s/\n+/\n/gs;
15285: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15286:
1.1299 raeburn 15287: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15288: '_enroll_'.$env{'request.course.id'}.'_'.
15289: time.'_'.$$);
15290: return if ($datatoken eq '');
15291:
1.31 albertel 15292: {
1.158 raeburn 15293: my $datafile = $r->dir_config('lonDaemons').
15294: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15295: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15296: print $fh $env{'form.upfile'};
1.158 raeburn 15297: close($fh);
15298: }
1.31 albertel 15299: }
15300: return $datatoken;
15301: }
15302:
1.56 matthew 15303: =pod
15304:
1.1290 raeburn 15305: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15306:
15307: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15308: $datatoken is the name to assign to the temporary file.
1.258 albertel 15309: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15310:
15311: =cut
1.31 albertel 15312:
15313: sub load_tmp_file {
1.1290 raeburn 15314: my ($r,$datatoken) = @_;
15315: return if ($datatoken eq '');
1.31 albertel 15316: my @studentdata=();
15317: {
1.158 raeburn 15318: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15319: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15320: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15321: @studentdata=<$fh>;
15322: close($fh);
15323: }
1.31 albertel 15324: }
1.258 albertel 15325: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15326: }
15327:
1.1290 raeburn 15328: sub valid_datatoken {
15329: my ($datatoken) = @_;
1.1325 raeburn 15330: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15331: return $datatoken;
15332: }
15333: return;
15334: }
15335:
1.56 matthew 15336: =pod
15337:
1.648 raeburn 15338: =item * &upfile_record_sep()
1.41 ng 15339:
15340: Separate uploaded file into records
15341: returns array of records,
1.258 albertel 15342: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15343:
15344: =cut
1.31 albertel 15345:
15346: sub upfile_record_sep {
1.258 albertel 15347: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15348: } else {
1.248 albertel 15349: my @records;
1.258 albertel 15350: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15351: if ($line=~/^\s*$/) { next; }
15352: push(@records,$line);
15353: }
15354: return @records;
1.31 albertel 15355: }
15356: }
15357:
1.56 matthew 15358: =pod
15359:
1.648 raeburn 15360: =item * &record_sep($record)
1.41 ng 15361:
1.258 albertel 15362: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15363:
15364: =cut
15365:
1.263 www 15366: sub takeleft {
15367: my $index=shift;
15368: return substr('0000'.$index,-4,4);
15369: }
15370:
1.31 albertel 15371: sub record_sep {
15372: my $record=shift;
15373: my %components=();
1.258 albertel 15374: if ($env{'form.upfiletype'} eq 'xml') {
15375: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15376: my $i=0;
1.356 albertel 15377: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15378: $field=~s/^(\"|\')//;
15379: $field=~s/(\"|\')$//;
1.263 www 15380: $components{&takeleft($i)}=$field;
1.31 albertel 15381: $i++;
15382: }
1.258 albertel 15383: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15384: my $i=0;
1.356 albertel 15385: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15386: $field=~s/^(\"|\')//;
15387: $field=~s/(\"|\')$//;
1.263 www 15388: $components{&takeleft($i)}=$field;
1.31 albertel 15389: $i++;
15390: }
15391: } else {
1.561 www 15392: my $separator=',';
1.480 banghart 15393: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15394: $separator=';';
1.480 banghart 15395: }
1.31 albertel 15396: my $i=0;
1.561 www 15397: # the character we are looking for to indicate the end of a quote or a record
15398: my $looking_for=$separator;
15399: # do not add the characters to the fields
15400: my $ignore=0;
15401: # we just encountered a separator (or the beginning of the record)
15402: my $just_found_separator=1;
15403: # store the field we are working on here
15404: my $field='';
15405: # work our way through all characters in record
15406: foreach my $character ($record=~/(.)/g) {
15407: if ($character eq $looking_for) {
15408: if ($character ne $separator) {
15409: # Found the end of a quote, again looking for separator
15410: $looking_for=$separator;
15411: $ignore=1;
15412: } else {
15413: # Found a separator, store away what we got
15414: $components{&takeleft($i)}=$field;
15415: $i++;
15416: $just_found_separator=1;
15417: $ignore=0;
15418: $field='';
15419: }
15420: next;
15421: }
15422: # single or double quotation marks after a separator indicate beginning of a quote
15423: # we are now looking for the end of the quote and need to ignore separators
15424: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15425: $looking_for=$character;
15426: next;
15427: }
15428: # ignore would be true after we reached the end of a quote
15429: if ($ignore) { next; }
15430: if (($just_found_separator) && ($character=~/\s/)) { next; }
15431: $field.=$character;
15432: $just_found_separator=0;
1.31 albertel 15433: }
1.561 www 15434: # catch the very last entry, since we never encountered the separator
15435: $components{&takeleft($i)}=$field;
1.31 albertel 15436: }
15437: return %components;
15438: }
15439:
1.144 matthew 15440: ######################################################
15441: ######################################################
15442:
1.56 matthew 15443: =pod
15444:
1.648 raeburn 15445: =item * &upfile_select_html()
1.41 ng 15446:
1.144 matthew 15447: Return HTML code to select a file from the users machine and specify
15448: the file type.
1.41 ng 15449:
15450: =cut
15451:
1.144 matthew 15452: ######################################################
15453: ######################################################
1.31 albertel 15454: sub upfile_select_html {
1.144 matthew 15455: my %Types = (
15456: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15457: semisv => &mt('Semicolon separated values'),
1.144 matthew 15458: space => &mt('Space separated'),
15459: tab => &mt('Tabulator separated'),
15460: # xml => &mt('HTML/XML'),
15461: );
15462: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15463: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15464: foreach my $type (sort(keys(%Types))) {
15465: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15466: }
15467: $Str .= "</select>\n";
15468: return $Str;
1.31 albertel 15469: }
15470:
1.301 albertel 15471: sub get_samples {
15472: my ($records,$toget) = @_;
15473: my @samples=({});
15474: my $got=0;
15475: foreach my $rec (@$records) {
15476: my %temp = &record_sep($rec);
15477: if (! grep(/\S/, values(%temp))) { next; }
15478: if (%temp) {
15479: $samples[$got]=\%temp;
15480: $got++;
15481: if ($got == $toget) { last; }
15482: }
15483: }
15484: return \@samples;
15485: }
15486:
1.144 matthew 15487: ######################################################
15488: ######################################################
15489:
1.56 matthew 15490: =pod
15491:
1.648 raeburn 15492: =item * &csv_print_samples($r,$records)
1.41 ng 15493:
15494: Prints a table of sample values from each column uploaded $r is an
15495: Apache Request ref, $records is an arrayref from
15496: &Apache::loncommon::upfile_record_sep
15497:
15498: =cut
15499:
1.144 matthew 15500: ######################################################
15501: ######################################################
1.31 albertel 15502: sub csv_print_samples {
15503: my ($r,$records) = @_;
1.662 bisitz 15504: my $samples = &get_samples($records,5);
1.301 albertel 15505:
1.594 raeburn 15506: $r->print(&mt('Samples').'<br />'.&start_data_table().
15507: &start_data_table_header_row());
1.356 albertel 15508: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15509: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15510: $r->print(&end_data_table_header_row());
1.301 albertel 15511: foreach my $hash (@$samples) {
1.594 raeburn 15512: $r->print(&start_data_table_row());
1.356 albertel 15513: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15514: $r->print('<td>');
1.356 albertel 15515: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15516: $r->print('</td>');
15517: }
1.594 raeburn 15518: $r->print(&end_data_table_row());
1.31 albertel 15519: }
1.594 raeburn 15520: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15521: }
15522:
1.144 matthew 15523: ######################################################
15524: ######################################################
15525:
1.56 matthew 15526: =pod
15527:
1.648 raeburn 15528: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15529:
15530: Prints a table to create associations between values and table columns.
1.144 matthew 15531:
1.41 ng 15532: $r is an Apache Request ref,
15533: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15534: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15535:
15536: =cut
15537:
1.144 matthew 15538: ######################################################
15539: ######################################################
1.31 albertel 15540: sub csv_print_select_table {
15541: my ($r,$records,$d) = @_;
1.301 albertel 15542: my $i=0;
15543: my $samples = &get_samples($records,1);
1.144 matthew 15544: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15545: &start_data_table().&start_data_table_header_row().
1.144 matthew 15546: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15547: '<th>'.&mt('Column').'</th>'.
15548: &end_data_table_header_row()."\n");
1.356 albertel 15549: foreach my $array_ref (@$d) {
15550: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15551: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15552:
1.875 bisitz 15553: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15554: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15555: $r->print('<option value="none"></option>');
1.356 albertel 15556: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15557: $r->print('<option value="'.$sample.'"'.
15558: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15559: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15560: }
1.594 raeburn 15561: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15562: $i++;
15563: }
1.594 raeburn 15564: $r->print(&end_data_table());
1.31 albertel 15565: $i--;
15566: return $i;
15567: }
1.56 matthew 15568:
1.144 matthew 15569: ######################################################
15570: ######################################################
15571:
1.56 matthew 15572: =pod
1.31 albertel 15573:
1.648 raeburn 15574: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15575:
15576: Prints a table of sample values from the upload and can make associate samples to internal names.
15577:
15578: $r is an Apache Request ref,
15579: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15580: $d is an array of 2 element arrays (internal name, displayed name)
15581:
15582: =cut
15583:
1.144 matthew 15584: ######################################################
15585: ######################################################
1.31 albertel 15586: sub csv_samples_select_table {
15587: my ($r,$records,$d) = @_;
15588: my $i=0;
1.144 matthew 15589: #
1.662 bisitz 15590: my $max_samples = 5;
15591: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15592: $r->print(&start_data_table().
15593: &start_data_table_header_row().'<th>'.
15594: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15595: &end_data_table_header_row());
1.301 albertel 15596:
15597: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15598: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15599: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15600: foreach my $option (@$d) {
15601: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15602: $r->print('<option value="'.$value.'"'.
1.253 albertel 15603: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15604: $display.'</option>');
1.31 albertel 15605: }
15606: $r->print('</select></td><td>');
1.662 bisitz 15607: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15608: if (defined($samples->[$line]{$key})) {
15609: $r->print($samples->[$line]{$key}."<br />\n");
15610: }
15611: }
1.594 raeburn 15612: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15613: $i++;
15614: }
1.594 raeburn 15615: $r->print(&end_data_table());
1.31 albertel 15616: $i--;
15617: return($i);
1.115 matthew 15618: }
15619:
1.144 matthew 15620: ######################################################
15621: ######################################################
15622:
1.115 matthew 15623: =pod
15624:
1.648 raeburn 15625: =item * &clean_excel_name($name)
1.115 matthew 15626:
15627: Returns a replacement for $name which does not contain any illegal characters.
15628:
15629: =cut
15630:
1.144 matthew 15631: ######################################################
15632: ######################################################
1.115 matthew 15633: sub clean_excel_name {
15634: my ($name) = @_;
15635: $name =~ s/[:\*\?\/\\]//g;
15636: if (length($name) > 31) {
15637: $name = substr($name,0,31);
15638: }
15639: return $name;
1.25 albertel 15640: }
1.84 albertel 15641:
1.85 albertel 15642: =pod
15643:
1.648 raeburn 15644: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15645:
15646: Returns either 1 or undef
15647:
15648: 1 if the part is to be hidden, undef if it is to be shown
15649:
15650: Arguments are:
15651:
15652: $id the id of the part to be checked
15653: $symb, optional the symb of the resource to check
15654: $udom, optional the domain of the user to check for
15655: $uname, optional the username of the user to check for
15656:
15657: =cut
1.84 albertel 15658:
15659: sub check_if_partid_hidden {
15660: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15661: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15662: $symb,$udom,$uname);
1.141 albertel 15663: my $truth=1;
15664: #if the string starts with !, then the list is the list to show not hide
15665: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15666: my @hiddenlist=split(/,/,$hiddenparts);
15667: foreach my $checkid (@hiddenlist) {
1.141 albertel 15668: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15669: }
1.141 albertel 15670: return !$truth;
1.84 albertel 15671: }
1.127 matthew 15672:
1.138 matthew 15673:
15674: ############################################################
15675: ############################################################
15676:
15677: =pod
15678:
1.157 matthew 15679: =back
15680:
1.138 matthew 15681: =head1 cgi-bin script and graphing routines
15682:
1.157 matthew 15683: =over 4
15684:
1.648 raeburn 15685: =item * &get_cgi_id()
1.138 matthew 15686:
15687: Inputs: none
15688:
15689: Returns an id which can be used to pass environment variables
15690: to various cgi-bin scripts. These environment variables will
15691: be removed from the users environment after a given time by
15692: the routine &Apache::lonnet::transfer_profile_to_env.
15693:
15694: =cut
15695:
15696: ############################################################
15697: ############################################################
1.152 albertel 15698: my $uniq=0;
1.136 matthew 15699: sub get_cgi_id {
1.154 albertel 15700: $uniq=($uniq+1)%100000;
1.280 albertel 15701: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15702: }
15703:
1.127 matthew 15704: ############################################################
15705: ############################################################
15706:
15707: =pod
15708:
1.648 raeburn 15709: =item * &DrawBarGraph()
1.127 matthew 15710:
1.138 matthew 15711: Facilitates the plotting of data in a (stacked) bar graph.
15712: Puts plot definition data into the users environment in order for
15713: graph.png to plot it. Returns an <img> tag for the plot.
15714: The bars on the plot are labeled '1','2',...,'n'.
15715:
15716: Inputs:
15717:
15718: =over 4
15719:
15720: =item $Title: string, the title of the plot
15721:
15722: =item $xlabel: string, text describing the X-axis of the plot
15723:
15724: =item $ylabel: string, text describing the Y-axis of the plot
15725:
15726: =item $Max: scalar, the maximum Y value to use in the plot
15727: If $Max is < any data point, the graph will not be rendered.
15728:
1.140 matthew 15729: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15730: they are plotted. If undefined, default values will be used.
15731:
1.178 matthew 15732: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15733:
1.138 matthew 15734: =item @Values: An array of array references. Each array reference holds data
15735: to be plotted in a stacked bar chart.
15736:
1.239 matthew 15737: =item If the final element of @Values is a hash reference the key/value
15738: pairs will be added to the graph definition.
15739:
1.138 matthew 15740: =back
15741:
15742: Returns:
15743:
15744: An <img> tag which references graph.png and the appropriate identifying
15745: information for the plot.
15746:
1.127 matthew 15747: =cut
15748:
15749: ############################################################
15750: ############################################################
1.134 matthew 15751: sub DrawBarGraph {
1.178 matthew 15752: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15753: #
15754: if (! defined($colors)) {
15755: $colors = ['#33ff00',
15756: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15757: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15758: ];
15759: }
1.228 matthew 15760: my $extra_settings = {};
15761: if (ref($Values[-1]) eq 'HASH') {
15762: $extra_settings = pop(@Values);
15763: }
1.127 matthew 15764: #
1.136 matthew 15765: my $identifier = &get_cgi_id();
15766: my $id = 'cgi.'.$identifier;
1.129 matthew 15767: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15768: return '';
15769: }
1.225 matthew 15770: #
15771: my @Labels;
15772: if (defined($labels)) {
15773: @Labels = @$labels;
15774: } else {
15775: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15776: push(@Labels,$i+1);
1.225 matthew 15777: }
15778: }
15779: #
1.129 matthew 15780: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15781: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15782: my %ValuesHash;
15783: my $NumSets=1;
15784: foreach my $array (@Values) {
15785: next if (! ref($array));
1.136 matthew 15786: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15787: join(',',@$array);
1.129 matthew 15788: }
1.127 matthew 15789: #
1.136 matthew 15790: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15791: if ($NumBars < 3) {
15792: $width = 120+$NumBars*32;
1.220 matthew 15793: $xskip = 1;
1.225 matthew 15794: $bar_width = 30;
15795: } elsif ($NumBars < 5) {
15796: $width = 120+$NumBars*20;
15797: $xskip = 1;
15798: $bar_width = 20;
1.220 matthew 15799: } elsif ($NumBars < 10) {
1.136 matthew 15800: $width = 120+$NumBars*15;
15801: $xskip = 1;
15802: $bar_width = 15;
15803: } elsif ($NumBars <= 25) {
15804: $width = 120+$NumBars*11;
15805: $xskip = 5;
15806: $bar_width = 8;
15807: } elsif ($NumBars <= 50) {
15808: $width = 120+$NumBars*8;
15809: $xskip = 5;
15810: $bar_width = 4;
15811: } else {
15812: $width = 120+$NumBars*8;
15813: $xskip = 5;
15814: $bar_width = 4;
15815: }
15816: #
1.137 matthew 15817: $Max = 1 if ($Max < 1);
15818: if ( int($Max) < $Max ) {
15819: $Max++;
15820: $Max = int($Max);
15821: }
1.127 matthew 15822: $Title = '' if (! defined($Title));
15823: $xlabel = '' if (! defined($xlabel));
15824: $ylabel = '' if (! defined($ylabel));
1.369 www 15825: $ValuesHash{$id.'.title'} = &escape($Title);
15826: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15827: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15828: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15829: $ValuesHash{$id.'.NumBars'} = $NumBars;
15830: $ValuesHash{$id.'.NumSets'} = $NumSets;
15831: $ValuesHash{$id.'.PlotType'} = 'bar';
15832: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15833: $ValuesHash{$id.'.height'} = $height;
15834: $ValuesHash{$id.'.width'} = $width;
15835: $ValuesHash{$id.'.xskip'} = $xskip;
15836: $ValuesHash{$id.'.bar_width'} = $bar_width;
15837: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15838: #
1.228 matthew 15839: # Deal with other parameters
15840: while (my ($key,$value) = each(%$extra_settings)) {
15841: $ValuesHash{$id.'.'.$key} = $value;
15842: }
15843: #
1.646 raeburn 15844: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15845: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15846: }
15847:
15848: ############################################################
15849: ############################################################
15850:
15851: =pod
15852:
1.648 raeburn 15853: =item * &DrawXYGraph()
1.137 matthew 15854:
1.138 matthew 15855: Facilitates the plotting of data in an XY graph.
15856: Puts plot definition data into the users environment in order for
15857: graph.png to plot it. Returns an <img> tag for the plot.
15858:
15859: Inputs:
15860:
15861: =over 4
15862:
15863: =item $Title: string, the title of the plot
15864:
15865: =item $xlabel: string, text describing the X-axis of the plot
15866:
15867: =item $ylabel: string, text describing the Y-axis of the plot
15868:
15869: =item $Max: scalar, the maximum Y value to use in the plot
15870: If $Max is < any data point, the graph will not be rendered.
15871:
15872: =item $colors: Array ref containing the hex color codes for the data to be
15873: plotted in. If undefined, default values will be used.
15874:
15875: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15876:
15877: =item $Ydata: Array ref containing Array refs.
1.185 www 15878: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15879:
15880: =item %Values: hash indicating or overriding any default values which are
15881: passed to graph.png.
15882: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15883:
15884: =back
15885:
15886: Returns:
15887:
15888: An <img> tag which references graph.png and the appropriate identifying
15889: information for the plot.
15890:
1.137 matthew 15891: =cut
15892:
15893: ############################################################
15894: ############################################################
15895: sub DrawXYGraph {
15896: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15897: #
15898: # Create the identifier for the graph
15899: my $identifier = &get_cgi_id();
15900: my $id = 'cgi.'.$identifier;
15901: #
15902: $Title = '' if (! defined($Title));
15903: $xlabel = '' if (! defined($xlabel));
15904: $ylabel = '' if (! defined($ylabel));
15905: my %ValuesHash =
15906: (
1.369 www 15907: $id.'.title' => &escape($Title),
15908: $id.'.xlabel' => &escape($xlabel),
15909: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15910: $id.'.y_max_value'=> $Max,
15911: $id.'.labels' => join(',',@$Xlabels),
15912: $id.'.PlotType' => 'XY',
15913: );
15914: #
15915: if (defined($colors) && ref($colors) eq 'ARRAY') {
15916: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15917: }
15918: #
15919: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15920: return '';
15921: }
15922: my $NumSets=1;
1.138 matthew 15923: foreach my $array (@{$Ydata}){
1.137 matthew 15924: next if (! ref($array));
15925: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15926: }
1.138 matthew 15927: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15928: #
15929: # Deal with other parameters
15930: while (my ($key,$value) = each(%Values)) {
15931: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15932: }
15933: #
1.646 raeburn 15934: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15935: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15936: }
15937:
15938: ############################################################
15939: ############################################################
15940:
15941: =pod
15942:
1.648 raeburn 15943: =item * &DrawXYYGraph()
1.138 matthew 15944:
15945: Facilitates the plotting of data in an XY graph with two Y axes.
15946: Puts plot definition data into the users environment in order for
15947: graph.png to plot it. Returns an <img> tag for the plot.
15948:
15949: Inputs:
15950:
15951: =over 4
15952:
15953: =item $Title: string, the title of the plot
15954:
15955: =item $xlabel: string, text describing the X-axis of the plot
15956:
15957: =item $ylabel: string, text describing the Y-axis of the plot
15958:
15959: =item $colors: Array ref containing the hex color codes for the data to be
15960: plotted in. If undefined, default values will be used.
15961:
15962: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15963:
15964: =item $Ydata1: The first data set
15965:
15966: =item $Min1: The minimum value of the left Y-axis
15967:
15968: =item $Max1: The maximum value of the left Y-axis
15969:
15970: =item $Ydata2: The second data set
15971:
15972: =item $Min2: The minimum value of the right Y-axis
15973:
15974: =item $Max2: The maximum value of the left Y-axis
15975:
15976: =item %Values: hash indicating or overriding any default values which are
15977: passed to graph.png.
15978: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15979:
15980: =back
15981:
15982: Returns:
15983:
15984: An <img> tag which references graph.png and the appropriate identifying
15985: information for the plot.
1.136 matthew 15986:
15987: =cut
15988:
15989: ############################################################
15990: ############################################################
1.137 matthew 15991: sub DrawXYYGraph {
15992: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15993: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15994: #
15995: # Create the identifier for the graph
15996: my $identifier = &get_cgi_id();
15997: my $id = 'cgi.'.$identifier;
15998: #
15999: $Title = '' if (! defined($Title));
16000: $xlabel = '' if (! defined($xlabel));
16001: $ylabel = '' if (! defined($ylabel));
16002: my %ValuesHash =
16003: (
1.369 www 16004: $id.'.title' => &escape($Title),
16005: $id.'.xlabel' => &escape($xlabel),
16006: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16007: $id.'.labels' => join(',',@$Xlabels),
16008: $id.'.PlotType' => 'XY',
16009: $id.'.NumSets' => 2,
1.137 matthew 16010: $id.'.two_axes' => 1,
16011: $id.'.y1_max_value' => $Max1,
16012: $id.'.y1_min_value' => $Min1,
16013: $id.'.y2_max_value' => $Max2,
16014: $id.'.y2_min_value' => $Min2,
1.136 matthew 16015: );
16016: #
1.137 matthew 16017: if (defined($colors) && ref($colors) eq 'ARRAY') {
16018: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16019: }
16020: #
16021: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16022: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16023: return '';
16024: }
16025: my $NumSets=1;
1.137 matthew 16026: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16027: next if (! ref($array));
16028: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16029: }
16030: #
16031: # Deal with other parameters
16032: while (my ($key,$value) = each(%Values)) {
16033: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16034: }
16035: #
1.646 raeburn 16036: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16037: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16038: }
16039:
16040: ############################################################
16041: ############################################################
16042:
16043: =pod
16044:
1.157 matthew 16045: =back
16046:
1.139 matthew 16047: =head1 Statistics helper routines?
16048:
16049: Bad place for them but what the hell.
16050:
1.157 matthew 16051: =over 4
16052:
1.648 raeburn 16053: =item * &chartlink()
1.139 matthew 16054:
16055: Returns a link to the chart for a specific student.
16056:
16057: Inputs:
16058:
16059: =over 4
16060:
16061: =item $linktext: The text of the link
16062:
16063: =item $sname: The students username
16064:
16065: =item $sdomain: The students domain
16066:
16067: =back
16068:
1.157 matthew 16069: =back
16070:
1.139 matthew 16071: =cut
16072:
16073: ############################################################
16074: ############################################################
16075: sub chartlink {
16076: my ($linktext, $sname, $sdomain) = @_;
16077: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16078: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16079: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16080: '">'.$linktext.'</a>';
1.153 matthew 16081: }
16082:
16083: #######################################################
16084: #######################################################
16085:
16086: =pod
16087:
16088: =head1 Course Environment Routines
1.157 matthew 16089:
16090: =over 4
1.153 matthew 16091:
1.648 raeburn 16092: =item * &restore_course_settings()
1.153 matthew 16093:
1.648 raeburn 16094: =item * &store_course_settings()
1.153 matthew 16095:
16096: Restores/Store indicated form parameters from the course environment.
16097: Will not overwrite existing values of the form parameters.
16098:
16099: Inputs:
16100: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16101:
16102: a hash ref describing the data to be stored. For example:
16103:
16104: %Save_Parameters = ('Status' => 'scalar',
16105: 'chartoutputmode' => 'scalar',
16106: 'chartoutputdata' => 'scalar',
16107: 'Section' => 'array',
1.373 raeburn 16108: 'Group' => 'array',
1.153 matthew 16109: 'StudentData' => 'array',
16110: 'Maps' => 'array');
16111:
16112: Returns: both routines return nothing
16113:
1.631 raeburn 16114: =back
16115:
1.153 matthew 16116: =cut
16117:
16118: #######################################################
16119: #######################################################
16120: sub store_course_settings {
1.496 albertel 16121: return &store_settings($env{'request.course.id'},@_);
16122: }
16123:
16124: sub store_settings {
1.153 matthew 16125: # save to the environment
16126: # appenv the same items, just to be safe
1.300 albertel 16127: my $udom = $env{'user.domain'};
16128: my $uname = $env{'user.name'};
1.496 albertel 16129: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16130: my %SaveHash;
16131: my %AppHash;
16132: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16133: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16134: my $envname = 'environment.'.$basename;
1.258 albertel 16135: if (exists($env{'form.'.$setting})) {
1.153 matthew 16136: # Save this value away
16137: if ($type eq 'scalar' &&
1.258 albertel 16138: (! exists($env{$envname}) ||
16139: $env{$envname} ne $env{'form.'.$setting})) {
16140: $SaveHash{$basename} = $env{'form.'.$setting};
16141: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16142: } elsif ($type eq 'array') {
16143: my $stored_form;
1.258 albertel 16144: if (ref($env{'form.'.$setting})) {
1.153 matthew 16145: $stored_form = join(',',
16146: map {
1.369 www 16147: &escape($_);
1.258 albertel 16148: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16149: } else {
16150: $stored_form =
1.369 www 16151: &escape($env{'form.'.$setting});
1.153 matthew 16152: }
16153: # Determine if the array contents are the same.
1.258 albertel 16154: if ($stored_form ne $env{$envname}) {
1.153 matthew 16155: $SaveHash{$basename} = $stored_form;
16156: $AppHash{$envname} = $stored_form;
16157: }
16158: }
16159: }
16160: }
16161: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16162: $udom,$uname);
1.153 matthew 16163: if ($put_result !~ /^(ok|delayed)/) {
16164: &Apache::lonnet::logthis('unable to save form parameters, '.
16165: 'got error:'.$put_result);
16166: }
16167: # Make sure these settings stick around in this session, too
1.646 raeburn 16168: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16169: return;
16170: }
16171:
16172: sub restore_course_settings {
1.499 albertel 16173: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16174: }
16175:
16176: sub restore_settings {
16177: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16178: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16179: next if (exists($env{'form.'.$setting}));
1.496 albertel 16180: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16181: '.'.$setting;
1.258 albertel 16182: if (exists($env{$envname})) {
1.153 matthew 16183: if ($type eq 'scalar') {
1.258 albertel 16184: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16185: } elsif ($type eq 'array') {
1.258 albertel 16186: $env{'form.'.$setting} = [
1.153 matthew 16187: map {
1.369 www 16188: &unescape($_);
1.258 albertel 16189: } split(',',$env{$envname})
1.153 matthew 16190: ];
16191: }
16192: }
16193: }
1.127 matthew 16194: }
16195:
1.618 raeburn 16196: #######################################################
16197: #######################################################
16198:
16199: =pod
16200:
16201: =head1 Domain E-mail Routines
16202:
16203: =over 4
16204:
1.648 raeburn 16205: =item * &build_recipient_list()
1.618 raeburn 16206:
1.1144 raeburn 16207: Build recipient lists for following types of e-mail:
1.766 raeburn 16208: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16209: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16210: module change checking, student/employee ID conflict checks, as
16211: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16212: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16213:
16214: Inputs:
1.619 raeburn 16215: defmail (scalar - email address of default recipient),
1.1144 raeburn 16216: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16217: requestsmail, updatesmail, or idconflictsmail).
16218:
1.619 raeburn 16219: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16220:
1.619 raeburn 16221: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16222: i.e., predates configuration by DC via domainprefs.pm
16223:
16224: $requname username of requester (if mailing type is helpdeskmail)
16225:
16226: $requdom domain of requester (if mailing type is helpdeskmail)
16227:
16228: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16229:
1.618 raeburn 16230:
1.655 raeburn 16231: Returns: comma separated list of addresses to which to send e-mail.
16232:
16233: =back
1.618 raeburn 16234:
16235: =cut
16236:
16237: ############################################################
16238: ############################################################
16239: sub build_recipient_list {
1.1297 raeburn 16240: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16241: my @recipients;
1.1270 raeburn 16242: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16243: my %domconfig =
1.1270 raeburn 16244: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16245: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16246: if (exists($domconfig{'contacts'}{$mailing})) {
16247: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16248: my @contacts = ('adminemail','supportemail');
16249: foreach my $item (@contacts) {
16250: if ($domconfig{'contacts'}{$mailing}{$item}) {
16251: my $addr = $domconfig{'contacts'}{$item};
16252: if (!grep(/^\Q$addr\E$/,@recipients)) {
16253: push(@recipients,$addr);
16254: }
1.619 raeburn 16255: }
1.1270 raeburn 16256: }
16257: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16258: if ($mailing eq 'helpdeskmail') {
16259: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16260: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16261: my @ok_bccs;
16262: foreach my $bcc (@bccs) {
16263: $bcc =~ s/^\s+//g;
16264: $bcc =~ s/\s+$//g;
16265: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16266: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16267: push(@ok_bccs,$bcc);
16268: }
16269: }
16270: }
16271: if (@ok_bccs > 0) {
16272: $allbcc = join(', ',@ok_bccs);
16273: }
16274: }
16275: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16276: }
16277: }
1.766 raeburn 16278: } elsif ($origmail ne '') {
1.1270 raeburn 16279: $lastresort = $origmail;
1.618 raeburn 16280: }
1.1297 raeburn 16281: if ($mailing eq 'helpdeskmail') {
16282: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16283: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16284: my ($inststatus,$inststatus_checked);
16285: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16286: ($env{'user.domain'} ne 'public')) {
16287: $inststatus_checked = 1;
16288: $inststatus = $env{'environment.inststatus'};
16289: }
16290: unless ($inststatus_checked) {
16291: if (($requname ne '') && ($requdom ne '')) {
16292: if (($requname =~ /^$match_username$/) &&
16293: ($requdom =~ /^$match_domain$/) &&
16294: (&Apache::lonnet::domain($requdom))) {
16295: my $requhome = &Apache::lonnet::homeserver($requname,
16296: $requdom);
16297: unless ($requhome eq 'no_host') {
16298: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16299: $inststatus = $userenv{'inststatus'};
16300: $inststatus_checked = 1;
16301: }
16302: }
16303: }
16304: }
16305: unless ($inststatus_checked) {
16306: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16307: my %srch = (srchby => 'email',
16308: srchdomain => $defdom,
16309: srchterm => $reqemail,
16310: srchtype => 'exact');
16311: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16312: foreach my $uname (keys(%srch_results)) {
16313: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16314: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16315: $inststatus_checked = 1;
16316: last;
16317: }
16318: }
16319: unless ($inststatus_checked) {
16320: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16321: if ($dirsrchres eq 'ok') {
16322: foreach my $uname (keys(%srch_results)) {
16323: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16324: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16325: $inststatus_checked = 1;
16326: last;
16327: }
16328: }
16329: }
16330: }
16331: }
16332: }
16333: if ($inststatus ne '') {
16334: foreach my $status (split(/\:/,$inststatus)) {
16335: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16336: my @contacts = ('adminemail','supportemail');
16337: foreach my $item (@contacts) {
16338: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16339: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16340: if (!grep(/^\Q$addr\E$/,@recipients)) {
16341: push(@recipients,$addr);
16342: }
16343: }
16344: }
16345: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16346: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16347: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16348: my @ok_bccs;
16349: foreach my $bcc (@bccs) {
16350: $bcc =~ s/^\s+//g;
16351: $bcc =~ s/\s+$//g;
16352: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16353: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16354: push(@ok_bccs,$bcc);
16355: }
16356: }
16357: }
16358: if (@ok_bccs > 0) {
16359: $allbcc = join(', ',@ok_bccs);
16360: }
16361: }
16362: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16363: last;
16364: }
16365: }
16366: }
16367: }
16368: }
1.619 raeburn 16369: } elsif ($origmail ne '') {
1.1270 raeburn 16370: $lastresort = $origmail;
16371: }
1.1297 raeburn 16372: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16373: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16374: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16375: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16376: my %what = (
16377: perlvar => 1,
16378: );
16379: my $primary = &Apache::lonnet::domain($defdom,'primary');
16380: if ($primary) {
16381: my $gotaddr;
16382: my ($result,$returnhash) =
16383: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16384: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16385: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16386: $lastresort = $returnhash->{'lonSupportEMail'};
16387: $gotaddr = 1;
16388: }
16389: }
16390: unless ($gotaddr) {
16391: my $uintdom = &Apache::lonnet::internet_dom($primary);
16392: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16393: unless ($uintdom eq $intdom) {
16394: my %domconfig =
16395: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16396: if (ref($domconfig{'contacts'}) eq 'HASH') {
16397: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16398: my @contacts = ('adminemail','supportemail');
16399: foreach my $item (@contacts) {
16400: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16401: my $addr = $domconfig{'contacts'}{$item};
16402: if (!grep(/^\Q$addr\E$/,@recipients)) {
16403: push(@recipients,$addr);
16404: }
16405: }
16406: }
16407: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16408: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16409: }
16410: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16411: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16412: my @ok_bccs;
16413: foreach my $bcc (@bccs) {
16414: $bcc =~ s/^\s+//g;
16415: $bcc =~ s/\s+$//g;
16416: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16417: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16418: push(@ok_bccs,$bcc);
16419: }
16420: }
16421: }
16422: if (@ok_bccs > 0) {
16423: $allbcc = join(', ',@ok_bccs);
16424: }
16425: }
16426: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16427: }
16428: }
16429: }
16430: }
16431: }
16432: }
1.618 raeburn 16433: }
1.688 raeburn 16434: if (defined($defmail)) {
16435: if ($defmail ne '') {
16436: push(@recipients,$defmail);
16437: }
1.618 raeburn 16438: }
16439: if ($otheremails) {
1.619 raeburn 16440: my @others;
16441: if ($otheremails =~ /,/) {
16442: @others = split(/,/,$otheremails);
1.618 raeburn 16443: } else {
1.619 raeburn 16444: push(@others,$otheremails);
16445: }
16446: foreach my $addr (@others) {
16447: if (!grep(/^\Q$addr\E$/,@recipients)) {
16448: push(@recipients,$addr);
16449: }
1.618 raeburn 16450: }
16451: }
1.1298 raeburn 16452: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16453: if ((!@recipients) && ($lastresort ne '')) {
16454: push(@recipients,$lastresort);
16455: }
16456: } elsif ($lastresort ne '') {
16457: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16458: push(@recipients,$lastresort);
16459: }
16460: }
1.1271 raeburn 16461: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16462: if (wantarray) {
16463: return ($recipientlist,$allbcc,$addtext);
16464: } else {
16465: return $recipientlist;
16466: }
1.618 raeburn 16467: }
16468:
1.127 matthew 16469: ############################################################
16470: ############################################################
1.154 albertel 16471:
1.655 raeburn 16472: =pod
16473:
1.1224 musolffc 16474: =over 4
16475:
1.1223 musolffc 16476: =item * &mime_email()
16477:
16478: Sends an email with a possible attachment
16479:
16480: Inputs:
16481:
16482: =over 4
16483:
16484: from - Sender's email address
16485:
1.1343 raeburn 16486: replyto - Reply-To email address
16487:
1.1223 musolffc 16488: to - Email address of recipient
16489:
16490: subject - Subject of email
16491:
16492: body - Body of email
16493:
16494: cc_string - Carbon copy email address
16495:
16496: bcc - Blind carbon copy email address
16497:
16498: attachment_path - Path of file to be attached
16499:
16500: file_name - Name of file to be attached
16501:
16502: attachment_text - The body of an attachment of type "TEXT"
16503:
16504: =back
16505:
16506: =back
16507:
16508: =cut
16509:
16510: ############################################################
16511: ############################################################
16512:
16513: sub mime_email {
1.1343 raeburn 16514: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16515: $file_name,$attachment_text) = @_;
16516:
1.1223 musolffc 16517: my $msg = MIME::Lite->new(
16518: From => $from,
16519: To => $to,
16520: Subject => $subject,
16521: Type =>'TEXT',
16522: Data => $body,
16523: );
1.1343 raeburn 16524: if ($replyto ne '') {
16525: $msg->add("Reply-To" => $replyto);
16526: }
1.1223 musolffc 16527: if ($cc_string ne '') {
16528: $msg->add("Cc" => $cc_string);
16529: }
16530: if ($bcc ne '') {
16531: $msg->add("Bcc" => $bcc);
16532: }
16533: $msg->attr("content-type" => "text/plain");
16534: $msg->attr("content-type.charset" => "UTF-8");
16535: # Attach file if given
16536: if ($attachment_path) {
16537: unless ($file_name) {
16538: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16539: }
16540: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16541: $msg->attach(Type => $type,
16542: Path => $attachment_path,
16543: Filename => $file_name
16544: );
16545: # Otherwise attach text if given
16546: } elsif ($attachment_text) {
16547: $msg->attach(Type => 'TEXT',
16548: Data => $attachment_text);
16549: }
16550: # Send it
16551: $msg->send('sendmail');
16552: }
16553:
16554: ############################################################
16555: ############################################################
16556:
16557: =pod
16558:
1.655 raeburn 16559: =head1 Course Catalog Routines
16560:
16561: =over 4
16562:
16563: =item * &gather_categories()
16564:
16565: Converts category definitions - keys of categories hash stored in
16566: coursecategories in configuration.db on the primary library server in a
16567: domain - to an array. Also generates javascript and idx hash used to
16568: generate Domain Coordinator interface for editing Course Categories.
16569:
16570: Inputs:
1.663 raeburn 16571:
1.655 raeburn 16572: categories (reference to hash of category definitions).
1.663 raeburn 16573:
1.655 raeburn 16574: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16575: categories and subcategories).
1.663 raeburn 16576:
1.655 raeburn 16577: idx (reference to hash of counters used in Domain Coordinator interface for
16578: editing Course Categories).
1.663 raeburn 16579:
1.655 raeburn 16580: jsarray (reference to array of categories used to create Javascript arrays for
16581: Domain Coordinator interface for editing Course Categories).
16582:
16583: Returns: nothing
16584:
16585: Side effects: populates cats, idx and jsarray.
16586:
16587: =cut
16588:
16589: sub gather_categories {
16590: my ($categories,$cats,$idx,$jsarray) = @_;
16591: my %counters;
16592: my $num = 0;
16593: foreach my $item (keys(%{$categories})) {
16594: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16595: if ($container eq '' && $depth == 0) {
16596: $cats->[$depth][$categories->{$item}] = $cat;
16597: } else {
16598: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16599: }
16600: my ($escitem,$tail) = split(/:/,$item,2);
16601: if ($counters{$tail} eq '') {
16602: $counters{$tail} = $num;
16603: $num ++;
16604: }
16605: if (ref($idx) eq 'HASH') {
16606: $idx->{$item} = $counters{$tail};
16607: }
16608: if (ref($jsarray) eq 'ARRAY') {
16609: push(@{$jsarray->[$counters{$tail}]},$item);
16610: }
16611: }
16612: return;
16613: }
16614:
16615: =pod
16616:
16617: =item * &extract_categories()
16618:
16619: Used to generate breadcrumb trails for course categories.
16620:
16621: Inputs:
1.663 raeburn 16622:
1.655 raeburn 16623: categories (reference to hash of category definitions).
1.663 raeburn 16624:
1.655 raeburn 16625: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16626: categories and subcategories).
1.663 raeburn 16627:
1.655 raeburn 16628: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16629:
1.655 raeburn 16630: allitems (reference to hash - key is category key
16631: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16632:
1.655 raeburn 16633: idx (reference to hash of counters used in Domain Coordinator interface for
16634: editing Course Categories).
1.663 raeburn 16635:
1.655 raeburn 16636: jsarray (reference to array of categories used to create Javascript arrays for
16637: Domain Coordinator interface for editing Course Categories).
16638:
1.665 raeburn 16639: subcats (reference to hash of arrays containing all subcategories within each
16640: category, -recursive)
16641:
1.1321 raeburn 16642: maxd (reference to hash used to hold max depth for all top-level categories).
16643:
1.655 raeburn 16644: Returns: nothing
16645:
16646: Side effects: populates trails and allitems hash references.
16647:
16648: =cut
16649:
16650: sub extract_categories {
1.1321 raeburn 16651: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16652: if (ref($categories) eq 'HASH') {
16653: &gather_categories($categories,$cats,$idx,$jsarray);
16654: if (ref($cats->[0]) eq 'ARRAY') {
16655: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16656: my $name = $cats->[0][$i];
16657: my $item = &escape($name).'::0';
16658: my $trailstr;
16659: if ($name eq 'instcode') {
16660: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16661: } elsif ($name eq 'communities') {
16662: $trailstr = &mt('Communities');
1.1239 raeburn 16663: } elsif ($name eq 'placement') {
16664: $trailstr = &mt('Placement Tests');
1.655 raeburn 16665: } else {
16666: $trailstr = $name;
16667: }
16668: if ($allitems->{$item} eq '') {
16669: push(@{$trails},$trailstr);
16670: $allitems->{$item} = scalar(@{$trails})-1;
16671: }
16672: my @parents = ($name);
16673: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16674: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16675: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16676: if (ref($subcats) eq 'HASH') {
16677: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16678: }
1.1321 raeburn 16679: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16680: }
16681: } else {
16682: if (ref($subcats) eq 'HASH') {
16683: $subcats->{$item} = [];
1.655 raeburn 16684: }
1.1321 raeburn 16685: if (ref($maxd) eq 'HASH') {
16686: $maxd->{$name} = 1;
16687: }
1.655 raeburn 16688: }
16689: }
16690: }
16691: }
16692: return;
16693: }
16694:
16695: =pod
16696:
1.1162 raeburn 16697: =item * &recurse_categories()
1.655 raeburn 16698:
16699: Recursively used to generate breadcrumb trails for course categories.
16700:
16701: Inputs:
1.663 raeburn 16702:
1.655 raeburn 16703: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16704: categories and subcategories).
1.663 raeburn 16705:
1.655 raeburn 16706: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16707:
16708: category (current course category, for which breadcrumb trail is being generated).
16709:
16710: trails (reference to array of breadcrumb trails for each category).
16711:
1.655 raeburn 16712: allitems (reference to hash - key is category key
16713: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16714:
1.655 raeburn 16715: parents (array containing containers directories for current category,
16716: back to top level).
16717:
16718: Returns: nothing
16719:
16720: Side effects: populates trails and allitems hash references
16721:
16722: =cut
16723:
16724: sub recurse_categories {
1.1321 raeburn 16725: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16726: my $shallower = $depth - 1;
16727: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16728: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16729: my $name = $cats->[$depth]{$category}[$k];
16730: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16731: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16732: if ($allitems->{$item} eq '') {
16733: push(@{$trails},$trailstr);
16734: $allitems->{$item} = scalar(@{$trails})-1;
16735: }
16736: my $deeper = $depth+1;
16737: push(@{$parents},$category);
1.665 raeburn 16738: if (ref($subcats) eq 'HASH') {
16739: my $subcat = &escape($name).':'.$category.':'.$depth;
16740: for (my $j=@{$parents}; $j>=0; $j--) {
16741: my $higher;
16742: if ($j > 0) {
16743: $higher = &escape($parents->[$j]).':'.
16744: &escape($parents->[$j-1]).':'.$j;
16745: } else {
16746: $higher = &escape($parents->[$j]).'::'.$j;
16747: }
16748: push(@{$subcats->{$higher}},$subcat);
16749: }
16750: }
16751: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16752: $subcats,$maxd);
1.655 raeburn 16753: pop(@{$parents});
16754: }
16755: } else {
16756: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16757: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16758: if ($allitems->{$item} eq '') {
16759: push(@{$trails},$trailstr);
16760: $allitems->{$item} = scalar(@{$trails})-1;
16761: }
1.1321 raeburn 16762: if (ref($maxd) eq 'HASH') {
16763: if ($depth > $maxd->{$parents->[0]}) {
16764: $maxd->{$parents->[0]} = $depth;
16765: }
16766: }
1.655 raeburn 16767: }
16768: return;
16769: }
16770:
1.663 raeburn 16771: =pod
16772:
1.1162 raeburn 16773: =item * &assign_categories_table()
1.663 raeburn 16774:
16775: Create a datatable for display of hierarchical categories in a domain,
16776: with checkboxes to allow a course to be categorized.
16777:
16778: Inputs:
16779:
16780: cathash - reference to hash of categories defined for the domain (from
16781: configuration.db)
16782:
16783: currcat - scalar with an & separated list of categories assigned to a course.
16784:
1.919 raeburn 16785: type - scalar contains course type (Course or Community).
16786:
1.1260 raeburn 16787: disabled - scalar (optional) contains disabled="disabled" if input elements are
16788: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16789:
1.663 raeburn 16790: Returns: $output (markup to be displayed)
16791:
16792: =cut
16793:
16794: sub assign_categories_table {
1.1259 raeburn 16795: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16796: my $output;
16797: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16798: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16799: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16800: $maxdepth = scalar(@cats);
16801: if (@cats > 0) {
16802: my $itemcount = 0;
16803: if (ref($cats[0]) eq 'ARRAY') {
16804: my @currcategories;
16805: if ($currcat ne '') {
16806: @currcategories = split('&',$currcat);
16807: }
1.919 raeburn 16808: my $table;
1.663 raeburn 16809: for (my $i=0; $i<@{$cats[0]}; $i++) {
16810: my $parent = $cats[0][$i];
1.919 raeburn 16811: next if ($parent eq 'instcode');
16812: if ($type eq 'Community') {
16813: next unless ($parent eq 'communities');
1.1239 raeburn 16814: } elsif ($type eq 'Placement') {
16815: next unless ($parent eq 'placement');
1.919 raeburn 16816: } else {
1.1239 raeburn 16817: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16818: }
1.663 raeburn 16819: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16820: my $item = &escape($parent).'::0';
16821: my $checked = '';
16822: if (@currcategories > 0) {
16823: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16824: $checked = ' checked="checked"';
1.663 raeburn 16825: }
16826: }
1.919 raeburn 16827: my $parent_title = $parent;
16828: if ($parent eq 'communities') {
16829: $parent_title = &mt('Communities');
1.1239 raeburn 16830: } elsif ($parent eq 'placement') {
16831: $parent_title = &mt('Placement Tests');
1.919 raeburn 16832: }
16833: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16834: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16835: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16836: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16837: my $depth = 1;
16838: push(@path,$parent);
1.1259 raeburn 16839: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16840: pop(@path);
1.919 raeburn 16841: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16842: $itemcount ++;
16843: }
1.919 raeburn 16844: if ($itemcount) {
16845: $output = &Apache::loncommon::start_data_table().
16846: $table.
16847: &Apache::loncommon::end_data_table();
16848: }
1.663 raeburn 16849: }
16850: }
16851: }
16852: return $output;
16853: }
16854:
16855: =pod
16856:
1.1162 raeburn 16857: =item * &assign_category_rows()
1.663 raeburn 16858:
16859: Create a datatable row for display of nested categories in a domain,
16860: with checkboxes to allow a course to be categorized,called recursively.
16861:
16862: Inputs:
16863:
16864: itemcount - track row number for alternating colors
16865:
16866: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16867: categories and subcategories.
16868:
16869: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16870:
16871: parent - parent of current category item
16872:
16873: path - Array containing all categories back up through the hierarchy from the
16874: current category to the top level.
16875:
16876: currcategories - reference to array of current categories assigned to the course
16877:
1.1260 raeburn 16878: disabled - scalar (optional) contains disabled="disabled" if input elements are
16879: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16880:
1.663 raeburn 16881: Returns: $output (markup to be displayed).
16882:
16883: =cut
16884:
16885: sub assign_category_rows {
1.1259 raeburn 16886: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16887: my ($text,$name,$item,$chgstr);
16888: if (ref($cats) eq 'ARRAY') {
16889: my $maxdepth = scalar(@{$cats});
16890: if (ref($cats->[$depth]) eq 'HASH') {
16891: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16892: my $numchildren = @{$cats->[$depth]{$parent}};
16893: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16894: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16895: for (my $j=0; $j<$numchildren; $j++) {
16896: $name = $cats->[$depth]{$parent}[$j];
16897: $item = &escape($name).':'.&escape($parent).':'.$depth;
16898: my $deeper = $depth+1;
16899: my $checked = '';
16900: if (ref($currcategories) eq 'ARRAY') {
16901: if (@{$currcategories} > 0) {
16902: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16903: $checked = ' checked="checked"';
1.663 raeburn 16904: }
16905: }
16906: }
1.664 raeburn 16907: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16908: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16909: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16910: '<input type="hidden" name="catname" value="'.$name.'" />'.
16911: '</td><td>';
1.663 raeburn 16912: if (ref($path) eq 'ARRAY') {
16913: push(@{$path},$name);
1.1259 raeburn 16914: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16915: pop(@{$path});
16916: }
16917: $text .= '</td></tr>';
16918: }
16919: $text .= '</table></td>';
16920: }
16921: }
16922: }
16923: return $text;
16924: }
16925:
1.1181 raeburn 16926: =pod
16927:
16928: =back
16929:
16930: =cut
16931:
1.655 raeburn 16932: ############################################################
16933: ############################################################
16934:
16935:
1.443 albertel 16936: sub commit_customrole {
1.1408 raeburn 16937: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16938: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16939: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16940: $context,$othdomby,$requester);
1.630 raeburn 16941: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16942: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16943: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16944: if (wantarray) {
16945: return ($output,$result);
16946: } else {
16947: return $output;
16948: }
1.443 albertel 16949: }
16950:
16951: sub commit_standardrole {
1.1408 raeburn 16952: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16953: $othdomby,$requester) = @_;
1.1399 raeburn 16954: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16955: if ($context eq 'auto') {
16956: $linefeed = "\n";
16957: } else {
16958: $linefeed = "<br />\n";
16959: }
1.443 albertel 16960: if ($three eq 'st') {
1.1399 raeburn 16961: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16962: $one,$two,$sec,$context,$credits,$othdomby,
16963: $requester);
1.541 raeburn 16964: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16965: ($result eq 'unknown_course') || ($result eq 'refused')) {
16966: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16967: } else {
1.541 raeburn 16968: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16969: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16970: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16971: if ($context eq 'auto') {
16972: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16973: } else {
16974: $output .= '<b>'.$result.'</b>'.$linefeed.
16975: &mt('Add to classlist').': <b>ok</b>';
16976: }
16977: $output .= $linefeed;
1.443 albertel 16978: }
16979: } else {
16980: $output = &mt('Assigning').' '.$three.' in '.$url.
16981: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16982: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 16983: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
16984: '','',$context,$othdomby,$requester);
1.541 raeburn 16985: if ($context eq 'auto') {
16986: $output .= $result.$linefeed;
16987: } else {
16988: $output .= '<b>'.$result.'</b>'.$linefeed;
16989: }
1.443 albertel 16990: }
1.1399 raeburn 16991: if (wantarray) {
16992: return ($output,$result);
16993: } else {
16994: return $output;
16995: }
1.443 albertel 16996: }
16997:
16998: sub commit_studentrole {
1.1116 raeburn 16999: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17000: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17001: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17002: if ($context eq 'auto') {
17003: $linefeed = "\n";
17004: } else {
17005: $linefeed = '<br />'."\n";
17006: }
1.443 albertel 17007: if (defined($one) && defined($two)) {
17008: my $cid=$one.'_'.$two;
17009: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17010: my $secchange = 0;
17011: my $expire_role_result;
17012: my $modify_section_result;
1.628 raeburn 17013: if ($oldsec ne '-1') {
17014: if ($oldsec ne $sec) {
1.443 albertel 17015: $secchange = 1;
1.628 raeburn 17016: my $now = time;
1.443 albertel 17017: my $uurl='/'.$cid;
17018: $uurl=~s/\_/\//g;
17019: if ($oldsec) {
17020: $uurl.='/'.$oldsec;
17021: }
1.626 raeburn 17022: $oldsecurl = $uurl;
1.628 raeburn 17023: $expire_role_result =
1.1408 raeburn 17024: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17025: '','','',$context,$othdomby,$requester);
17026: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17027: if ($expire_role_result eq 'refused') {
17028: my @roles = ('st');
17029: my @statuses = ('previous');
17030: my @roledoms = ($one);
17031: my $withsec = 1;
17032: my %roleshash =
17033: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17034: \@statuses,\@roles,\@roledoms,$withsec);
17035: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17036: my ($oldstart,$oldend) =
17037: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17038: if ($oldend > 0 && $oldend <= $now) {
17039: $expire_role_result = 'ok';
17040: }
17041: }
17042: }
17043: }
1.443 albertel 17044: $result = $expire_role_result;
17045: }
17046: }
17047: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17048: $modify_section_result =
17049: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17050: undef,undef,undef,$sec,
17051: $end,$start,'','',$cid,
1.1408 raeburn 17052: '',$context,$credits,'',
17053: $othdomby,$requester);
1.443 albertel 17054: if ($modify_section_result =~ /^ok/) {
17055: if ($secchange == 1) {
1.628 raeburn 17056: if ($sec eq '') {
17057: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17058: } else {
17059: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17060: }
1.443 albertel 17061: } elsif ($oldsec eq '-1') {
1.628 raeburn 17062: if ($sec eq '') {
17063: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17064: } else {
17065: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17066: }
1.443 albertel 17067: } else {
1.628 raeburn 17068: if ($sec eq '') {
17069: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17070: } else {
17071: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17072: }
1.443 albertel 17073: }
17074: } else {
1.1115 raeburn 17075: if ($secchange) {
1.628 raeburn 17076: $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
17077: } else {
17078: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17079: }
1.443 albertel 17080: }
17081: $result = $modify_section_result;
17082: } elsif ($secchange == 1) {
1.628 raeburn 17083: if ($oldsec eq '') {
1.1103 raeburn 17084: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_2] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
1.628 raeburn 17085: } else {
17086: $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
17087: }
1.626 raeburn 17088: if ($expire_role_result eq 'refused') {
17089: my $newsecurl = '/'.$cid;
17090: $newsecurl =~ s/\_/\//g;
17091: if ($sec ne '') {
17092: $newsecurl.='/'.$sec;
17093: }
17094: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17095: if ($sec eq '') {
17096: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
17097: } else {
17098: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
17099: }
17100: }
17101: }
1.443 albertel 17102: }
17103: } else {
1.626 raeburn 17104: $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443 albertel 17105: $result = "error: incomplete course id\n";
17106: }
17107: return $result;
17108: }
17109:
1.1108 raeburn 17110: sub show_role_extent {
17111: my ($scope,$context,$role) = @_;
17112: $scope =~ s{^/}{};
17113: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17114: push(@courseroles,'co');
17115: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17116: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17117: $scope =~ s{/}{_};
17118: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17119: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17120: my ($audom,$auname) = split(/\//,$scope);
17121: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17122: &Apache::loncommon::plainname($auname,$audom).'</span>');
17123: } else {
17124: $scope =~ s{/$}{};
17125: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17126: &Apache::lonnet::domain($scope,'description').'</span>');
17127: }
17128: }
17129:
1.443 albertel 17130: ############################################################
17131: ############################################################
17132:
1.566 albertel 17133: sub check_clone {
1.578 raeburn 17134: my ($args,$linefeed) = @_;
1.566 albertel 17135: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17136: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17137: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17138: my $clonetitle;
17139: my @clonemsg;
1.566 albertel 17140: my $can_clone = 0;
1.944 raeburn 17141: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17142: if ($lctype ne 'community') {
17143: $lctype = 'course';
17144: }
1.566 albertel 17145: if ($clonehome eq 'no_host') {
1.944 raeburn 17146: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17147: push(@clonemsg,({
17148: mt => 'No new community created.',
17149: args => [],
17150: },
17151: {
17152: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17153: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17154: }));
1.908 raeburn 17155: } else {
1.1344 raeburn 17156: push(@clonemsg,({
17157: mt => 'No new course created.',
17158: args => [],
17159: },
17160: {
17161: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17162: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17163: }));
17164: }
1.566 albertel 17165: } else {
17166: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17167: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17168: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17169: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17170: push(@clonemsg,({
17171: mt => 'No new community created.',
17172: args => [],
17173: },
17174: {
17175: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17176: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17177: }));
17178: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17179: }
17180: }
1.1262 raeburn 17181: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17182: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17183: $can_clone = 1;
17184: } else {
1.1221 raeburn 17185: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17186: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17187: if ($clonehash{'cloners'} eq '') {
17188: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17189: if ($domdefs{'canclone'}) {
17190: unless ($domdefs{'canclone'} eq 'none') {
17191: if ($domdefs{'canclone'} eq 'domain') {
17192: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17193: $can_clone = 1;
17194: }
17195: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17196: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17197: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17198: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17199: $can_clone = 1;
17200: }
17201: }
17202: }
17203: }
1.578 raeburn 17204: } else {
1.1221 raeburn 17205: my @cloners = split(/,/,$clonehash{'cloners'});
17206: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17207: $can_clone = 1;
1.1221 raeburn 17208: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17209: $can_clone = 1;
1.1225 raeburn 17210: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17211: $can_clone = 1;
1.1221 raeburn 17212: }
17213: unless ($can_clone) {
1.1225 raeburn 17214: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17215: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17216: my (%gotdomdefaults,%gotcodedefaults);
17217: foreach my $cloner (@cloners) {
17218: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17219: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17220: my (%codedefaults,@code_order);
17221: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17222: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17223: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17224: }
17225: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17226: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17227: }
17228: } else {
17229: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17230: \%codedefaults,
17231: \@code_order);
17232: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17233: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17234: }
17235: if (@code_order > 0) {
17236: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17237: $cloner,$clonehash{'internal.coursecode'},
17238: $args->{'crscode'})) {
17239: $can_clone = 1;
17240: last;
17241: }
17242: }
17243: }
17244: }
17245: }
1.1225 raeburn 17246: }
17247: }
17248: unless ($can_clone) {
17249: my $ccrole = 'cc';
17250: if ($args->{'crstype'} eq 'Community') {
17251: $ccrole = 'co';
17252: }
17253: my %roleshash =
17254: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17255: $args->{'ccdomain'},
17256: 'userroles',['active'],[$ccrole],
17257: [$args->{'clonedomain'}]);
17258: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17259: $can_clone = 1;
17260: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17261: $args->{'ccuname'},$args->{'ccdomain'})) {
17262: $can_clone = 1;
1.1221 raeburn 17263: }
17264: }
17265: unless ($can_clone) {
17266: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17267: push(@clonemsg,({
17268: mt => 'No new community created.',
17269: args => [],
17270: },
17271: {
17272: mt => 'The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',
17273: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17274: }));
1.942 raeburn 17275: } else {
1.1344 raeburn 17276: push(@clonemsg,({
17277: mt => 'No new course created.',
17278: args => [],
17279: },
17280: {
17281: mt => 'The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',
17282: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17283: }));
1.1221 raeburn 17284: }
1.566 albertel 17285: }
1.578 raeburn 17286: }
1.566 albertel 17287: }
1.1344 raeburn 17288: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17289: }
17290:
1.444 albertel 17291: sub construct_course {
1.1262 raeburn 17292: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17293: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17294: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17295: my $linefeed = '<br />'."\n";
17296: if ($context eq 'auto') {
17297: $linefeed = "\n";
17298: }
1.566 albertel 17299:
17300: #
17301: # Are we cloning?
17302: #
1.1344 raeburn 17303: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17304: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17305: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17306: if (!$can_clone) {
1.1344 raeburn 17307: return (0,$outcome,$clonemsgref);
1.566 albertel 17308: }
17309: }
17310:
1.444 albertel 17311: #
17312: # Open course
17313: #
1.1239 raeburn 17314: my $showncrstype;
17315: if ($args->{'crstype'} eq 'Placement') {
17316: $showncrstype = 'placement test';
17317: } else {
17318: $showncrstype = lc($args->{'crstype'});
17319: }
1.444 albertel 17320: my %cenv=();
17321: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17322: $args->{'cdescr'},
17323: $args->{'curl'},
17324: $args->{'course_home'},
17325: $args->{'nonstandard'},
17326: $args->{'crscode'},
17327: $args->{'ccuname'}.':'.
17328: $args->{'ccdomain'},
1.882 raeburn 17329: $args->{'crstype'},
1.1344 raeburn 17330: $cnum,$context,$category,
17331: $callercontext);
1.444 albertel 17332:
17333: # Note: The testing routines depend on this being output; see
17334: # Utils::Course. This needs to at least be output as a comment
17335: # if anyone ever decides to not show this, and Utils::Course::new
17336: # will need to be suitably modified.
1.1344 raeburn 17337: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17338: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17339: } else {
17340: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17341: }
1.943 raeburn 17342: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17343: return (0,$outcome,$clonemsgref);
1.943 raeburn 17344: }
17345:
1.444 albertel 17346: #
17347: # Check if created correctly
17348: #
1.479 albertel 17349: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17350: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17351: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17352: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17353: $outcome .= &mt_user($user_lh,
17354: 'Course creation failed, unrecognized course home server.');
17355: } else {
17356: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17357: }
17358: $outcome .= $linefeed;
17359: return (0,$outcome,$clonemsgref);
1.943 raeburn 17360: }
1.541 raeburn 17361: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17362:
1.444 albertel 17363: #
1.566 albertel 17364: # Do the cloning
17365: #
1.1344 raeburn 17366: my @clonemsg;
1.566 albertel 17367: if ($can_clone && $cloneid) {
1.1344 raeburn 17368: push(@clonemsg,
17369: {
17370: mt => 'Created [_1] by cloning from [_2]',
17371: args => [$showncrstype,$clonetitle],
17372: });
1.566 albertel 17373: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17374: # Copy all files
1.1344 raeburn 17375: my @info =
17376: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17377: $args->{'dateshift'},$args->{'crscode'},
17378: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17379: $args->{'tinyurls'});
17380: if (@info) {
17381: push(@clonemsg,@info);
17382: }
1.444 albertel 17383: # Restore URL
1.566 albertel 17384: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17385: # Restore title
1.566 albertel 17386: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17387: # Restore creation date, creator and creation context.
17388: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17389: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17390: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17391: # Mark as cloned
1.566 albertel 17392: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17393: # Need to clone grading mode
17394: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17395: $cenv{'grading'}=$newenv{'grading'};
17396: # Do not clone these environment entries
17397: &Apache::lonnet::del('environment',
17398: ['default_enrollment_start_date',
17399: 'default_enrollment_end_date',
17400: 'question.email',
17401: 'policy.email',
17402: 'comment.email',
17403: 'pch.users.denied',
1.725 raeburn 17404: 'plc.users.denied',
17405: 'hidefromcat',
1.1121 raeburn 17406: 'checkforpriv',
1.1355 raeburn 17407: 'categories'],
1.638 www 17408: $$crsudom,$$crsunum);
1.1170 raeburn 17409: if ($args->{'textbook'}) {
17410: $cenv{'internal.textbook'} = $args->{'textbook'};
17411: }
1.444 albertel 17412: }
1.566 albertel 17413:
1.444 albertel 17414: #
17415: # Set environment (will override cloned, if existing)
17416: #
17417: my @sections = ();
17418: my @xlists = ();
17419: if ($args->{'crstype'}) {
17420: $cenv{'type'}=$args->{'crstype'};
17421: }
1.1371 raeburn 17422: if ($args->{'lti'}) {
17423: $cenv{'internal.lti'}=$args->{'lti'};
17424: }
1.444 albertel 17425: if ($args->{'crsid'}) {
17426: $cenv{'courseid'}=$args->{'crsid'};
17427: }
17428: if ($args->{'crscode'}) {
17429: $cenv{'internal.coursecode'}=$args->{'crscode'};
17430: }
17431: if ($args->{'crsquota'} ne '') {
17432: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17433: } else {
17434: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17435: }
17436: if ($args->{'ccuname'}) {
17437: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17438: ':'.$args->{'ccdomain'};
17439: } else {
17440: $cenv{'internal.courseowner'} = $args->{'curruser'};
17441: }
1.1116 raeburn 17442: if ($args->{'defaultcredits'}) {
17443: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17444: }
1.444 albertel 17445: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17446: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17447: if ($args->{'crssections'}) {
17448: $cenv{'internal.sectionnums'} = '';
17449: if ($args->{'crssections'} =~ m/,/) {
17450: @sections = split/,/,$args->{'crssections'};
17451: } else {
17452: $sections[0] = $args->{'crssections'};
17453: }
17454: if (@sections > 0) {
17455: foreach my $item (@sections) {
17456: my ($sec,$gp) = split/:/,$item;
17457: my $class = $args->{'crscode'}.$sec;
17458: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17459: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17460: if ($addcheck eq 'ok') {
17461: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17462: push(@oklcsecs,$gp);
17463: }
17464: } else {
1.1263 raeburn 17465: push(@badclasses,$class);
1.444 albertel 17466: }
17467: }
17468: $cenv{'internal.sectionnums'} =~ s/,$//;
17469: }
17470: }
17471: # do not hide course coordinator from staff listing,
17472: # even if privileged
17473: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17474: # add course coordinator's domain to domains to check for privileged users
17475: # if different to course domain
17476: if ($$crsudom ne $args->{'ccdomain'}) {
17477: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17478: }
1.444 albertel 17479: # add crosslistings
17480: if ($args->{'crsxlist'}) {
17481: $cenv{'internal.crosslistings'}='';
17482: if ($args->{'crsxlist'} =~ m/,/) {
17483: @xlists = split/,/,$args->{'crsxlist'};
17484: } else {
17485: $xlists[0] = $args->{'crsxlist'};
17486: }
17487: if (@xlists > 0) {
17488: foreach my $item (@xlists) {
17489: my ($xl,$gp) = split/:/,$item;
17490: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17491: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17492: if ($addcheck eq 'ok') {
17493: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17494: push(@oklcsecs,$gp);
17495: }
17496: } else {
1.1263 raeburn 17497: push(@badclasses,$xl);
1.444 albertel 17498: }
17499: }
17500: $cenv{'internal.crosslistings'} =~ s/,$//;
17501: }
17502: }
17503: if ($args->{'autoadds'}) {
17504: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17505: }
17506: if ($args->{'autodrops'}) {
17507: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17508: }
17509: # check for notification of enrollment changes
17510: my @notified = ();
17511: if ($args->{'notify_owner'}) {
17512: if ($args->{'ccuname'} ne '') {
17513: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17514: }
17515: }
17516: if ($args->{'notify_dc'}) {
17517: if ($uname ne '') {
1.630 raeburn 17518: push(@notified,$uname.':'.$udom);
1.444 albertel 17519: }
17520: }
17521: if (@notified > 0) {
17522: my $notifylist;
17523: if (@notified > 1) {
17524: $notifylist = join(',',@notified);
17525: } else {
17526: $notifylist = $notified[0];
17527: }
17528: $cenv{'internal.notifylist'} = $notifylist;
17529: }
17530: if (@badclasses > 0) {
17531: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17532: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17533: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17534: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17535: );
1.1264 raeburn 17536: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17537: &mt('That is because the user identified as the course owner ([_1]) does not have rights to access enrollment in these classes, as determined by the policies of your institution on access to official classlists',$cenv{'internal.courseowner'}).$linefeed.$lt{'itis'};
1.541 raeburn 17538: if ($context eq 'auto') {
17539: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17540: } else {
1.566 albertel 17541: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17542: }
17543: foreach my $item (@badclasses) {
1.541 raeburn 17544: if ($context eq 'auto') {
1.1261 raeburn 17545: $outcome .= " - $item\n";
1.541 raeburn 17546: } else {
1.1261 raeburn 17547: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17548: }
1.1261 raeburn 17549: }
17550: if ($context eq 'auto') {
17551: $outcome .= $linefeed;
17552: } else {
17553: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17554: }
1.444 albertel 17555: }
17556: if ($args->{'no_end_date'}) {
17557: $args->{'endaccess'} = 0;
17558: }
1.1412 raeburn 17559: # If an official course with institutional sections is created by cloning
17560: # an existing course, section-specific hiding of course totals in student's
17561: # view of grades as copied from cloned course, will be checked for valid
17562: # sections.
17563: if (($can_clone && $cloneid) &&
17564: ($cenv{'internal.coursecode'} ne '') &&
17565: ($cenv{'grading'} eq 'standard') &&
17566: ($cenv{'hidetotals'} ne '') &&
17567: ($cenv{'hidetotals'} ne 'all')) {
17568: my @hidesecs;
17569: my $deletehidetotals;
17570: if (@oklcsecs) {
17571: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17572: if (grep(/^\Q$sec$/,@oklcsecs)) {
17573: push(@hidesecs,$sec);
17574: }
17575: }
17576: if (@hidesecs) {
17577: $cenv{'hidetotals'} = join(',',@hidesecs);
17578: } else {
17579: $deletehidetotals = 1;
17580: }
17581: } else {
17582: $deletehidetotals = 1;
17583: }
17584: if ($deletehidetotals) {
17585: delete($cenv{'hidetotals'});
17586: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17587: }
17588: }
1.444 albertel 17589: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17590: $cenv{'internal.autoend'}=$args->{'enrollend'};
17591: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17592: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17593: if ($args->{'showphotos'}) {
17594: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17595: }
17596: $cenv{'internal.authtype'} = $args->{'authtype'};
17597: $cenv{'internal.autharg'} = $args->{'autharg'};
17598: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17599: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17600: my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student');
17601: if ($context eq 'auto') {
17602: $outcome .= $krb_msg;
17603: } else {
1.566 albertel 17604: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17605: }
17606: $outcome .= $linefeed;
1.444 albertel 17607: }
17608: }
17609: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17610: if ($args->{'setpolicy'}) {
17611: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17612: }
17613: if ($args->{'setcontent'}) {
17614: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17615: }
1.1251 raeburn 17616: if ($args->{'setcomment'}) {
17617: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17618: }
1.444 albertel 17619: }
17620: if ($args->{'reshome'}) {
17621: $cenv{'reshome'}=$args->{'reshome'}.'/';
17622: $cenv{'reshome'}=~s/\/+$/\//;
17623: }
17624: #
17625: # course has keyed access
17626: #
17627: if ($args->{'setkeys'}) {
17628: $cenv{'keyaccess'}='yes';
17629: }
17630: # if specified, key authority is not course, but user
17631: # only active if keyaccess is yes
17632: if ($args->{'keyauth'}) {
1.487 albertel 17633: my ($user,$domain) = split(':',$args->{'keyauth'});
17634: $user = &LONCAPA::clean_username($user);
17635: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17636: if ($user ne '' && $domain ne '') {
1.487 albertel 17637: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17638: }
17639: }
17640:
1.1166 raeburn 17641: #
1.1167 raeburn 17642: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17643: #
17644: if ($args->{'uniquecode'}) {
17645: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17646: if ($code) {
17647: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17648: my %crsinfo =
17649: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17650: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17651: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17652: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17653: }
1.1166 raeburn 17654: if (ref($coderef)) {
17655: $$coderef = $code;
17656: }
17657: }
17658: }
17659:
1.444 albertel 17660: if ($args->{'disresdis'}) {
17661: $cenv{'pch.roles.denied'}='st';
17662: }
17663: if ($args->{'disablechat'}) {
17664: $cenv{'plc.roles.denied'}='st';
17665: }
17666:
17667: # Record we've not yet viewed the Course Initialization Helper for this
17668: # course
17669: $cenv{'course.helper.not.run'} = 1;
17670: #
17671: # Use new Randomseed
17672: #
17673: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17674: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17675: #
17676: # The encryption code and receipt prefix for this course
17677: #
17678: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17679: $cenv{'internal.encpref'}=100+int(9*rand(99));
17680: #
17681: # By default, use standard grading
17682: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17683:
1.541 raeburn 17684: $outcome .= $linefeed.&mt('Setting environment').': '.
17685: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17686: #
17687: # Open all assignments
17688: #
17689: if ($args->{'openall'}) {
1.1341 raeburn 17690: my $opendate = time;
17691: if ($args->{'openallfrom'} =~ /^\d+$/) {
17692: $opendate = $args->{'openallfrom'};
17693: }
1.444 albertel 17694: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17695: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17696: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17697: $outcome .= &mt('All assignments open starting [_1]',
17698: &Apache::lonlocal::locallocaltime($opendate)).': '.
17699: &Apache::lonnet::cput
17700: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17701: }
17702: #
17703: # Set first page
17704: #
17705: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17706: || ($cloneid)) {
17707: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17708:
17709: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17710: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17711:
1.444 albertel 17712: $outcome .= ($fatal?$errtext:'read ok').' - ';
17713: my $title; my $url;
17714: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17715: $title=&mt('Syllabus');
1.444 albertel 17716: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17717: } else {
1.963 raeburn 17718: $title=&mt('Table of Contents');
1.444 albertel 17719: $url='/adm/navmaps';
17720: }
1.445 albertel 17721:
17722: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17723: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17724:
17725: if ($errtext) { $fatal=2; }
1.541 raeburn 17726: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17727: }
1.566 albertel 17728:
1.1237 raeburn 17729: #
17730: # Set params for Placement Tests
17731: #
1.1239 raeburn 17732: if ($args->{'crstype'} eq 'Placement') {
17733: my %storecontent;
17734: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17735: my %defaults = (
17736: buttonshide => { value => 'yes',
17737: type => 'string_yesno',},
17738: type => { value => 'randomizetry',
17739: type => 'string_questiontype',},
17740: maxtries => { value => 1,
17741: type => 'int_pos',},
17742: problemstatus => { value => 'no',
17743: type => 'string_problemstatus',},
17744: );
17745: foreach my $key (keys(%defaults)) {
17746: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17747: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17748: }
1.1237 raeburn 17749: &Apache::lonnet::cput
17750: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17751: }
17752:
1.1344 raeburn 17753: return (1,$outcome,\@clonemsg);
1.444 albertel 17754: }
17755:
1.1166 raeburn 17756: sub make_unique_code {
17757: my ($cdom,$cnum) = @_;
17758: # get lock on uniquecodes db
17759: my $lockhash = {
17760: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17761: ':'.$env{'user.domain'},
17762: };
17763: my $tries = 0;
17764: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17765: my ($code,$error);
17766:
17767: while (($gotlock ne 'ok') && ($tries<3)) {
17768: $tries ++;
17769: sleep 1;
17770: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17771: }
17772: if ($gotlock eq 'ok') {
17773: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17774: my $gotcode;
17775: my $attempts = 0;
17776: while ((!$gotcode) && ($attempts < 100)) {
17777: $code = &generate_code();
17778: if (!exists($currcodes{$code})) {
17779: $gotcode = 1;
17780: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17781: $error = 'nostore';
17782: }
17783: }
17784: $attempts ++;
17785: }
17786: my @del_lock = ($cnum."\0".'uniquecodes');
17787: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17788: } else {
17789: $error = 'nolock';
17790: }
17791: return ($code,$error);
17792: }
17793:
17794: sub generate_code {
17795: my $code;
17796: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17797: for (my $i=0; $i<6; $i++) {
17798: my $lettnum = int (rand 2);
17799: my $item = '';
17800: if ($lettnum) {
17801: $item = $letts[int( rand(18) )];
17802: } else {
17803: $item = 1+int( rand(8) );
17804: }
17805: $code .= $item;
17806: }
17807: return $code;
17808: }
17809:
1.444 albertel 17810: ############################################################
17811: ############################################################
17812:
1.1237 raeburn 17813: # Community, Course and Placement Test
1.378 raeburn 17814: sub course_type {
17815: my ($cid) = @_;
17816: if (!defined($cid)) {
17817: $cid = $env{'request.course.id'};
17818: }
1.404 albertel 17819: if (defined($env{'course.'.$cid.'.type'})) {
17820: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17821: } else {
17822: return 'Course';
1.377 raeburn 17823: }
17824: }
1.156 albertel 17825:
1.406 raeburn 17826: sub group_term {
17827: my $crstype = &course_type();
17828: my %names = (
17829: 'Course' => 'group',
1.865 raeburn 17830: 'Community' => 'group',
1.1237 raeburn 17831: 'Placement' => 'group',
1.406 raeburn 17832: );
17833: return $names{$crstype};
17834: }
17835:
1.902 raeburn 17836: sub course_types {
1.1310 raeburn 17837: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17838: my %typename = (
17839: official => 'Official course',
17840: unofficial => 'Unofficial course',
17841: community => 'Community',
1.1165 raeburn 17842: textbook => 'Textbook course',
1.1237 raeburn 17843: placement => 'Placement test',
1.1310 raeburn 17844: lti => 'LTI provider',
1.902 raeburn 17845: );
17846: return (\@types,\%typename);
17847: }
17848:
1.156 albertel 17849: sub icon {
17850: my ($file)=@_;
1.505 albertel 17851: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17852: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17853: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17854: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17855: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17856: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17857: $curfext.".gif") {
17858: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17859: $curfext.".gif";
17860: }
17861: }
1.249 albertel 17862: return &lonhttpdurl($iconname);
1.154 albertel 17863: }
1.84 albertel 17864:
1.575 albertel 17865: sub lonhttpdurl {
1.692 www 17866: #
17867: # Had been used for "small fry" static images on separate port 8080.
17868: # Modify here if lightweight http functionality desired again.
17869: # Currently eliminated due to increasing firewall issues.
17870: #
1.575 albertel 17871: my ($url)=@_;
1.692 www 17872: return $url;
1.215 albertel 17873: }
17874:
1.213 albertel 17875: sub connection_aborted {
17876: my ($r)=@_;
17877: $r->print(" ");$r->rflush();
17878: my $c = $r->connection;
17879: return $c->aborted();
17880: }
17881:
1.221 foxr 17882: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17883: # strings as 'strings'.
17884: sub escape_single {
1.221 foxr 17885: my ($input) = @_;
1.223 albertel 17886: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17887: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17888: return $input;
17889: }
1.223 albertel 17890:
1.222 foxr 17891: # Same as escape_single, but escape's "'s This
17892: # can be used for "strings"
17893: sub escape_double {
17894: my ($input) = @_;
17895: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17896: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17897: return $input;
17898: }
1.223 albertel 17899:
1.222 foxr 17900: # Escapes the last element of a full URL.
17901: sub escape_url {
17902: my ($url) = @_;
1.238 raeburn 17903: my @urlslices = split(/\//, $url,-1);
1.369 www 17904: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17905: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17906: }
1.462 albertel 17907:
1.820 raeburn 17908: sub compare_arrays {
17909: my ($arrayref1,$arrayref2) = @_;
17910: my (@difference,%count);
17911: @difference = ();
17912: %count = ();
17913: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17914: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17915: foreach my $element (keys(%count)) {
17916: if ($count{$element} == 1) {
17917: push(@difference,$element);
17918: }
17919: }
17920: }
17921: return @difference;
17922: }
17923:
1.1322 raeburn 17924: sub lon_status_items {
17925: my %defaults = (
17926: E => 100,
17927: W => 4,
17928: N => 1,
1.1324 raeburn 17929: U => 5,
1.1322 raeburn 17930: threshold => 200,
17931: sysmail => 2500,
17932: );
17933: my %names = (
17934: E => 'Errors',
17935: W => 'Warnings',
17936: N => 'Notices',
1.1324 raeburn 17937: U => 'Unsent',
1.1322 raeburn 17938: );
17939: return (\%defaults,\%names);
17940: }
17941:
1.817 bisitz 17942: # -------------------------------------------------------- Initialize user login
1.462 albertel 17943: sub init_user_environment {
1.463 albertel 17944: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17945: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17946:
17947: my $public=($username eq 'public' && $domain eq 'public');
17948:
1.1415 raeburn 17949: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17950: $coauthorenv);
1.462 albertel 17951: my $now=time;
17952:
17953: if ($public) {
17954: my $max_public=100;
17955: my $oldest;
17956: my $oldest_time=0;
17957: for(my $next=1;$next<=$max_public;$next++) {
17958: if (-e $lonids."/publicuser_$next.id") {
17959: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17960: if ($mtime<$oldest_time || !$oldest_time) {
17961: $oldest_time=$mtime;
17962: $oldest=$next;
17963: }
17964: } else {
17965: $cookie="publicuser_$next";
17966: last;
17967: }
17968: }
17969: if (!$cookie) { $cookie="publicuser_$oldest"; }
17970: } else {
1.1275 raeburn 17971: # See if old ID present, if so, remove if this isn't a robot,
17972: # killing any existing non-robot sessions
1.463 albertel 17973: if (!$args->{'robot'}) {
17974: opendir(DIR,$lonids);
17975: while ($filename=readdir(DIR)) {
17976: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17977: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17978: &GDBM_READER(),0640)) {
1.1295 raeburn 17979: my $linkedfile;
1.1320 raeburn 17980: if (exists($oldenv{'user.linkedenv'})) {
17981: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17982: }
1.1320 raeburn 17983: untie(%oldenv);
17984: if (unlink("$lonids/$filename")) {
17985: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17986: if (-l "$lonids/$linkedfile.id") {
17987: unlink("$lonids/$linkedfile.id");
17988: }
1.1295 raeburn 17989: }
17990: }
17991: } else {
17992: unlink($lonids.'/'.$filename);
17993: }
1.463 albertel 17994: }
1.462 albertel 17995: }
1.463 albertel 17996: closedir(DIR);
1.1204 raeburn 17997: # If there is a undeleted lockfile for the user's paste buffer remove it.
17998: my $namespace = 'nohist_courseeditor';
17999: my $lockingkey = 'paste'."\0".'locked_num';
18000: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18001: $domain,$username);
18002: if (exists($lockhash{$lockingkey})) {
18003: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18004: unless ($delresult eq 'ok') {
18005: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18006: }
18007: }
1.462 albertel 18008: }
18009: # Give them a new cookie
1.463 albertel 18010: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18011: : $now.$$.int(rand(10000)));
1.463 albertel 18012: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18013:
18014: # Initialize roles
18015:
1.1414 raeburn 18016: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18017: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18018: }
18019: # ------------------------------------ Check browser type and MathML capability
18020:
1.1194 raeburn 18021: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18022: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18023:
18024: # ------------------------------------------------------------- Get environment
18025:
18026: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18027: my ($tmp) = keys(%userenv);
1.1275 raeburn 18028: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18029: undef(%userenv);
18030: }
18031: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18032: $form->{'interface'}=$userenv{'interface'};
18033: }
18034: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18035:
18036: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18037: foreach my $option ('interface','localpath','localres') {
18038: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18039: }
18040: # --------------------------------------------------------- Write first profile
18041:
18042: {
1.1350 raeburn 18043: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18044: my %initial_env =
18045: ("user.name" => $username,
18046: "user.domain" => $domain,
18047: "user.home" => $authhost,
18048: "browser.type" => $clientbrowser,
18049: "browser.version" => $clientversion,
18050: "browser.mathml" => $clientmathml,
18051: "browser.unicode" => $clientunicode,
18052: "browser.os" => $clientos,
1.1137 raeburn 18053: "browser.mobile" => $clientmobile,
1.1141 raeburn 18054: "browser.info" => $clientinfo,
1.1194 raeburn 18055: "browser.osversion" => $clientosversion,
1.462 albertel 18056: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18057: "request.course.fn" => '',
18058: "request.course.uri" => '',
18059: "request.course.sec" => '',
18060: "request.role" => 'cm',
18061: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18062: "request.host" => $ip,);
1.462 albertel 18063:
18064: if ($form->{'localpath'}) {
18065: $initial_env{"browser.localpath"} = $form->{'localpath'};
18066: $initial_env{"browser.localres"} = $form->{'localres'};
18067: }
18068:
18069: if ($form->{'interface'}) {
18070: $form->{'interface'}=~s/\W//gs;
18071: $initial_env{"browser.interface"} = $form->{'interface'};
18072: $env{'browser.interface'}=$form->{'interface'};
18073: }
18074:
1.1157 raeburn 18075: if ($form->{'iptoken'}) {
18076: my $lonhost = $r->dir_config('lonHostID');
18077: $initial_env{"user.noloadbalance"} = $lonhost;
18078: $env{'user.noloadbalance'} = $lonhost;
18079: }
18080:
1.1268 raeburn 18081: if ($form->{'noloadbalance'}) {
18082: my @hosts = &Apache::lonnet::current_machine_ids();
18083: my $hosthere = $form->{'noloadbalance'};
18084: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18085: $initial_env{"user.noloadbalance"} = $hosthere;
18086: $env{'user.noloadbalance'} = $hosthere;
18087: }
18088: }
18089:
1.1016 raeburn 18090: unless ($domain eq 'public') {
1.1273 raeburn 18091: my %is_adv = ( is_adv => $env{'user.adv'} );
18092: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18093:
1.1414 raeburn 18094: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18095: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18096: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18097: undef,\%userenv,\%domdef,\%is_adv);
18098: }
1.980 raeburn 18099:
1.1311 raeburn 18100: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18101: $userenv{'canrequest.'.$crstype} =
18102: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18103: 'reload','requestcourses',
18104: \%userenv,\%domdef,\%is_adv);
18105: }
1.724 raeburn 18106:
1.1418 raeburn 18107: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18108: (exists($userroles->{"user.role.au./$domain/"}))) {
18109: if ($userenv{'authoreditors'}) {
18110: $userenv{'editors'} = $userenv{'authoreditors'};
18111: } elsif ($domdef{'editors'} ne '') {
18112: $userenv{'editors'} = $domdef{'editors'};
18113: } else {
18114: $userenv{'editors'} = 'edit,xml';
18115: }
1.1431 raeburn 18116: if ($userenv{'authorarchive'}) {
18117: $userenv{'canarchive'} = 1;
18118: } elsif (($userenv{'authorarchive'} eq '') &&
18119: ($domdef{'archive'})) {
18120: $userenv{'canarchive'} = 1;
18121: }
1.1418 raeburn 18122: }
18123:
1.1273 raeburn 18124: $userenv{'canrequest.author'} =
18125: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18126: 'reload','requestauthor',
1.980 raeburn 18127: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18128: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18129: $domain,$username);
18130: my $reqstatus = $reqauthor{'author_status'};
18131: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18132: if (ref($reqauthor{'author'}) eq 'HASH') {
18133: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18134: $reqauthor{'author'}{'timestamp'};
18135: }
1.1092 raeburn 18136: }
1.1287 raeburn 18137: my ($types,$typename) = &course_types();
18138: if (ref($types) eq 'ARRAY') {
18139: my @options = ('approval','validate','autolimit');
18140: my $optregex = join('|',@options);
18141: my (%willtrust,%trustchecked);
18142: foreach my $type (@{$types}) {
18143: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18144: if ($dom_str ne '') {
18145: my $updatedstr = '';
18146: my @possdomains = split(',',$dom_str);
18147: foreach my $entry (@possdomains) {
18148: my ($extdom,$extopt) = split(':',$entry);
18149: unless ($trustchecked{$extdom}) {
18150: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18151: $trustchecked{$extdom} = 1;
18152: }
18153: if ($willtrust{$extdom}) {
18154: $updatedstr .= $entry.',';
18155: }
18156: }
18157: $updatedstr =~ s/,$//;
18158: if ($updatedstr) {
18159: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18160: } else {
18161: delete($userenv{'reqcrsotherdom.'.$type});
18162: }
18163: }
18164: }
18165: }
1.1092 raeburn 18166: }
1.462 albertel 18167: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18168:
1.462 albertel 18169: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18170: &GDBM_WRCREAT(),0640)) {
18171: &_add_to_env(\%disk_env,\%initial_env);
18172: &_add_to_env(\%disk_env,\%userenv,'environment.');
18173: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18174: if (ref($firstaccenv) eq 'HASH') {
18175: &_add_to_env(\%disk_env,$firstaccenv);
18176: }
18177: if (ref($timerintenv) eq 'HASH') {
18178: &_add_to_env(\%disk_env,$timerintenv);
18179: }
1.1414 raeburn 18180: if (ref($coauthorenv) eq 'HASH') {
18181: if (keys(%{$coauthorenv})) {
18182: &_add_to_env(\%disk_env,$coauthorenv);
18183: }
18184: }
1.463 albertel 18185: if (ref($args->{'extra_env'})) {
18186: &_add_to_env(\%disk_env,$args->{'extra_env'});
18187: }
1.462 albertel 18188: untie(%disk_env);
18189: } else {
1.705 tempelho 18190: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18191: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18192: return 'error: '.$!;
18193: }
18194: }
18195: $env{'request.role'}='cm';
18196: $env{'request.role.adv'}=$env{'user.adv'};
18197: $env{'browser.type'}=$clientbrowser;
18198:
18199: return $cookie;
18200:
18201: }
18202:
18203: sub _add_to_env {
18204: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18205: if (ref($env_data) eq 'HASH') {
18206: while (my ($key,$value) = each(%$env_data)) {
18207: $idf->{$prefix.$key} = $value;
18208: $env{$prefix.$key} = $value;
18209: }
1.462 albertel 18210: }
18211: }
18212:
1.685 tempelho 18213: # --- Get the symbolic name of a problem and the url
18214: sub get_symb {
18215: my ($request,$silent) = @_;
1.726 raeburn 18216: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18217: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18218: if ($symb eq '') {
18219: if (!$silent) {
1.1071 raeburn 18220: if (ref($request)) {
18221: $request->print("Unable to handle ambiguous references:$url:.");
18222: }
1.685 tempelho 18223: return ();
18224: }
18225: }
18226: &Apache::lonenc::check_decrypt(\$symb);
18227: return ($symb);
18228: }
18229:
18230: # --------------------------------------------------------------Get annotation
18231:
18232: sub get_annotation {
18233: my ($symb,$enc) = @_;
18234:
18235: my $key = $symb;
18236: if (!$enc) {
18237: $key =
18238: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18239: }
18240: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18241: return $annotation{$key};
18242: }
18243:
18244: sub clean_symb {
1.731 raeburn 18245: my ($symb,$delete_enc) = @_;
1.685 tempelho 18246:
18247: &Apache::lonenc::check_decrypt(\$symb);
18248: my $enc = $env{'request.enc'};
1.731 raeburn 18249: if ($delete_enc) {
1.730 raeburn 18250: delete($env{'request.enc'});
18251: }
1.685 tempelho 18252:
18253: return ($symb,$enc);
18254: }
1.462 albertel 18255:
1.1181 raeburn 18256: ############################################################
18257: ############################################################
18258:
18259: =pod
18260:
18261: =head1 Routines for building display used to search for courses
18262:
18263:
18264: =over 4
18265:
18266: =item * &build_filters()
18267:
18268: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18269: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18270: and quotacheck.pl
18271:
1.1181 raeburn 18272:
18273: Inputs:
18274:
18275: filterlist - anonymous array of fields to include as potential filters
18276:
18277: crstype - course type
18278:
18279: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18280: to pop-open a course selector (will contain "extra element").
18281:
18282: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18283:
18284: filter - anonymous hash of criteria and their values
18285:
18286: action - form action
18287:
18288: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18289:
1.1182 raeburn 18290: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18291:
18292: cloneruname - username of owner of new course who wants to clone
18293:
18294: clonerudom - domain of owner of new course who wants to clone
18295:
18296: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18297:
18298: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18299:
18300: codedom - domain
18301:
18302: formname - value of form element named "form".
18303:
18304: fixeddom - domain, if fixed.
18305:
18306: prevphase - value to assign to form element named "phase" when going back to the previous screen
18307:
18308: cnameelement - name of form element in form on opener page which will receive title of selected course
18309:
18310: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18311:
18312: cdomelement - name of form element in form on opener page which will receive domain of selected course
18313:
18314: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18315:
18316: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18317:
18318: clonewarning - warning message about missing information for intended course owner when DC creates a course
18319:
1.1182 raeburn 18320:
1.1181 raeburn 18321: Returns: $output - HTML for display of search criteria, and hidden form elements.
18322:
1.1182 raeburn 18323:
1.1181 raeburn 18324: Side Effects: None
18325:
18326: =cut
18327:
18328: # ---------------------------------------------- search for courses based on last activity etc.
18329:
18330: sub build_filters {
18331: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18332: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18333: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18334: $cnameelement,$cnumelement,$cdomelement,$setroles,
18335: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18336: my ($list,$jscript);
1.1181 raeburn 18337: my $onchange = 'javascript:updateFilters(this)';
18338: my ($domainselectform,$sincefilterform,$createdfilterform,
18339: $ownerdomselectform,$persondomselectform,$instcodeform,
18340: $typeselectform,$instcodetitle);
18341: if ($formname eq '') {
18342: $formname = $caller;
18343: }
18344: foreach my $item (@{$filterlist}) {
18345: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18346: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18347: if ($item eq 'domainfilter') {
18348: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18349: } elsif ($item eq 'coursefilter') {
18350: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18351: } elsif ($item eq 'ownerfilter') {
18352: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18353: } elsif ($item eq 'ownerdomfilter') {
18354: $filter->{'ownerdomfilter'} =
18355: &LONCAPA::clean_domain($filter->{$item});
18356: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18357: 'ownerdomfilter',1);
18358: } elsif ($item eq 'personfilter') {
18359: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18360: } elsif ($item eq 'persondomfilter') {
18361: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18362: 'persondomfilter',1);
18363: } else {
18364: $filter->{$item} =~ s/\W//g;
18365: }
18366: if (!$filter->{$item}) {
18367: $filter->{$item} = '';
18368: }
18369: }
18370: if ($item eq 'domainfilter') {
18371: my $allow_blank = 1;
18372: if ($formname eq 'portform') {
18373: $allow_blank=0;
18374: } elsif ($formname eq 'studentform') {
18375: $allow_blank=0;
18376: }
18377: if ($fixeddom) {
18378: $domainselectform = '<input type="hidden" name="domainfilter"'.
18379: ' value="'.$codedom.'" />'.
18380: &Apache::lonnet::domain($codedom,'description');
18381: } else {
18382: $domainselectform = &select_dom_form($filter->{$item},
18383: 'domainfilter',
18384: $allow_blank,'',$onchange);
18385: }
18386: } else {
18387: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18388: }
18389: }
18390:
18391: # last course activity filter and selection
18392: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18393:
18394: # course created filter and selection
18395: if (exists($filter->{'createdfilter'})) {
18396: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18397: }
18398:
1.1239 raeburn 18399: my $prefix = $crstype;
18400: if ($crstype eq 'Placement') {
18401: $prefix = 'Placement Test'
18402: }
1.1181 raeburn 18403: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18404: 'cac' => "$prefix Activity",
18405: 'ccr' => "$prefix Created",
18406: 'cde' => "$prefix Title",
18407: 'cdo' => "$prefix Domain",
1.1181 raeburn 18408: 'ins' => 'Institutional Code',
18409: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18410: 'cow' => "$prefix Owner/Co-owner",
18411: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18412: 'cog' => 'Type',
18413: );
18414:
18415: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18416: my $typeval = 'Course';
18417: if ($crstype eq 'Community') {
18418: $typeval = 'Community';
1.1239 raeburn 18419: } elsif ($crstype eq 'Placement') {
18420: $typeval = 'Placement';
1.1181 raeburn 18421: }
18422: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18423: } else {
18424: $typeselectform = '<select name="type" size="1"';
18425: if ($onchange) {
18426: $typeselectform .= ' onchange="'.$onchange.'"';
18427: }
18428: $typeselectform .= '>'."\n";
1.1237 raeburn 18429: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18430: my $shown;
18431: if ($posstype eq 'Placement') {
18432: $shown = &mt('Placement Test');
18433: } else {
18434: $shown = &mt($posstype);
18435: }
1.1181 raeburn 18436: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18437: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18438: }
18439: $typeselectform.="</select>";
18440: }
18441:
18442: my ($cloneableonlyform,$cloneabletitle);
18443: if (exists($filter->{'cloneableonly'})) {
18444: my $cloneableon = '';
18445: my $cloneableoff = ' checked="checked"';
18446: if ($filter->{'cloneableonly'}) {
18447: $cloneableon = $cloneableoff;
18448: $cloneableoff = '';
18449: }
18450: $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/> '.&mt('Required').'</label>'.(' 'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' /> '.&mt('No restriction').'</label></span>';
18451: if ($formname eq 'ccrs') {
1.1187 bisitz 18452: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18453: } else {
18454: $cloneabletitle = &mt('Cloneable by you');
18455: }
18456: }
18457: my $officialjs;
18458: if ($crstype eq 'Course') {
18459: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18460: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18461: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18462: if ($codedom) {
1.1181 raeburn 18463: $officialjs = 1;
18464: ($instcodeform,$jscript,$$numtitlesref) =
18465: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18466: $officialjs,$codetitlesref);
18467: if ($jscript) {
1.1182 raeburn 18468: $jscript = '<script type="text/javascript">'."\n".
18469: '// <![CDATA['."\n".
18470: $jscript."\n".
18471: '// ]]>'."\n".
18472: '</script>'."\n";
1.1181 raeburn 18473: }
18474: }
18475: if ($instcodeform eq '') {
18476: $instcodeform =
18477: '<input type="text" name="instcodefilter" size="10" value="'.
18478: $list->{'instcodefilter'}.'" />';
18479: $instcodetitle = $lt{'ins'};
18480: } else {
18481: $instcodetitle = $lt{'inc'};
18482: }
18483: if ($fixeddom) {
18484: $instcodetitle .= '<br />('.$codedom.')';
18485: }
18486: }
18487: }
18488: my $output = qq|
18489: <form method="post" name="filterpicker" action="$action">
18490: <input type="hidden" name="form" value="$formname" />
18491: |;
18492: if ($formname eq 'modifycourse') {
18493: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18494: '<input type="hidden" name="prevphase" value="'.
18495: $prevphase.'" />'."\n";
1.1198 musolffc 18496: } elsif ($formname eq 'quotacheck') {
18497: $output .= qq|
18498: <input type="hidden" name="sortby" value="" />
18499: <input type="hidden" name="sortorder" value="" />
18500: |;
18501: } else {
1.1181 raeburn 18502: my $name_input;
18503: if ($cnameelement ne '') {
18504: $name_input = '<input type="hidden" name="cnameelement" value="'.
18505: $cnameelement.'" />';
18506: }
18507: $output .= qq|
1.1182 raeburn 18508: <input type="hidden" name="cnumelement" value="$cnumelement" />
18509: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18510: $name_input
18511: $roleelement
18512: $multelement
18513: $typeelement
18514: |;
18515: if ($formname eq 'portform') {
18516: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18517: }
18518: }
18519: if ($fixeddom) {
18520: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18521: }
18522: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18523: if ($sincefilterform) {
18524: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18525: .$sincefilterform
18526: .&Apache::lonhtmlcommon::row_closure();
18527: }
18528: if ($createdfilterform) {
18529: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18530: .$createdfilterform
18531: .&Apache::lonhtmlcommon::row_closure();
18532: }
18533: if ($domainselectform) {
18534: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18535: .$domainselectform
18536: .&Apache::lonhtmlcommon::row_closure();
18537: }
18538: if ($typeselectform) {
18539: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18540: $output .= $typeselectform;
18541: } else {
18542: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18543: .$typeselectform
18544: .&Apache::lonhtmlcommon::row_closure();
18545: }
18546: }
18547: if ($instcodeform) {
18548: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18549: .$instcodeform
18550: .&Apache::lonhtmlcommon::row_closure();
18551: }
18552: if (exists($filter->{'ownerfilter'})) {
18553: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18554: '<table><tr><td>'.&mt('Username').'<br />'.
18555: '<input type="text" name="ownerfilter" size="20" value="'.
18556: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18557: $ownerdomselectform.'</td></tr></table>'.
18558: &Apache::lonhtmlcommon::row_closure();
18559: }
18560: if (exists($filter->{'personfilter'})) {
18561: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18562: '<table><tr><td>'.&mt('Username').'<br />'.
18563: '<input type="text" name="personfilter" size="20" value="'.
18564: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18565: $persondomselectform.'</td></tr></table>'.
18566: &Apache::lonhtmlcommon::row_closure();
18567: }
18568: if (exists($filter->{'coursefilter'})) {
18569: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18570: .'<input type="text" name="coursefilter" size="25" value="'
18571: .$list->{'coursefilter'}.'" />'
18572: .&Apache::lonhtmlcommon::row_closure();
18573: }
18574: if ($cloneableonlyform) {
18575: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18576: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18577: }
18578: if (exists($filter->{'descriptfilter'})) {
18579: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18580: .'<input type="text" name="descriptfilter" size="40" value="'
18581: .$list->{'descriptfilter'}.'" />'
18582: .&Apache::lonhtmlcommon::row_closure(1);
18583: }
18584: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18585: '<input type="hidden" name="updater" value="" />'."\n".
18586: '<input type="submit" name="gosearch" value="'.
18587: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18588: return $jscript.$clonewarning.$output;
18589: }
18590:
18591: =pod
18592:
18593: =item * &timebased_select_form()
18594:
1.1182 raeburn 18595: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18596: filter e.g., Course Activity, Course Created, when searching for courses
18597: or communities
18598:
18599: Inputs:
18600:
18601: item - name of form element (sincefilter or createdfilter)
18602:
18603: filter - anonymous hash of criteria and their values
18604:
18605: Returns: HTML for a select box contained a blank, then six time selections,
18606: with value set in incoming form variables currently selected.
18607:
18608: Side Effects: None
18609:
18610: =cut
18611:
18612: sub timebased_select_form {
18613: my ($item,$filter) = @_;
18614: if (ref($filter) eq 'HASH') {
18615: $filter->{$item} =~ s/[^\d-]//g;
18616: if (!$filter->{$item}) { $filter->{$item}=-1; }
18617: return &select_form(
18618: $filter->{$item},
18619: $item,
18620: { '-1' => '',
18621: '86400' => &mt('today'),
18622: '604800' => &mt('last week'),
18623: '2592000' => &mt('last month'),
18624: '7776000' => &mt('last three months'),
18625: '15552000' => &mt('last six months'),
18626: '31104000' => &mt('last year'),
18627: 'select_form_order' =>
18628: ['-1','86400','604800','2592000','7776000',
18629: '15552000','31104000']});
18630: }
18631: }
18632:
18633: =pod
18634:
18635: =item * &js_changer()
18636:
18637: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18638: when course type or domain is changed, and also to hide 'Searching ...' on
18639: page load completion for page showing search result.
1.1181 raeburn 18640:
18641: Inputs: None
18642:
1.1183 raeburn 18643: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18644:
18645: Side Effects: None
18646:
18647: =cut
18648:
18649: sub js_changer {
18650: return <<ENDJS;
18651: <script type="text/javascript">
18652: // <![CDATA[
18653: function updateFilters(caller) {
18654: if (typeof(caller) != "undefined") {
18655: document.filterpicker.updater.value = caller.name;
18656: }
18657: document.filterpicker.submit();
18658: }
1.1183 raeburn 18659:
18660: function hideSearching() {
18661: if (document.getElementById('searching')) {
18662: document.getElementById('searching').style.display = 'none';
18663: }
18664: return;
18665: }
18666:
1.1181 raeburn 18667: // ]]>
18668: </script>
18669:
18670: ENDJS
18671: }
18672:
18673: =pod
18674:
1.1182 raeburn 18675: =item * &search_courses()
18676:
18677: Process selected filters form course search form and pass to lonnet::courseiddump
18678: to retrieve a hash for which keys are courseIDs which match the selected filters.
18679:
18680: Inputs:
18681:
18682: dom - domain being searched
18683:
18684: type - course type ('Course' or 'Community' or '.' if any).
18685:
18686: filter - anonymous hash of criteria and their values
18687:
18688: numtitles - for institutional codes - number of categories
18689:
18690: cloneruname - optional username of new course owner
18691:
18692: clonerudom - optional domain of new course owner
18693:
1.1221 raeburn 18694: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18695: (used when DC is using course creation form)
18696:
18697: codetitles - reference to array of titles of components in institutional codes (official courses).
18698:
1.1221 raeburn 18699: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18700: (and so can clone automatically)
18701:
18702: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18703:
18704: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18705: courses to clone
1.1182 raeburn 18706:
18707: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18708:
18709:
18710: Side Effects: None
18711:
18712: =cut
18713:
18714:
18715: sub search_courses {
1.1221 raeburn 18716: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18717: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18718: my (%courses,%showcourses,$cloner);
18719: if (($filter->{'ownerfilter'} ne '') ||
18720: ($filter->{'ownerdomfilter'} ne '')) {
18721: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18722: $filter->{'ownerdomfilter'};
18723: }
18724: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18725: if (!$filter->{$item}) {
18726: $filter->{$item}='.';
18727: }
18728: }
18729: my $now = time;
18730: my $timefilter =
18731: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18732: my ($createdbefore,$createdafter);
18733: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18734: $createdbefore = $now;
18735: $createdafter = $now-$filter->{'createdfilter'};
18736: }
18737: my ($instcodefilter,$regexpok);
18738: if ($numtitles) {
18739: if ($env{'form.official'} eq 'on') {
18740: $instcodefilter =
18741: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18742: $regexpok = 1;
18743: } elsif ($env{'form.official'} eq 'off') {
18744: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18745: unless ($instcodefilter eq '') {
18746: $regexpok = -1;
18747: }
18748: }
18749: } else {
18750: $instcodefilter = $filter->{'instcodefilter'};
18751: }
18752: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18753: if ($type eq '') { $type = '.'; }
18754:
18755: if (($clonerudom ne '') && ($cloneruname ne '')) {
18756: $cloner = $cloneruname.':'.$clonerudom;
18757: }
18758: %courses = &Apache::lonnet::courseiddump($dom,
18759: $filter->{'descriptfilter'},
18760: $timefilter,
18761: $instcodefilter,
18762: $filter->{'combownerfilter'},
18763: $filter->{'coursefilter'},
18764: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18765: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18766: $filter->{'cloneableonly'},
18767: $createdbefore,$createdafter,undef,
1.1221 raeburn 18768: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18769: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18770: my $ccrole;
18771: if ($type eq 'Community') {
18772: $ccrole = 'co';
18773: } else {
18774: $ccrole = 'cc';
18775: }
18776: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18777: $filter->{'persondomfilter'},
18778: 'userroles',undef,
18779: [$ccrole,'in','ad','ep','ta','cr'],
18780: $dom);
18781: foreach my $role (keys(%rolehash)) {
18782: my ($cnum,$cdom,$courserole) = split(':',$role);
18783: my $cid = $cdom.'_'.$cnum;
18784: if (exists($courses{$cid})) {
18785: if (ref($courses{$cid}) eq 'HASH') {
18786: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18787: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18788: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18789: }
18790: } else {
18791: $courses{$cid}{roles} = [$courserole];
18792: }
18793: $showcourses{$cid} = $courses{$cid};
18794: }
18795: }
18796: }
18797: %courses = %showcourses;
18798: }
18799: return %courses;
18800: }
18801:
18802: =pod
18803:
1.1181 raeburn 18804: =back
18805:
1.1207 raeburn 18806: =head1 Routines for version requirements for current course.
18807:
18808: =over 4
18809:
18810: =item * &check_release_required()
18811:
18812: Compares required LON-CAPA version with version on server, and
18813: if required version is newer looks for a server with the required version.
18814:
18815: Looks first at servers in user's owen domain; if none suitable, looks at
18816: servers in course's domain are permitted to host sessions for user's domain.
18817:
18818: Inputs:
18819:
18820: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18821:
18822: $courseid - Course ID of current course
18823:
18824: $rolecode - User's current role in course (for switchserver query string).
18825:
18826: $required - LON-CAPA version needed by course (format: Major.Minor).
18827:
18828:
18829: Returns:
18830:
18831: $switchserver - query string tp append to /adm/switchserver call (if
18832: current server's LON-CAPA version is too old.
18833:
18834: $warning - Message is displayed if no suitable server could be found.
18835:
18836: =cut
18837:
18838: sub check_release_required {
18839: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18840: my ($switchserver,$warning);
18841: if ($required ne '') {
18842: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18843: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18844: if ($reqdmajor ne '' && $reqdminor ne '') {
18845: my $otherserver;
18846: if (($major eq '' && $minor eq '') ||
18847: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18848: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18849: my $switchlcrev =
18850: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18851: $userdomserver);
18852: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18853: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18854: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18855: my $cdom = $env{'course.'.$courseid.'.domain'};
18856: if ($cdom ne $env{'user.domain'}) {
18857: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18858: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18859: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18860: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18861: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18862: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18863: my $canhost =
18864: &Apache::lonnet::can_host_session($env{'user.domain'},
18865: $coursedomserver,
18866: $remoterev,
18867: $udomdefaults{'remotesessions'},
18868: $defdomdefaults{'hostedsessions'});
18869:
18870: if ($canhost) {
18871: $otherserver = $coursedomserver;
18872: } else {
18873: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
18874: }
18875: } else {
18876: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
18877: }
18878: } else {
18879: $otherserver = $userdomserver;
18880: }
18881: }
18882: if ($otherserver ne '') {
18883: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18884: }
18885: }
18886: }
18887: return ($switchserver,$warning);
18888: }
18889:
18890: =pod
18891:
18892: =item * &check_release_result()
18893:
18894: Inputs:
18895:
18896: $switchwarning - Warning message if no suitable server found to host session.
18897:
18898: $switchserver - query string to append to /adm/switchserver containing lonHostID
18899: and current role.
18900:
18901: Returns: HTML to display with information about requirement to switch server.
18902: Either displaying warning with link to Roles/Courses screen or
18903: display link to switchserver.
18904:
1.1181 raeburn 18905: =cut
18906:
1.1207 raeburn 18907: sub check_release_result {
18908: my ($switchwarning,$switchserver) = @_;
18909: my $output = &start_page('Selected course unavailable on this server').
18910: '<p class="LC_warning">';
18911: if ($switchwarning) {
18912: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18913: if (&show_course()) {
18914: $output .= &mt('Display courses');
18915: } else {
18916: $output .= &mt('Display roles');
18917: }
18918: $output .= '</a>';
18919: } elsif ($switchserver) {
18920: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18921: '<br />'.
18922: '<a href="/adm/switchserver?'.$switchserver.'">'.
18923: &mt('Switch Server').
18924: '</a>';
18925: }
18926: $output .= '</p>'.&end_page();
18927: return $output;
18928: }
18929:
18930: =pod
18931:
18932: =item * &needs_coursereinit()
18933:
18934: Determine if course contents stored for user's session needs to be
18935: refreshed, because content has changed since "Big Hash" last tied.
18936:
18937: Check for change is made if time last checked is more than 10 minutes ago
18938: (by default).
18939:
18940: Inputs:
18941:
18942: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18943:
18944: $interval (optional) - Time which may elapse (in s) between last check for content
18945: change in current course. (default: 600 s).
18946:
18947: Returns: an array; first element is:
18948:
18949: =over 4
18950:
18951: 'switch' - if content updates mean user's session
18952: needs to be switched to a server running a newer LON-CAPA version
18953:
18954: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18955: on current server hosting user's session
18956:
18957: '' - if no action required.
18958:
18959: =back
18960:
18961: If first item element is 'switch':
18962:
18963: second item is $switchwarning - Warning message if no suitable server found to host session.
18964:
18965: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18966: and current role.
18967:
18968: otherwise: no other elements returned.
18969:
18970: =back
18971:
18972: =cut
18973:
18974: sub needs_coursereinit {
18975: my ($loncaparev,$interval) = @_;
18976: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18977: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18978: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18979: my $now = time;
18980: if ($interval eq '') {
18981: $interval = 600;
18982: }
18983: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18984: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18985: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18986: if ($blocked) {
18987: return ();
18988: }
1.1391 raeburn 18989: my $update;
18990: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18991: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
18992: if ($lastmainchange > $env{'request.course.tied'}) {
18993: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18994: if ($needswitch) {
18995: return ('switch',$switchwarning,$switchserver);
18996: }
18997: $update = 'main';
18998: }
18999: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19000: if ($update) {
19001: $update = 'both';
19002: } else {
19003: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19004: if ($needswitch) {
19005: return ('switch',$switchwarning,$switchserver);
19006: } else {
19007: $update = 'supp';
1.1207 raeburn 19008: }
19009: }
1.1391 raeburn 19010: return ($update);
19011: }
19012: }
19013: return ();
19014: }
19015:
19016: sub switch_for_update {
19017: my ($loncaparev,$cdom,$cnum) = @_;
19018: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19019: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19020: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19021: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19022: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19023: $curr_reqd_hash{'internal.releaserequired'}});
19024: my ($switchserver,$switchwarning) =
19025: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19026: $curr_reqd_hash{'internal.releaserequired'});
19027: if ($switchwarning ne '' || $switchserver ne '') {
19028: return ('switch',$switchwarning,$switchserver);
19029: }
1.1207 raeburn 19030: }
19031: }
19032: return ();
19033: }
1.1181 raeburn 19034:
1.1083 raeburn 19035: sub update_content_constraints {
1.1395 raeburn 19036: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19037: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19038: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19039: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19040: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19041: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19042: if ($item eq 'resourcetag') {
19043: if ($name eq 'responsetype') {
19044: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19045: }
1.1307 raeburn 19046: } elsif ($item eq 'course') {
19047: if ($name eq 'courserestype') {
19048: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19049: }
1.1083 raeburn 19050: }
19051: }
19052: my $navmap = Apache::lonnavmaps::navmap->new();
19053: if (defined($navmap)) {
1.1307 raeburn 19054: my (%allresponses,%allcrsrestypes);
19055: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19056: if ($res->is_tool()) {
19057: if ($allcrsrestypes{'exttool'}) {
19058: $allcrsrestypes{'exttool'} ++;
19059: } else {
19060: $allcrsrestypes{'exttool'} = 1;
19061: }
19062: next;
19063: }
1.1083 raeburn 19064: my %responses = $res->responseTypes();
19065: foreach my $key (keys(%responses)) {
19066: next unless(exists($checkresponsetypes{$key}));
19067: $allresponses{$key} += $responses{$key};
19068: }
19069: }
19070: foreach my $key (keys(%allresponses)) {
19071: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19072: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19073: ($reqdmajor,$reqdminor) = ($major,$minor);
19074: }
19075: }
1.1307 raeburn 19076: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19077: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19078: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19079: ($reqdmajor,$reqdminor) = ($major,$minor);
19080: }
19081: }
1.1083 raeburn 19082: undef($navmap);
19083: }
1.1391 raeburn 19084: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19085: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19086: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19087: ($reqdmajor,$reqdminor) = ($major,$minor);
19088: }
19089: }
1.1083 raeburn 19090: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19091: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19092: }
19093: return;
19094: }
19095:
1.1110 raeburn 19096: sub allmaps_incourse {
19097: my ($cdom,$cnum,$chome,$cid) = @_;
19098: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19099: $cid = $env{'request.course.id'};
19100: $cdom = $env{'course.'.$cid.'.domain'};
19101: $cnum = $env{'course.'.$cid.'.num'};
19102: $chome = $env{'course.'.$cid.'.home'};
19103: }
19104: my %allmaps = ();
19105: my $lastchange =
19106: &Apache::lonnet::get_coursechange($cdom,$cnum);
19107: if ($lastchange > $env{'request.course.tied'}) {
19108: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19109: unless ($ferr) {
1.1395 raeburn 19110: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19111: }
19112: }
19113: my $navmap = Apache::lonnavmaps::navmap->new();
19114: if (defined($navmap)) {
19115: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19116: $allmaps{$res->src()} = 1;
19117: }
19118: }
19119: return \%allmaps;
19120: }
19121:
1.1083 raeburn 19122: sub parse_supplemental_title {
19123: my ($title) = @_;
19124:
19125: my ($foldertitle,$renametitle);
19126: if ($title =~ /&&&/) {
19127: $title = &HTML::Entites::decode($title);
19128: }
19129: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19130: $renametitle=$4;
19131: my ($time,$uname,$udom) = ($1,$2,$3);
19132: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19133: my $name = &plainname($uname,$udom);
19134: $name = &HTML::Entities::encode($name,'"<>&\'');
19135: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19136: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19137: if ($foldertitle ne '') {
1.1401 raeburn 19138: $title .= ': <br />'.$foldertitle;
19139: }
1.1083 raeburn 19140: }
19141: if (wantarray) {
19142: return ($title,$foldertitle,$renametitle);
19143: }
19144: return $title;
19145: }
19146:
1.1395 raeburn 19147: sub get_supplemental {
19148: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19149: my $hashid=$cnum.':'.$cdom;
19150: my ($supplemental,$cached,$set_httprefs);
19151: unless ($ignorecache) {
19152: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19153: }
19154: unless (defined($cached)) {
19155: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19156: unless ($chome eq 'no_host') {
19157: my @order = @LONCAPA::map::order;
19158: my @resources = @LONCAPA::map::resources;
19159: my @resparms = @LONCAPA::map::resparms;
19160: my @zombies = @LONCAPA::map::zombies;
19161: my ($errors,%ids,%hidden);
19162: $errors =
19163: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19164: $errors,$possdel,\%ids,\%hidden);
19165: @LONCAPA::map::order = @order;
19166: @LONCAPA::map::resources = @resources;
19167: @LONCAPA::map::resparms = @resparms;
19168: @LONCAPA::map::zombies = @zombies;
19169: $set_httprefs = 1;
19170: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19171: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19172: }
19173: $supplemental = {
19174: ids => \%ids,
19175: hidden => \%hidden,
19176: };
19177: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19178: }
19179: }
19180: return ($supplemental,$set_httprefs);
19181: }
19182:
1.1143 raeburn 19183: sub recurse_supplemental {
1.1391 raeburn 19184: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19185: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19186: my $mapnum;
19187: if ($suppmap eq 'supplemental.sequence') {
19188: $mapnum = 0;
19189: } else {
19190: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19191: }
1.1143 raeburn 19192: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19193: if ($fatal) {
19194: $errors ++;
19195: } else {
1.1389 raeburn 19196: my @order = @LONCAPA::map::order;
19197: if (@order > 0) {
19198: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19199: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19200: foreach my $idx (@order) {
19201: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19202: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19203: my $id = $mapnum.':'.$idx;
19204: push(@{$suppids->{$src}},$id);
19205: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19206: $hiddensupp->{$id} = 1;
19207: }
1.1146 raeburn 19208: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19209: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19210: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19211: } else {
1.1391 raeburn 19212: my $allowed;
19213: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19214: $allowed = 1;
19215: } elsif ($possdel) {
19216: foreach my $item (@{$suppids->{$src}}) {
19217: next if ($item eq $id);
19218: unless ($hiddensupp->{$item}) {
19219: $allowed = 1;
19220: last;
19221: }
19222: }
19223: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19224: &Apache::lonnet::delenv('httpref.'.$src);
19225: }
19226: }
19227: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19228: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19229: }
1.1143 raeburn 19230: }
19231: }
19232: }
19233: }
19234: }
19235: }
1.1391 raeburn 19236: return $errors;
19237: }
19238:
19239: sub set_supp_httprefs {
19240: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19241: if (ref($supplemental) eq 'HASH') {
19242: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19243: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19244: next if ($src =~ /\.sequence$/);
19245: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19246: my $allowed;
19247: if ($env{'request.role.adv'}) {
19248: $allowed = 1;
19249: } else {
19250: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19251: unless ($supplemental->{'hidden'}->{$id}) {
19252: $allowed = 1;
19253: last;
19254: }
19255: }
19256: }
19257: if (exists($env{'httpref.'.$src})) {
19258: if ($possdel) {
19259: unless ($allowed) {
19260: &Apache::lonnet::delenv('httpref.'.$src);
19261: }
19262: }
19263: } elsif ($allowed) {
19264: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19265: }
19266: }
19267: }
19268: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19269: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19270: }
19271: }
19272: }
19273: }
19274:
19275: sub get_supp_parameter {
19276: my ($resparm,$name)=@_;
19277: return if ($resparm eq '');
19278: my $value=undef;
19279: my $ptype=undef;
19280: foreach (split('&&&',$resparm)) {
19281: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19282: if ($thisname eq $name) {
19283: $value=$thisvalue;
19284: $ptype=$thistype;
19285: }
19286: }
19287: return $value;
1.1143 raeburn 19288: }
19289:
1.1101 raeburn 19290: sub symb_to_docspath {
1.1267 raeburn 19291: my ($symb,$navmapref) = @_;
19292: return unless ($symb && ref($navmapref));
1.1101 raeburn 19293: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19294: if ($resurl=~/\.(sequence|page)$/) {
19295: $mapurl=$resurl;
19296: } elsif ($resurl eq 'adm/navmaps') {
19297: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19298: }
19299: my $mapresobj;
1.1267 raeburn 19300: unless (ref($$navmapref)) {
19301: $$navmapref = Apache::lonnavmaps::navmap->new();
19302: }
19303: if (ref($$navmapref)) {
19304: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19305: }
19306: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19307: my $type=$2;
19308: my $path;
19309: if (ref($mapresobj)) {
19310: my $pcslist = $mapresobj->map_hierarchy();
19311: if ($pcslist ne '') {
19312: foreach my $pc (split(/,/,$pcslist)) {
19313: next if ($pc <= 1);
1.1267 raeburn 19314: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19315: if (ref($res)) {
19316: my $thisurl = $res->src();
19317: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19318: my $thistitle = $res->title();
19319: $path .= '&'.
19320: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19321: &escape($thistitle).
1.1101 raeburn 19322: ':'.$res->randompick().
19323: ':'.$res->randomout().
19324: ':'.$res->encrypted().
19325: ':'.$res->randomorder().
19326: ':'.$res->is_page();
19327: }
19328: }
19329: }
19330: $path =~ s/^\&//;
19331: my $maptitle = $mapresobj->title();
19332: if ($mapurl eq 'default') {
1.1129 raeburn 19333: $maptitle = 'Main Content';
1.1101 raeburn 19334: }
19335: $path .= (($path ne '')? '&' : '').
19336: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19337: &escape($maptitle).
1.1101 raeburn 19338: ':'.$mapresobj->randompick().
19339: ':'.$mapresobj->randomout().
19340: ':'.$mapresobj->encrypted().
19341: ':'.$mapresobj->randomorder().
19342: ':'.$mapresobj->is_page();
19343: } else {
19344: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19345: my $ispage = (($type eq 'page')? 1 : '');
19346: if ($mapurl eq 'default') {
1.1129 raeburn 19347: $maptitle = 'Main Content';
1.1101 raeburn 19348: }
19349: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19350: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19351: }
19352: unless ($mapurl eq 'default') {
19353: $path = 'default&'.
1.1146 raeburn 19354: &escape('Main Content').
1.1101 raeburn 19355: ':::::&'.$path;
19356: }
19357: return $path;
19358: }
19359:
1.1393 raeburn 19360: sub validate_folderpath {
19361: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19362: if ($env{'form.folderpath'} ne '') {
19363: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19364: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19365: for (my $i=0; $i<@items; $i++) {
19366: my $odd = $i%2;
19367: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19368: $badpath = 1;
1.1394 raeburn 19369: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19370: my $idx = $i-1;
1.1394 raeburn 19371: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19372: my $esc_name = $1;
19373: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19374: $supppath .= '&'.$esc_name;
19375: $changed = 1;
19376: } else {
19377: $supppath .= '&'.$items[$i];
19378: }
19379: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19380: $changed = 1;
1.1393 raeburn 19381: my $is_hidden;
19382: unless ($got_supp) {
1.1395 raeburn 19383: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19384: if (ref($supplemental) eq 'HASH') {
19385: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19386: %supphidden = %{$supplemental->{'hidden'}};
19387: }
19388: if (ref($supplemental->{'ids'}) eq 'HASH') {
19389: %suppids = %{$supplemental->{'ids'}};
19390: }
19391: }
19392: $got_supp = 1;
19393: }
19394: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19395: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19396: if ($supphidden{$mapid}) {
19397: $is_hidden = 1;
19398: }
19399: }
1.1394 raeburn 19400: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19401: } else {
19402: $supppath .= '&'.$items[$i];
1.1393 raeburn 19403: }
19404: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19405: $badpath = 1;
1.1394 raeburn 19406: } elsif ($supplementalflag) {
1.1393 raeburn 19407: $supppath .= '&'.$items[$i];
19408: }
19409: last if ($badpath);
19410: }
19411: if ($badpath) {
19412: delete($env{'form.folderpath'});
1.1394 raeburn 19413: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19414: $supppath =~ s/^\&//;
19415: $env{'form.folderpath'} = $supppath;
19416: }
19417: }
19418: return;
19419: }
19420:
1.1094 raeburn 19421: sub captcha_display {
1.1327 raeburn 19422: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19423: my ($output,$error);
1.1234 raeburn 19424: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19425: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19426: if ($captcha eq 'original') {
1.1094 raeburn 19427: $output = &create_captcha();
19428: unless ($output) {
1.1172 raeburn 19429: $error = 'captcha';
1.1094 raeburn 19430: }
19431: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19432: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19433: unless ($output) {
1.1172 raeburn 19434: $error = 'recaptcha';
1.1094 raeburn 19435: }
19436: }
1.1234 raeburn 19437: return ($output,$error,$captcha,$version);
1.1094 raeburn 19438: }
19439:
19440: sub captcha_response {
1.1327 raeburn 19441: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19442: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19443: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19444: if ($captcha eq 'original') {
1.1094 raeburn 19445: ($captcha_chk,$captcha_error) = &check_captcha();
19446: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19447: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19448: } else {
19449: $captcha_chk = 1;
19450: }
19451: return ($captcha_chk,$captcha_error);
19452: }
19453:
19454: sub get_captcha_config {
1.1327 raeburn 19455: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19456: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19457: my $hostname = &Apache::lonnet::hostname($lonhost);
19458: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19459: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19460: if ($context eq 'usercreation') {
19461: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19462: if (ref($domconfig{$context}) eq 'HASH') {
19463: $hashtocheck = $domconfig{$context}{'cancreate'};
19464: if (ref($hashtocheck) eq 'HASH') {
19465: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19466: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19467: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19468: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19469: }
19470: if ($privkey && $pubkey) {
19471: $captcha = 'recaptcha';
1.1234 raeburn 19472: $version = $hashtocheck->{'recaptchaversion'};
19473: if ($version ne '2') {
19474: $version = 1;
19475: }
1.1095 raeburn 19476: } else {
19477: $captcha = 'original';
19478: }
19479: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19480: $captcha = 'original';
19481: }
1.1094 raeburn 19482: }
1.1095 raeburn 19483: } else {
19484: $captcha = 'captcha';
19485: }
19486: } elsif ($context eq 'login') {
19487: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19488: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19489: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19490: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19491: if ($privkey && $pubkey) {
19492: $captcha = 'recaptcha';
1.1234 raeburn 19493: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19494: if ($version ne '2') {
19495: $version = 1;
19496: }
1.1095 raeburn 19497: } else {
19498: $captcha = 'original';
1.1094 raeburn 19499: }
1.1095 raeburn 19500: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19501: $captcha = 'original';
1.1094 raeburn 19502: }
1.1327 raeburn 19503: } elsif ($context eq 'passwords') {
19504: if ($dom_in_effect) {
19505: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19506: if ($passwdconf{'captcha'} eq 'recaptcha') {
19507: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19508: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19509: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19510: }
19511: if ($privkey && $pubkey) {
19512: $captcha = 'recaptcha';
19513: $version = $passwdconf{'recaptchaversion'};
19514: if ($version ne '2') {
19515: $version = 1;
19516: }
19517: } else {
19518: $captcha = 'original';
19519: }
19520: } elsif ($passwdconf{'captcha'} ne 'notused') {
19521: $captcha = 'original';
19522: }
19523: }
19524: }
1.1234 raeburn 19525: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19526: }
19527:
19528: sub create_captcha {
19529: my %captcha_params = &captcha_settings();
19530: my ($output,$maxtries,$tries) = ('',10,0);
19531: while ($tries < $maxtries) {
19532: $tries ++;
19533: my $captcha = Authen::Captcha->new (
19534: output_folder => $captcha_params{'output_dir'},
19535: data_folder => $captcha_params{'db_dir'},
19536: );
19537: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19538:
19539: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19540: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19541: '<span class="LC_nobreak">'.
1.1094 raeburn 19542: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19543: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19544: '</span><br />'.
1.1176 raeburn 19545: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19546: last;
19547: }
19548: }
1.1323 raeburn 19549: if ($output eq '') {
19550: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19551: }
1.1094 raeburn 19552: return $output;
19553: }
19554:
19555: sub captcha_settings {
19556: my %captcha_params = (
19557: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19558: www_output_dir => "/captchaspool",
19559: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19560: numchars => '5',
19561: );
19562: return %captcha_params;
19563: }
19564:
19565: sub check_captcha {
19566: my ($captcha_chk,$captcha_error);
19567: my $code = $env{'form.code'};
19568: my $md5sum = $env{'form.crypt'};
19569: my %captcha_params = &captcha_settings();
19570: my $captcha = Authen::Captcha->new(
19571: output_folder => $captcha_params{'output_dir'},
19572: data_folder => $captcha_params{'db_dir'},
19573: );
1.1109 raeburn 19574: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19575: my %captcha_hash = (
19576: 0 => 'Code not checked (file error)',
19577: -1 => 'Failed: code expired',
19578: -2 => 'Failed: invalid code (not in database)',
19579: -3 => 'Failed: invalid code (code does not match crypt)',
19580: );
19581: if ($captcha_chk != 1) {
19582: $captcha_error = $captcha_hash{$captcha_chk}
19583: }
19584: return ($captcha_chk,$captcha_error);
19585: }
19586:
19587: sub create_recaptcha {
1.1234 raeburn 19588: my ($pubkey,$version) = @_;
19589: if ($version >= 2) {
1.1367 raeburn 19590: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19591: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19592: } else {
19593: my $use_ssl;
19594: if ($ENV{'SERVER_PORT'} == 443) {
19595: $use_ssl = 1;
19596: }
19597: my $captcha = Captcha::reCAPTCHA->new;
19598: return $captcha->get_options_setter({theme => 'white'})."\n".
19599: $captcha->get_html($pubkey,undef,$use_ssl).
19600: &mt('If the text is hard to read, [_1] will replace them.',
19601: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19602: '<br /><br />';
19603: }
1.1094 raeburn 19604: }
19605:
19606: sub check_recaptcha {
1.1234 raeburn 19607: my ($privkey,$version) = @_;
1.1094 raeburn 19608: my $captcha_chk;
1.1350 raeburn 19609: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19610: if ($version >= 2) {
19611: my %info = (
19612: secret => $privkey,
19613: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19614: remoteip => $ip,
1.1234 raeburn 19615: );
1.1280 raeburn 19616: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19617: $request->content(join('&',map {
19618: my $name = escape($_);
19619: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19620: ? join("&$name=", map {escape($_) } @{$info{$_}})
19621: : &escape($info{$_}) );
19622: } keys(%info)));
19623: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19624: if ($response->is_success) {
19625: my $data = JSON::DWIW->from_json($response->decoded_content);
19626: if (ref($data) eq 'HASH') {
19627: if ($data->{'success'}) {
19628: $captcha_chk = 1;
19629: }
19630: }
19631: }
19632: } else {
19633: my $captcha = Captcha::reCAPTCHA->new;
19634: my $captcha_result =
19635: $captcha->check_answer(
19636: $privkey,
1.1350 raeburn 19637: $ip,
1.1234 raeburn 19638: $env{'form.recaptcha_challenge_field'},
19639: $env{'form.recaptcha_response_field'},
19640: );
19641: if ($captcha_result->{is_valid}) {
19642: $captcha_chk = 1;
19643: }
1.1094 raeburn 19644: }
19645: return $captcha_chk;
19646: }
19647:
1.1174 raeburn 19648: sub emailusername_info {
1.1244 raeburn 19649: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19650: my %titles = &Apache::lonlocal::texthash (
19651: lastname => 'Last Name',
19652: firstname => 'First Name',
19653: institution => 'School/college/university',
19654: location => "School's city, state/province, country",
19655: web => "School's web address",
19656: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19657: id => 'Student/Employee ID',
1.1174 raeburn 19658: );
19659: return (\@fields,\%titles);
19660: }
19661:
1.1161 raeburn 19662: sub cleanup_html {
19663: my ($incoming) = @_;
19664: my $outgoing;
19665: if ($incoming ne '') {
19666: $outgoing = $incoming;
19667: $outgoing =~ s/;/;/g;
19668: $outgoing =~ s/\#/#/g;
19669: $outgoing =~ s/\&/&/g;
19670: $outgoing =~ s/</</g;
19671: $outgoing =~ s/>/>/g;
19672: $outgoing =~ s/\(/(/g;
19673: $outgoing =~ s/\)/)/g;
19674: $outgoing =~ s/"/"/g;
19675: $outgoing =~ s/'/'/g;
19676: $outgoing =~ s/\$/$/g;
19677: $outgoing =~ s{/}{/}g;
19678: $outgoing =~ s/=/=/g;
19679: $outgoing =~ s/\\/\/g
19680: }
19681: return $outgoing;
19682: }
19683:
1.1190 musolffc 19684: # Checks for critical messages and returns a redirect url if one exists.
19685: # $interval indicates how often to check for messages.
1.1282 raeburn 19686: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19687: sub critical_redirect {
1.1282 raeburn 19688: my ($interval,$context) = @_;
1.1356 raeburn 19689: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19690: return ();
19691: }
1.1190 musolffc 19692: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19693: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19694: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19695: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19696: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19697: if ($blocked) {
19698: my $checkrole = "cm./$cdom/$cnum";
19699: if ($env{'request.course.sec'} ne '') {
19700: $checkrole .= "/$env{'request.course.sec'}";
19701: }
19702: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19703: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19704: return;
19705: }
19706: }
19707: }
1.1190 musolffc 19708: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19709: $env{'user.name'});
19710: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19711: my $redirecturl;
1.1190 musolffc 19712: if ($what[0]) {
1.1356 raeburn 19713: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19714: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19715: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19716: return (1, $url);
1.1190 musolffc 19717: }
1.1191 raeburn 19718: }
19719: }
19720: return ();
1.1190 musolffc 19721: }
19722:
1.1174 raeburn 19723: # Use:
19724: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19725: #
19726: ##################################################
19727: # password associated functions #
19728: ##################################################
19729: sub des_keys {
19730: # Make a new key for DES encryption.
19731: # Each key has two parts which are returned separately.
19732: # Please note: Each key must be passed through the &hex function
19733: # before it is output to the web browser. The hex versions cannot
19734: # be used to decrypt.
19735: my @hexstr=('0','1','2','3','4','5','6','7',
19736: '8','9','a','b','c','d','e','f');
19737: my $lkey='';
19738: for (0..7) {
19739: $lkey.=$hexstr[rand(15)];
19740: }
19741: my $ukey='';
19742: for (0..7) {
19743: $ukey.=$hexstr[rand(15)];
19744: }
19745: return ($lkey,$ukey);
19746: }
19747:
19748: sub des_decrypt {
19749: my ($key,$cyphertext) = @_;
19750: my $keybin=pack("H16",$key);
19751: my $cypher;
19752: if ($Crypt::DES::VERSION>=2.03) {
19753: $cypher=new Crypt::DES $keybin;
19754: } else {
19755: $cypher=new DES $keybin;
19756: }
1.1233 raeburn 19757: my $plaintext='';
19758: my $cypherlength = length($cyphertext);
19759: my $numchunks = int($cypherlength/32);
19760: for (my $j=0; $j<$numchunks; $j++) {
19761: my $start = $j*32;
19762: my $cypherblock = substr($cyphertext,$start,32);
19763: my $chunk =
19764: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19765: $chunk .=
19766: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19767: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19768: $plaintext .= $chunk;
19769: }
1.1174 raeburn 19770: return $plaintext;
19771: }
19772:
1.1344 raeburn 19773: sub get_requested_shorturls {
1.1309 raeburn 19774: my ($cdom,$cnum,$navmap) = @_;
19775: return unless (ref($navmap));
1.1344 raeburn 19776: my ($numnew,$errors);
1.1309 raeburn 19777: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19778: if (@toshorten) {
19779: my (%maps,%resources,%titles);
19780: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19781: 'shorturls',$cdom,$cnum);
19782: if (keys(%resources)) {
1.1344 raeburn 19783: my %tocreate;
1.1309 raeburn 19784: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19785: my $symb = $resources{$item};
19786: if ($symb) {
19787: $tocreate{$cnum.'&'.$symb} = 1;
19788: }
19789: }
1.1344 raeburn 19790: if (keys(%tocreate)) {
19791: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19792: \%tocreate);
19793: }
1.1309 raeburn 19794: }
1.1344 raeburn 19795: }
19796: return ($numnew,$errors);
19797: }
19798:
19799: sub make_short_symbs {
19800: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19801: my ($numnew,@errors);
19802: if (ref($tocreateref) eq 'HASH') {
19803: my %tocreate = %{$tocreateref};
1.1309 raeburn 19804: if (keys(%tocreate)) {
19805: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19806: my $su = Short::URL->new(no_vowels => 1);
19807: my $init = '';
19808: my (%newunique,%addcourse,%courseonly,%failed);
19809: # get lock on tiny db
19810: my $now = time;
1.1344 raeburn 19811: if ($lockuser eq '') {
19812: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19813: }
1.1309 raeburn 19814: my $lockhash = {
1.1344 raeburn 19815: "lock\0$now" => $lockuser,
1.1309 raeburn 19816: };
19817: my $tries = 0;
19818: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19819: my ($code,$error);
19820: while (($gotlock ne 'ok') && ($tries<3)) {
19821: $tries ++;
19822: sleep 1;
1.1319 raeburn 19823: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19824: }
19825: if ($gotlock eq 'ok') {
19826: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19827: \%addcourse,\%courseonly,\%failed);
19828: if (keys(%failed)) {
19829: my $numfailed = scalar(keys(%failed));
19830: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19831: }
19832: if (keys(%newunique)) {
19833: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19834: if ($putres eq 'ok') {
19835: $numnew = scalar(keys(%newunique));
19836: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19837: unless ($newputres eq 'ok') {
19838: push(@errors,&mt('error: could not store course look-up of short URLs'));
19839: }
19840: } else {
19841: push(@errors,&mt('error: could not store unique six character URLs'));
19842: }
19843: }
19844: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19845: unless ($dellockres eq 'ok') {
19846: push(@errors,&mt('error: could not release lockfile'));
19847: }
19848: } else {
19849: push(@errors,&mt('error: could not obtain lockfile'));
19850: }
19851: if (keys(%courseonly)) {
19852: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19853: if ($result ne 'ok') {
19854: push(@errors,&mt('error: could not update course look-up of short URLs'));
19855: }
19856: }
19857: }
19858: }
19859: return ($numnew,\@errors);
19860: }
19861:
19862: sub shorten_symbs {
19863: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19864: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19865: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19866: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19867: my (%possibles,%collisions);
19868: foreach my $key (keys(%{$tocreate})) {
19869: my $num = String::CRC32::crc32($key);
19870: my $tiny = $su->encode($num,$init);
19871: if ($tiny) {
19872: $possibles{$tiny} = $key;
19873: }
19874: }
19875: if (!$init) {
19876: $init = 1;
19877: } else {
19878: $init ++;
19879: }
19880: if (keys(%possibles)) {
19881: my @posstiny = keys(%possibles);
19882: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19883: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19884: if (keys(%currtiny)) {
19885: foreach my $key (keys(%currtiny)) {
19886: next if ($currtiny{$key} eq '');
19887: if ($currtiny{$key} eq $possibles{$key}) {
19888: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19889: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19890: $courseonly->{$tsymb} = $key;
19891: }
19892: } else {
19893: $collisions{$possibles{$key}} = 1;
19894: }
19895: delete($possibles{$key});
19896: }
19897: }
19898: foreach my $key (keys(%possibles)) {
19899: $newunique->{$key} = $possibles{$key};
19900: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19901: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19902: $addcourse->{$tsymb} = $key;
19903: }
19904: }
19905: }
19906: if (keys(%collisions)) {
19907: if ($init <5) {
19908: if (!$init) {
19909: $init = 1;
19910: } else {
19911: $init ++;
19912: }
19913: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19914: $newunique,$addcourse,$courseonly,$failed);
19915: } else {
19916: foreach my $key (keys(%collisions)) {
19917: $failed->{$key} = 1;
19918: }
19919: }
19920: }
19921: return $init;
19922: }
19923:
1.1328 raeburn 19924: sub is_nonframeable {
1.1329 raeburn 19925: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19926: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19927: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19928:
19929: $remprotocol = lc($remprotocol);
19930: $remhost = lc($remhost);
19931: my $remport = 80;
19932: if ($remprotocol eq 'https') {
19933: $remport = 443;
19934: }
1.1330 raeburn 19935: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19936: if ($cached) {
19937: unless ($nocache) {
19938: if ($result) {
19939: return 1;
19940: } else {
19941: return 0;
19942: }
19943: }
19944: }
1.1328 raeburn 19945: my $uselink;
19946: my $request = new HTTP::Request('HEAD',$url);
19947: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19948: if ($response->is_success()) {
19949: my $secpolicy = lc($response->header('content-security-policy'));
19950: my $xframeop = lc($response->header('x-frame-options'));
19951: $secpolicy =~ s/^\s+|\s+$//g;
19952: $xframeop =~ s/^\s+|\s+$//g;
19953: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19954: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19955: my ($origin,$protocol,$port);
19956: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19957: $port = $ENV{'SERVER_PORT'};
19958: } else {
19959: $port = 80;
19960: }
19961: if ($absolute eq '') {
19962: $protocol = 'http:';
19963: if ($port == 443) {
19964: $protocol = 'https:';
19965: }
19966: $origin = $protocol.'//'.lc($hostname);
19967: } else {
19968: $origin = lc($absolute);
19969: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19970: }
19971: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19972: my $framepolicy = $1;
19973: $framepolicy =~ s/^\s+|\s+$//g;
19974: my @policies = split(/\s+/,$framepolicy);
19975: if (@policies) {
19976: if (grep(/^\Q'none'\E$/,@policies)) {
19977: $uselink = 1;
19978: } else {
19979: $uselink = 1;
19980: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19981: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19982: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19983: undef($uselink);
19984: }
19985: if ($uselink) {
19986: if (grep(/^\Q'self'\E$/,@policies)) {
19987: if (($origin ne '') && ($remotehost eq $origin)) {
19988: undef($uselink);
19989: }
19990: }
19991: }
19992: if ($uselink) {
19993: my @possok;
19994: if ($ip ne '') {
19995: push(@possok,$ip);
19996: }
19997: my $hoststr = '';
19998: foreach my $part (reverse(split(/\./,$hostname))) {
19999: if ($hoststr eq '') {
20000: $hoststr = $part;
20001: } else {
20002: $hoststr = "$part.$hoststr";
20003: }
20004: if ($hoststr eq $hostname) {
20005: push(@possok,$hostname);
20006: } else {
20007: push(@possok,"*.$hoststr");
20008: }
20009: }
20010: if (@possok) {
20011: foreach my $poss (@possok) {
20012: last if (!$uselink);
20013: foreach my $policy (@policies) {
20014: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20015: undef($uselink);
20016: last;
20017: }
20018: }
20019: }
20020: }
20021: }
20022: }
20023: }
20024: } elsif ($xframeop ne '') {
20025: $uselink = 1;
20026: my @policies = split(/\s*,\s*/,$xframeop);
20027: if (@policies) {
20028: unless (grep(/^deny$/,@policies)) {
20029: if ($origin ne '') {
20030: if (grep(/^sameorigin$/,@policies)) {
20031: if ($remotehost eq $origin) {
20032: undef($uselink);
20033: }
20034: }
20035: if ($uselink) {
20036: foreach my $policy (@policies) {
20037: if ($policy =~ /^allow-from\s*(.+)$/) {
20038: my $allowfrom = $1;
20039: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20040: undef($uselink);
20041: last;
20042: }
20043: }
20044: }
20045: }
20046: }
20047: }
20048: }
20049: }
20050: }
20051: }
1.1329 raeburn 20052: if ($nocache) {
20053: if ($cached) {
20054: my $devalidate;
20055: if ($uselink && !$result) {
20056: $devalidate = 1;
20057: } elsif (!$uselink && $result) {
20058: $devalidate = 1;
20059: }
20060: if ($devalidate) {
20061: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20062: }
20063: }
20064: } else {
20065: if ($uselink) {
20066: $result = 1;
20067: } else {
20068: $result = 0;
20069: }
20070: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20071: }
1.1328 raeburn 20072: return $uselink;
20073: }
20074:
1.1359 raeburn 20075: sub page_menu {
20076: my ($menucolls,$menunum) = @_;
20077: my %menu;
20078: foreach my $item (split(/;/,$menucolls)) {
20079: my ($num,$value) = split(/\%/,$item);
20080: if ($num eq $menunum) {
20081: my @entries = split(/\&/,$value);
20082: foreach my $entry (@entries) {
20083: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20084: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20085: $menu{$name} = $fields;
20086: } else {
20087: my @shown;
20088: if ($fields =~ /,/) {
20089: @shown = split(/,/,$fields);
20090: } else {
20091: @shown = ($fields);
20092: }
20093: if (@shown) {
20094: foreach my $field (@shown) {
20095: next if ($field eq '');
20096: $menu{$field} = 1;
20097: }
20098: }
20099: }
20100: }
20101: }
20102: }
20103: return %menu;
20104: }
20105:
1.112 bowersj2 20106: 1;
20107: __END__;
1.41 ng 20108:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncommon.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface