Annotation of loncom/interface/loncommon.pm, revision 1.1441
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1441 ! raeburn 4: # $Id: loncommon.pm,v 1.1440 2024/10/07 19:52:16 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 $img = &designparm($function.'.img',$domain);
6881: my $font = &designparm($function.'.font',$domain);
6882: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6883:
1.803 bisitz 6884: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6885: 'bgcolor' => $pgbg,
1.339 albertel 6886: 'text' => $font,
6887: 'alink' => &designparm($function.'.alink',$domain),
6888: 'vlink' => &designparm($function.'.vlink',$domain),
6889: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6890: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6891:
1.63 www 6892: # role and realm
1.1178 raeburn 6893: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6894: if ($realm) {
6895: $realm = '/'.$realm;
6896: }
1.1357 raeburn 6897: if ($role eq 'ca') {
1.479 albertel 6898: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6899: $realm = &plainname($rname,$rdom);
1.378 raeburn 6900: }
1.55 www 6901: # realm
1.1357 raeburn 6902: my ($cid,$sec);
1.258 albertel 6903: if ($env{'request.course.id'}) {
1.1357 raeburn 6904: $cid = $env{'request.course.id'};
6905: if ($env{'request.course.sec'}) {
6906: $sec = $env{'request.course.sec'};
6907: }
6908: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6909: if (&Apache::lonnet::is_course($1,$2)) {
6910: $cid = $1.'_'.$2;
6911: $sec = $3;
6912: }
6913: }
6914: if ($cid) {
1.378 raeburn 6915: if ($env{'request.role'} !~ /^cr/) {
6916: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6917: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6918: if ($env{'request.role.desc'}) {
6919: $role = $env{'request.role.desc'};
6920: } else {
6921: $role = &mt('Helpdesk[_1]',' '.$2);
6922: }
1.1257 raeburn 6923: } else {
6924: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6925: }
1.1357 raeburn 6926: if ($sec) {
6927: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6928: }
1.1357 raeburn 6929: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6930: } else {
6931: $role = &Apache::lonnet::plaintext($role);
1.54 www 6932: }
1.433 albertel 6933:
1.359 albertel 6934: if (!$realm) { $realm=' '; }
1.330 albertel 6935:
1.438 albertel 6936: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6937:
1.101 www 6938: # construct main body tag
1.359 albertel 6939: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6940: &Apache::lontexconvert::init_math_support();
1.252 albertel 6941:
1.1131 raeburn 6942: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6943:
1.1130 raeburn 6944: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6945: return $bodytag;
1.1130 raeburn 6946: }
1.359 albertel 6947:
1.954 raeburn 6948: if ($public) {
1.433 albertel 6949: undef($role);
6950: }
1.1318 raeburn 6951:
1.1359 raeburn 6952: my $showcrstitle = 1;
1.1357 raeburn 6953: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6954: if (ref($ltimenu) eq 'HASH') {
6955: unless ($ltimenu->{'role'}) {
6956: undef($role);
6957: }
6958: unless ($ltimenu->{'coursetitle'}) {
6959: $realm=' ';
1.1359 raeburn 6960: $showcrstitle = 0;
6961: }
6962: }
6963: } elsif (($cid) && ($menucoll)) {
6964: if (ref($menuref) eq 'HASH') {
6965: unless ($menuref->{'role'}) {
6966: undef($role);
6967: }
6968: unless ($menuref->{'crs'}) {
6969: $realm=' ';
6970: $showcrstitle = 0;
1.1318 raeburn 6971: }
6972: }
6973: }
6974:
1.762 bisitz 6975: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6976: #
6977: # Extra info if you are the DC
6978: my $dc_info = '';
1.1359 raeburn 6979: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6980: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6981: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6982: $dc_info =~ s/\s+$//;
1.359 albertel 6983: }
6984:
1.1237 raeburn 6985: my $crstype;
1.1357 raeburn 6986: if ($cid) {
6987: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6988: } elsif ($args->{'crstype'}) {
6989: $crstype = $args->{'crstype'};
6990: }
6991: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6992: undef($role);
6993: } else {
1.1242 raeburn 6994: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6995: }
1.853 droeschl 6996:
1.903 droeschl 6997: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6998:
6999: # if ($env{'request.state'} eq 'construct') {
7000: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7001: # }
7002:
1.1440 raeburn 7003: my $need_endlcint;
7004: unless ($args->{'switchserver'}) {
7005: $bodytag .= Apache::lonhtmlcommon::scripttag(
7006: Apache::lonmenu::utilityfunctions($httphost), 'start');
7007: $need_endlcint = 1;
7008: }
1.359 albertel 7009:
1.1427 raeburn 7010: my $collapsible;
1.1423 raeburn 7011: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7012: $collapsible = 1;
7013: my ($menustate,$tiptext,$divclass);
7014: if ($args->{'start_collapsed'}) {
7015: $menustate = 'collapsed';
7016: $tiptext = 'display';
7017: $divclass = 'hidden';
7018: } else {
7019: $menustate = 'expanded';
7020: $tiptext = 'hide';
7021: $divclass = 'shown';
7022: }
7023: my $alttext = &mt('menu state: '.$menustate);
7024: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7025: $bodytag .= <<"END";
7026: <div id="LC_expandingContainer" style="display:inline;">
7027: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7028: <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>
7029: <div class="LC_menus_content $divclass">
1.1421 raeburn 7030: END
7031: }
1.1318 raeburn 7032: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7033: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7034: $args->{'links_disabled'},
1.1421 raeburn 7035: $args->{'links_target'},
1.1427 raeburn 7036: $collapsible);
1.359 albertel 7037:
1.1318 raeburn 7038: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7039: if ($dc_info) {
7040: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7041: }
7042: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7043: <em>$realm</em> $dc_info</div>|;
1.1440 raeburn 7044: if ($need_endlcint) {
7045: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7046: }
1.1318 raeburn 7047: return $bodytag;
7048: }
1.894 droeschl 7049:
1.1318 raeburn 7050: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7051: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7052: }
1.916 droeschl 7053:
1.1318 raeburn 7054: $bodytag .= $right;
1.852 droeschl 7055:
1.1318 raeburn 7056: if ($dc_info) {
7057: $dc_info = &dc_courseid_toggle($dc_info);
7058: }
7059: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7060: }
1.916 droeschl 7061:
1.1169 raeburn 7062: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7063: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7064: if ($need_endlcint) {
7065: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7066: }
1.1168 raeburn 7067: return $bodytag;
7068: }
1.1169 raeburn 7069: #don't show menus for public users
1.954 raeburn 7070: if (!$public){
1.1318 raeburn 7071: unless ($args->{'no_inline_menu'}) {
7072: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7073: $args->{'no_primary_menu'},
1.1369 raeburn 7074: $menucoll,$menuref,
1.1380 raeburn 7075: $args->{'links_disabled'},
7076: $args->{'links_target'});
1.1318 raeburn 7077: }
1.903 droeschl 7078: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7079: if ($need_endlcint) {
7080: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7081: }
1.920 raeburn 7082: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7083: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7084: $args->{'bread_crumbs'},'','',$hostname,
7085: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7086: } elsif ($forcereg) {
7087: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7088: $args->{'group'},$args->{'hide_buttons'},
7089: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7090: } else {
7091: $bodytag .=
7092: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7093: $forcereg,$args->{'group'},
7094: $args->{'bread_crumbs'},
1.1274 raeburn 7095: $advtoolsref,'',$hostname);
1.920 raeburn 7096: }
1.1440 raeburn 7097: } else {
7098: # this is to separate menu from content when there's no secondary
1.1441 ! raeburn 7099: # menu. Especially needed for publicly accessible resources.
1.903 droeschl 7100: $bodytag .= '<hr style="clear:both" />';
1.1440 raeburn 7101: if ($need_endlcint) {
7102: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7103: }
1.235 raeburn 7104: }
1.1423 raeburn 7105: if ($args->{'collapsible_header'} ne '') {
7106: $bodytag .= $args->{'collapsible_header'}.
7107: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7108: '</div></div>';
7109: }
1.235 raeburn 7110: return $bodytag;
1.182 matthew 7111: }
7112:
1.917 raeburn 7113: sub dc_courseid_toggle {
7114: my ($dc_info) = @_;
1.980 raeburn 7115: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7116: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7117: &mt('(More ...)').'</a></span>'.
7118: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7119: }
7120:
1.330 albertel 7121: sub make_attr_string {
7122: my ($register,$attr_ref) = @_;
7123:
7124: if ($attr_ref && !ref($attr_ref)) {
7125: die("addentries Must be a hash ref ".
7126: join(':',caller(1))." ".
7127: join(':',caller(0))." ");
7128: }
7129:
7130: if ($register) {
1.339 albertel 7131: my ($on_load,$on_unload);
7132: foreach my $key (keys(%{$attr_ref})) {
7133: if (lc($key) eq 'onload') {
7134: $on_load.=$attr_ref->{$key}.';';
7135: delete($attr_ref->{$key});
7136:
7137: } elsif (lc($key) eq 'onunload') {
7138: $on_unload.=$attr_ref->{$key}.';';
7139: delete($attr_ref->{$key});
7140: }
7141: }
1.953 droeschl 7142: $attr_ref->{'onload'} = $on_load;
7143: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7144: }
1.339 albertel 7145:
1.330 albertel 7146: my $attr_string;
1.1159 raeburn 7147: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7148: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7149: }
7150: return $attr_string;
7151: }
7152:
7153:
1.182 matthew 7154: ###############################################
1.251 albertel 7155: ###############################################
7156:
7157: =pod
7158:
7159: =item * &endbodytag()
7160:
7161: Returns a uniform footer for LON-CAPA web pages.
7162:
1.635 raeburn 7163: Inputs: 1 - optional reference to an args hash
7164: If in the hash, key for noredirectlink has a value which evaluates to true,
7165: a 'Continue' link is not displayed if the page contains an
7166: internal redirect in the <head></head> section,
7167: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7168:
7169: =cut
7170:
7171: sub endbodytag {
1.635 raeburn 7172: my ($args) = @_;
1.1080 raeburn 7173: my $endbodytag;
7174: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7175: $endbodytag='</body>';
7176: }
1.315 albertel 7177: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7178: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7179: my ($endbodyjs,$idattr);
7180: if ($env{'internal.head.to_opener'}) {
7181: my $linkid = 'LC_continue_link';
7182: $idattr = ' id="'.$linkid.'"';
7183: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7184: $endbodyjs=<<ENDJS;
7185: <script type="text/javascript">
7186: // <![CDATA[
7187: function ebFunction(evt) {
7188: evt.preventDefault();
7189: var dest = '$redirect_for_js';
7190: if (window.opener != null && !window.opener.closed) {
7191: window.opener.location.href=dest;
7192: window.close();
7193: } else {
7194: window.location.href=dest;
7195: }
7196: return false;
7197: }
7198:
7199: \$(document).ready(function () {
7200: if (document.getElementById('$linkid')) {
7201: var clickelem = document.getElementById('$linkid');
7202: clickelem.addEventListener('click',ebFunction,false);
7203: }
7204: });
7205: // ]]>
7206: </script>
7207: ENDJS
7208: }
1.635 raeburn 7209: $endbodytag=
1.1386 raeburn 7210: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7211: &mt('Continue').'</a>'.
7212: $endbodytag;
7213: }
1.315 albertel 7214: }
1.1411 raeburn 7215: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7216: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7217: }
1.251 albertel 7218: return $endbodytag;
7219: }
7220:
1.352 albertel 7221: =pod
7222:
7223: =item * &standard_css()
7224:
7225: Returns a style sheet
7226:
7227: Inputs: (all optional)
7228: domain -> force to color decorate a page for a specific
7229: domain
7230: function -> force usage of a specific rolish color scheme
7231: bgcolor -> override the default page bgcolor
7232:
7233: =cut
7234:
1.343 albertel 7235: sub standard_css {
1.345 albertel 7236: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7237: $function = &get_users_function() if (!$function);
7238: my $img = &designparm($function.'.img', $domain);
7239: my $tabbg = &designparm($function.'.tabbg', $domain);
7240: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7241: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7242: #second colour for later usage
1.345 albertel 7243: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7244: my $pgbg_or_bgcolor =
7245: $bgcolor ||
1.352 albertel 7246: &designparm($function.'.pgbg', $domain);
1.382 albertel 7247: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7248: my $alink = &designparm($function.'.alink', $domain);
7249: my $vlink = &designparm($function.'.vlink', $domain);
7250: my $link = &designparm($function.'.link', $domain);
7251:
1.602 albertel 7252: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7253: my $mono = 'monospace';
1.850 bisitz 7254: my $data_table_head = $sidebg;
7255: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7256: my $data_table_dark = '#E0E0E0';
1.470 banghart 7257: my $data_table_darker = '#CCCCCC';
1.349 albertel 7258: my $data_table_highlight = '#FFFF00';
1.352 albertel 7259: my $mail_new = '#FFBB77';
7260: my $mail_new_hover = '#DD9955';
7261: my $mail_read = '#BBBB77';
7262: my $mail_read_hover = '#999944';
7263: my $mail_replied = '#AAAA88';
7264: my $mail_replied_hover = '#888855';
7265: my $mail_other = '#99BBBB';
7266: my $mail_other_hover = '#669999';
1.391 albertel 7267: my $table_header = '#DDDDDD';
1.489 raeburn 7268: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7269: my $lg_border_color = '#C8C8C8';
1.952 onken 7270: my $button_hover = '#BF2317';
1.392 albertel 7271:
1.608 albertel 7272: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7273: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7274: : '0 3px 0 4px';
1.448 albertel 7275:
1.523 albertel 7276:
1.343 albertel 7277: return <<END;
1.947 droeschl 7278:
7279: /* needed for iframe to allow 100% height in FF */
7280: body, html {
7281: margin: 0;
7282: padding: 0 0.5%;
7283: height: 99%; /* to avoid scrollbars */
7284: }
7285:
1.795 www 7286: body {
1.911 bisitz 7287: font-family: $sans;
7288: line-height:130%;
7289: font-size:0.83em;
7290: color:$font;
1.1436 raeburn 7291: background-color: $pgbg_or_bgcolor;
1.795 www 7292: }
7293:
1.959 onken 7294: a:focus,
7295: a:focus img {
1.795 www 7296: color: red;
7297: }
1.698 harmsja 7298:
1.911 bisitz 7299: form, .inline {
7300: display: inline;
1.795 www 7301: }
1.721 harmsja 7302:
1.1421 raeburn 7303: .LC_menus_content.shown{
1.1428 raeburn 7304: display: block;
1.1421 raeburn 7305: }
7306:
7307: .LC_menus_content.hidden {
7308: display: none;
7309: }
7310:
1.795 www 7311: .LC_right {
1.911 bisitz 7312: text-align:right;
1.795 www 7313: }
7314:
7315: .LC_middle {
1.911 bisitz 7316: vertical-align:middle;
1.795 www 7317: }
1.721 harmsja 7318:
1.1130 raeburn 7319: .LC_floatleft {
7320: float: left;
7321: }
7322:
7323: .LC_floatright {
7324: float: right;
7325: }
7326:
1.911 bisitz 7327: .LC_400Box {
7328: width:400px;
7329: }
1.721 harmsja 7330:
1.1421 raeburn 7331: #LC_collapsible_separator {
7332: border: 1px solid black;
7333: width: 99.9%;
7334: height: 0px;
7335: }
7336:
1.947 droeschl 7337: .LC_iframecontainer {
7338: width: 98%;
7339: margin: 0;
7340: position: fixed;
7341: top: 8.5em;
7342: bottom: 0;
7343: }
7344:
7345: .LC_iframecontainer iframe{
7346: border: none;
7347: width: 100%;
7348: height: 100%;
7349: }
7350:
1.778 bisitz 7351: .LC_filename {
7352: font-family: $mono;
7353: white-space:pre;
1.921 bisitz 7354: font-size: 120%;
1.778 bisitz 7355: }
7356:
7357: .LC_fileicon {
7358: border: none;
7359: height: 1.3em;
7360: vertical-align: text-bottom;
7361: margin-right: 0.3em;
7362: text-decoration:none;
7363: }
7364:
1.1008 www 7365: .LC_setting {
7366: text-decoration:underline;
7367: }
7368:
1.350 albertel 7369: .LC_error {
7370: color: red;
7371: }
1.795 www 7372:
1.1097 bisitz 7373: .LC_warning {
7374: color: darkorange;
7375: }
7376:
1.457 albertel 7377: .LC_diff_removed {
1.733 bisitz 7378: color: red;
1.394 albertel 7379: }
1.532 albertel 7380:
7381: .LC_info,
1.457 albertel 7382: .LC_success,
7383: .LC_diff_added {
1.350 albertel 7384: color: green;
7385: }
1.795 www 7386:
1.802 bisitz 7387: div.LC_confirm_box {
7388: background-color: #FAFAFA;
7389: border: 1px solid $lg_border_color;
7390: margin-right: 0;
7391: padding: 5px;
7392: }
7393:
7394: div.LC_confirm_box .LC_error img,
7395: div.LC_confirm_box .LC_success img {
7396: vertical-align: middle;
7397: }
7398:
1.1242 raeburn 7399: .LC_maxwidth {
7400: max-width: 100%;
7401: height: auto;
7402: }
7403:
1.1243 raeburn 7404: .LC_textsize_mobile {
7405: \@media only screen and (max-device-width: 480px) {
7406: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7407: }
7408: }
7409:
1.440 albertel 7410: .LC_icon {
1.771 droeschl 7411: border: none;
1.790 droeschl 7412: vertical-align: middle;
1.771 droeschl 7413: }
7414:
1.543 albertel 7415: .LC_docs_spacer {
7416: width: 25px;
7417: height: 1px;
1.771 droeschl 7418: border: none;
1.543 albertel 7419: }
1.346 albertel 7420:
1.532 albertel 7421: .LC_internal_info {
1.735 bisitz 7422: color: #999999;
1.532 albertel 7423: }
7424:
1.794 www 7425: .LC_discussion {
1.1050 www 7426: background: $data_table_dark;
1.911 bisitz 7427: border: 1px solid black;
7428: margin: 2px;
1.794 www 7429: }
7430:
7431: .LC_disc_action_left {
1.1050 www 7432: background: $sidebg;
1.911 bisitz 7433: text-align: left;
1.1050 www 7434: padding: 4px;
7435: margin: 2px;
1.794 www 7436: }
7437:
7438: .LC_disc_action_right {
1.1050 www 7439: background: $sidebg;
1.911 bisitz 7440: text-align: right;
1.1050 www 7441: padding: 4px;
7442: margin: 2px;
1.794 www 7443: }
7444:
7445: .LC_disc_new_item {
1.911 bisitz 7446: background: white;
7447: border: 2px solid red;
1.1050 www 7448: margin: 4px;
7449: padding: 4px;
1.794 www 7450: }
7451:
7452: .LC_disc_old_item {
1.911 bisitz 7453: background: white;
1.1050 www 7454: margin: 4px;
7455: padding: 4px;
1.794 www 7456: }
7457:
1.458 albertel 7458: table.LC_pastsubmission {
7459: border: 1px solid black;
7460: margin: 2px;
7461: }
7462:
1.924 bisitz 7463: table#LC_menubuttons {
1.345 albertel 7464: width: 100%;
7465: background: $pgbg;
1.392 albertel 7466: border: 2px;
1.402 albertel 7467: border-collapse: separate;
1.803 bisitz 7468: padding: 0;
1.345 albertel 7469: }
1.392 albertel 7470:
1.801 tempelho 7471: table#LC_title_bar a {
7472: color: $fontmenu;
7473: }
1.836 bisitz 7474:
1.807 droeschl 7475: table#LC_title_bar {
1.819 tempelho 7476: clear: both;
1.836 bisitz 7477: display: none;
1.807 droeschl 7478: }
7479:
1.795 www 7480: table#LC_title_bar,
1.933 droeschl 7481: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7482: table#LC_title_bar.LC_with_remote {
1.359 albertel 7483: width: 100%;
1.392 albertel 7484: border-color: $pgbg;
7485: border-style: solid;
7486: border-width: $border;
1.379 albertel 7487: background: $pgbg;
1.801 tempelho 7488: color: $fontmenu;
1.392 albertel 7489: border-collapse: collapse;
1.803 bisitz 7490: padding: 0;
1.819 tempelho 7491: margin: 0;
1.359 albertel 7492: }
1.795 www 7493:
1.933 droeschl 7494: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7495: margin: 0;
7496: padding: 0;
1.933 droeschl 7497: position: relative;
7498: list-style: none;
1.913 droeschl 7499: }
1.933 droeschl 7500: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7501: display: inline;
7502: }
1.933 droeschl 7503:
7504: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7505: padding: 0;
1.933 droeschl 7506: margin: 0;
7507: float: left;
1.913 droeschl 7508: }
1.933 droeschl 7509: .LC_breadcrumb_tools_tools {
7510: padding: 0;
7511: margin: 0;
1.913 droeschl 7512: float: right;
7513: }
7514:
1.1240 raeburn 7515: .LC_placement_prog {
7516: padding-right: 20px;
7517: font-weight: bold;
7518: font-size: 90%;
7519: }
7520:
1.359 albertel 7521: table#LC_title_bar td {
7522: background: $tabbg;
7523: }
1.795 www 7524:
1.911 bisitz 7525: table#LC_menubuttons img {
1.803 bisitz 7526: border: none;
1.346 albertel 7527: }
1.795 www 7528:
1.842 droeschl 7529: .LC_breadcrumbs_component {
1.911 bisitz 7530: float: right;
7531: margin: 0 1em;
1.357 albertel 7532: }
1.842 droeschl 7533: .LC_breadcrumbs_component img {
1.911 bisitz 7534: vertical-align: middle;
1.777 tempelho 7535: }
1.795 www 7536:
1.1243 raeburn 7537: .LC_breadcrumbs_hoverable {
7538: background: $sidebg;
7539: }
7540:
1.383 albertel 7541: td.LC_table_cell_checkbox {
7542: text-align: center;
7543: }
1.795 www 7544:
7545: .LC_fontsize_small {
1.911 bisitz 7546: font-size: 70%;
1.705 tempelho 7547: }
7548:
1.844 bisitz 7549: #LC_breadcrumbs {
1.911 bisitz 7550: clear:both;
7551: background: $sidebg;
7552: border-bottom: 1px solid $lg_border_color;
7553: line-height: 2.5em;
1.933 droeschl 7554: overflow: hidden;
1.911 bisitz 7555: margin: 0;
7556: padding: 0;
1.995 raeburn 7557: text-align: left;
1.819 tempelho 7558: }
1.862 bisitz 7559:
1.1098 bisitz 7560: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7561: clear:both;
7562: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7563: border: 1px solid $sidebg;
1.1098 bisitz 7564: margin: 0 0 10px 0;
1.966 bisitz 7565: padding: 3px;
1.995 raeburn 7566: text-align: left;
1.822 bisitz 7567: }
7568:
1.795 www 7569: .LC_fontsize_medium {
1.911 bisitz 7570: font-size: 85%;
1.705 tempelho 7571: }
7572:
1.795 www 7573: .LC_fontsize_large {
1.911 bisitz 7574: font-size: 120%;
1.705 tempelho 7575: }
7576:
1.346 albertel 7577: .LC_menubuttons_inline_text {
7578: color: $font;
1.698 harmsja 7579: font-size: 90%;
1.701 harmsja 7580: padding-left:3px;
1.346 albertel 7581: }
7582:
1.934 droeschl 7583: .LC_menubuttons_inline_text img{
7584: vertical-align: middle;
7585: }
7586:
1.1051 www 7587: li.LC_menubuttons_inline_text img {
1.951 onken 7588: cursor:pointer;
1.1002 droeschl 7589: text-decoration: none;
1.951 onken 7590: }
7591:
1.526 www 7592: .LC_menubuttons_link {
7593: text-decoration: none;
7594: }
1.795 www 7595:
1.522 albertel 7596: .LC_menubuttons_category {
1.521 www 7597: color: $font;
1.526 www 7598: background: $pgbg;
1.521 www 7599: font-size: larger;
7600: font-weight: bold;
7601: }
7602:
1.346 albertel 7603: td.LC_menubuttons_text {
1.911 bisitz 7604: color: $font;
1.346 albertel 7605: }
1.706 harmsja 7606:
1.346 albertel 7607: .LC_current_location {
7608: background: $tabbg;
7609: }
1.795 www 7610:
1.1286 raeburn 7611: td.LC_zero_height {
7612: line-height: 0;
7613: cellpadding: 0;
7614: }
7615:
1.938 bisitz 7616: table.LC_data_table {
1.347 albertel 7617: border: 1px solid #000000;
1.402 albertel 7618: border-collapse: separate;
1.426 albertel 7619: border-spacing: 1px;
1.610 albertel 7620: background: $pgbg;
1.347 albertel 7621: }
1.795 www 7622:
1.422 albertel 7623: .LC_data_table_dense {
7624: font-size: small;
7625: }
1.795 www 7626:
1.507 raeburn 7627: table.LC_nested_outer {
7628: border: 1px solid #000000;
1.589 raeburn 7629: border-collapse: collapse;
1.803 bisitz 7630: border-spacing: 0;
1.507 raeburn 7631: width: 100%;
7632: }
1.795 www 7633:
1.879 raeburn 7634: table.LC_innerpickbox,
1.507 raeburn 7635: table.LC_nested {
1.803 bisitz 7636: border: none;
1.589 raeburn 7637: border-collapse: collapse;
1.803 bisitz 7638: border-spacing: 0;
1.507 raeburn 7639: width: 100%;
7640: }
1.795 www 7641:
1.911 bisitz 7642: table.LC_data_table tr th,
7643: table.LC_calendar tr th,
1.879 raeburn 7644: table.LC_prior_tries tr th,
7645: table.LC_innerpickbox tr th {
1.349 albertel 7646: font-weight: bold;
7647: background-color: $data_table_head;
1.801 tempelho 7648: color:$fontmenu;
1.701 harmsja 7649: font-size:90%;
1.347 albertel 7650: }
1.795 www 7651:
1.879 raeburn 7652: table.LC_innerpickbox tr th,
7653: table.LC_innerpickbox tr td {
7654: vertical-align: top;
7655: }
7656:
1.711 raeburn 7657: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7658: background-color: #CCCCCC;
1.711 raeburn 7659: font-weight: bold;
7660: text-align: left;
7661: }
1.795 www 7662:
1.912 bisitz 7663: table.LC_data_table tr.LC_odd_row > td {
7664: background-color: $data_table_light;
7665: padding: 2px;
7666: vertical-align: top;
7667: }
7668:
1.809 bisitz 7669: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7670: background-color: $data_table_light;
1.912 bisitz 7671: vertical-align: top;
7672: }
7673:
7674: table.LC_data_table tr.LC_even_row > td {
7675: background-color: $data_table_dark;
1.425 albertel 7676: padding: 2px;
1.900 bisitz 7677: vertical-align: top;
1.347 albertel 7678: }
1.795 www 7679:
1.809 bisitz 7680: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7681: background-color: $data_table_dark;
1.900 bisitz 7682: vertical-align: top;
1.347 albertel 7683: }
1.795 www 7684:
1.425 albertel 7685: table.LC_data_table tr.LC_data_table_highlight td {
7686: background-color: $data_table_darker;
7687: }
1.795 www 7688:
1.639 raeburn 7689: table.LC_data_table tr td.LC_leftcol_header {
7690: background-color: $data_table_head;
7691: font-weight: bold;
7692: }
1.795 www 7693:
1.451 albertel 7694: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7695: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7696: font-weight: bold;
7697: font-style: italic;
7698: text-align: center;
7699: padding: 8px;
1.347 albertel 7700: }
1.795 www 7701:
1.1114 raeburn 7702: table.LC_data_table tr.LC_empty_row td,
7703: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7704: background-color: $sidebg;
7705: }
7706:
7707: table.LC_nested tr.LC_empty_row td {
7708: background-color: #FFFFFF;
7709: }
7710:
1.890 droeschl 7711: table.LC_caption {
7712: }
7713:
1.507 raeburn 7714: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7715: padding: 4ex
7716: }
1.795 www 7717:
1.507 raeburn 7718: table.LC_nested_outer tr th {
7719: font-weight: bold;
1.801 tempelho 7720: color:$fontmenu;
1.507 raeburn 7721: background-color: $data_table_head;
1.701 harmsja 7722: font-size: small;
1.507 raeburn 7723: border-bottom: 1px solid #000000;
7724: }
1.795 www 7725:
1.507 raeburn 7726: table.LC_nested_outer tr td.LC_subheader {
7727: background-color: $data_table_head;
7728: font-weight: bold;
7729: font-size: small;
7730: border-bottom: 1px solid #000000;
7731: text-align: right;
1.451 albertel 7732: }
1.795 www 7733:
1.507 raeburn 7734: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7735: background-color: #CCCCCC;
1.451 albertel 7736: font-weight: bold;
7737: font-size: small;
1.507 raeburn 7738: text-align: center;
7739: }
1.795 www 7740:
1.589 raeburn 7741: table.LC_nested tr.LC_info_row td.LC_left_item,
7742: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7743: text-align: left;
1.451 albertel 7744: }
1.795 www 7745:
1.507 raeburn 7746: table.LC_nested td {
1.735 bisitz 7747: background-color: #FFFFFF;
1.451 albertel 7748: font-size: small;
1.507 raeburn 7749: }
1.795 www 7750:
1.507 raeburn 7751: table.LC_nested_outer tr th.LC_right_item,
7752: table.LC_nested tr.LC_info_row td.LC_right_item,
7753: table.LC_nested tr.LC_odd_row td.LC_right_item,
7754: table.LC_nested tr td.LC_right_item {
1.451 albertel 7755: text-align: right;
7756: }
7757:
1.507 raeburn 7758: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7759: background-color: #EEEEEE;
1.451 albertel 7760: }
7761:
1.473 raeburn 7762: table.LC_createuser {
7763: }
7764:
7765: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7766: font-size: small;
1.473 raeburn 7767: }
7768:
7769: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7770: background-color: #CCCCCC;
1.473 raeburn 7771: font-weight: bold;
7772: text-align: center;
7773: }
7774:
1.349 albertel 7775: table.LC_calendar {
7776: border: 1px solid #000000;
7777: border-collapse: collapse;
1.917 raeburn 7778: width: 98%;
1.349 albertel 7779: }
1.795 www 7780:
1.349 albertel 7781: table.LC_calendar_pickdate {
7782: font-size: xx-small;
7783: }
1.795 www 7784:
1.349 albertel 7785: table.LC_calendar tr td {
7786: border: 1px solid #000000;
7787: vertical-align: top;
1.917 raeburn 7788: width: 14%;
1.349 albertel 7789: }
1.795 www 7790:
1.349 albertel 7791: table.LC_calendar tr td.LC_calendar_day_empty {
7792: background-color: $data_table_dark;
7793: }
1.795 www 7794:
1.779 bisitz 7795: table.LC_calendar tr td.LC_calendar_day_current {
7796: background-color: $data_table_highlight;
1.777 tempelho 7797: }
1.795 www 7798:
1.938 bisitz 7799: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7800: background-color: $mail_new;
7801: }
1.795 www 7802:
1.938 bisitz 7803: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7804: background-color: $mail_new_hover;
7805: }
1.795 www 7806:
1.938 bisitz 7807: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7808: background-color: $mail_read;
7809: }
1.795 www 7810:
1.938 bisitz 7811: /*
7812: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7813: background-color: $mail_read_hover;
7814: }
1.938 bisitz 7815: */
1.795 www 7816:
1.938 bisitz 7817: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7818: background-color: $mail_replied;
7819: }
1.795 www 7820:
1.938 bisitz 7821: /*
7822: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7823: background-color: $mail_replied_hover;
7824: }
1.938 bisitz 7825: */
1.795 www 7826:
1.938 bisitz 7827: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7828: background-color: $mail_other;
7829: }
1.795 www 7830:
1.938 bisitz 7831: /*
7832: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7833: background-color: $mail_other_hover;
7834: }
1.938 bisitz 7835: */
1.494 raeburn 7836:
1.777 tempelho 7837: table.LC_data_table tr > td.LC_browser_file,
7838: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7839: background: #AAEE77;
1.389 albertel 7840: }
1.795 www 7841:
1.777 tempelho 7842: table.LC_data_table tr > td.LC_browser_file_locked,
7843: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7844: background: #FFAA99;
1.387 albertel 7845: }
1.795 www 7846:
1.777 tempelho 7847: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7848: background: #888888;
1.779 bisitz 7849: }
1.795 www 7850:
1.777 tempelho 7851: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7852: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7853: background: #F8F866;
1.777 tempelho 7854: }
1.795 www 7855:
1.696 bisitz 7856: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7857: background: #E0E8FF;
1.387 albertel 7858: }
1.696 bisitz 7859:
1.707 bisitz 7860: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7861: /* background: #77FF77; */
1.707 bisitz 7862: }
1.795 www 7863:
1.707 bisitz 7864: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7865: border-right: 8px solid #FFFF77;
1.707 bisitz 7866: }
1.795 www 7867:
1.707 bisitz 7868: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7869: border-right: 8px solid #FFAA77;
1.707 bisitz 7870: }
1.795 www 7871:
1.707 bisitz 7872: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7873: border-right: 8px solid #FF7777;
1.707 bisitz 7874: }
1.795 www 7875:
1.707 bisitz 7876: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7877: border-right: 8px solid #AAFF77;
1.707 bisitz 7878: }
1.795 www 7879:
1.707 bisitz 7880: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7881: border-right: 8px solid #11CC55;
1.707 bisitz 7882: }
7883:
1.388 albertel 7884: span.LC_current_location {
1.701 harmsja 7885: font-size:larger;
1.388 albertel 7886: background: $pgbg;
7887: }
1.387 albertel 7888:
1.1029 www 7889: span.LC_current_nav_location {
7890: font-weight:bold;
7891: background: $sidebg;
7892: }
7893:
1.395 albertel 7894: span.LC_parm_menu_item {
7895: font-size: larger;
7896: }
1.795 www 7897:
1.395 albertel 7898: span.LC_parm_scope_all {
7899: color: red;
7900: }
1.795 www 7901:
1.395 albertel 7902: span.LC_parm_scope_folder {
7903: color: green;
7904: }
1.795 www 7905:
1.395 albertel 7906: span.LC_parm_scope_resource {
7907: color: orange;
7908: }
1.795 www 7909:
1.395 albertel 7910: span.LC_parm_part {
7911: color: blue;
7912: }
1.795 www 7913:
1.911 bisitz 7914: span.LC_parm_folder,
7915: span.LC_parm_symb {
1.395 albertel 7916: font-size: x-small;
7917: font-family: $mono;
7918: color: #AAAAAA;
7919: }
7920:
1.977 bisitz 7921: ul.LC_parm_parmlist li {
7922: display: inline-block;
7923: padding: 0.3em 0.8em;
7924: vertical-align: top;
7925: width: 150px;
7926: border-top:1px solid $lg_border_color;
7927: }
7928:
1.795 www 7929: td.LC_parm_overview_level_menu,
7930: td.LC_parm_overview_map_menu,
7931: td.LC_parm_overview_parm_selectors,
7932: td.LC_parm_overview_restrictions {
1.396 albertel 7933: border: 1px solid black;
7934: border-collapse: collapse;
7935: }
1.795 www 7936:
1.1285 raeburn 7937: span.LC_parm_recursive,
7938: td.LC_parm_recursive {
7939: font-weight: bold;
7940: font-size: smaller;
7941: }
7942:
1.396 albertel 7943: table.LC_parm_overview_restrictions td {
7944: border-width: 1px 4px 1px 4px;
7945: border-style: solid;
7946: border-color: $pgbg;
7947: text-align: center;
7948: }
1.795 www 7949:
1.396 albertel 7950: table.LC_parm_overview_restrictions th {
7951: background: $tabbg;
7952: border-width: 1px 4px 1px 4px;
7953: border-style: solid;
7954: border-color: $pgbg;
7955: }
1.795 www 7956:
1.398 albertel 7957: table#LC_helpmenu {
1.803 bisitz 7958: border: none;
1.398 albertel 7959: height: 55px;
1.803 bisitz 7960: border-spacing: 0;
1.398 albertel 7961: }
7962:
7963: table#LC_helpmenu fieldset legend {
7964: font-size: larger;
7965: }
1.795 www 7966:
1.397 albertel 7967: table#LC_helpmenu_links {
7968: width: 100%;
7969: border: 1px solid black;
7970: background: $pgbg;
1.803 bisitz 7971: padding: 0;
1.397 albertel 7972: border-spacing: 1px;
7973: }
1.795 www 7974:
1.397 albertel 7975: table#LC_helpmenu_links tr td {
7976: padding: 1px;
7977: background: $tabbg;
1.399 albertel 7978: text-align: center;
7979: font-weight: bold;
1.397 albertel 7980: }
1.396 albertel 7981:
1.795 www 7982: table#LC_helpmenu_links a:link,
7983: table#LC_helpmenu_links a:visited,
1.397 albertel 7984: table#LC_helpmenu_links a:active {
7985: text-decoration: none;
7986: color: $font;
7987: }
1.795 www 7988:
1.397 albertel 7989: table#LC_helpmenu_links a:hover {
7990: text-decoration: underline;
7991: color: $vlink;
7992: }
1.396 albertel 7993:
1.417 albertel 7994: .LC_chrt_popup_exists {
7995: border: 1px solid #339933;
7996: margin: -1px;
7997: }
1.795 www 7998:
1.417 albertel 7999: .LC_chrt_popup_up {
8000: border: 1px solid yellow;
8001: margin: -1px;
8002: }
1.795 www 8003:
1.417 albertel 8004: .LC_chrt_popup {
8005: border: 1px solid #8888FF;
8006: background: #CCCCFF;
8007: }
1.795 www 8008:
1.421 albertel 8009: table.LC_pick_box {
8010: border-collapse: separate;
8011: background: white;
8012: border: 1px solid black;
8013: border-spacing: 1px;
8014: }
1.795 www 8015:
1.421 albertel 8016: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8017: background: $sidebg;
1.421 albertel 8018: font-weight: bold;
1.900 bisitz 8019: text-align: left;
1.740 bisitz 8020: vertical-align: top;
1.421 albertel 8021: width: 184px;
8022: padding: 8px;
8023: }
1.795 www 8024:
1.579 raeburn 8025: table.LC_pick_box td.LC_pick_box_value {
8026: text-align: left;
8027: padding: 8px;
8028: }
1.795 www 8029:
1.579 raeburn 8030: table.LC_pick_box td.LC_pick_box_select {
8031: text-align: left;
8032: padding: 8px;
8033: }
1.795 www 8034:
1.424 albertel 8035: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8036: padding: 0;
1.421 albertel 8037: height: 1px;
8038: background: black;
8039: }
1.795 www 8040:
1.421 albertel 8041: table.LC_pick_box td.LC_pick_box_submit {
8042: text-align: right;
8043: }
1.795 www 8044:
1.579 raeburn 8045: table.LC_pick_box td.LC_evenrow_value {
8046: text-align: left;
8047: padding: 8px;
8048: background-color: $data_table_light;
8049: }
1.795 www 8050:
1.579 raeburn 8051: table.LC_pick_box td.LC_oddrow_value {
8052: text-align: left;
8053: padding: 8px;
8054: background-color: $data_table_light;
8055: }
1.795 www 8056:
1.579 raeburn 8057: span.LC_helpform_receipt_cat {
8058: font-weight: bold;
8059: }
1.795 www 8060:
1.424 albertel 8061: table.LC_group_priv_box {
8062: background: white;
8063: border: 1px solid black;
8064: border-spacing: 1px;
8065: }
1.795 www 8066:
1.424 albertel 8067: table.LC_group_priv_box td.LC_pick_box_title {
8068: background: $tabbg;
8069: font-weight: bold;
8070: text-align: right;
8071: width: 184px;
8072: }
1.795 www 8073:
1.424 albertel 8074: table.LC_group_priv_box td.LC_groups_fixed {
8075: background: $data_table_light;
8076: text-align: center;
8077: }
1.795 www 8078:
1.424 albertel 8079: table.LC_group_priv_box td.LC_groups_optional {
8080: background: $data_table_dark;
8081: text-align: center;
8082: }
1.795 www 8083:
1.424 albertel 8084: table.LC_group_priv_box td.LC_groups_functionality {
8085: background: $data_table_darker;
8086: text-align: center;
8087: font-weight: bold;
8088: }
1.795 www 8089:
1.424 albertel 8090: table.LC_group_priv td {
8091: text-align: left;
1.803 bisitz 8092: padding: 0;
1.424 albertel 8093: }
8094:
8095: .LC_navbuttons {
8096: margin: 2ex 0ex 2ex 0ex;
8097: }
1.795 www 8098:
1.423 albertel 8099: .LC_topic_bar {
8100: font-weight: bold;
8101: background: $tabbg;
1.918 wenzelju 8102: margin: 1em 0em 1em 2em;
1.805 bisitz 8103: padding: 3px;
1.918 wenzelju 8104: font-size: 1.2em;
1.423 albertel 8105: }
1.795 www 8106:
1.423 albertel 8107: .LC_topic_bar span {
1.918 wenzelju 8108: left: 0.5em;
8109: position: absolute;
1.423 albertel 8110: vertical-align: middle;
1.918 wenzelju 8111: font-size: 1.2em;
1.423 albertel 8112: }
1.795 www 8113:
1.423 albertel 8114: table.LC_course_group_status {
8115: margin: 20px;
8116: }
1.795 www 8117:
1.423 albertel 8118: table.LC_status_selector td {
8119: vertical-align: top;
8120: text-align: center;
1.424 albertel 8121: padding: 4px;
8122: }
1.795 www 8123:
1.599 albertel 8124: div.LC_feedback_link {
1.616 albertel 8125: clear: both;
1.829 kalberla 8126: background: $sidebg;
1.779 bisitz 8127: width: 100%;
1.829 kalberla 8128: padding-bottom: 10px;
8129: border: 1px $tabbg solid;
1.833 kalberla 8130: height: 22px;
8131: line-height: 22px;
8132: padding-top: 5px;
8133: }
8134:
8135: div.LC_feedback_link img {
8136: height: 22px;
1.867 kalberla 8137: vertical-align:middle;
1.829 kalberla 8138: }
8139:
1.911 bisitz 8140: div.LC_feedback_link a {
1.829 kalberla 8141: text-decoration: none;
1.489 raeburn 8142: }
1.795 www 8143:
1.867 kalberla 8144: div.LC_comblock {
1.911 bisitz 8145: display:inline;
1.867 kalberla 8146: color:$font;
8147: font-size:90%;
8148: }
8149:
8150: div.LC_feedback_link div.LC_comblock {
8151: padding-left:5px;
8152: }
8153:
8154: div.LC_feedback_link div.LC_comblock a {
8155: color:$font;
8156: }
8157:
1.489 raeburn 8158: span.LC_feedback_link {
1.858 bisitz 8159: /* background: $feedback_link_bg; */
1.599 albertel 8160: font-size: larger;
8161: }
1.795 www 8162:
1.599 albertel 8163: span.LC_message_link {
1.858 bisitz 8164: /* background: $feedback_link_bg; */
1.599 albertel 8165: font-size: larger;
8166: position: absolute;
8167: right: 1em;
1.489 raeburn 8168: }
1.421 albertel 8169:
1.515 albertel 8170: table.LC_prior_tries {
1.524 albertel 8171: border: 1px solid #000000;
8172: border-collapse: separate;
8173: border-spacing: 1px;
1.515 albertel 8174: }
1.523 albertel 8175:
1.515 albertel 8176: table.LC_prior_tries td {
1.524 albertel 8177: padding: 2px;
1.515 albertel 8178: }
1.523 albertel 8179:
8180: .LC_answer_correct {
1.795 www 8181: background: lightgreen;
8182: color: darkgreen;
8183: padding: 6px;
1.523 albertel 8184: }
1.795 www 8185:
1.523 albertel 8186: .LC_answer_charged_try {
1.797 www 8187: background: #FFAAAA;
1.795 www 8188: color: darkred;
8189: padding: 6px;
1.523 albertel 8190: }
1.795 www 8191:
1.779 bisitz 8192: .LC_answer_not_charged_try,
1.523 albertel 8193: .LC_answer_no_grade,
8194: .LC_answer_late {
1.795 www 8195: background: lightyellow;
1.523 albertel 8196: color: black;
1.795 www 8197: padding: 6px;
1.523 albertel 8198: }
1.795 www 8199:
1.523 albertel 8200: .LC_answer_previous {
1.795 www 8201: background: lightblue;
8202: color: darkblue;
8203: padding: 6px;
1.523 albertel 8204: }
1.795 www 8205:
1.779 bisitz 8206: .LC_answer_no_message {
1.777 tempelho 8207: background: #FFFFFF;
8208: color: black;
1.795 www 8209: padding: 6px;
1.779 bisitz 8210: }
1.795 www 8211:
1.1334 raeburn 8212: .LC_answer_unknown,
8213: .LC_answer_warning {
1.779 bisitz 8214: background: orange;
8215: color: black;
1.795 www 8216: padding: 6px;
1.777 tempelho 8217: }
1.795 www 8218:
1.529 albertel 8219: span.LC_prior_numerical,
8220: span.LC_prior_string,
8221: span.LC_prior_custom,
8222: span.LC_prior_reaction,
8223: span.LC_prior_math {
1.925 bisitz 8224: font-family: $mono;
1.523 albertel 8225: white-space: pre;
8226: }
8227:
1.525 albertel 8228: span.LC_prior_string {
1.925 bisitz 8229: font-family: $mono;
1.525 albertel 8230: white-space: pre;
8231: }
8232:
1.523 albertel 8233: table.LC_prior_option {
8234: width: 100%;
8235: border-collapse: collapse;
8236: }
1.795 www 8237:
1.911 bisitz 8238: table.LC_prior_rank,
1.795 www 8239: table.LC_prior_match {
1.528 albertel 8240: border-collapse: collapse;
8241: }
1.795 www 8242:
1.528 albertel 8243: table.LC_prior_option tr td,
8244: table.LC_prior_rank tr td,
8245: table.LC_prior_match tr td {
1.524 albertel 8246: border: 1px solid #000000;
1.515 albertel 8247: }
8248:
1.855 bisitz 8249: .LC_nobreak {
1.544 albertel 8250: white-space: nowrap;
1.519 raeburn 8251: }
8252:
1.576 raeburn 8253: span.LC_cusr_emph {
8254: font-style: italic;
8255: }
8256:
1.633 raeburn 8257: span.LC_cusr_subheading {
8258: font-weight: normal;
8259: font-size: 85%;
8260: }
8261:
1.861 bisitz 8262: div.LC_docs_entry_move {
1.859 bisitz 8263: border: 1px solid #BBBBBB;
1.545 albertel 8264: background: #DDDDDD;
1.861 bisitz 8265: width: 22px;
1.859 bisitz 8266: padding: 1px;
8267: margin: 0;
1.545 albertel 8268: }
8269:
1.861 bisitz 8270: table.LC_data_table tr > td.LC_docs_entry_commands,
8271: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8272: font-size: x-small;
8273: }
1.795 www 8274:
1.861 bisitz 8275: .LC_docs_entry_parameter {
8276: white-space: nowrap;
8277: }
8278:
1.544 albertel 8279: .LC_docs_copy {
1.545 albertel 8280: color: #000099;
1.544 albertel 8281: }
1.795 www 8282:
1.544 albertel 8283: .LC_docs_cut {
1.545 albertel 8284: color: #550044;
1.544 albertel 8285: }
1.795 www 8286:
1.544 albertel 8287: .LC_docs_rename {
1.545 albertel 8288: color: #009900;
1.544 albertel 8289: }
1.795 www 8290:
1.544 albertel 8291: .LC_docs_remove {
1.545 albertel 8292: color: #990000;
8293: }
8294:
1.1284 raeburn 8295: .LC_docs_alias {
8296: color: #440055;
8297: }
8298:
1.1286 raeburn 8299: .LC_domprefs_email,
1.1284 raeburn 8300: .LC_docs_alias_name,
1.547 albertel 8301: .LC_docs_reinit_warn,
8302: .LC_docs_ext_edit {
8303: font-size: x-small;
8304: }
8305:
1.545 albertel 8306: table.LC_docs_adddocs td,
8307: table.LC_docs_adddocs th {
8308: border: 1px solid #BBBBBB;
8309: padding: 4px;
8310: background: #DDDDDD;
1.543 albertel 8311: }
8312:
1.584 albertel 8313: table.LC_sty_begin {
8314: background: #BBFFBB;
8315: }
1.795 www 8316:
1.584 albertel 8317: table.LC_sty_end {
8318: background: #FFBBBB;
8319: }
8320:
1.589 raeburn 8321: table.LC_double_column {
1.803 bisitz 8322: border-width: 0;
1.589 raeburn 8323: border-collapse: collapse;
8324: width: 100%;
8325: padding: 2px;
8326: }
8327:
8328: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8329: top: 2px;
1.589 raeburn 8330: left: 2px;
8331: width: 47%;
8332: vertical-align: top;
8333: }
8334:
8335: table.LC_double_column tr td.LC_right_col {
8336: top: 2px;
1.779 bisitz 8337: right: 2px;
1.589 raeburn 8338: width: 47%;
8339: vertical-align: top;
8340: }
8341:
1.591 raeburn 8342: div.LC_left_float {
8343: float: left;
8344: padding-right: 5%;
1.597 albertel 8345: padding-bottom: 4px;
1.591 raeburn 8346: }
8347:
8348: div.LC_clear_float_header {
1.597 albertel 8349: padding-bottom: 2px;
1.591 raeburn 8350: }
8351:
8352: div.LC_clear_float_footer {
1.597 albertel 8353: padding-top: 10px;
1.591 raeburn 8354: clear: both;
8355: }
8356:
1.597 albertel 8357: div.LC_grade_show_user {
1.941 bisitz 8358: /* border-left: 5px solid $sidebg; */
8359: border-top: 5px solid #000000;
8360: margin: 50px 0 0 0;
1.936 bisitz 8361: padding: 15px 0 5px 10px;
1.597 albertel 8362: }
1.795 www 8363:
1.936 bisitz 8364: div.LC_grade_show_user_odd_row {
1.941 bisitz 8365: /* border-left: 5px solid #000000; */
8366: }
8367:
8368: div.LC_grade_show_user div.LC_Box {
8369: margin-right: 50px;
1.597 albertel 8370: }
8371:
8372: div.LC_grade_submissions,
8373: div.LC_grade_message_center,
1.936 bisitz 8374: div.LC_grade_info_links {
1.597 albertel 8375: margin: 5px;
8376: width: 99%;
8377: background: #FFFFFF;
8378: }
1.795 www 8379:
1.597 albertel 8380: div.LC_grade_submissions_header,
1.936 bisitz 8381: div.LC_grade_message_center_header {
1.705 tempelho 8382: font-weight: bold;
8383: font-size: large;
1.597 albertel 8384: }
1.795 www 8385:
1.597 albertel 8386: div.LC_grade_submissions_body,
1.936 bisitz 8387: div.LC_grade_message_center_body {
1.597 albertel 8388: border: 1px solid black;
8389: width: 99%;
8390: background: #FFFFFF;
8391: }
1.795 www 8392:
1.613 albertel 8393: table.LC_scantron_action {
8394: width: 100%;
8395: }
1.795 www 8396:
1.613 albertel 8397: table.LC_scantron_action tr th {
1.698 harmsja 8398: font-weight:bold;
8399: font-style:normal;
1.613 albertel 8400: }
1.795 www 8401:
1.779 bisitz 8402: .LC_edit_problem_header,
1.614 albertel 8403: div.LC_edit_problem_footer {
1.705 tempelho 8404: font-weight: normal;
8405: font-size: medium;
1.602 albertel 8406: margin: 2px;
1.1060 bisitz 8407: background-color: $sidebg;
1.600 albertel 8408: }
1.795 www 8409:
1.600 albertel 8410: div.LC_edit_problem_header,
1.602 albertel 8411: div.LC_edit_problem_header div,
1.614 albertel 8412: div.LC_edit_problem_footer,
8413: div.LC_edit_problem_footer div,
1.602 albertel 8414: div.LC_edit_problem_editxml_header,
8415: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8416: z-index: 100;
1.600 albertel 8417: }
1.795 www 8418:
1.600 albertel 8419: div.LC_edit_problem_header_title {
1.705 tempelho 8420: font-weight: bold;
8421: font-size: larger;
1.602 albertel 8422: background: $tabbg;
8423: padding: 3px;
1.1060 bisitz 8424: margin: 0 0 5px 0;
1.602 albertel 8425: }
1.795 www 8426:
1.602 albertel 8427: table.LC_edit_problem_header_title {
8428: width: 100%;
1.600 albertel 8429: background: $tabbg;
1.602 albertel 8430: }
8431:
1.1205 golterma 8432: div.LC_edit_actionbar {
8433: background-color: $sidebg;
1.1218 droeschl 8434: margin: 0;
8435: padding: 0;
8436: line-height: 200%;
1.602 albertel 8437: }
1.795 www 8438:
1.1218 droeschl 8439: div.LC_edit_actionbar div{
8440: padding: 0;
8441: margin: 0;
8442: display: inline-block;
1.600 albertel 8443: }
1.795 www 8444:
1.1124 bisitz 8445: .LC_edit_opt {
8446: padding-left: 1em;
8447: white-space: nowrap;
8448: }
8449:
1.1152 golterma 8450: .LC_edit_problem_latexhelper{
8451: text-align: right;
8452: }
8453:
8454: #LC_edit_problem_colorful div{
8455: margin-left: 40px;
8456: }
8457:
1.1205 golterma 8458: #LC_edit_problem_codemirror div{
8459: margin-left: 0px;
8460: }
8461:
1.911 bisitz 8462: img.stift {
1.803 bisitz 8463: border-width: 0;
8464: vertical-align: middle;
1.677 riegler 8465: }
1.680 riegler 8466:
1.923 bisitz 8467: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8468: vertical-align: top;
1.777 tempelho 8469: }
1.795 www 8470:
1.716 raeburn 8471: div.LC_createcourse {
1.911 bisitz 8472: margin: 10px 10px 10px 10px;
1.716 raeburn 8473: }
8474:
1.917 raeburn 8475: .LC_dccid {
1.1130 raeburn 8476: float: right;
1.917 raeburn 8477: margin: 0.2em 0 0 0;
8478: padding: 0;
8479: font-size: 90%;
8480: display:none;
8481: }
8482:
1.897 wenzelju 8483: ol.LC_primary_menu a:hover,
1.721 harmsja 8484: ol#LC_MenuBreadcrumbs a:hover,
8485: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8486: ul#LC_secondary_menu a:hover,
1.721 harmsja 8487: .LC_FormSectionClearButton input:hover
1.795 www 8488: ul.LC_TabContent li:hover a {
1.952 onken 8489: color:$button_hover;
1.911 bisitz 8490: text-decoration:none;
1.693 droeschl 8491: }
8492:
1.779 bisitz 8493: h1 {
1.911 bisitz 8494: padding: 0;
8495: line-height:130%;
1.693 droeschl 8496: }
1.698 harmsja 8497:
1.911 bisitz 8498: h2,
8499: h3,
8500: h4,
8501: h5,
8502: h6 {
8503: margin: 5px 0 5px 0;
8504: padding: 0;
8505: line-height:130%;
1.693 droeschl 8506: }
1.795 www 8507:
8508: .LC_hcell {
1.911 bisitz 8509: padding:3px 15px 3px 15px;
8510: margin: 0;
8511: background-color:$tabbg;
8512: color:$fontmenu;
8513: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8514: }
1.795 www 8515:
1.840 bisitz 8516: .LC_Box > .LC_hcell {
1.911 bisitz 8517: margin: 0 -10px 10px -10px;
1.835 bisitz 8518: }
8519:
1.721 harmsja 8520: .LC_noBorder {
1.911 bisitz 8521: border: 0;
1.698 harmsja 8522: }
1.693 droeschl 8523:
1.721 harmsja 8524: .LC_FormSectionClearButton input {
1.911 bisitz 8525: background-color:transparent;
8526: border: none;
8527: cursor:pointer;
8528: text-decoration:underline;
1.693 droeschl 8529: }
1.763 bisitz 8530:
8531: .LC_help_open_topic {
1.911 bisitz 8532: color: #FFFFFF;
8533: background-color: #EEEEFF;
8534: margin: 1px;
8535: padding: 4px;
8536: border: 1px solid #000033;
8537: white-space: nowrap;
8538: /* vertical-align: middle; */
1.759 neumanie 8539: }
1.693 droeschl 8540:
1.911 bisitz 8541: dl,
8542: ul,
8543: div,
8544: fieldset {
8545: margin: 10px 10px 10px 0;
8546: /* overflow: hidden; */
1.693 droeschl 8547: }
1.795 www 8548:
1.1404 raeburn 8549: fieldset#LC_selectuser {
8550: margin: 0;
8551: padding: 0;
8552: }
8553:
1.1211 raeburn 8554: article.geogebraweb div {
8555: margin: 0;
8556: }
8557:
1.838 bisitz 8558: fieldset > legend {
1.911 bisitz 8559: font-weight: bold;
8560: padding: 0 5px 0 5px;
1.838 bisitz 8561: }
8562:
1.813 bisitz 8563: #LC_nav_bar {
1.911 bisitz 8564: float: left;
1.995 raeburn 8565: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8566: margin: 0 0 2px 0;
1.807 droeschl 8567: }
8568:
1.916 droeschl 8569: #LC_realm {
8570: margin: 0.2em 0 0 0;
8571: padding: 0;
8572: font-weight: bold;
8573: text-align: center;
1.995 raeburn 8574: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8575: }
8576:
1.911 bisitz 8577: #LC_nav_bar em {
8578: font-weight: bold;
8579: font-style: normal;
1.807 droeschl 8580: }
8581:
1.897 wenzelju 8582: ol.LC_primary_menu {
1.934 droeschl 8583: margin: 0;
1.1076 raeburn 8584: padding: 0;
1.807 droeschl 8585: }
8586:
1.852 droeschl 8587: ol#LC_PathBreadcrumbs {
1.911 bisitz 8588: margin: 0;
1.693 droeschl 8589: }
8590:
1.897 wenzelju 8591: ol.LC_primary_menu li {
1.1076 raeburn 8592: color: RGB(80, 80, 80);
8593: vertical-align: middle;
8594: text-align: left;
8595: list-style: none;
1.1205 golterma 8596: position: relative;
1.1076 raeburn 8597: float: left;
1.1205 golterma 8598: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8599: line-height: 1.5em;
1.1076 raeburn 8600: }
8601:
1.1205 golterma 8602: ol.LC_primary_menu li a,
8603: ol.LC_primary_menu li p {
1.1076 raeburn 8604: display: block;
8605: margin: 0;
8606: padding: 0 5px 0 10px;
8607: text-decoration: none;
8608: }
8609:
1.1205 golterma 8610: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8611: display: inline-block;
8612: width: 95%;
8613: text-align: left;
8614: }
8615:
8616: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8617: display: inline-block;
8618: width: 5%;
8619: float: right;
8620: text-align: right;
8621: font-size: 70%;
8622: }
8623:
8624: ol.LC_primary_menu ul {
1.1076 raeburn 8625: display: none;
1.1205 golterma 8626: width: 15em;
1.1076 raeburn 8627: background-color: $data_table_light;
1.1205 golterma 8628: position: absolute;
8629: top: 100%;
1.1076 raeburn 8630: }
8631:
1.1205 golterma 8632: ol.LC_primary_menu ul ul {
8633: left: 100%;
8634: top: 0;
8635: }
8636:
8637: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8638: display: block;
8639: position: absolute;
8640: margin: 0;
8641: padding: 0;
1.1078 raeburn 8642: z-index: 2;
1.1076 raeburn 8643: }
8644:
8645: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8646: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8647: font-size: 90%;
1.911 bisitz 8648: vertical-align: top;
1.1076 raeburn 8649: float: none;
1.1079 raeburn 8650: border-left: 1px solid black;
8651: border-right: 1px solid black;
1.1205 golterma 8652: /* A dark bottom border to visualize different menu options;
8653: overwritten in the create_submenu routine for the last border-bottom of the menu */
8654: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8655: }
8656:
1.1205 golterma 8657: ol.LC_primary_menu li li p:hover {
8658: color:$button_hover;
8659: text-decoration:none;
8660: background-color:$data_table_dark;
1.1076 raeburn 8661: }
8662:
8663: ol.LC_primary_menu li li a:hover {
8664: color:$button_hover;
8665: background-color:$data_table_dark;
1.693 droeschl 8666: }
8667:
1.1205 golterma 8668: /* Font-size equal to the size of the predecessors*/
8669: ol.LC_primary_menu li:hover li li {
8670: font-size: 100%;
8671: }
8672:
1.897 wenzelju 8673: ol.LC_primary_menu li img {
1.911 bisitz 8674: vertical-align: bottom;
1.934 droeschl 8675: height: 1.1em;
1.1077 raeburn 8676: margin: 0.2em 0 0 0;
1.693 droeschl 8677: }
8678:
1.897 wenzelju 8679: ol.LC_primary_menu a {
1.911 bisitz 8680: color: RGB(80, 80, 80);
8681: text-decoration: none;
1.693 droeschl 8682: }
1.795 www 8683:
1.949 droeschl 8684: ol.LC_primary_menu a.LC_new_message {
8685: font-weight:bold;
8686: color: darkred;
8687: }
8688:
1.975 raeburn 8689: ol.LC_docs_parameters {
8690: margin-left: 0;
8691: padding: 0;
8692: list-style: none;
8693: }
8694:
8695: ol.LC_docs_parameters li {
8696: margin: 0;
8697: padding-right: 20px;
8698: display: inline;
8699: }
8700:
1.976 raeburn 8701: ol.LC_docs_parameters li:before {
8702: content: "\\002022 \\0020";
8703: }
8704:
8705: li.LC_docs_parameters_title {
8706: font-weight: bold;
8707: }
8708:
8709: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8710: content: "";
8711: }
8712:
1.897 wenzelju 8713: ul#LC_secondary_menu {
1.1107 raeburn 8714: clear: right;
1.911 bisitz 8715: color: $fontmenu;
8716: background: $tabbg;
8717: list-style: none;
8718: padding: 0;
8719: margin: 0;
8720: width: 100%;
1.995 raeburn 8721: text-align: left;
1.1107 raeburn 8722: float: left;
1.808 droeschl 8723: }
8724:
1.897 wenzelju 8725: ul#LC_secondary_menu li {
1.911 bisitz 8726: font-weight: bold;
8727: line-height: 1.8em;
1.1107 raeburn 8728: border-right: 1px solid black;
8729: float: left;
8730: }
8731:
8732: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8733: background-color: $data_table_light;
8734: }
8735:
8736: ul#LC_secondary_menu li a {
1.911 bisitz 8737: padding: 0 0.8em;
1.1107 raeburn 8738: }
8739:
8740: ul#LC_secondary_menu li ul {
8741: display: none;
8742: }
8743:
8744: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8745: display: block;
8746: position: absolute;
8747: margin: 0;
8748: padding: 0;
8749: list-style:none;
8750: float: none;
8751: background-color: $data_table_light;
8752: z-index: 2;
8753: margin-left: -1px;
8754: }
8755:
8756: ul#LC_secondary_menu li ul li {
8757: font-size: 90%;
8758: vertical-align: top;
8759: border-left: 1px solid black;
1.911 bisitz 8760: border-right: 1px solid black;
1.1119 raeburn 8761: background-color: $data_table_light;
1.1107 raeburn 8762: list-style:none;
8763: float: none;
8764: }
8765:
8766: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8767: background-color: $data_table_dark;
1.807 droeschl 8768: }
8769:
1.847 tempelho 8770: ul.LC_TabContent {
1.911 bisitz 8771: display:block;
8772: background: $sidebg;
8773: border-bottom: solid 1px $lg_border_color;
8774: list-style:none;
1.1020 raeburn 8775: margin: -1px -10px 0 -10px;
1.911 bisitz 8776: padding: 0;
1.693 droeschl 8777: }
8778:
1.795 www 8779: ul.LC_TabContent li,
8780: ul.LC_TabContentBigger li {
1.911 bisitz 8781: float:left;
1.741 harmsja 8782: }
1.795 www 8783:
1.897 wenzelju 8784: ul#LC_secondary_menu li a {
1.911 bisitz 8785: color: $fontmenu;
8786: text-decoration: none;
1.693 droeschl 8787: }
1.795 www 8788:
1.721 harmsja 8789: ul.LC_TabContent {
1.952 onken 8790: min-height:20px;
1.721 harmsja 8791: }
1.795 www 8792:
8793: ul.LC_TabContent li {
1.911 bisitz 8794: vertical-align:middle;
1.959 onken 8795: padding: 0 16px 0 10px;
1.911 bisitz 8796: background-color:$tabbg;
8797: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8798: border-left: solid 1px $font;
1.721 harmsja 8799: }
1.795 www 8800:
1.847 tempelho 8801: ul.LC_TabContent .right {
1.911 bisitz 8802: float:right;
1.847 tempelho 8803: }
8804:
1.911 bisitz 8805: ul.LC_TabContent li a,
8806: ul.LC_TabContent li {
8807: color:rgb(47,47,47);
8808: text-decoration:none;
8809: font-size:95%;
8810: font-weight:bold;
1.952 onken 8811: min-height:20px;
8812: }
8813:
1.959 onken 8814: ul.LC_TabContent li a:hover,
8815: ul.LC_TabContent li a:focus {
1.952 onken 8816: color: $button_hover;
1.959 onken 8817: background:none;
8818: outline:none;
1.952 onken 8819: }
8820:
8821: ul.LC_TabContent li:hover {
8822: color: $button_hover;
8823: cursor:pointer;
1.721 harmsja 8824: }
1.795 www 8825:
1.911 bisitz 8826: ul.LC_TabContent li.active {
1.952 onken 8827: color: $font;
1.911 bisitz 8828: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8829: border-bottom:solid 1px #FFFFFF;
8830: cursor: default;
1.744 ehlerst 8831: }
1.795 www 8832:
1.959 onken 8833: ul.LC_TabContent li.active a {
8834: color:$font;
8835: background:#FFFFFF;
8836: outline: none;
8837: }
1.1047 raeburn 8838:
8839: ul.LC_TabContent li.goback {
8840: float: left;
8841: border-left: none;
8842: }
8843:
1.870 tempelho 8844: #maincoursedoc {
1.911 bisitz 8845: clear:both;
1.870 tempelho 8846: }
8847:
8848: ul.LC_TabContentBigger {
1.911 bisitz 8849: display:block;
8850: list-style:none;
8851: padding: 0;
1.870 tempelho 8852: }
8853:
1.795 www 8854: ul.LC_TabContentBigger li {
1.911 bisitz 8855: vertical-align:bottom;
8856: height: 30px;
8857: font-size:110%;
8858: font-weight:bold;
8859: color: #737373;
1.841 tempelho 8860: }
8861:
1.957 onken 8862: ul.LC_TabContentBigger li.active {
8863: position: relative;
8864: top: 1px;
8865: }
8866:
1.870 tempelho 8867: ul.LC_TabContentBigger li a {
1.911 bisitz 8868: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8869: height: 30px;
8870: line-height: 30px;
8871: text-align: center;
8872: display: block;
8873: text-decoration: none;
1.958 onken 8874: outline: none;
1.741 harmsja 8875: }
1.795 www 8876:
1.870 tempelho 8877: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8878: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8879: color:$font;
1.744 ehlerst 8880: }
1.795 www 8881:
1.870 tempelho 8882: ul.LC_TabContentBigger li b {
1.911 bisitz 8883: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8884: display: block;
8885: float: left;
8886: padding: 0 30px;
1.957 onken 8887: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8888: }
8889:
1.956 onken 8890: ul.LC_TabContentBigger li:hover b {
8891: color:$button_hover;
8892: }
8893:
1.870 tempelho 8894: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8895: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8896: color:$font;
1.957 onken 8897: border: 0;
1.741 harmsja 8898: }
1.693 droeschl 8899:
1.870 tempelho 8900:
1.862 bisitz 8901: ul.LC_CourseBreadcrumbs {
8902: background: $sidebg;
1.1020 raeburn 8903: height: 2em;
1.862 bisitz 8904: padding-left: 10px;
1.1020 raeburn 8905: margin: 0;
1.862 bisitz 8906: list-style-position: inside;
8907: }
8908:
1.911 bisitz 8909: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8910: ol#LC_PathBreadcrumbs {
1.911 bisitz 8911: padding-left: 10px;
8912: margin: 0;
1.933 droeschl 8913: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8914: }
8915:
1.911 bisitz 8916: ol#LC_MenuBreadcrumbs li,
8917: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8918: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8919: display: inline;
1.933 droeschl 8920: white-space: normal;
1.693 droeschl 8921: }
8922:
1.823 bisitz 8923: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8924: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8925: text-decoration: none;
8926: font-size:90%;
1.693 droeschl 8927: }
1.795 www 8928:
1.969 droeschl 8929: ol#LC_MenuBreadcrumbs h1 {
8930: display: inline;
8931: font-size: 90%;
8932: line-height: 2.5em;
8933: margin: 0;
8934: padding: 0;
8935: }
8936:
1.795 www 8937: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8938: text-decoration:none;
8939: font-size:100%;
8940: font-weight:bold;
1.693 droeschl 8941: }
1.795 www 8942:
1.840 bisitz 8943: .LC_Box {
1.911 bisitz 8944: border: solid 1px $lg_border_color;
8945: padding: 0 10px 10px 10px;
1.746 neumanie 8946: }
1.795 www 8947:
1.1020 raeburn 8948: .LC_DocsBox {
8949: border: solid 1px $lg_border_color;
8950: padding: 0 0 10px 10px;
8951: }
8952:
1.795 www 8953: .LC_AboutMe_Image {
1.911 bisitz 8954: float:left;
8955: margin-right:10px;
1.747 neumanie 8956: }
1.795 www 8957:
8958: .LC_Clear_AboutMe_Image {
1.911 bisitz 8959: clear:left;
1.747 neumanie 8960: }
1.795 www 8961:
1.721 harmsja 8962: dl.LC_ListStyleClean dt {
1.911 bisitz 8963: padding-right: 5px;
8964: display: table-header-group;
1.693 droeschl 8965: }
8966:
1.721 harmsja 8967: dl.LC_ListStyleClean dd {
1.911 bisitz 8968: display: table-row;
1.693 droeschl 8969: }
8970:
1.721 harmsja 8971: .LC_ListStyleClean,
8972: .LC_ListStyleSimple,
8973: .LC_ListStyleNormal,
1.795 www 8974: .LC_ListStyleSpecial {
1.911 bisitz 8975: /* display:block; */
8976: list-style-position: inside;
8977: list-style-type: none;
8978: overflow: hidden;
8979: padding: 0;
1.693 droeschl 8980: }
8981:
1.721 harmsja 8982: .LC_ListStyleSimple li,
8983: .LC_ListStyleSimple dd,
8984: .LC_ListStyleNormal li,
8985: .LC_ListStyleNormal dd,
8986: .LC_ListStyleSpecial li,
1.795 www 8987: .LC_ListStyleSpecial dd {
1.911 bisitz 8988: margin: 0;
8989: padding: 5px 5px 5px 10px;
8990: clear: both;
1.693 droeschl 8991: }
8992:
1.721 harmsja 8993: .LC_ListStyleClean li,
8994: .LC_ListStyleClean dd {
1.911 bisitz 8995: padding-top: 0;
8996: padding-bottom: 0;
1.693 droeschl 8997: }
8998:
1.721 harmsja 8999: .LC_ListStyleSimple dd,
1.795 www 9000: .LC_ListStyleSimple li {
1.911 bisitz 9001: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9002: }
9003:
1.721 harmsja 9004: .LC_ListStyleSpecial li,
9005: .LC_ListStyleSpecial dd {
1.911 bisitz 9006: list-style-type: none;
9007: background-color: RGB(220, 220, 220);
9008: margin-bottom: 4px;
1.693 droeschl 9009: }
9010:
1.721 harmsja 9011: table.LC_SimpleTable {
1.911 bisitz 9012: margin:5px;
9013: border:solid 1px $lg_border_color;
1.795 www 9014: }
1.693 droeschl 9015:
1.721 harmsja 9016: table.LC_SimpleTable tr {
1.911 bisitz 9017: padding: 0;
9018: border:solid 1px $lg_border_color;
1.693 droeschl 9019: }
1.795 www 9020:
9021: table.LC_SimpleTable thead {
1.911 bisitz 9022: background:rgb(220,220,220);
1.693 droeschl 9023: }
9024:
1.721 harmsja 9025: div.LC_columnSection {
1.911 bisitz 9026: display: block;
9027: clear: both;
9028: overflow: hidden;
9029: margin: 0;
1.693 droeschl 9030: }
9031:
1.721 harmsja 9032: div.LC_columnSection>* {
1.911 bisitz 9033: float: left;
9034: margin: 10px 20px 10px 0;
9035: overflow:hidden;
1.693 droeschl 9036: }
1.721 harmsja 9037:
1.795 www 9038: table em {
1.911 bisitz 9039: font-weight: bold;
9040: font-style: normal;
1.748 schulted 9041: }
1.795 www 9042:
1.779 bisitz 9043: table.LC_tableBrowseRes,
1.795 www 9044: table.LC_tableOfContent {
1.911 bisitz 9045: border:none;
9046: border-spacing: 1px;
9047: padding: 3px;
9048: background-color: #FFFFFF;
9049: font-size: 90%;
1.753 droeschl 9050: }
1.789 droeschl 9051:
1.911 bisitz 9052: table.LC_tableOfContent {
9053: border-collapse: collapse;
1.789 droeschl 9054: }
9055:
1.771 droeschl 9056: table.LC_tableBrowseRes a,
1.768 schulted 9057: table.LC_tableOfContent a {
1.911 bisitz 9058: background-color: transparent;
9059: text-decoration: none;
1.753 droeschl 9060: }
9061:
1.795 www 9062: table.LC_tableOfContent img {
1.911 bisitz 9063: border: none;
9064: height: 1.3em;
9065: vertical-align: text-bottom;
9066: margin-right: 0.3em;
1.753 droeschl 9067: }
1.757 schulted 9068:
1.795 www 9069: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9070: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9071: }
9072:
1.795 www 9073: a#LC_content_toolbar_everything {
1.911 bisitz 9074: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9075: }
9076:
1.795 www 9077: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9078: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9079: }
9080:
1.795 www 9081: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9082: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9083: }
9084:
1.795 www 9085: a#LC_content_toolbar_changefolder {
1.911 bisitz 9086: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9087: }
9088:
1.795 www 9089: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9090: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9091: }
9092:
1.1043 raeburn 9093: a#LC_content_toolbar_edittoplevel {
9094: background-image:url(/res/adm/pages/edittoplevel.gif);
9095: }
9096:
1.1384 raeburn 9097: a#LC_content_toolbar_printout {
9098: background-image:url(/res/adm/pages/printout.gif);
9099: }
9100:
1.795 www 9101: ul#LC_toolbar li a:hover {
1.911 bisitz 9102: background-position: bottom center;
1.757 schulted 9103: }
9104:
1.795 www 9105: ul#LC_toolbar {
1.911 bisitz 9106: padding: 0;
9107: margin: 2px;
9108: list-style:none;
9109: position:relative;
9110: background-color:white;
1.1082 raeburn 9111: overflow: auto;
1.757 schulted 9112: }
9113:
1.795 www 9114: ul#LC_toolbar li {
1.911 bisitz 9115: border:1px solid white;
9116: padding: 0;
9117: margin: 0;
9118: float: left;
9119: display:inline;
9120: vertical-align:middle;
1.1082 raeburn 9121: white-space: nowrap;
1.911 bisitz 9122: }
1.757 schulted 9123:
1.783 amueller 9124:
1.795 www 9125: a.LC_toolbarItem {
1.911 bisitz 9126: display:block;
9127: padding: 0;
9128: margin: 0;
9129: height: 32px;
9130: width: 32px;
9131: color:white;
9132: border: none;
9133: background-repeat:no-repeat;
9134: background-color:transparent;
1.757 schulted 9135: }
9136:
1.915 droeschl 9137: ul.LC_funclist {
9138: margin: 0;
9139: padding: 0.5em 1em 0.5em 0;
9140: }
9141:
1.933 droeschl 9142: ul.LC_funclist > li:first-child {
9143: font-weight:bold;
9144: margin-left:0.8em;
9145: }
9146:
1.915 droeschl 9147: ul.LC_funclist + ul.LC_funclist {
9148: /*
9149: left border as a seperator if we have more than
9150: one list
9151: */
9152: border-left: 1px solid $sidebg;
9153: /*
9154: this hides the left border behind the border of the
9155: outer box if element is wrapped to the next 'line'
9156: */
9157: margin-left: -1px;
9158: }
9159:
1.843 bisitz 9160: ul.LC_funclist li {
1.915 droeschl 9161: display: inline;
1.782 bisitz 9162: white-space: nowrap;
1.915 droeschl 9163: margin: 0 0 0 25px;
9164: line-height: 150%;
1.782 bisitz 9165: }
9166:
1.974 wenzelju 9167: .LC_hidden {
9168: display: none;
9169: }
9170:
1.1030 www 9171: .LCmodal-overlay {
9172: position:fixed;
9173: top:0;
9174: right:0;
9175: bottom:0;
9176: left:0;
9177: height:100%;
9178: width:100%;
9179: margin:0;
9180: padding:0;
9181: background:#999;
9182: opacity:.75;
9183: filter: alpha(opacity=75);
9184: -moz-opacity: 0.75;
9185: z-index:101;
9186: }
9187:
9188: * html .LCmodal-overlay {
9189: position: absolute;
9190: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9191: }
9192:
9193: .LCmodal-window {
9194: position:fixed;
9195: top:50%;
9196: left:50%;
9197: margin:0;
9198: padding:0;
9199: z-index:102;
9200: }
9201:
9202: * html .LCmodal-window {
9203: position:absolute;
9204: }
9205:
9206: .LCclose-window {
9207: position:absolute;
9208: width:32px;
9209: height:32px;
9210: right:8px;
9211: top:8px;
9212: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9213: text-indent:-99999px;
9214: overflow:hidden;
9215: cursor:pointer;
9216: }
9217:
1.1369 raeburn 9218: .LCisDisabled {
9219: cursor: not-allowed;
9220: opacity: 0.5;
9221: }
9222:
9223: a[aria-disabled="true"] {
9224: color: currentColor;
9225: display: inline-block; /* For IE11/ MS Edge bug */
9226: pointer-events: none;
9227: text-decoration: none;
9228: }
9229:
1.1335 raeburn 9230: pre.LC_wordwrap {
9231: white-space: pre-wrap;
9232: white-space: -moz-pre-wrap;
9233: white-space: -pre-wrap;
9234: white-space: -o-pre-wrap;
9235: word-wrap: break-word;
9236: }
9237:
1.1100 raeburn 9238: /*
1.1231 damieng 9239: styles used for response display
9240: */
9241: div.LC_radiofoil, div.LC_rankfoil {
9242: margin: .5em 0em .5em 0em;
9243: }
9244: table.LC_itemgroup {
9245: margin-top: 1em;
9246: }
9247:
9248: /*
1.1100 raeburn 9249: styles used by TTH when "Default set of options to pass to tth/m
9250: when converting TeX" in course settings has been set
9251:
9252: option passed: -t
9253:
9254: */
9255:
9256: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9257: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9258: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9259: td div.norm {line-height:normal;}
9260:
9261: /*
9262: option passed -y3
9263: */
9264:
9265: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9266: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9267: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9268:
1.1230 damieng 9269: /*
9270: sections with roles, for content only
9271: */
9272: section[class^="role-"] {
9273: padding-left: 10px;
9274: padding-right: 5px;
9275: margin-top: 8px;
9276: margin-bottom: 8px;
9277: border: 1px solid #2A4;
9278: border-radius: 5px;
9279: box-shadow: 0px 1px 1px #BBB;
9280: }
9281: section[class^="role-"]>h1 {
9282: position: relative;
9283: margin: 0px;
9284: padding-top: 10px;
9285: padding-left: 40px;
9286: }
9287: section[class^="role-"]>h1:before {
9288: position: absolute;
9289: left: -5px;
9290: top: 5px;
9291: }
9292: section.role-activity>h1:before {
9293: content:url('/adm/daxe/images/section_icons/activity.png');
9294: }
9295: section.role-advice>h1:before {
9296: content:url('/adm/daxe/images/section_icons/advice.png');
9297: }
9298: section.role-bibliography>h1:before {
9299: content:url('/adm/daxe/images/section_icons/bibliography.png');
9300: }
9301: section.role-citation>h1:before {
9302: content:url('/adm/daxe/images/section_icons/citation.png');
9303: }
9304: section.role-conclusion>h1:before {
9305: content:url('/adm/daxe/images/section_icons/conclusion.png');
9306: }
9307: section.role-definition>h1:before {
9308: content:url('/adm/daxe/images/section_icons/definition.png');
9309: }
9310: section.role-demonstration>h1:before {
9311: content:url('/adm/daxe/images/section_icons/demonstration.png');
9312: }
9313: section.role-example>h1:before {
9314: content:url('/adm/daxe/images/section_icons/example.png');
9315: }
9316: section.role-explanation>h1:before {
9317: content:url('/adm/daxe/images/section_icons/explanation.png');
9318: }
9319: section.role-introduction>h1:before {
9320: content:url('/adm/daxe/images/section_icons/introduction.png');
9321: }
9322: section.role-method>h1:before {
9323: content:url('/adm/daxe/images/section_icons/method.png');
9324: }
9325: section.role-more_information>h1:before {
9326: content:url('/adm/daxe/images/section_icons/more_information.png');
9327: }
9328: section.role-objectives>h1:before {
9329: content:url('/adm/daxe/images/section_icons/objectives.png');
9330: }
9331: section.role-prerequisites>h1:before {
9332: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9333: }
9334: section.role-remark>h1:before {
9335: content:url('/adm/daxe/images/section_icons/remark.png');
9336: }
9337: section.role-reminder>h1:before {
9338: content:url('/adm/daxe/images/section_icons/reminder.png');
9339: }
9340: section.role-summary>h1:before {
9341: content:url('/adm/daxe/images/section_icons/summary.png');
9342: }
9343: section.role-syntax>h1:before {
9344: content:url('/adm/daxe/images/section_icons/syntax.png');
9345: }
9346: section.role-warning>h1:before {
9347: content:url('/adm/daxe/images/section_icons/warning.png');
9348: }
9349:
1.1269 raeburn 9350: #LC_minitab_header {
9351: float:left;
9352: width:100%;
9353: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9354: font-size:93%;
9355: line-height:normal;
9356: margin: 0.5em 0 0.5em 0;
9357: }
9358: #LC_minitab_header ul {
9359: margin:0;
9360: padding:10px 10px 0;
9361: list-style:none;
9362: }
9363: #LC_minitab_header li {
9364: float:left;
9365: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9366: margin:0;
9367: padding:0 0 0 9px;
9368: }
9369: #LC_minitab_header a {
9370: display:block;
9371: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9372: padding:5px 15px 4px 6px;
9373: }
9374: #LC_minitab_header #LC_current_minitab {
9375: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9376: }
9377: #LC_minitab_header #LC_current_minitab a {
9378: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9379: padding-bottom:5px;
9380: }
9381:
9382:
1.343 albertel 9383: END
9384: }
9385:
1.306 albertel 9386: =pod
9387:
9388: =item * &headtag()
9389:
9390: Returns a uniform footer for LON-CAPA web pages.
9391:
1.307 albertel 9392: Inputs: $title - optional title for the head
9393: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9394: $args - optional arguments
1.319 albertel 9395: force_register - if is true call registerurl so the remote is
9396: informed
1.415 albertel 9397: redirect -> array ref of
9398: 1- seconds before redirect occurs
9399: 2- url to redirect to
9400: 3- whether the side effect should occur
1.315 albertel 9401: (side effect of setting
9402: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9403: redirected to)
9404: 4- whether the redirect target should be
9405: the opener of the current (pop-up)
9406: window (side effect of setting
9407: $env{'internal.head.to_opener'} to
9408: 1, if true.
1.1388 raeburn 9409: 5- whether encrypt check should be skipped
1.352 albertel 9410: domain -> force to color decorate a page for a specific
9411: domain
9412: function -> force usage of a specific rolish color scheme
9413: bgcolor -> override the default page bgcolor
1.460 albertel 9414: no_auto_mt_title
9415: -> prevent &mt()ing the title arg
1.464 albertel 9416:
1.306 albertel 9417: =cut
9418:
9419: sub headtag {
1.313 albertel 9420: my ($title,$head_extra,$args) = @_;
1.306 albertel 9421:
1.363 albertel 9422: my $function = $args->{'function'} || &get_users_function();
9423: my $domain = $args->{'domain'} || &determinedomain();
9424: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9425: my $httphost = $args->{'use_absolute'};
1.418 albertel 9426: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9427: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9428: #time(),
1.418 albertel 9429: $env{'environment.color.timestamp'},
1.363 albertel 9430: $function,$domain,$bgcolor);
9431:
1.369 www 9432: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9433:
1.308 albertel 9434: my $result =
9435: '<head>'.
1.1160 raeburn 9436: &font_settings($args);
1.319 albertel 9437:
1.1188 raeburn 9438: my $inhibitprint;
9439: if ($args->{'print_suppress'}) {
9440: $inhibitprint = &print_suppression();
9441: }
1.1064 raeburn 9442:
1.1439 raeburn 9443: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9444: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9445: }
1.962 droeschl 9446: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9447: $result .= Apache::lonxml::display_title();
1.319 albertel 9448: }
1.436 albertel 9449: if (!$args->{'no_nav_bar'}
9450: && !$args->{'only_body'}
1.1438 raeburn 9451: && !$args->{'frameset'}
9452: && !$args->{'switchserver'}) {
1.1154 raeburn 9453: $result .= &help_menu_js($httphost);
1.1032 www 9454: $result.=&modal_window();
1.1038 www 9455: $result.=&togglebox_script();
1.1034 www 9456: $result.=&wishlist_window();
1.1041 www 9457: $result.=&LCprogressbarUpdate_script();
1.1034 www 9458: } else {
9459: if ($args->{'add_modal'}) {
9460: $result.=&modal_window();
9461: }
9462: if ($args->{'add_wishlist'}) {
9463: $result.=&wishlist_window();
9464: }
1.1038 www 9465: if ($args->{'add_togglebox'}) {
9466: $result.=&togglebox_script();
9467: }
1.1041 www 9468: if ($args->{'add_progressbar'}) {
9469: $result.=&LCprogressbarUpdate_script();
9470: }
1.436 albertel 9471: }
1.314 albertel 9472: if (ref($args->{'redirect'})) {
1.1388 raeburn 9473: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9474: if (!$skip_enc_check) {
9475: $url = &Apache::lonenc::check_encrypt($url);
9476: }
1.414 albertel 9477: if (!$inhibit_continue) {
9478: $env{'internal.head.redirect'} = $url;
9479: }
1.1386 raeburn 9480: $result.=<<"ADDMETA";
1.313 albertel 9481: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9482: ADDMETA
9483: if ($to_opener) {
9484: $env{'internal.head.to_opener'} = 1;
9485: my $dest = &js_escape($url);
9486: my $timeout = int($time * 1000);
9487: $result .=<<"ENDJS";
9488: <script type="text/javascript">
9489: // <![CDATA[
9490: function LC_To_Opener() {
9491: var dest = '$dest';
9492: if (dest != '') {
9493: if (window.opener != null && !window.opener.closed) {
9494: window.opener.location.href=dest;
9495: window.close();
9496: } else {
9497: window.location.href=dest;
9498: }
9499: }
9500: }
9501: \$(document).ready(function () {
9502: setTimeout('LC_To_Opener()',$timeout);
9503: });
9504: // ]]>
9505: </script>
9506: ENDJS
9507: } else {
9508: $result.=<<"ADDMETA";
1.344 albertel 9509: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9510: ADDMETA
1.1386 raeburn 9511: }
1.1210 raeburn 9512: } else {
9513: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9514: my $requrl = $env{'request.uri'};
9515: if ($requrl eq '') {
9516: $requrl = $ENV{'REQUEST_URI'};
9517: $requrl =~ s/\?.+$//;
9518: }
9519: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9520: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9521: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9522: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9523: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9524: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9525: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9526: my ($offload,$offloadoth);
1.1210 raeburn 9527: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9528: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9529: $offload = 1;
1.1353 raeburn 9530: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9531: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9532: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9533: $offloadoth = 1;
9534: $dom_in_use = $env{'user.domain'};
9535: }
9536: }
1.1340 raeburn 9537: }
9538: }
9539: unless ($offload) {
9540: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9541: if ($domdefs{'offloadoth'}{$lonhost}) {
9542: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9543: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9544: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9545: $offload = 1;
1.1352 raeburn 9546: $offloadoth = 1;
1.1340 raeburn 9547: $dom_in_use = $env{'user.domain'};
9548: }
1.1210 raeburn 9549: }
1.1340 raeburn 9550: }
9551: }
9552: }
9553: if ($offload) {
1.1358 raeburn 9554: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9555: if (($newserver eq '') && ($offloadoth)) {
9556: my @domains = &Apache::lonnet::current_machine_domains();
9557: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9558: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9559: }
9560: }
1.1340 raeburn 9561: if (($newserver) && ($newserver ne $lonhost)) {
9562: my $numsec = 5;
9563: my $timeout = $numsec * 1000;
9564: my ($newurl,$locknum,%locks,$msg);
9565: if ($env{'request.role.adv'}) {
9566: ($locknum,%locks) = &Apache::lonnet::get_locks();
9567: }
9568: my $disable_submit = 0;
9569: if ($requrl =~ /$LONCAPA::assess_re/) {
9570: $disable_submit = 1;
9571: }
9572: if ($locknum) {
9573: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9574: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9575: join(", ",sort(values(%locks)))."\n";
9576: if (&show_course()) {
9577: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9578: } else {
9579: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9580: }
1.1340 raeburn 9581: } else {
9582: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9583: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9584: }
9585: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9586: $newurl = '/adm/switchserver?otherserver='.$newserver;
9587: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9588: $newurl .= '&role='.$env{'request.role'};
9589: }
9590: if ($env{'request.symb'}) {
9591: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9592: if ($shownsymb =~ m{^/enc/}) {
9593: my $reqdmajor = 2;
9594: my $reqdminor = 11;
9595: my $reqdsubminor = 3;
9596: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9597: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9598: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9599: if (($major eq '' && $minor eq '') ||
9600: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9601: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9602: ($reqdsubminor > $subminor))))) {
9603: undef($shownsymb);
9604: }
1.1210 raeburn 9605: }
1.1340 raeburn 9606: if ($shownsymb) {
9607: &js_escape(\$shownsymb);
9608: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9609: }
1.1340 raeburn 9610: } else {
9611: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9612: &js_escape(\$shownurl);
9613: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9614: }
1.1340 raeburn 9615: }
9616: &js_escape(\$msg);
9617: $result.=<<OFFLOAD
1.1210 raeburn 9618: <meta http-equiv="pragma" content="no-cache" />
9619: <script type="text/javascript">
1.1215 raeburn 9620: // <![CDATA[
1.1210 raeburn 9621: function LC_Offload_Now() {
9622: var dest = "$newurl";
9623: if (dest != '') {
9624: window.location.href="$newurl";
9625: }
9626: }
1.1214 raeburn 9627: \$(document).ready(function () {
9628: window.alert('$msg');
9629: if ($disable_submit) {
1.1210 raeburn 9630: \$(".LC_hwk_submit").prop("disabled", true);
9631: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9632: }
9633: setTimeout('LC_Offload_Now()', $timeout);
9634: });
1.1215 raeburn 9635: // ]]>
1.1210 raeburn 9636: </script>
9637: OFFLOAD
9638: }
9639: }
9640: }
9641: }
9642: }
1.313 albertel 9643: }
1.306 albertel 9644: if (!defined($title)) {
9645: $title = 'The LearningOnline Network with CAPA';
9646: }
1.460 albertel 9647: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9648: if ($title =~ /^LON-CAPA\s+/) {
9649: $result .= '<title> '.$title.'</title>';
9650: } else {
9651: $result .= '<title> LON-CAPA '.$title.'</title>';
9652: }
9653: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9654: if (!$args->{'frameset'}) {
9655: $result .= ' /';
9656: }
9657: $result .= '>'
1.1064 raeburn 9658: .$inhibitprint
1.414 albertel 9659: .$head_extra;
1.1242 raeburn 9660: my $clientmobile;
9661: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9662: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9663: } else {
9664: $clientmobile = $env{'browser.mobile'};
9665: }
9666: if ($clientmobile) {
1.1137 raeburn 9667: $result .= '
1.1435 raeburn 9668: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9669: <meta name="apple-mobile-web-app-capable" content="yes" />';
9670: }
1.1278 raeburn 9671: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9672: return $result.'</head>';
1.306 albertel 9673: }
9674:
9675: =pod
9676:
1.340 albertel 9677: =item * &font_settings()
9678:
9679: Returns neccessary <meta> to set the proper encoding
9680:
1.1160 raeburn 9681: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9682:
9683: =cut
9684:
9685: sub font_settings {
1.1160 raeburn 9686: my ($args) = @_;
1.340 albertel 9687: my $headerstring='';
1.1160 raeburn 9688: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9689: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9690: $headerstring.=
9691: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9692: if (!$args->{'frameset'}) {
9693: $headerstring.= ' /';
9694: }
9695: $headerstring .= '>'."\n";
1.340 albertel 9696: }
9697: return $headerstring;
9698: }
9699:
1.341 albertel 9700: =pod
9701:
1.1064 raeburn 9702: =item * &print_suppression()
9703:
9704: In course context returns css which causes the body to be blank when media="print",
9705: if printout generation is unavailable for the current resource.
9706:
9707: This could be because:
9708:
9709: (a) printstartdate is in the future
9710:
9711: (b) printenddate is in the past
9712:
9713: (c) there is an active exam block with "printout"
9714: functionality blocked
9715:
9716: Users with pav, pfo or evb privileges are exempt.
9717:
9718: Inputs: none
9719:
9720: =cut
9721:
9722:
9723: sub print_suppression {
9724: my $noprint;
9725: if ($env{'request.course.id'}) {
9726: my $scope = $env{'request.course.id'};
9727: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9728: (&Apache::lonnet::allowed('pfo',$scope))) {
9729: return;
9730: }
9731: if ($env{'request.course.sec'} ne '') {
9732: $scope .= "/$env{'request.course.sec'}";
9733: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9734: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9735: return;
1.1064 raeburn 9736: }
9737: }
9738: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9739: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9740: my $clientip = &Apache::lonnet::get_requestor_ip();
9741: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9742: if ($blocked) {
9743: my $checkrole = "cm./$cdom/$cnum";
9744: if ($env{'request.course.sec'} ne '') {
9745: $checkrole .= "/$env{'request.course.sec'}";
9746: }
9747: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9748: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9749: $noprint = 1;
9750: }
9751: }
9752: unless ($noprint) {
9753: my $symb = &Apache::lonnet::symbread();
9754: if ($symb ne '') {
9755: my $navmap = Apache::lonnavmaps::navmap->new();
9756: if (ref($navmap)) {
9757: my $res = $navmap->getBySymb($symb);
9758: if (ref($res)) {
9759: if (!$res->resprintable()) {
9760: $noprint = 1;
9761: }
9762: }
9763: }
9764: }
9765: }
9766: if ($noprint) {
9767: return <<"ENDSTYLE";
9768: <style type="text/css" media="print">
9769: body { display:none }
9770: </style>
9771: ENDSTYLE
9772: }
9773: }
9774: return;
9775: }
9776:
9777: =pod
9778:
1.341 albertel 9779: =item * &xml_begin()
9780:
9781: Returns the needed doctype and <html>
9782:
9783: Inputs: none
9784:
9785: =cut
9786:
9787: sub xml_begin {
1.1168 raeburn 9788: my ($is_frameset) = @_;
1.341 albertel 9789: my $output='';
9790:
9791: if ($env{'browser.mathml'}) {
9792: $output='<?xml version="1.0"?>'
9793: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9794: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9795:
9796: # .'<!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">] >'
9797: .'<!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">'
9798: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9799: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9800: } elsif ($is_frameset) {
9801: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9802: '<html>'."\n";
1.341 albertel 9803: } else {
1.1168 raeburn 9804: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9805: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9806: }
9807: return $output;
9808: }
1.340 albertel 9809:
9810: =pod
9811:
1.306 albertel 9812: =item * &start_page()
9813:
9814: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9815:
1.648 raeburn 9816: Inputs:
9817:
9818: =over 4
9819:
9820: $title - optional title for the page
9821:
9822: $head_extra - optional extra HTML to incude inside the <head>
9823:
9824: $args - additional optional args supported are:
9825:
9826: =over 8
9827:
9828: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9829: arg on
1.814 bisitz 9830: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9831: add_entries -> additional attributes to add to the <body>
9832: domain -> force to color decorate a page for a
1.317 albertel 9833: specific domain
1.648 raeburn 9834: function -> force usage of a specific rolish color
1.317 albertel 9835: scheme
1.648 raeburn 9836: redirect -> see &headtag()
9837: bgcolor -> override the default page bg color
9838: js_ready -> return a string ready for being used in
1.317 albertel 9839: a javascript writeln
1.648 raeburn 9840: html_encode -> return a string ready for being used in
1.320 albertel 9841: a html attribute
1.648 raeburn 9842: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9843: $forcereg arg
1.648 raeburn 9844: frameset -> if true will start with a <frameset>
1.330 albertel 9845: rather than <body>
1.648 raeburn 9846: skip_phases -> hash ref of
1.338 albertel 9847: head -> skip the <html><head> generation
9848: body -> skip all <body> generation
1.648 raeburn 9849: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9850: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9851: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9852: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9853: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9854: to override those values, or add to them, specify the value to
9855: include in the style attribute to include in the div tag by using
9856: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9857: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9858: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9859: group -> includes the current group, if page is for a
1.1274 raeburn 9860: specific group
9861: use_absolute -> for request for external resource or syllabus, this
9862: will contain https://<hostname> if server uses
9863: https (as per hosts.tab), but request is for http
9864: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9865: links_disabled -> Links in primary and secondary menus are disabled
9866: (Can enable them once page has loaded - see lonroles.pm
9867: for an example).
1.1380 raeburn 9868: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9869:
1.648 raeburn 9870: =back
1.460 albertel 9871:
1.648 raeburn 9872: =back
1.562 albertel 9873:
1.306 albertel 9874: =cut
9875:
9876: sub start_page {
1.309 albertel 9877: my ($title,$head_extra,$args) = @_;
1.318 albertel 9878: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9879:
1.315 albertel 9880: $env{'internal.start_page'}++;
1.1359 raeburn 9881: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9882:
1.338 albertel 9883: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9884: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9885: }
1.1316 raeburn 9886:
9887: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9888: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9889: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9890: $args->{'no_primary_menu'} = 1;
9891: }
9892: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9893: $args->{'no_inline_menu'} = 1;
9894: }
9895: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9896: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9897: }
9898: } else {
9899: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9900: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9901: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9902: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9903: $args->{'no_primary_menu'} = 1;
9904: }
9905: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9906: $args->{'no_inline_menu'} = 1;
9907: }
9908: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9909: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9910: }
9911: }
9912: }
1.1316 raeburn 9913: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9914: $env{'course.'.$env{'request.course.id'}.'.domain'},
9915: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9916: } elsif ($env{'request.course.id'}) {
9917: my $expiretime=600;
9918: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9919: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9920: }
9921: my ($deeplinkmenu,$menuref);
9922: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9923: if ($menucoll) {
9924: if (ref($menuref) eq 'HASH') {
9925: %menu = %{$menuref};
9926: }
9927: if ($menu{'top'} eq 'n') {
9928: $args->{'no_primary_menu'} = 1;
9929: }
9930: if ($menu{'inline'} eq 'n') {
9931: unless (&Apache::lonnet::allowed('opa')) {
9932: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9933: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9934: my $crstype = &course_type();
9935: my $now = time;
9936: my $ccrole;
9937: if ($crstype eq 'Community') {
9938: $ccrole = 'co';
9939: } else {
9940: $ccrole = 'cc';
9941: }
9942: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9943: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9944: if ((($start) && ($start<0)) ||
9945: (($end) && ($end<$now)) ||
9946: (($start) && ($now<$start))) {
9947: $args->{'no_inline_menu'} = 1;
9948: }
9949: } else {
9950: $args->{'no_inline_menu'} = 1;
9951: }
9952: }
9953: }
9954: }
1.1316 raeburn 9955: }
1.1359 raeburn 9956:
1.1385 raeburn 9957: my $showncrumbs;
1.338 albertel 9958: if (! exists($args->{'skip_phases'}{'body'}) ) {
9959: if ($args->{'frameset'}) {
9960: my $attr_string = &make_attr_string($args->{'force_register'},
9961: $args->{'add_entries'});
9962: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9963: } else {
9964: $result .=
9965: &bodytag($title,
9966: $args->{'function'}, $args->{'add_entries'},
9967: $args->{'only_body'}, $args->{'domain'},
9968: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9969: $args->{'bgcolor'}, $args,
1.1385 raeburn 9970: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9971: \%menu,\$showncrumbs);
1.831 bisitz 9972: }
1.330 albertel 9973: }
1.338 albertel 9974:
1.315 albertel 9975: if ($args->{'js_ready'}) {
1.713 kaisler 9976: $result = &js_ready($result);
1.315 albertel 9977: }
1.320 albertel 9978: if ($args->{'html_encode'}) {
1.713 kaisler 9979: $result = &html_encode($result);
9980: }
9981:
1.813 bisitz 9982: # Preparation for new and consistent functionlist at top of screen
9983: # if ($args->{'functionlist'}) {
9984: # $result .= &build_functionlist();
9985: #}
9986:
1.964 droeschl 9987: # Don't add anything more if only_body wanted or in const space
9988: return $result if $args->{'only_body'}
9989: || $env{'request.state'} eq 'construct';
1.813 bisitz 9990:
9991: #Breadcrumbs
1.758 kaisler 9992: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 9993: unless ($showncrumbs) {
1.758 kaisler 9994: &Apache::lonhtmlcommon::clear_breadcrumbs();
9995: #if any br links exists, add them to the breadcrumbs
9996: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9997: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9998: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9999: }
10000: }
1.1096 raeburn 10001: # if @advtools array contains items add then to the breadcrumbs
10002: if (@advtools > 0) {
10003: &Apache::lonmenu::advtools_crumbs(@advtools);
10004: }
1.1272 raeburn 10005: my $menulink;
10006: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10007: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10008: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10009: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10010: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10011: (!$env{'request.role.adv'}))) {
10012: $menulink = 0;
10013: } else {
10014: undef($menulink);
10015: }
1.1385 raeburn 10016: my $linkprotout;
10017: if ($env{'request.deeplink.login'}) {
10018: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10019: if ($linkprotout) {
10020: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10021: }
10022: }
1.758 kaisler 10023: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10024: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10025: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10026: '',$menulink,'',
10027: $args->{'bread_crumbs_style'});
1.1237 raeburn 10028: } else {
1.1437 raeburn 10029: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10030: $args->{'bread_crumbs_style'});
1.758 kaisler 10031: }
1.1385 raeburn 10032: }
1.320 albertel 10033: }
1.315 albertel 10034: return $result;
1.306 albertel 10035: }
10036:
10037: sub end_page {
1.315 albertel 10038: my ($args) = @_;
10039: $env{'internal.end_page'}++;
1.330 albertel 10040: my $result;
1.335 albertel 10041: if ($args->{'discussion'}) {
10042: my ($target,$parser);
10043: if (ref($args->{'discussion'})) {
10044: ($target,$parser) =($args->{'discussion'}{'target'},
10045: $args->{'discussion'}{'parser'});
10046: }
10047: $result .= &Apache::lonxml::xmlend($target,$parser);
10048: }
1.330 albertel 10049: if ($args->{'frameset'}) {
10050: $result .= '</frameset>';
10051: } else {
1.635 raeburn 10052: $result .= &endbodytag($args);
1.330 albertel 10053: }
1.1080 raeburn 10054: unless ($args->{'notbody'}) {
10055: $result .= "\n</html>";
10056: }
1.330 albertel 10057:
1.315 albertel 10058: if ($args->{'js_ready'}) {
1.317 albertel 10059: $result = &js_ready($result);
1.315 albertel 10060: }
1.335 albertel 10061:
1.320 albertel 10062: if ($args->{'html_encode'}) {
10063: $result = &html_encode($result);
10064: }
1.335 albertel 10065:
1.315 albertel 10066: return $result;
10067: }
10068:
1.1359 raeburn 10069: sub menucoll_in_effect {
10070: my ($menucoll,$deeplinkmenu,%menu);
10071: if ($env{'request.course.id'}) {
10072: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10073: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10074: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10075: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10076: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10077: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10078: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10079: my $navmap = Apache::lonnavmaps::navmap->new();
10080: if (ref($navmap)) {
10081: $deeplink = $navmap->get_mapparam(undef,
10082: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10083: '0.deeplink');
1.1370 raeburn 10084: } else {
10085: $check_login_symb = 1;
1.1362 raeburn 10086: }
10087: } else {
1.1370 raeburn 10088: my $symb = &Apache::lonnet::symbread();
10089: if ($symb) {
10090: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10091: } else {
10092: $check_login_symb = 1;
10093: }
1.1362 raeburn 10094: }
10095: } else {
1.1370 raeburn 10096: $check_login_symb = 1;
10097: }
10098: if ($check_login_symb) {
1.1362 raeburn 10099: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10100: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10101: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10102: my $navmap = Apache::lonnavmaps::navmap->new();
10103: if (ref($navmap)) {
10104: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10105: }
10106: } else {
10107: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10108: }
10109: }
1.1359 raeburn 10110: if ($deeplink ne '') {
1.1378 raeburn 10111: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10112: if ($display =~ /^\d+$/) {
10113: $deeplinkmenu = 1;
10114: $menucoll = $display;
10115: }
10116: }
10117: }
10118: if ($menucoll) {
10119: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10120: }
10121: }
10122: return ($menucoll,$deeplinkmenu,\%menu);
10123: }
10124:
1.1362 raeburn 10125: sub deeplink_login_symb {
10126: my ($cnum,$cdom) = @_;
10127: my $login_symb;
10128: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10129: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10130: }
10131: return $login_symb;
10132: }
10133:
10134: sub symb_from_tinyurl {
10135: my ($url,$cnum,$cdom) = @_;
10136: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10137: my $key = $1;
10138: my ($tinyurl,$login);
10139: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10140: if (defined($cached)) {
10141: $tinyurl = $result;
10142: } else {
10143: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10144: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10145: if ($currtiny{$key} ne '') {
10146: $tinyurl = $currtiny{$key};
10147: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10148: }
1.1364 raeburn 10149: }
10150: if ($tinyurl ne '') {
10151: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10152: if (wantarray) {
10153: return ($cnumreq,$symb);
10154: } elsif ($cnumreq eq $cnum) {
10155: return $symb;
1.1362 raeburn 10156: }
10157: }
10158: }
1.1364 raeburn 10159: if (wantarray) {
10160: return ();
10161: } else {
10162: return;
10163: }
1.1362 raeburn 10164: }
10165:
1.1405 raeburn 10166: sub usable_exttools {
10167: my %tooltypes;
10168: if ($env{'request.course.id'}) {
10169: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10170: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10171: %tooltypes = (
10172: crs => 1,
10173: dom => 1,
10174: );
10175: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10176: $tooltypes{'crs'} = 1;
10177: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10178: $tooltypes{'dom'} = 1;
10179: }
10180: } else {
10181: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10182: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10183: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10184: if ($crstype eq '') {
10185: $crstype = 'course';
10186: }
10187: if ($crstype eq 'course') {
10188: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10189: $crstype = 'official';
10190: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10191: $crstype = 'textbook';
10192: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10193: $crstype = 'lti';
10194: } else {
10195: $crstype = 'unofficial';
10196: }
10197: }
10198: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10199: if ($domdefaults{$crstype.'domexttool'}) {
10200: $tooltypes{'dom'} = 1;
10201: }
10202: if ($domdefaults{$crstype.'exttool'}) {
10203: $tooltypes{'crs'} = 1;
10204: }
10205: }
10206: }
10207: return %tooltypes;
10208: }
10209:
1.1034 www 10210: sub wishlist_window {
10211: return(<<'ENDWISHLIST');
1.1046 raeburn 10212: <script type="text/javascript">
1.1034 www 10213: // <![CDATA[
10214: // <!-- BEGIN LON-CAPA Internal
10215: function set_wishlistlink(title, path) {
10216: if (!title) {
10217: title = document.title;
10218: title = title.replace(/^LON-CAPA /,'');
10219: }
1.1175 raeburn 10220: title = encodeURIComponent(title);
1.1203 raeburn 10221: title = title.replace("'","\\\'");
1.1034 www 10222: if (!path) {
10223: path = location.pathname;
10224: }
1.1175 raeburn 10225: path = encodeURIComponent(path);
1.1203 raeburn 10226: path = path.replace("'","\\\'");
1.1034 www 10227: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10228: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10229: }
10230: // END LON-CAPA Internal -->
10231: // ]]>
10232: </script>
10233: ENDWISHLIST
10234: }
10235:
1.1030 www 10236: sub modal_window {
10237: return(<<'ENDMODAL');
1.1046 raeburn 10238: <script type="text/javascript">
1.1030 www 10239: // <![CDATA[
10240: // <!-- BEGIN LON-CAPA Internal
10241: var modalWindow = {
10242: parent:"body",
10243: windowId:null,
10244: content:null,
10245: width:null,
10246: height:null,
10247: close:function()
10248: {
10249: $(".LCmodal-window").remove();
10250: $(".LCmodal-overlay").remove();
10251: },
10252: open:function()
10253: {
10254: var modal = "";
10255: modal += "<div class=\"LCmodal-overlay\"></div>";
10256: 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;\">";
10257: modal += this.content;
10258: modal += "</div>";
10259:
10260: $(this.parent).append(modal);
10261:
10262: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10263: $(".LCclose-window").click(function(){modalWindow.close();});
10264: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10265: }
10266: };
1.1140 raeburn 10267: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10268: {
1.1266 raeburn 10269: source = source.replace(/'/g,"'");
1.1030 www 10270: modalWindow.windowId = "myModal";
10271: modalWindow.width = width;
10272: modalWindow.height = height;
1.1196 raeburn 10273: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10274: modalWindow.open();
1.1208 raeburn 10275: };
1.1030 www 10276: // END LON-CAPA Internal -->
10277: // ]]>
10278: </script>
10279: ENDMODAL
10280: }
10281:
10282: sub modal_link {
1.1140 raeburn 10283: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10284: unless ($width) { $width=480; }
10285: unless ($height) { $height=400; }
1.1031 www 10286: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10287: unless ($transparency) { $transparency='true'; }
10288:
1.1074 raeburn 10289: my $target_attr;
10290: if (defined($target)) {
10291: $target_attr = 'target="'.$target.'"';
10292: }
10293: return <<"ENDLINK";
1.1336 raeburn 10294: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10295: ENDLINK
1.1030 www 10296: }
10297:
1.1032 www 10298: sub modal_adhoc_script {
1.1365 raeburn 10299: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10300: my $mathjax;
10301: if ($possmathjax) {
10302: $mathjax = <<'ENDJAX';
10303: if (typeof MathJax == 'object') {
10304: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10305: }
10306: ENDJAX
10307: }
1.1032 www 10308: return (<<ENDADHOC);
1.1046 raeburn 10309: <script type="text/javascript">
1.1032 www 10310: // <![CDATA[
10311: var $funcname = function()
10312: {
10313: modalWindow.windowId = "myModal";
10314: modalWindow.width = $width;
10315: modalWindow.height = $height;
10316: modalWindow.content = '$content';
10317: modalWindow.open();
1.1365 raeburn 10318: $mathjax
1.1032 www 10319: };
10320: // ]]>
10321: </script>
10322: ENDADHOC
10323: }
10324:
1.1041 www 10325: sub modal_adhoc_inner {
1.1365 raeburn 10326: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10327: my $innerwidth=$width-20;
10328: $content=&js_ready(
1.1140 raeburn 10329: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10330: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10331: $content.
1.1041 www 10332: &end_scrollbox().
1.1140 raeburn 10333: &end_page()
1.1041 www 10334: );
1.1365 raeburn 10335: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10336: }
10337:
10338: sub modal_adhoc_window {
1.1365 raeburn 10339: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10340: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10341: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10342: }
10343:
10344: sub modal_adhoc_launch {
10345: my ($funcname,$width,$height,$content)=@_;
10346: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10347: <script type="text/javascript">
10348: // <![CDATA[
10349: $funcname();
10350: // ]]>
10351: </script>
10352: ENDLAUNCH
10353: }
10354:
10355: sub modal_adhoc_close {
10356: return (<<ENDCLOSE);
10357: <script type="text/javascript">
10358: // <![CDATA[
10359: modalWindow.close();
10360: // ]]>
10361: </script>
10362: ENDCLOSE
10363: }
10364:
1.1038 www 10365: sub togglebox_script {
10366: return(<<ENDTOGGLE);
10367: <script type="text/javascript">
10368: // <![CDATA[
10369: function LCtoggleDisplay(id,hidetext,showtext) {
10370: link = document.getElementById(id + "link").childNodes[0];
10371: with (document.getElementById(id).style) {
10372: if (display == "none" ) {
10373: display = "inline";
10374: link.nodeValue = hidetext;
10375: } else {
10376: display = "none";
10377: link.nodeValue = showtext;
10378: }
10379: }
10380: }
10381: // ]]>
10382: </script>
10383: ENDTOGGLE
10384: }
10385:
1.1039 www 10386: sub start_togglebox {
10387: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10388: unless ($heading) { $heading=''; } else { $heading.=' '; }
10389: unless ($showtext) { $showtext=&mt('show'); }
10390: unless ($hidetext) { $hidetext=&mt('hide'); }
10391: unless ($headerbg) { $headerbg='#FFFFFF'; }
10392: return &start_data_table().
10393: &start_data_table_header_row().
10394: '<td bgcolor="'.$headerbg.'">'.$heading.
10395: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10396: $showtext.'\')">'.$showtext.'</a>]</td>'.
10397: &end_data_table_header_row().
10398: '<tr id="'.$id.'" style="display:none""><td>';
10399: }
10400:
10401: sub end_togglebox {
10402: return '</td></tr>'.&end_data_table();
10403: }
10404:
1.1041 www 10405: sub LCprogressbar_script {
1.1302 raeburn 10406: my ($id,$number_to_do)=@_;
10407: if ($number_to_do) {
10408: return(<<ENDPROGRESS);
1.1041 www 10409: <script type="text/javascript">
10410: // <![CDATA[
1.1045 www 10411: \$('#progressbar$id').progressbar({
1.1041 www 10412: value: 0,
10413: change: function(event, ui) {
10414: var newVal = \$(this).progressbar('option', 'value');
10415: \$('.pblabel', this).text(LCprogressTxt);
10416: }
10417: });
10418: // ]]>
10419: </script>
10420: ENDPROGRESS
1.1302 raeburn 10421: } else {
10422: return(<<ENDPROGRESS);
10423: <script type="text/javascript">
10424: // <![CDATA[
10425: \$('#progressbar$id').progressbar({
10426: value: false,
10427: create: function(event, ui) {
10428: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10429: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10430: }
10431: });
10432: // ]]>
10433: </script>
10434: ENDPROGRESS
10435: }
1.1041 www 10436: }
10437:
10438: sub LCprogressbarUpdate_script {
10439: return(<<ENDPROGRESSUPDATE);
10440: <style type="text/css">
10441: .ui-progressbar { position:relative; }
1.1302 raeburn 10442: .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 10443: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10444: </style>
10445: <script type="text/javascript">
10446: // <![CDATA[
1.1045 www 10447: var LCprogressTxt='---';
10448:
1.1302 raeburn 10449: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10450: LCprogressTxt=progresstext;
1.1302 raeburn 10451: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10452: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10453: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10454: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10455: } else {
10456: \$('#progressbar'+id).progressbar('value',percent);
10457: }
1.1041 www 10458: }
10459: // ]]>
10460: </script>
10461: ENDPROGRESSUPDATE
10462: }
10463:
1.1042 www 10464: my $LClastpercent;
1.1045 www 10465: my $LCidcnt;
10466: my $LCcurrentid;
1.1042 www 10467:
1.1041 www 10468: sub LCprogressbar {
1.1302 raeburn 10469: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10470: $LClastpercent=0;
1.1045 www 10471: $LCidcnt++;
10472: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10473: my ($starting,$content);
10474: if ($number_to_do) {
10475: $starting=&mt('Starting');
10476: $content=(<<ENDPROGBAR);
10477: $preamble
1.1045 www 10478: <div id="progressbar$LCcurrentid">
1.1041 www 10479: <span class="pblabel">$starting</span>
10480: </div>
10481: ENDPROGBAR
1.1302 raeburn 10482: } else {
10483: $starting=&mt('Loading...');
10484: $LClastpercent='false';
10485: $content=(<<ENDPROGBAR);
10486: $preamble
10487: <div id="progressbar$LCcurrentid">
10488: <div class="progress-label">$starting</div>
10489: </div>
10490: ENDPROGBAR
10491: }
10492: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10493: }
10494:
10495: sub LCprogressbarUpdate {
1.1302 raeburn 10496: my ($r,$val,$text,$number_to_do)=@_;
10497: if ($number_to_do) {
10498: unless ($val) {
10499: if ($LClastpercent) {
10500: $val=$LClastpercent;
10501: } else {
10502: $val=0;
10503: }
10504: }
10505: if ($val<0) { $val=0; }
10506: if ($val>100) { $val=0; }
10507: $LClastpercent=$val;
10508: unless ($text) { $text=$val.'%'; }
10509: } else {
10510: $val = 'false';
1.1042 www 10511: }
1.1041 www 10512: $text=&js_ready($text);
1.1044 www 10513: &r_print($r,<<ENDUPDATE);
1.1041 www 10514: <script type="text/javascript">
10515: // <![CDATA[
1.1302 raeburn 10516: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10517: // ]]>
10518: </script>
10519: ENDUPDATE
1.1035 www 10520: }
10521:
1.1042 www 10522: sub LCprogressbarClose {
10523: my ($r)=@_;
10524: $LClastpercent=0;
1.1044 www 10525: &r_print($r,<<ENDCLOSE);
1.1042 www 10526: <script type="text/javascript">
10527: // <![CDATA[
1.1045 www 10528: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10529: // ]]>
10530: </script>
10531: ENDCLOSE
1.1044 www 10532: }
10533:
10534: sub r_print {
10535: my ($r,$to_print)=@_;
10536: if ($r) {
10537: $r->print($to_print);
10538: $r->rflush();
10539: } else {
10540: print($to_print);
10541: }
1.1042 www 10542: }
10543:
1.320 albertel 10544: sub html_encode {
10545: my ($result) = @_;
10546:
1.322 albertel 10547: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10548:
10549: return $result;
10550: }
1.1044 www 10551:
1.317 albertel 10552: sub js_ready {
10553: my ($result) = @_;
10554:
1.323 albertel 10555: $result =~ s/[\n\r]/ /xmsg;
10556: $result =~ s/\\/\\\\/xmsg;
10557: $result =~ s/'/\\'/xmsg;
1.372 albertel 10558: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10559:
10560: return $result;
10561: }
10562:
1.315 albertel 10563: sub validate_page {
10564: if ( exists($env{'internal.start_page'})
1.316 albertel 10565: && $env{'internal.start_page'} > 1) {
10566: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10567: $env{'internal.start_page'}.' '.
1.316 albertel 10568: $ENV{'request.filename'});
1.315 albertel 10569: }
10570: if ( exists($env{'internal.end_page'})
1.316 albertel 10571: && $env{'internal.end_page'} > 1) {
10572: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10573: $env{'internal.end_page'}.' '.
1.316 albertel 10574: $env{'request.filename'});
1.315 albertel 10575: }
10576: if ( exists($env{'internal.start_page'})
10577: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10578: &Apache::lonnet::logthis('start_page called without end_page '.
10579: $env{'request.filename'});
1.315 albertel 10580: }
10581: if ( ! exists($env{'internal.start_page'})
10582: && exists($env{'internal.end_page'})) {
1.316 albertel 10583: &Apache::lonnet::logthis('end_page called without start_page'.
10584: $env{'request.filename'});
1.315 albertel 10585: }
1.306 albertel 10586: }
1.315 albertel 10587:
1.996 www 10588:
10589: sub start_scrollbox {
1.1140 raeburn 10590: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10591: unless ($outerwidth) { $outerwidth='520px'; }
10592: unless ($width) { $width='500px'; }
10593: unless ($height) { $height='200px'; }
1.1075 raeburn 10594: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10595: if ($id ne '') {
1.1140 raeburn 10596: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10597: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10598: }
1.1075 raeburn 10599: if ($bgcolor ne '') {
10600: $tdcol = "background-color: $bgcolor;";
10601: }
1.1137 raeburn 10602: my $nicescroll_js;
10603: if ($env{'browser.mobile'}) {
1.1140 raeburn 10604: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10605: }
10606: return <<"END";
10607: $nicescroll_js
10608:
10609: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10610: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10611: END
10612: }
10613:
10614: sub end_scrollbox {
10615: return '</div></td></tr></table>';
10616: }
10617:
10618: sub nicescroll_javascript {
10619: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10620: my %options;
10621: if (ref($cursor) eq 'HASH') {
10622: %options = %{$cursor};
10623: }
10624: unless ($options{'railalign'} =~ /^left|right$/) {
10625: $options{'railalign'} = 'left';
10626: }
10627: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10628: my $function = &get_users_function();
10629: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10630: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10631: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10632: }
1.1140 raeburn 10633: }
10634: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10635: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10636: $options{'cursoropacity'}='1.0';
10637: }
1.1140 raeburn 10638: } else {
10639: $options{'cursoropacity'}='1.0';
10640: }
10641: if ($options{'cursorfixedheight'} eq 'none') {
10642: delete($options{'cursorfixedheight'});
10643: } else {
10644: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10645: }
10646: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10647: delete($options{'railoffset'});
10648: }
10649: my @niceoptions;
10650: while (my($key,$value) = each(%options)) {
10651: if ($value =~ /^\{.+\}$/) {
10652: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10653: } else {
1.1140 raeburn 10654: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10655: }
1.1140 raeburn 10656: }
10657: my $nicescroll_js = '
1.1137 raeburn 10658: $(document).ready(
1.1140 raeburn 10659: function() {
10660: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10661: }
1.1137 raeburn 10662: );
10663: ';
1.1140 raeburn 10664: if ($framecheck) {
10665: $nicescroll_js .= '
10666: function expand_div(caller) {
10667: if (top === self) {
10668: document.getElementById("'.$id.'").style.width = "auto";
10669: document.getElementById("'.$id.'").style.height = "auto";
10670: } else {
10671: try {
10672: if (parent.frames) {
10673: if (parent.frames.length > 1) {
10674: var framesrc = parent.frames[1].location.href;
10675: var currsrc = framesrc.replace(/\#.*$/,"");
10676: if ((caller == "search") || (currsrc == "'.$location.'")) {
10677: document.getElementById("'.$id.'").style.width = "auto";
10678: document.getElementById("'.$id.'").style.height = "auto";
10679: }
10680: }
10681: }
10682: } catch (e) {
10683: return;
10684: }
1.1137 raeburn 10685: }
1.1140 raeburn 10686: return;
1.996 www 10687: }
1.1140 raeburn 10688: ';
10689: }
10690: if ($needjsready) {
10691: $nicescroll_js = '
10692: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10693: } else {
10694: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10695: }
10696: return $nicescroll_js;
1.996 www 10697: }
10698:
1.318 albertel 10699: sub simple_error_page {
1.1150 bisitz 10700: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10701: my %displayargs;
1.1151 raeburn 10702: if (ref($args) eq 'HASH') {
10703: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10704: if ($args->{'only_body'}) {
10705: $displayargs{'only_body'} = 1;
10706: }
10707: if ($args->{'no_nav_bar'}) {
10708: $displayargs{'no_nav_bar'} = 1;
10709: }
1.1151 raeburn 10710: } else {
10711: $msg = &mt($msg);
10712: }
1.1150 bisitz 10713:
1.318 albertel 10714: my $page =
1.1304 raeburn 10715: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10716: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10717: &Apache::loncommon::end_page();
10718: if (ref($r)) {
10719: $r->print($page);
1.327 albertel 10720: return;
1.318 albertel 10721: }
10722: return $page;
10723: }
1.347 albertel 10724:
10725: {
1.610 albertel 10726: my @row_count;
1.961 onken 10727:
10728: sub start_data_table_count {
10729: unshift(@row_count, 0);
10730: return;
10731: }
10732:
10733: sub end_data_table_count {
10734: shift(@row_count);
10735: return;
10736: }
10737:
1.347 albertel 10738: sub start_data_table {
1.1018 raeburn 10739: my ($add_class,$id) = @_;
1.422 albertel 10740: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10741: my $table_id;
10742: if (defined($id)) {
10743: $table_id = ' id="'.$id.'"';
10744: }
1.961 onken 10745: &start_data_table_count();
1.1018 raeburn 10746: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10747: }
10748:
10749: sub end_data_table {
1.961 onken 10750: &end_data_table_count();
1.389 albertel 10751: return '</table>'."\n";;
1.347 albertel 10752: }
10753:
10754: sub start_data_table_row {
1.974 wenzelju 10755: my ($add_class, $id) = @_;
1.610 albertel 10756: $row_count[0]++;
10757: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10758: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10759: $id = (' id="'.$id.'"') unless ($id eq '');
10760: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10761: }
1.471 banghart 10762:
10763: sub continue_data_table_row {
1.974 wenzelju 10764: my ($add_class, $id) = @_;
1.610 albertel 10765: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10766: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10767: $id = (' id="'.$id.'"') unless ($id eq '');
10768: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10769: }
1.347 albertel 10770:
10771: sub end_data_table_row {
1.389 albertel 10772: return '</tr>'."\n";;
1.347 albertel 10773: }
1.367 www 10774:
1.421 albertel 10775: sub start_data_table_empty_row {
1.707 bisitz 10776: # $row_count[0]++;
1.421 albertel 10777: return '<tr class="LC_empty_row" >'."\n";;
10778: }
10779:
10780: sub end_data_table_empty_row {
10781: return '</tr>'."\n";;
10782: }
10783:
1.367 www 10784: sub start_data_table_header_row {
1.389 albertel 10785: return '<tr class="LC_header_row">'."\n";;
1.367 www 10786: }
10787:
10788: sub end_data_table_header_row {
1.389 albertel 10789: return '</tr>'."\n";;
1.367 www 10790: }
1.890 droeschl 10791:
10792: sub data_table_caption {
10793: my $caption = shift;
10794: return "<caption class=\"LC_caption\">$caption</caption>";
10795: }
1.347 albertel 10796: }
10797:
1.548 albertel 10798: =pod
10799:
10800: =item * &inhibit_menu_check($arg)
10801:
10802: Checks for a inhibitmenu state and generates output to preserve it
10803:
10804: Inputs: $arg - can be any of
10805: - undef - in which case the return value is a string
10806: to add into arguments list of a uri
10807: - 'input' - in which case the return value is a HTML
10808: <form> <input> field of type hidden to
10809: preserve the value
10810: - a url - in which case the return value is the url with
10811: the neccesary cgi args added to preserve the
10812: inhibitmenu state
10813: - a ref to a url - no return value, but the string is
10814: updated to include the neccessary cgi
10815: args to preserve the inhibitmenu state
10816:
10817: =cut
10818:
10819: sub inhibit_menu_check {
10820: my ($arg) = @_;
10821: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10822: if ($arg eq 'input') {
10823: if ($env{'form.inhibitmenu'}) {
10824: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10825: } else {
10826: return
10827: }
10828: }
10829: if ($env{'form.inhibitmenu'}) {
10830: if (ref($arg)) {
10831: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10832: } elsif ($arg eq '') {
10833: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10834: } else {
10835: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10836: }
10837: }
10838: if (!ref($arg)) {
10839: return $arg;
10840: }
10841: }
10842:
1.251 albertel 10843: ###############################################
1.182 matthew 10844:
10845: =pod
10846:
1.549 albertel 10847: =back
10848:
10849: =head1 User Information Routines
10850:
10851: =over 4
10852:
1.405 albertel 10853: =item * &get_users_function()
1.182 matthew 10854:
10855: Used by &bodytag to determine the current users primary role.
10856: Returns either 'student','coordinator','admin', or 'author'.
10857:
10858: =cut
10859:
10860: ###############################################
10861: sub get_users_function {
1.815 tempelho 10862: my $function = 'norole';
1.818 tempelho 10863: if ($env{'request.role'}=~/^(st)/) {
10864: $function='student';
10865: }
1.907 raeburn 10866: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10867: $function='coordinator';
10868: }
1.258 albertel 10869: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10870: $function='admin';
10871: }
1.826 bisitz 10872: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10873: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10874: $function='author';
10875: }
10876: return $function;
1.54 www 10877: }
1.99 www 10878:
10879: ###############################################
10880:
1.233 raeburn 10881: =pod
10882:
1.821 raeburn 10883: =item * &show_course()
10884:
10885: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10886: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10887:
10888: Inputs:
10889: None
10890:
10891: Outputs:
10892: Scalar: 1 if 'Course' to be used, 0 otherwise.
10893:
10894: =cut
10895:
10896: ###############################################
10897: sub show_course {
1.1408 raeburn 10898: my ($udom,$uname) = @_;
10899: if (($udom ne '') && ($uname ne '')) {
10900: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10901: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10902: return 0;
10903: } else {
10904: return 1;
10905: }
10906: }
10907: }
1.821 raeburn 10908: my $course = !$env{'user.adv'};
10909: if (!$env{'user.adv'}) {
10910: foreach my $env (keys(%env)) {
10911: next if ($env !~ m/^user\.priv\./);
10912: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10913: $course = 0;
10914: last;
10915: }
10916: }
10917: }
10918: return $course;
10919: }
10920:
10921: ###############################################
10922:
10923: =pod
10924:
1.542 raeburn 10925: =item * &check_user_status()
1.274 raeburn 10926:
10927: Determines current status of supplied role for a
10928: specific user. Roles can be active, previous or future.
10929:
10930: Inputs:
10931: user's domain, user's username, course's domain,
1.375 raeburn 10932: course's number, optional section ID.
1.274 raeburn 10933:
10934: Outputs:
10935: role status: active, previous or future.
10936:
10937: =cut
10938:
10939: sub check_user_status {
1.412 raeburn 10940: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10941: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10942: my @uroles = keys(%userinfo);
1.274 raeburn 10943: my $srchstr;
10944: my $active_chk = 'none';
1.412 raeburn 10945: my $now = time;
1.274 raeburn 10946: if (@uroles > 0) {
1.908 raeburn 10947: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10948: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10949: } else {
1.412 raeburn 10950: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10951: }
10952: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10953: my $role_end = 0;
10954: my $role_start = 0;
10955: $active_chk = 'active';
1.412 raeburn 10956: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10957: $role_end = $1;
10958: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10959: $role_start = $1;
1.274 raeburn 10960: }
10961: }
10962: if ($role_start > 0) {
1.412 raeburn 10963: if ($now < $role_start) {
1.274 raeburn 10964: $active_chk = 'future';
10965: }
10966: }
10967: if ($role_end > 0) {
1.412 raeburn 10968: if ($now > $role_end) {
1.274 raeburn 10969: $active_chk = 'previous';
10970: }
10971: }
10972: }
10973: }
10974: return $active_chk;
10975: }
10976:
10977: ###############################################
10978:
10979: =pod
10980:
1.405 albertel 10981: =item * &get_sections()
1.233 raeburn 10982:
10983: Determines all the sections for a course including
10984: sections with students and sections containing other roles.
1.419 raeburn 10985: Incoming parameters:
10986:
10987: 1. domain
10988: 2. course number
10989: 3. reference to array containing roles for which sections should
10990: be gathered (optional).
10991: 4. reference to array containing status types for which sections
10992: should be gathered (optional).
10993:
10994: If the third argument is undefined, sections are gathered for any role.
10995: If the fourth argument is undefined, sections are gathered for any status.
10996: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10997:
1.374 raeburn 10998: Returns section hash (keys are section IDs, values are
10999: number of users in each section), subject to the
1.419 raeburn 11000: optional roles filter, optional status filter
1.233 raeburn 11001:
11002: =cut
11003:
11004: ###############################################
11005: sub get_sections {
1.419 raeburn 11006: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11007: if (!defined($cdom) || !defined($cnum)) {
11008: my $cid = $env{'request.course.id'};
11009:
11010: return if (!defined($cid));
11011:
11012: $cdom = $env{'course.'.$cid.'.domain'};
11013: $cnum = $env{'course.'.$cid.'.num'};
11014: }
11015:
11016: my %sectioncount;
1.419 raeburn 11017: my $now = time;
1.240 albertel 11018:
1.1118 raeburn 11019: my $check_students = 1;
11020: my $only_students = 0;
11021: if (ref($possible_roles) eq 'ARRAY') {
11022: if (grep(/^st$/,@{$possible_roles})) {
11023: if (@{$possible_roles} == 1) {
11024: $only_students = 1;
11025: }
11026: } else {
11027: $check_students = 0;
11028: }
11029: }
11030:
11031: if ($check_students) {
1.276 albertel 11032: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11033: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11034: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11035: my $start_index = &Apache::loncoursedata::CL_START();
11036: my $end_index = &Apache::loncoursedata::CL_END();
11037: my $status;
1.366 albertel 11038: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11039: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11040: $data->[$status_index],
11041: $data->[$start_index],
11042: $data->[$end_index]);
11043: if ($stu_status eq 'Active') {
11044: $status = 'active';
11045: } elsif ($end < $now) {
11046: $status = 'previous';
11047: } elsif ($start > $now) {
11048: $status = 'future';
11049: }
11050: if ($section ne '-1' && $section !~ /^\s*$/) {
11051: if ((!defined($possible_status)) || (($status ne '') &&
11052: (grep/^\Q$status\E$/,@{$possible_status}))) {
11053: $sectioncount{$section}++;
11054: }
1.240 albertel 11055: }
11056: }
11057: }
1.1118 raeburn 11058: if ($only_students) {
11059: return %sectioncount;
11060: }
1.240 albertel 11061: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11062: foreach my $user (sort(keys(%courseroles))) {
11063: if ($user !~ /^(\w{2})/) { next; }
11064: my ($role) = ($user =~ /^(\w{2})/);
11065: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11066: my ($section,$status);
1.240 albertel 11067: if ($role eq 'cr' &&
11068: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11069: $section=$1;
11070: }
11071: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11072: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11073: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11074: if ($end == -1 && $start == -1) {
11075: next; #deleted role
11076: }
11077: if (!defined($possible_status)) {
11078: $sectioncount{$section}++;
11079: } else {
11080: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11081: $status = 'active';
11082: } elsif ($end < $now) {
11083: $status = 'future';
11084: } elsif ($start > $now) {
11085: $status = 'previous';
11086: }
11087: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11088: $sectioncount{$section}++;
11089: }
11090: }
1.233 raeburn 11091: }
1.366 albertel 11092: return %sectioncount;
1.233 raeburn 11093: }
11094:
1.274 raeburn 11095: ###############################################
1.294 raeburn 11096:
11097: =pod
1.405 albertel 11098:
11099: =item * &get_course_users()
11100:
1.275 raeburn 11101: Retrieves usernames:domains for users in the specified course
11102: with specific role(s), and access status.
11103:
11104: Incoming parameters:
1.277 albertel 11105: 1. course domain
11106: 2. course number
11107: 3. access status: users must have - either active,
1.275 raeburn 11108: previous, future, or all.
1.277 albertel 11109: 4. reference to array of permissible roles
1.288 raeburn 11110: 5. reference to array of section restrictions (optional)
11111: 6. reference to results object (hash of hashes).
11112: 7. reference to optional userdata hash
1.609 raeburn 11113: 8. reference to optional statushash
1.630 raeburn 11114: 9. flag if privileged users (except those set to unhide in
11115: course settings) should be excluded
1.609 raeburn 11116: Keys of top level results hash are roles.
1.275 raeburn 11117: Keys of inner hashes are username:domain, with
11118: values set to access type.
1.288 raeburn 11119: Optional userdata hash returns an array with arguments in the
11120: same order as loncoursedata::get_classlist() for student data.
11121:
1.609 raeburn 11122: Optional statushash returns
11123:
1.288 raeburn 11124: Entries for end, start, section and status are blank because
11125: of the possibility of multiple values for non-student roles.
11126:
1.275 raeburn 11127: =cut
1.405 albertel 11128:
1.275 raeburn 11129: ###############################################
1.405 albertel 11130:
1.275 raeburn 11131: sub get_course_users {
1.630 raeburn 11132: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11133: my %idx = ();
1.419 raeburn 11134: my %seclists;
1.288 raeburn 11135:
11136: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11137: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11138: $idx{end} = &Apache::loncoursedata::CL_END();
11139: $idx{start} = &Apache::loncoursedata::CL_START();
11140: $idx{id} = &Apache::loncoursedata::CL_ID();
11141: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11142: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11143: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11144:
1.290 albertel 11145: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11146: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11147: my $now = time;
1.277 albertel 11148: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11149: my $match = 0;
1.412 raeburn 11150: my $secmatch = 0;
1.419 raeburn 11151: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11152: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11153: if ($section eq '') {
11154: $section = 'none';
11155: }
1.291 albertel 11156: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11157: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11158: $secmatch = 1;
11159: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11160: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11161: $secmatch = 1;
11162: }
11163: } else {
1.419 raeburn 11164: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11165: $secmatch = 1;
11166: }
1.290 albertel 11167: }
1.412 raeburn 11168: if (!$secmatch) {
11169: next;
11170: }
1.419 raeburn 11171: }
1.275 raeburn 11172: if (defined($$types{'active'})) {
1.288 raeburn 11173: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11174: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11175: $match = 1;
1.275 raeburn 11176: }
11177: }
11178: if (defined($$types{'previous'})) {
1.609 raeburn 11179: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11180: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11181: $match = 1;
1.275 raeburn 11182: }
11183: }
11184: if (defined($$types{'future'})) {
1.609 raeburn 11185: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11186: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11187: $match = 1;
1.275 raeburn 11188: }
11189: }
1.609 raeburn 11190: if ($match) {
11191: push(@{$seclists{$student}},$section);
11192: if (ref($userdata) eq 'HASH') {
11193: $$userdata{$student} = $$classlist{$student};
11194: }
11195: if (ref($statushash) eq 'HASH') {
11196: $statushash->{$student}{'st'}{$section} = $status;
11197: }
1.288 raeburn 11198: }
1.275 raeburn 11199: }
11200: }
1.412 raeburn 11201: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11202: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11203: my $now = time;
1.609 raeburn 11204: my %displaystatus = ( previous => 'Expired',
11205: active => 'Active',
11206: future => 'Future',
11207: );
1.1121 raeburn 11208: my (%nothide,@possdoms);
1.630 raeburn 11209: if ($hidepriv) {
11210: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11211: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11212: if ($user !~ /:/) {
11213: $nothide{join(':',split(/[\@]/,$user))}=1;
11214: } else {
11215: $nothide{$user} = 1;
11216: }
11217: }
1.1121 raeburn 11218: my @possdoms = ($cdom);
11219: if ($coursehash{'checkforpriv'}) {
11220: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11221: }
1.630 raeburn 11222: }
1.439 raeburn 11223: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11224: my $match = 0;
1.412 raeburn 11225: my $secmatch = 0;
1.439 raeburn 11226: my $status;
1.412 raeburn 11227: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11228: $user =~ s/:$//;
1.439 raeburn 11229: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11230: if ($end == -1 || $start == -1) {
11231: next;
11232: }
11233: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11234: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11235: my ($uname,$udom) = split(/:/,$user);
11236: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11237: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11238: $secmatch = 1;
11239: } elsif ($usec eq '') {
1.420 albertel 11240: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11241: $secmatch = 1;
11242: }
11243: } else {
11244: if (grep(/^\Q$usec\E$/,@{$sections})) {
11245: $secmatch = 1;
11246: }
11247: }
11248: if (!$secmatch) {
11249: next;
11250: }
1.288 raeburn 11251: }
1.419 raeburn 11252: if ($usec eq '') {
11253: $usec = 'none';
11254: }
1.275 raeburn 11255: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11256: if ($hidepriv) {
1.1121 raeburn 11257: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11258: (!$nothide{$uname.':'.$udom})) {
11259: next;
11260: }
11261: }
1.503 raeburn 11262: if ($end > 0 && $end < $now) {
1.439 raeburn 11263: $status = 'previous';
11264: } elsif ($start > $now) {
11265: $status = 'future';
11266: } else {
11267: $status = 'active';
11268: }
1.277 albertel 11269: foreach my $type (keys(%{$types})) {
1.275 raeburn 11270: if ($status eq $type) {
1.420 albertel 11271: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11272: push(@{$$users{$role}{$user}},$type);
11273: }
1.288 raeburn 11274: $match = 1;
11275: }
11276: }
1.419 raeburn 11277: if (($match) && (ref($userdata) eq 'HASH')) {
11278: if (!exists($$userdata{$uname.':'.$udom})) {
11279: &get_user_info($udom,$uname,\%idx,$userdata);
11280: }
1.420 albertel 11281: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11282: push(@{$seclists{$uname.':'.$udom}},$usec);
11283: }
1.609 raeburn 11284: if (ref($statushash) eq 'HASH') {
11285: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11286: }
1.275 raeburn 11287: }
11288: }
11289: }
11290: }
1.290 albertel 11291: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11292: if ((defined($cdom)) && (defined($cnum))) {
11293: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11294: if ( defined($csettings{'internal.courseowner'}) ) {
11295: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11296: next if ($owner eq '');
11297: my ($ownername,$ownerdom);
11298: if ($owner =~ /^([^:]+):([^:]+)$/) {
11299: $ownername = $1;
11300: $ownerdom = $2;
11301: } else {
11302: $ownername = $owner;
11303: $ownerdom = $cdom;
11304: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11305: }
11306: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11307: if (defined($userdata) &&
1.609 raeburn 11308: !exists($$userdata{$owner})) {
11309: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11310: if (!grep(/^none$/,@{$seclists{$owner}})) {
11311: push(@{$seclists{$owner}},'none');
11312: }
11313: if (ref($statushash) eq 'HASH') {
11314: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11315: }
1.290 albertel 11316: }
1.279 raeburn 11317: }
11318: }
11319: }
1.419 raeburn 11320: foreach my $user (keys(%seclists)) {
11321: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11322: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11323: }
1.275 raeburn 11324: }
11325: return;
11326: }
11327:
1.288 raeburn 11328: sub get_user_info {
11329: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11330: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11331: &plainname($uname,$udom,'lastname');
1.291 albertel 11332: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11333: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11334: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11335: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11336: return;
11337: }
1.275 raeburn 11338:
1.472 raeburn 11339: ###############################################
11340:
11341: =pod
11342:
11343: =item * &get_user_quota()
11344:
1.1134 raeburn 11345: Retrieves quota assigned for storage of user files.
11346: Default is to report quota for portfolio files.
1.472 raeburn 11347:
11348: Incoming parameters:
11349: 1. user's username
11350: 2. user's domain
1.1134 raeburn 11351: 3. quota name - portfolio, author, or course
1.1136 raeburn 11352: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11353: 4. crstype - official, unofficial, textbook, placement or community,
11354: if quota name is course
1.472 raeburn 11355:
11356: Returns:
1.1163 raeburn 11357: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11358: 2. (Optional) Type of setting: custom or default
11359: (individually assigned or default for user's
11360: institutional status).
11361: 3. (Optional) - User's institutional status (e.g., faculty, staff
11362: or student - types as defined in localenroll::inst_usertypes
11363: for user's domain, which determines default quota for user.
11364: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11365:
11366: If a value has been stored in the user's environment,
1.536 raeburn 11367: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11368: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11369:
11370: =cut
11371:
11372: ###############################################
11373:
11374:
11375: sub get_user_quota {
1.1136 raeburn 11376: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11377: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11378: if (!defined($udom)) {
11379: $udom = $env{'user.domain'};
11380: }
11381: if (!defined($uname)) {
11382: $uname = $env{'user.name'};
11383: }
11384: if (($udom eq '' || $uname eq '') ||
11385: ($udom eq 'public') && ($uname eq 'public')) {
11386: $quota = 0;
1.536 raeburn 11387: $quotatype = 'default';
11388: $defquota = 0;
1.472 raeburn 11389: } else {
1.536 raeburn 11390: my $inststatus;
1.1134 raeburn 11391: if ($quotaname eq 'course') {
11392: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11393: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11394: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11395: } else {
11396: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11397: $quota = $cenv{'internal.uploadquota'};
11398: }
1.536 raeburn 11399: } else {
1.1134 raeburn 11400: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11401: if ($quotaname eq 'author') {
11402: $quota = $env{'environment.authorquota'};
11403: } else {
11404: $quota = $env{'environment.portfolioquota'};
11405: }
11406: $inststatus = $env{'environment.inststatus'};
11407: } else {
11408: my %userenv =
11409: &Apache::lonnet::get('environment',['portfolioquota',
11410: 'authorquota','inststatus'],$udom,$uname);
11411: my ($tmp) = keys(%userenv);
11412: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11413: if ($quotaname eq 'author') {
11414: $quota = $userenv{'authorquota'};
11415: } else {
11416: $quota = $userenv{'portfolioquota'};
11417: }
11418: $inststatus = $userenv{'inststatus'};
11419: } else {
11420: undef(%userenv);
11421: }
11422: }
11423: }
11424: if ($quota eq '' || wantarray) {
11425: if ($quotaname eq 'course') {
11426: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11427: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11428: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11429: ($crstype eq 'placement')) {
1.1136 raeburn 11430: $defquota = $domdefs{$crstype.'quota'};
11431: }
11432: if ($defquota eq '') {
11433: $defquota = 500;
11434: }
1.1134 raeburn 11435: } else {
11436: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11437: }
11438: if ($quota eq '') {
11439: $quota = $defquota;
11440: $quotatype = 'default';
11441: } else {
11442: $quotatype = 'custom';
11443: }
1.472 raeburn 11444: }
11445: }
1.536 raeburn 11446: if (wantarray) {
11447: return ($quota,$quotatype,$settingstatus,$defquota);
11448: } else {
11449: return $quota;
11450: }
1.472 raeburn 11451: }
11452:
11453: ###############################################
11454:
11455: =pod
11456:
11457: =item * &default_quota()
11458:
1.536 raeburn 11459: Retrieves default quota assigned for storage of user portfolio files,
11460: given an (optional) user's institutional status.
1.472 raeburn 11461:
11462: Incoming parameters:
1.1142 raeburn 11463:
1.472 raeburn 11464: 1. domain
1.536 raeburn 11465: 2. (Optional) institutional status(es). This is a : separated list of
11466: status types (e.g., faculty, staff, student etc.)
11467: which apply to the user for whom the default is being retrieved.
11468: If the institutional status string in undefined, the domain
1.1134 raeburn 11469: default quota will be returned.
11470: 3. quota name - portfolio, author, or course
11471: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11472:
11473: Returns:
1.1142 raeburn 11474:
1.1163 raeburn 11475: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11476: 2. (Optional) institutional type which determined the value of the
11477: default quota.
1.472 raeburn 11478:
11479: If a value has been stored in the domain's configuration db,
11480: it will return that, otherwise it returns 20 (for backwards
11481: compatibility with domains which have not set up a configuration
1.1163 raeburn 11482: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11483:
1.536 raeburn 11484: If the user's status includes multiple types (e.g., staff and student),
11485: the largest default quota which applies to the user determines the
11486: default quota returned.
11487:
1.472 raeburn 11488: =cut
11489:
11490: ###############################################
11491:
11492:
11493: sub default_quota {
1.1134 raeburn 11494: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11495: my ($defquota,$settingstatus);
11496: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11497: ['quotas'],$udom);
1.1134 raeburn 11498: my $key = 'defaultquota';
11499: if ($quotaname eq 'author') {
11500: $key = 'authorquota';
11501: }
1.622 raeburn 11502: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11503: if ($inststatus ne '') {
1.765 raeburn 11504: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11505: foreach my $item (@statuses) {
1.1134 raeburn 11506: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11507: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11508: if ($defquota eq '') {
1.1134 raeburn 11509: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11510: $settingstatus = $item;
1.1134 raeburn 11511: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11512: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11513: $settingstatus = $item;
11514: }
11515: }
1.1134 raeburn 11516: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11517: if ($quotahash{'quotas'}{$item} ne '') {
11518: if ($defquota eq '') {
11519: $defquota = $quotahash{'quotas'}{$item};
11520: $settingstatus = $item;
11521: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11522: $defquota = $quotahash{'quotas'}{$item};
11523: $settingstatus = $item;
11524: }
1.536 raeburn 11525: }
11526: }
11527: }
11528: }
11529: if ($defquota eq '') {
1.1134 raeburn 11530: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11531: $defquota = $quotahash{'quotas'}{$key}{'default'};
11532: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11533: $defquota = $quotahash{'quotas'}{'default'};
11534: }
1.536 raeburn 11535: $settingstatus = 'default';
1.1139 raeburn 11536: if ($defquota eq '') {
11537: if ($quotaname eq 'author') {
11538: $defquota = 500;
11539: }
11540: }
1.536 raeburn 11541: }
11542: } else {
11543: $settingstatus = 'default';
1.1134 raeburn 11544: if ($quotaname eq 'author') {
11545: $defquota = 500;
11546: } else {
11547: $defquota = 20;
11548: }
1.536 raeburn 11549: }
11550: if (wantarray) {
11551: return ($defquota,$settingstatus);
1.472 raeburn 11552: } else {
1.536 raeburn 11553: return $defquota;
1.472 raeburn 11554: }
11555: }
11556:
1.1135 raeburn 11557: ###############################################
11558:
11559: =pod
11560:
1.1136 raeburn 11561: =item * &excess_filesize_warning()
1.1135 raeburn 11562:
11563: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11564: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11565: space to be exceeded.
1.1136 raeburn 11566:
11567: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11568: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11569:
1.1165 raeburn 11570: Inputs: 7
1.1136 raeburn 11571: 1. username or coursenum
1.1135 raeburn 11572: 2. domain
1.1136 raeburn 11573: 3. context ('author' or 'course')
1.1135 raeburn 11574: 4. filename of file for which action is being requested
11575: 5. filesize (kB) of file
11576: 6. action being taken: copy or upload.
1.1237 raeburn 11577: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11578:
11579: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11580: otherwise return null.
11581:
11582: =back
1.1135 raeburn 11583:
11584: =cut
11585:
1.1136 raeburn 11586: sub excess_filesize_warning {
1.1165 raeburn 11587: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11588: my $current_disk_usage = 0;
1.1165 raeburn 11589: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11590: if ($context eq 'author') {
11591: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11592: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11593: } else {
11594: foreach my $subdir ('docs','supplemental') {
11595: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11596: }
11597: }
1.1135 raeburn 11598: $disk_quota = int($disk_quota * 1000);
11599: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11600: return '<p class="LC_warning">'.
1.1135 raeburn 11601: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11602: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11603: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11604: $disk_quota,$current_disk_usage).
11605: '</p>';
11606: }
11607: return;
11608: }
11609:
11610: ###############################################
11611:
11612:
1.1136 raeburn 11613:
11614:
1.384 raeburn 11615: sub get_secgrprole_info {
11616: my ($cdom,$cnum,$needroles,$type) = @_;
11617: my %sections_count = &get_sections($cdom,$cnum);
11618: my @sections = (sort {$a <=> $b} keys(%sections_count));
11619: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11620: my @groups = sort(keys(%curr_groups));
11621: my $allroles = [];
11622: my $rolehash;
11623: my $accesshash = {
11624: active => 'Currently has access',
11625: future => 'Will have future access',
11626: previous => 'Previously had access',
11627: };
11628: if ($needroles) {
11629: $rolehash = {'all' => 'all'};
1.385 albertel 11630: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11631: if (&Apache::lonnet::error(%user_roles)) {
11632: undef(%user_roles);
11633: }
11634: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11635: my ($role)=split(/\:/,$item,2);
11636: if ($role eq 'cr') { next; }
11637: if ($role =~ /^cr/) {
11638: $$rolehash{$role} = (split('/',$role))[3];
11639: } else {
11640: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11641: }
11642: }
11643: foreach my $key (sort(keys(%{$rolehash}))) {
11644: push(@{$allroles},$key);
11645: }
11646: push (@{$allroles},'st');
11647: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11648: }
11649: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11650: }
11651:
1.555 raeburn 11652: sub user_picker {
1.1279 raeburn 11653: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11654: my $currdom = $dom;
1.1253 raeburn 11655: my @alldoms = &Apache::lonnet::all_domains();
11656: if (@alldoms == 1) {
11657: my %domsrch = &Apache::lonnet::get_dom('configuration',
11658: ['directorysrch'],$alldoms[0]);
11659: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11660: my $showdom = $domdesc;
11661: if ($showdom eq '') {
11662: $showdom = $dom;
11663: }
11664: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11665: if ((!$domsrch{'directorysrch'}{'available'}) &&
11666: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11667: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11668: }
11669: }
11670: }
1.555 raeburn 11671: my %curr_selected = (
11672: srchin => 'dom',
1.580 raeburn 11673: srchby => 'lastname',
1.555 raeburn 11674: );
11675: my $srchterm;
1.625 raeburn 11676: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11677: if ($srch->{'srchby'} ne '') {
11678: $curr_selected{'srchby'} = $srch->{'srchby'};
11679: }
11680: if ($srch->{'srchin'} ne '') {
11681: $curr_selected{'srchin'} = $srch->{'srchin'};
11682: }
11683: if ($srch->{'srchtype'} ne '') {
11684: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11685: }
11686: if ($srch->{'srchdomain'} ne '') {
11687: $currdom = $srch->{'srchdomain'};
11688: }
11689: $srchterm = $srch->{'srchterm'};
11690: }
1.1222 damieng 11691: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11692: 'usr' => 'Search criteria',
1.563 raeburn 11693: 'doma' => 'Domain/institution to search',
1.558 albertel 11694: 'uname' => 'username',
11695: 'lastname' => 'last name',
1.555 raeburn 11696: 'lastfirst' => 'last name, first name',
1.558 albertel 11697: 'crs' => 'in this course',
1.576 raeburn 11698: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11699: 'alc' => 'all LON-CAPA',
1.573 raeburn 11700: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11701: 'exact' => 'is',
11702: 'contains' => 'contains',
1.569 raeburn 11703: 'begins' => 'begins with',
1.1222 damieng 11704: );
11705: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11706: 'youm' => "You must include some text to search for.",
11707: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11708: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11709: 'yomc' => "You must choose a domain when using an institutional directory search.",
11710: 'ymcd' => "You must choose a domain when using a domain search.",
11711: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11712: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11713: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11714: );
1.1222 damieng 11715: &html_escape(\%html_lt);
11716: &js_escape(\%js_lt);
1.1255 raeburn 11717: my $domform;
1.1277 raeburn 11718: my $allow_blank = 1;
1.1255 raeburn 11719: if ($fixeddom) {
1.1277 raeburn 11720: $allow_blank = 0;
11721: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11722: } else {
1.1287 raeburn 11723: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11724: my ($trusted,$untrusted);
1.1287 raeburn 11725: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11726: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11727: } elsif ($context eq 'author') {
1.1288 raeburn 11728: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11729: } elsif ($context eq 'domain') {
1.1288 raeburn 11730: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11731: }
1.1288 raeburn 11732: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11733: }
1.563 raeburn 11734: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11735:
11736: my @srchins = ('crs','dom','alc','instd');
11737:
11738: foreach my $option (@srchins) {
11739: # FIXME 'alc' option unavailable until
11740: # loncreateuser::print_user_query_page()
11741: # has been completed.
11742: next if ($option eq 'alc');
1.880 raeburn 11743: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11744: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11745: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11746: if ($curr_selected{'srchin'} eq $option) {
11747: $srchinsel .= '
1.1222 damieng 11748: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11749: } else {
11750: $srchinsel .= '
1.1222 damieng 11751: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11752: }
1.555 raeburn 11753: }
1.563 raeburn 11754: $srchinsel .= "\n </select>\n";
1.555 raeburn 11755:
11756: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11757: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11758: if ($curr_selected{'srchby'} eq $option) {
11759: $srchbysel .= '
1.1222 damieng 11760: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11761: } else {
11762: $srchbysel .= '
1.1222 damieng 11763: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11764: }
11765: }
11766: $srchbysel .= "\n </select>\n";
11767:
11768: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11769: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11770: if ($curr_selected{'srchtype'} eq $option) {
11771: $srchtypesel .= '
1.1222 damieng 11772: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11773: } else {
11774: $srchtypesel .= '
1.1222 damieng 11775: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11776: }
11777: }
11778: $srchtypesel .= "\n </select>\n";
11779:
1.558 albertel 11780: my ($newuserscript,$new_user_create);
1.994 raeburn 11781: my $context_dom = $env{'request.role.domain'};
11782: if ($context eq 'requestcrs') {
11783: if ($env{'form.coursedom'} ne '') {
11784: $context_dom = $env{'form.coursedom'};
11785: }
11786: }
1.556 raeburn 11787: if ($forcenewuser) {
1.576 raeburn 11788: if (ref($srch) eq 'HASH') {
1.994 raeburn 11789: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11790: if ($cancreate) {
11791: $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>';
11792: } else {
1.799 bisitz 11793: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11794: my %usertypetext = (
11795: official => 'institutional',
11796: unofficial => 'non-institutional',
11797: );
1.799 bisitz 11798: $new_user_create = '<p class="LC_warning">'
11799: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11800: .' '
11801: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11802: ,'<a href="'.$helplink.'">','</a>')
11803: .'</p><br />';
1.627 raeburn 11804: }
1.576 raeburn 11805: }
11806: }
11807:
1.556 raeburn 11808: $newuserscript = <<"ENDSCRIPT";
11809:
1.570 raeburn 11810: function setSearch(createnew,callingForm) {
1.556 raeburn 11811: if (createnew == 1) {
1.570 raeburn 11812: for (var i=0; i<callingForm.srchby.length; i++) {
11813: if (callingForm.srchby.options[i].value == 'uname') {
11814: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11815: }
11816: }
1.570 raeburn 11817: for (var i=0; i<callingForm.srchin.length; i++) {
11818: if ( callingForm.srchin.options[i].value == 'dom') {
11819: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11820: }
11821: }
1.570 raeburn 11822: for (var i=0; i<callingForm.srchtype.length; i++) {
11823: if (callingForm.srchtype.options[i].value == 'exact') {
11824: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11825: }
11826: }
1.570 raeburn 11827: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11828: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11829: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11830: }
11831: }
11832: }
11833: }
11834: ENDSCRIPT
1.558 albertel 11835:
1.556 raeburn 11836: }
11837:
1.555 raeburn 11838: my $output = <<"END_BLOCK";
1.556 raeburn 11839: <script type="text/javascript">
1.824 bisitz 11840: // <![CDATA[
1.570 raeburn 11841: function validateEntry(callingForm) {
1.558 albertel 11842:
1.556 raeburn 11843: var checkok = 1;
1.558 albertel 11844: var srchin;
1.570 raeburn 11845: for (var i=0; i<callingForm.srchin.length; i++) {
11846: if ( callingForm.srchin[i].checked ) {
11847: srchin = callingForm.srchin[i].value;
1.558 albertel 11848: }
11849: }
11850:
1.570 raeburn 11851: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11852: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11853: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11854: var srchterm = callingForm.srchterm.value;
11855: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11856: var msg = "";
11857:
11858: if (srchterm == "") {
11859: checkok = 0;
1.1222 damieng 11860: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11861: }
11862:
1.569 raeburn 11863: if (srchtype== 'begins') {
11864: if (srchterm.length < 2) {
11865: checkok = 0;
1.1222 damieng 11866: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11867: }
11868: }
11869:
1.556 raeburn 11870: if (srchtype== 'contains') {
11871: if (srchterm.length < 3) {
11872: checkok = 0;
1.1222 damieng 11873: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11874: }
11875: }
11876: if (srchin == 'instd') {
11877: if (srchdomain == '') {
11878: checkok = 0;
1.1222 damieng 11879: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11880: }
11881: }
11882: if (srchin == 'dom') {
11883: if (srchdomain == '') {
11884: checkok = 0;
1.1222 damieng 11885: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11886: }
11887: }
11888: if (srchby == 'lastfirst') {
11889: if (srchterm.indexOf(",") == -1) {
11890: checkok = 0;
1.1222 damieng 11891: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11892: }
11893: if (srchterm.indexOf(",") == srchterm.length -1) {
11894: checkok = 0;
1.1222 damieng 11895: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11896: }
11897: }
11898: if (checkok == 0) {
1.1222 damieng 11899: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11900: return;
11901: }
11902: if (checkok == 1) {
1.570 raeburn 11903: callingForm.submit();
1.556 raeburn 11904: }
11905: }
11906:
11907: $newuserscript
11908:
1.824 bisitz 11909: // ]]>
1.556 raeburn 11910: </script>
1.558 albertel 11911:
11912: $new_user_create
11913:
1.555 raeburn 11914: END_BLOCK
1.558 albertel 11915:
1.876 raeburn 11916: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11917: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11918: $domform.
11919: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11920: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11921: $srchbysel.
11922: $srchtypesel.
11923: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11924: $srchinsel.
11925: &Apache::lonhtmlcommon::row_closure(1).
11926: &Apache::lonhtmlcommon::end_pick_box().
11927: '<br />';
1.1253 raeburn 11928: return ($output,1);
1.555 raeburn 11929: }
11930:
1.612 raeburn 11931: sub user_rule_check {
1.615 raeburn 11932: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11933: my ($response,%inst_response);
1.612 raeburn 11934: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11935: if (keys(%{$usershash}) > 1) {
11936: my (%by_username,%by_id,%userdoms);
11937: my $checkid;
11938: if (ref($checks) eq 'HASH') {
11939: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11940: $checkid = 1;
11941: }
11942: }
11943: foreach my $user (keys(%{$usershash})) {
11944: my ($uname,$udom) = split(/:/,$user);
11945: if ($checkid) {
11946: if (ref($usershash->{$user}) eq 'HASH') {
11947: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11948: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11949: $userdoms{$udom} = 1;
1.1227 raeburn 11950: if (ref($inst_results) eq 'HASH') {
11951: $inst_results->{$uname.':'.$udom} = {};
11952: }
1.1226 raeburn 11953: }
11954: }
11955: } else {
11956: $by_username{$udom}{$uname} = 1;
11957: $userdoms{$udom} = 1;
1.1227 raeburn 11958: if (ref($inst_results) eq 'HASH') {
11959: $inst_results->{$uname.':'.$udom} = {};
11960: }
1.1226 raeburn 11961: }
11962: }
11963: foreach my $udom (keys(%userdoms)) {
11964: if (!$got_rules->{$udom}) {
11965: my %domconfig = &Apache::lonnet::get_dom('configuration',
11966: ['usercreation'],$udom);
11967: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11968: foreach my $item ('username','id') {
11969: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11970: $$curr_rules{$udom}{$item} =
11971: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11972: }
11973: }
11974: }
11975: $got_rules->{$udom} = 1;
11976: }
1.612 raeburn 11977: }
1.1226 raeburn 11978: if ($checkid) {
11979: foreach my $udom (keys(%by_id)) {
11980: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11981: if ($outcome eq 'ok') {
1.1227 raeburn 11982: foreach my $id (keys(%{$by_id{$udom}})) {
11983: my $uname = $by_id{$udom}{$id};
11984: $inst_response{$uname.':'.$udom} = $outcome;
11985: }
1.1226 raeburn 11986: if (ref($results) eq 'HASH') {
11987: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11988: if (exists($inst_response{$uname.':'.$udom})) {
11989: $inst_response{$uname.':'.$udom} = $outcome;
11990: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11991: }
1.1226 raeburn 11992: }
11993: }
11994: }
1.612 raeburn 11995: }
1.615 raeburn 11996: } else {
1.1226 raeburn 11997: foreach my $udom (keys(%by_username)) {
11998: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11999: if ($outcome eq 'ok') {
1.1227 raeburn 12000: foreach my $uname (keys(%{$by_username{$udom}})) {
12001: $inst_response{$uname.':'.$udom} = $outcome;
12002: }
1.1226 raeburn 12003: if (ref($results) eq 'HASH') {
12004: foreach my $uname (keys(%{$results})) {
12005: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12006: }
12007: }
12008: }
12009: }
1.612 raeburn 12010: }
1.1226 raeburn 12011: } elsif (keys(%{$usershash}) == 1) {
12012: my $user = (keys(%{$usershash}))[0];
12013: my ($uname,$udom) = split(/:/,$user);
12014: if (($udom ne '') && ($uname ne '')) {
12015: if (ref($usershash->{$user}) eq 'HASH') {
12016: if (ref($checks) eq 'HASH') {
12017: if (defined($checks->{'username'})) {
12018: ($inst_response{$user},%{$inst_results->{$user}}) =
12019: &Apache::lonnet::get_instuser($udom,$uname);
12020: } elsif (defined($checks->{'id'})) {
12021: if ($usershash->{$user}->{'id'} ne '') {
12022: ($inst_response{$user},%{$inst_results->{$user}}) =
12023: &Apache::lonnet::get_instuser($udom,undef,
12024: $usershash->{$user}->{'id'});
12025: } else {
12026: ($inst_response{$user},%{$inst_results->{$user}}) =
12027: &Apache::lonnet::get_instuser($udom,$uname);
12028: }
1.585 raeburn 12029: }
1.1226 raeburn 12030: } else {
12031: ($inst_response{$user},%{$inst_results->{$user}}) =
12032: &Apache::lonnet::get_instuser($udom,$uname);
12033: return;
12034: }
12035: if (!$got_rules->{$udom}) {
12036: my %domconfig = &Apache::lonnet::get_dom('configuration',
12037: ['usercreation'],$udom);
12038: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12039: foreach my $item ('username','id') {
12040: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12041: $$curr_rules{$udom}{$item} =
12042: $domconfig{'usercreation'}{$item.'_rule'};
12043: }
12044: }
12045: }
12046: $got_rules->{$udom} = 1;
1.585 raeburn 12047: }
12048: }
1.1226 raeburn 12049: } else {
12050: return;
12051: }
12052: } else {
12053: return;
12054: }
12055: foreach my $user (keys(%{$usershash})) {
12056: my ($uname,$udom) = split(/:/,$user);
12057: next if (($udom eq '') || ($uname eq ''));
12058: my $id;
1.1227 raeburn 12059: if (ref($inst_results) eq 'HASH') {
12060: if (ref($inst_results->{$user}) eq 'HASH') {
12061: $id = $inst_results->{$user}->{'id'};
12062: }
12063: }
12064: if ($id eq '') {
12065: if (ref($usershash->{$user})) {
12066: $id = $usershash->{$user}->{'id'};
12067: }
1.585 raeburn 12068: }
1.612 raeburn 12069: foreach my $item (keys(%{$checks})) {
12070: if (ref($$curr_rules{$udom}) eq 'HASH') {
12071: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12072: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12073: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12074: $$curr_rules{$udom}{$item});
1.612 raeburn 12075: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12076: if ($rule_check{$rule}) {
12077: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12078: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12079: if (ref($inst_results) eq 'HASH') {
12080: if (ref($inst_results->{$user}) eq 'HASH') {
12081: if (keys(%{$inst_results->{$user}}) == 0) {
12082: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12083: } elsif ($item eq 'id') {
12084: if ($inst_results->{$user}->{'id'} eq '') {
12085: $$alerts{$item}{$udom}{$uname} = 1;
12086: }
1.615 raeburn 12087: }
1.612 raeburn 12088: }
12089: }
1.615 raeburn 12090: }
12091: last;
1.585 raeburn 12092: }
12093: }
12094: }
12095: }
12096: }
12097: }
12098: }
12099: }
1.612 raeburn 12100: return;
12101: }
12102:
12103: sub user_rule_formats {
12104: my ($domain,$domdesc,$curr_rules,$check) = @_;
12105: my %text = (
12106: 'username' => 'Usernames',
12107: 'id' => 'IDs',
12108: );
12109: my $output;
12110: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12111: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12112: if (@{$ruleorder} > 0) {
1.1102 raeburn 12113: $output = '<br />'.
12114: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12115: '<span class="LC_cusr_emph">','</span>',$domdesc).
12116: ' <ul>';
1.612 raeburn 12117: foreach my $rule (@{$ruleorder}) {
12118: if (ref($curr_rules) eq 'ARRAY') {
12119: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12120: if (ref($rules->{$rule}) eq 'HASH') {
12121: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12122: $rules->{$rule}{'desc'}.'</li>';
12123: }
12124: }
12125: }
12126: }
12127: $output .= '</ul>';
12128: }
12129: }
12130: return $output;
12131: }
12132:
12133: sub instrule_disallow_msg {
1.615 raeburn 12134: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12135: my $response;
12136: my %text = (
12137: item => 'username',
12138: items => 'usernames',
12139: match => 'matches',
12140: do => 'does',
12141: action => 'a username',
12142: one => 'one',
12143: );
12144: if ($count > 1) {
12145: $text{'item'} = 'usernames';
12146: $text{'match'} ='match';
12147: $text{'do'} = 'do';
12148: $text{'action'} = 'usernames',
12149: $text{'one'} = 'ones';
12150: }
12151: if ($checkitem eq 'id') {
12152: $text{'items'} = 'IDs';
12153: $text{'item'} = 'ID';
12154: $text{'action'} = 'an ID';
1.615 raeburn 12155: if ($count > 1) {
12156: $text{'item'} = 'IDs';
12157: $text{'action'} = 'IDs';
12158: }
1.612 raeburn 12159: }
1.674 bisitz 12160: $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 12161: if ($mode eq 'upload') {
12162: if ($checkitem eq 'username') {
12163: $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'}.");
12164: } elsif ($checkitem eq 'id') {
1.674 bisitz 12165: $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 12166: }
1.669 raeburn 12167: } elsif ($mode eq 'selfcreate') {
12168: if ($checkitem eq 'id') {
12169: $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.");
12170: }
1.615 raeburn 12171: } else {
12172: if ($checkitem eq 'username') {
12173: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12174: } elsif ($checkitem eq 'id') {
12175: $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.");
12176: }
1.612 raeburn 12177: }
12178: return $response;
1.585 raeburn 12179: }
12180:
1.624 raeburn 12181: sub personal_data_fieldtitles {
12182: my %fieldtitles = &Apache::lonlocal::texthash (
12183: id => 'Student/Employee ID',
12184: permanentemail => 'E-mail address',
12185: lastname => 'Last Name',
12186: firstname => 'First Name',
12187: middlename => 'Middle Name',
12188: generation => 'Generation',
12189: gen => 'Generation',
1.765 raeburn 12190: inststatus => 'Affiliation',
1.624 raeburn 12191: );
12192: return %fieldtitles;
12193: }
12194:
1.642 raeburn 12195: sub sorted_inst_types {
12196: my ($dom) = @_;
1.1185 raeburn 12197: my ($usertypes,$order);
12198: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12199: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12200: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12201: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12202: } else {
12203: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12204: }
1.642 raeburn 12205: my $othertitle = &mt('All users');
12206: if ($env{'request.course.id'}) {
1.668 raeburn 12207: $othertitle = &mt('Any users');
1.642 raeburn 12208: }
12209: my @types;
12210: if (ref($order) eq 'ARRAY') {
12211: @types = @{$order};
12212: }
12213: if (@types == 0) {
12214: if (ref($usertypes) eq 'HASH') {
12215: @types = sort(keys(%{$usertypes}));
12216: }
12217: }
12218: if (keys(%{$usertypes}) > 0) {
12219: $othertitle = &mt('Other users');
12220: }
12221: return ($othertitle,$usertypes,\@types);
12222: }
12223:
1.645 raeburn 12224: sub get_institutional_codes {
1.1361 raeburn 12225: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12226: # Get complete list of course sections to update
12227: my @currsections = ();
12228: my @currxlists = ();
1.1361 raeburn 12229: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12230: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12231: my $crskey = $crs.':'.$coursecode;
12232: @{$unclutteredsec{$crskey}} = ();
12233: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12234:
12235: if ($$settings{'internal.sectionnums'} ne '') {
12236: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12237: }
12238:
12239: if ($$settings{'internal.crosslistings'} ne '') {
12240: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12241: }
12242:
12243: if (@currxlists > 0) {
1.1361 raeburn 12244: foreach my $xl (@currxlists) {
12245: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12246: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12247: push(@{$allcourses},$1);
1.645 raeburn 12248: $$LC_code{$1} = $2;
12249: }
12250: }
12251: }
12252: }
1.1361 raeburn 12253:
1.645 raeburn 12254: if (@currsections > 0) {
1.1361 raeburn 12255: foreach my $sec (@currsections) {
12256: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12257: my $instsec = $1;
1.645 raeburn 12258: my $lc_sec = $2;
1.1361 raeburn 12259: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12260: push(@{$unclutteredsec{$crskey}},$instsec);
12261: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12262: }
12263: }
12264: }
12265: }
12266:
12267: if (@{$unclutteredsec{$crskey}} > 0) {
12268: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12269: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12270: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12271: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12272: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12273: push(@{$allcourses},$sec);
1.1361 raeburn 12274: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12275: }
12276: }
12277: }
12278: }
12279: return;
12280: }
12281:
1.971 raeburn 12282: sub get_standard_codeitems {
12283: return ('Year','Semester','Department','Number','Section');
12284: }
12285:
1.112 bowersj2 12286: =pod
12287:
1.780 raeburn 12288: =head1 Slot Helpers
12289:
12290: =over 4
12291:
12292: =item * sorted_slots()
12293:
1.1040 raeburn 12294: Sorts an array of slot names in order of an optional sort key,
12295: default sort is by slot start time (earliest first).
1.780 raeburn 12296:
12297: Inputs:
12298:
12299: =over 4
12300:
12301: slotsarr - Reference to array of unsorted slot names.
12302:
12303: slots - Reference to hash of hash, where outer hash keys are slot names.
12304:
1.1040 raeburn 12305: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12306:
1.549 albertel 12307: =back
12308:
1.780 raeburn 12309: Returns:
12310:
12311: =over 4
12312:
1.1040 raeburn 12313: sorted - An array of slot names sorted by a specified sort key
12314: (default sort key is start time of the slot).
1.780 raeburn 12315:
12316: =back
12317:
12318: =cut
12319:
12320:
12321: sub sorted_slots {
1.1040 raeburn 12322: my ($slotsarr,$slots,$sortkey) = @_;
12323: if ($sortkey eq '') {
12324: $sortkey = 'starttime';
12325: }
1.780 raeburn 12326: my @sorted;
12327: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12328: @sorted =
12329: sort {
12330: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12331: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12332: }
12333: if (ref($slots->{$a})) { return -1;}
12334: if (ref($slots->{$b})) { return 1;}
12335: return 0;
12336: } @{$slotsarr};
12337: }
12338: return @sorted;
12339: }
12340:
1.1040 raeburn 12341: =pod
12342:
12343: =item * get_future_slots()
12344:
12345: Inputs:
12346:
12347: =over 4
12348:
12349: cnum - course number
12350:
12351: cdom - course domain
12352:
12353: now - current UNIX time
12354:
12355: symb - optional symb
12356:
12357: =back
12358:
12359: Returns:
12360:
12361: =over 4
12362:
12363: sorted_reservable - ref to array of student_schedulable slots currently
12364: reservable, ordered by end date of reservation period.
12365:
12366: reservable_now - ref to hash of student_schedulable slots currently
12367: reservable.
12368:
12369: Keys in inner hash are:
12370: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12371: (b) endreserve: end date of reservation period.
12372: (c) uniqueperiod: start,end dates when slot is to be uniquely
12373: selected.
1.1040 raeburn 12374:
12375: sorted_future - ref to array of student_schedulable slots reservable in
12376: the future, ordered by start date of reservation period.
12377:
12378: future_reservable - ref to hash of student_schedulable slots reservable
12379: in the future.
12380:
12381: Keys in inner hash are:
12382: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12383: (b) startreserve: start date of reservation period.
12384: (c) uniqueperiod: start,end dates when slot is to be uniquely
12385: selected.
1.1040 raeburn 12386:
12387: =back
12388:
12389: =cut
12390:
12391: sub get_future_slots {
12392: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12393: my $map;
12394: if ($symb) {
12395: ($map) = &Apache::lonnet::decode_symb($symb);
12396: }
1.1040 raeburn 12397: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12398: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12399: foreach my $slot (keys(%slots)) {
12400: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12401: if ($symb) {
1.1229 raeburn 12402: if ($slots{$slot}->{'symb'} ne '') {
12403: my $canuse;
12404: my %oksymbs;
12405: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12406: map { $oksymbs{$_} = 1; } @slotsymbs;
12407: if ($oksymbs{$symb}) {
12408: $canuse = 1;
12409: } else {
12410: foreach my $item (@slotsymbs) {
12411: if ($item =~ /\.(page|sequence)$/) {
12412: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12413: if (($map ne '') && ($map eq $sloturl)) {
12414: $canuse = 1;
12415: last;
12416: }
12417: }
12418: }
12419: }
12420: next unless ($canuse);
12421: }
1.1040 raeburn 12422: }
12423: if (($slots{$slot}->{'starttime'} > $now) &&
12424: ($slots{$slot}->{'endtime'} > $now)) {
12425: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12426: my $userallowed = 0;
12427: if ($slots{$slot}->{'allowedsections'}) {
12428: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12429: if (!defined($env{'request.role.sec'})
12430: && grep(/^No section assigned$/,@allowed_sec)) {
12431: $userallowed=1;
12432: } else {
12433: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12434: $userallowed=1;
12435: }
12436: }
12437: unless ($userallowed) {
12438: if (defined($env{'request.course.groups'})) {
12439: my @groups = split(/:/,$env{'request.course.groups'});
12440: foreach my $group (@groups) {
12441: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12442: $userallowed=1;
12443: last;
12444: }
12445: }
12446: }
12447: }
12448: }
12449: if ($slots{$slot}->{'allowedusers'}) {
12450: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12451: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12452: if (grep(/^\Q$user\E$/,@allowed_users)) {
12453: $userallowed = 1;
12454: }
12455: }
12456: next unless($userallowed);
12457: }
12458: my $startreserve = $slots{$slot}->{'startreserve'};
12459: my $endreserve = $slots{$slot}->{'endreserve'};
12460: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12461: my $uniqueperiod;
12462: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12463: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12464: }
1.1040 raeburn 12465: if (($startreserve < $now) &&
12466: (!$endreserve || $endreserve > $now)) {
12467: my $lastres = $endreserve;
12468: if (!$lastres) {
12469: $lastres = $slots{$slot}->{'starttime'};
12470: }
12471: $reservable_now{$slot} = {
12472: symb => $symb,
1.1250 raeburn 12473: endreserve => $lastres,
12474: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12475: };
12476: } elsif (($startreserve > $now) &&
12477: (!$endreserve || $endreserve > $startreserve)) {
12478: $future_reservable{$slot} = {
12479: symb => $symb,
1.1250 raeburn 12480: startreserve => $startreserve,
12481: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12482: };
12483: }
12484: }
12485: }
12486: my @unsorted_reservable = keys(%reservable_now);
12487: if (@unsorted_reservable > 0) {
12488: @sorted_reservable =
12489: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12490: }
12491: my @unsorted_future = keys(%future_reservable);
12492: if (@unsorted_future > 0) {
12493: @sorted_future =
12494: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12495: }
12496: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12497: }
1.780 raeburn 12498:
12499: =pod
12500:
1.1057 foxr 12501: =back
12502:
1.549 albertel 12503: =head1 HTTP Helpers
12504:
12505: =over 4
12506:
1.648 raeburn 12507: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12508:
1.258 albertel 12509: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12510: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12511: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12512:
12513: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12514: $possible_names is an ref to an array of form element names. As an example:
12515: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12516: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12517:
12518: =cut
1.1 albertel 12519:
1.6 albertel 12520: sub get_unprocessed_cgi {
1.25 albertel 12521: my ($query,$possible_names)= @_;
1.26 matthew 12522: # $Apache::lonxml::debug=1;
1.356 albertel 12523: foreach my $pair (split(/&/,$query)) {
12524: my ($name, $value) = split(/=/,$pair);
1.369 www 12525: $name = &unescape($name);
1.25 albertel 12526: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12527: $value =~ tr/+/ /;
12528: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12529: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12530: }
1.16 harris41 12531: }
1.6 albertel 12532: }
12533:
1.112 bowersj2 12534: =pod
12535:
1.648 raeburn 12536: =item * &cacheheader()
1.112 bowersj2 12537:
12538: returns cache-controlling header code
12539:
12540: =cut
12541:
1.7 albertel 12542: sub cacheheader {
1.258 albertel 12543: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12544: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12545: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12546: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12547: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12548: return $output;
1.7 albertel 12549: }
12550:
1.112 bowersj2 12551: =pod
12552:
1.648 raeburn 12553: =item * &no_cache($r)
1.112 bowersj2 12554:
12555: specifies header code to not have cache
12556:
12557: =cut
12558:
1.9 albertel 12559: sub no_cache {
1.216 albertel 12560: my ($r) = @_;
12561: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12562: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12563: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12564: $r->no_cache(1);
12565: $r->header_out("Expires" => $date);
12566: $r->header_out("Pragma" => "no-cache");
1.123 www 12567: }
12568:
12569: sub content_type {
1.181 albertel 12570: my ($r,$type,$charset) = @_;
1.299 foxr 12571: if ($r) {
12572: # Note that printout.pl calls this with undef for $r.
12573: &no_cache($r);
12574: }
1.258 albertel 12575: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12576: unless ($charset) {
12577: $charset=&Apache::lonlocal::current_encoding;
12578: }
12579: if ($charset) { $type.='; charset='.$charset; }
12580: if ($r) {
12581: $r->content_type($type);
12582: } else {
12583: print("Content-type: $type\n\n");
12584: }
1.9 albertel 12585: }
1.25 albertel 12586:
1.112 bowersj2 12587: =pod
12588:
1.648 raeburn 12589: =item * &add_to_env($name,$value)
1.112 bowersj2 12590:
1.258 albertel 12591: adds $name to the %env hash with value
1.112 bowersj2 12592: $value, if $name already exists, the entry is converted to an array
12593: reference and $value is added to the array.
12594:
12595: =cut
12596:
1.25 albertel 12597: sub add_to_env {
12598: my ($name,$value)=@_;
1.258 albertel 12599: if (defined($env{$name})) {
12600: if (ref($env{$name})) {
1.25 albertel 12601: #already have multiple values
1.258 albertel 12602: push(@{ $env{$name} },$value);
1.25 albertel 12603: } else {
12604: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12605: my $first=$env{$name};
12606: undef($env{$name});
12607: push(@{ $env{$name} },$first,$value);
1.25 albertel 12608: }
12609: } else {
1.258 albertel 12610: $env{$name}=$value;
1.25 albertel 12611: }
1.31 albertel 12612: }
1.149 albertel 12613:
12614: =pod
12615:
1.648 raeburn 12616: =item * &get_env_multiple($name)
1.149 albertel 12617:
1.258 albertel 12618: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12619: values may be defined and end up as an array ref.
12620:
12621: returns an array of values
12622:
12623: =cut
12624:
12625: sub get_env_multiple {
12626: my ($name) = @_;
12627: my @values;
1.258 albertel 12628: if (defined($env{$name})) {
1.149 albertel 12629: # exists is it an array
1.258 albertel 12630: if (ref($env{$name})) {
12631: @values=@{ $env{$name} };
1.149 albertel 12632: } else {
1.258 albertel 12633: $values[0]=$env{$name};
1.149 albertel 12634: }
12635: }
12636: return(@values);
12637: }
12638:
1.1249 damieng 12639: # Looks at given dependencies, and returns something depending on the context.
12640: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12641: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12642: # For all other contexts, returns ($output, $counter, $numpathchg).
12643: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12644: # $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.
12645: # $numpathchg: integer with the number of cleaned up dependency paths.
12646: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12647: # \%mapping: hash reference clean path -> original path for all dependencies.
12648: # @param {string} actionurl - The path to the handler, indicative of the context.
12649: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12650: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12651: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12652: # @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)
12653: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12654: sub ask_for_embedded_content {
1.1249 damieng 12655: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12656: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12657: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12658: %currsubfile,%unused,$rem);
1.1071 raeburn 12659: my $counter = 0;
12660: my $numnew = 0;
1.987 raeburn 12661: my $numremref = 0;
12662: my $numinvalid = 0;
12663: my $numpathchg = 0;
12664: my $numexisting = 0;
1.1071 raeburn 12665: my $numunused = 0;
12666: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12667: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12668: my $heading = &mt('Upload embedded files');
12669: my $buttontext = &mt('Upload');
12670:
1.1249 damieng 12671: # fills these variables based on the context:
12672: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12673: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12674: if ($env{'request.course.id'}) {
1.1123 raeburn 12675: if ($actionurl eq '/adm/dependencies') {
12676: $navmap = Apache::lonnavmaps::navmap->new();
12677: }
12678: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12679: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12680: }
1.1123 raeburn 12681: if (($actionurl eq '/adm/portfolio') ||
12682: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12683: my $current_path='/';
12684: if ($env{'form.currentpath'}) {
12685: $current_path = $env{'form.currentpath'};
12686: }
12687: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12688: $udom = $cdom;
12689: $uname = $cnum;
1.984 raeburn 12690: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12691: } else {
12692: $udom = $env{'user.domain'};
12693: $uname = $env{'user.name'};
12694: $url = '/userfiles/portfolio';
12695: }
1.987 raeburn 12696: $toplevel = $url.'/';
1.984 raeburn 12697: $url .= $current_path;
12698: $getpropath = 1;
1.987 raeburn 12699: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12700: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12701: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12702: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12703: $toplevel = $url;
1.984 raeburn 12704: if ($rest ne '') {
1.987 raeburn 12705: $url .= $rest;
12706: }
12707: } elsif ($actionurl eq '/adm/coursedocs') {
12708: if (ref($args) eq 'HASH') {
1.1071 raeburn 12709: $url = $args->{'docs_url'};
12710: $toplevel = $url;
1.1084 raeburn 12711: if ($args->{'context'} eq 'paste') {
12712: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12713: ($path) =
12714: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12715: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12716: $fileloc =~ s{^/}{};
12717: }
1.1071 raeburn 12718: }
1.1084 raeburn 12719: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12720: if ($env{'request.course.id'} ne '') {
12721: if (ref($args) eq 'HASH') {
12722: $url = $args->{'docs_url'};
12723: $title = $args->{'docs_title'};
1.1126 raeburn 12724: $toplevel = $url;
12725: unless ($toplevel =~ m{^/}) {
12726: $toplevel = "/$url";
12727: }
1.1085 raeburn 12728: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12729: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12730: $path = $1;
12731: } else {
12732: ($path) =
12733: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12734: }
1.1195 raeburn 12735: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12736: $fileloc = $toplevel;
12737: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12738: my ($udom,$uname,$fname) =
12739: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12740: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12741: } else {
12742: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12743: }
1.1071 raeburn 12744: $fileloc =~ s{^/}{};
12745: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12746: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12747: }
1.987 raeburn 12748: }
1.1123 raeburn 12749: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12750: $udom = $cdom;
12751: $uname = $cnum;
12752: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12753: $toplevel = $url;
12754: $path = $url;
12755: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12756: $fileloc =~ s{^/}{};
1.987 raeburn 12757: }
1.1249 damieng 12758:
12759: # parses the dependency paths to get some info
12760: # fills $newfiles, $mapping, $subdependencies, $dependencies
12761: # $newfiles: hash URL -> 1 for new files or external URLs
12762: # (will be completed later)
12763: # $mapping:
12764: # for external URLs: external URL -> external URL
12765: # for relative paths: clean path -> original path
12766: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12767: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12768: foreach my $file (keys(%{$allfiles})) {
12769: my $embed_file;
12770: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12771: $embed_file = $1;
12772: } else {
12773: $embed_file = $file;
12774: }
1.1158 raeburn 12775: my ($absolutepath,$cleaned_file);
12776: if ($embed_file =~ m{^\w+://}) {
12777: $cleaned_file = $embed_file;
1.1147 raeburn 12778: $newfiles{$cleaned_file} = 1;
12779: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12780: } else {
1.1158 raeburn 12781: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12782: if ($embed_file =~ m{^/}) {
12783: $absolutepath = $embed_file;
12784: }
1.1147 raeburn 12785: if ($cleaned_file =~ m{/}) {
12786: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12787: $path = &check_for_traversal($path,$url,$toplevel);
12788: my $item = $fname;
12789: if ($path ne '') {
12790: $item = $path.'/'.$fname;
12791: $subdependencies{$path}{$fname} = 1;
12792: } else {
12793: $dependencies{$item} = 1;
12794: }
12795: if ($absolutepath) {
12796: $mapping{$item} = $absolutepath;
12797: } else {
12798: $mapping{$item} = $embed_file;
12799: }
12800: } else {
12801: $dependencies{$embed_file} = 1;
12802: if ($absolutepath) {
1.1147 raeburn 12803: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12804: } else {
1.1147 raeburn 12805: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12806: }
12807: }
1.984 raeburn 12808: }
12809: }
1.1249 damieng 12810:
12811: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12812: # and lists
12813: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12814: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12815: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12816: # the path had to be cleaned up
12817: # $existing: hash clean path -> 1 if the file exists
12818: # $numexisting: number of keys in $existing
12819: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12820: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12821: # dependency subdirectories that are
12822: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12823: my $dirptr = 16384;
1.984 raeburn 12824: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12825: $currsubfile{$path} = {};
1.1123 raeburn 12826: if (($actionurl eq '/adm/portfolio') ||
12827: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12828: my ($sublistref,$listerror) =
12829: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12830: if (ref($sublistref) eq 'ARRAY') {
12831: foreach my $line (@{$sublistref}) {
12832: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12833: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12834: }
1.984 raeburn 12835: }
1.987 raeburn 12836: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12837: if (opendir(my $dir,$url.'/'.$path)) {
12838: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12839: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12840: }
1.1084 raeburn 12841: } elsif (($actionurl eq '/adm/dependencies') ||
12842: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12843: ($args->{'context'} eq 'paste')) ||
12844: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12845: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12846: my $dir;
12847: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12848: $dir = $fileloc;
12849: } else {
12850: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12851: }
1.1071 raeburn 12852: if ($dir ne '') {
12853: my ($sublistref,$listerror) =
12854: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12855: if (ref($sublistref) eq 'ARRAY') {
12856: foreach my $line (@{$sublistref}) {
12857: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12858: undef,$mtime)=split(/\&/,$line,12);
12859: unless (($testdir&$dirptr) ||
12860: ($file_name =~ /^\.\.?$/)) {
12861: $currsubfile{$path}{$file_name} = [$size,$mtime];
12862: }
12863: }
12864: }
12865: }
1.984 raeburn 12866: }
12867: }
12868: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12869: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12870: my $item = $path.'/'.$file;
12871: unless ($mapping{$item} eq $item) {
12872: $pathchanges{$item} = 1;
12873: }
12874: $existing{$item} = 1;
12875: $numexisting ++;
12876: } else {
12877: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12878: }
12879: }
1.1071 raeburn 12880: if ($actionurl eq '/adm/dependencies') {
12881: foreach my $path (keys(%currsubfile)) {
12882: if (ref($currsubfile{$path}) eq 'HASH') {
12883: foreach my $file (keys(%{$currsubfile{$path}})) {
12884: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12885: next if (($rem ne '') &&
12886: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12887: (ref($navmap) &&
12888: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12889: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12890: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12891: $unused{$path.'/'.$file} = 1;
12892: }
12893: }
12894: }
12895: }
12896: }
1.984 raeburn 12897: }
1.1249 damieng 12898:
12899: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12900: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12901: my %currfile;
1.1123 raeburn 12902: if (($actionurl eq '/adm/portfolio') ||
12903: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12904: my ($dirlistref,$listerror) =
12905: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12906: if (ref($dirlistref) eq 'ARRAY') {
12907: foreach my $line (@{$dirlistref}) {
12908: my ($file_name,$rest) = split(/\&/,$line,2);
12909: $currfile{$file_name} = 1;
12910: }
1.984 raeburn 12911: }
1.987 raeburn 12912: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12913: if (opendir(my $dir,$url)) {
1.987 raeburn 12914: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12915: map {$currfile{$_} = 1;} @dir_list;
12916: }
1.1084 raeburn 12917: } elsif (($actionurl eq '/adm/dependencies') ||
12918: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12919: ($args->{'context'} eq 'paste')) ||
12920: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12921: if ($env{'request.course.id'} ne '') {
12922: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12923: if ($dir ne '') {
12924: my ($dirlistref,$listerror) =
12925: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12926: if (ref($dirlistref) eq 'ARRAY') {
12927: foreach my $line (@{$dirlistref}) {
12928: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12929: $size,undef,$mtime)=split(/\&/,$line,12);
12930: unless (($testdir&$dirptr) ||
12931: ($file_name =~ /^\.\.?$/)) {
12932: $currfile{$file_name} = [$size,$mtime];
12933: }
12934: }
12935: }
12936: }
12937: }
1.984 raeburn 12938: }
1.1249 damieng 12939: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12940: # are not in subdirectories, using $currfile
1.984 raeburn 12941: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12942: if (exists($currfile{$file})) {
1.987 raeburn 12943: unless ($mapping{$file} eq $file) {
12944: $pathchanges{$file} = 1;
12945: }
12946: $existing{$file} = 1;
12947: $numexisting ++;
12948: } else {
1.984 raeburn 12949: $newfiles{$file} = 1;
12950: }
12951: }
1.1071 raeburn 12952: foreach my $file (keys(%currfile)) {
12953: unless (($file eq $filename) ||
12954: ($file eq $filename.'.bak') ||
12955: ($dependencies{$file})) {
1.1085 raeburn 12956: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12957: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12958: next if (($rem ne '') &&
12959: (($env{"httpref.$rem".$file} ne '') ||
12960: (ref($navmap) &&
12961: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12962: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12963: ($navmap->getResourceByUrl($rem.$1)))))));
12964: }
1.1085 raeburn 12965: }
1.1071 raeburn 12966: $unused{$file} = 1;
12967: }
12968: }
1.1249 damieng 12969:
12970: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12971: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12972: ($args->{'context'} eq 'paste')) {
12973: $counter = scalar(keys(%existing));
12974: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12975: return ($output,$counter,$numpathchg,\%existing);
12976: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12977: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12978: $counter = scalar(keys(%existing));
12979: $numpathchg = scalar(keys(%pathchanges));
12980: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12981: }
1.1249 damieng 12982:
12983: # returns HTML otherwise, with dependency results and to ask for more uploads
12984:
12985: # $upload_output: missing dependencies (with upload form)
12986: # $modify_output: uploaded dependencies (in use)
12987: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12988: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12989: if ($actionurl eq '/adm/dependencies') {
12990: next if ($embed_file =~ m{^\w+://});
12991: }
1.660 raeburn 12992: $upload_output .= &start_data_table_row().
1.1123 raeburn 12993: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12994: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12995: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12996: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12997: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12998: }
1.1123 raeburn 12999: $upload_output .= '</td>';
1.1071 raeburn 13000: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13001: $upload_output.='<td align="right">'.
13002: '<span class="LC_info LC_fontsize_medium">'.
13003: &mt("URL points to web address").'</span>';
1.987 raeburn 13004: $numremref++;
1.660 raeburn 13005: } elsif ($args->{'error_on_invalid_names'}
13006: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13007: $upload_output.='<td align="right"><span class="LC_warning">'.
13008: &mt('Invalid characters').'</span>';
1.987 raeburn 13009: $numinvalid++;
1.660 raeburn 13010: } else {
1.1123 raeburn 13011: $upload_output .= '<td>'.
13012: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13013: $embed_file,\%mapping,
1.1071 raeburn 13014: $allfiles,$codebase,'upload');
13015: $counter ++;
13016: $numnew ++;
1.987 raeburn 13017: }
13018: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13019: }
13020: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13021: if ($actionurl eq '/adm/dependencies') {
13022: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13023: $modify_output .= &start_data_table_row().
13024: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13025: '<img src="'.&icon($embed_file).'" border="0" />'.
13026: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13027: '<td>'.$size.'</td>'.
13028: '<td>'.$mtime.'</td>'.
13029: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13030: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13031: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13032: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13033: &embedded_file_element('upload_embedded',$counter,
13034: $embed_file,\%mapping,
13035: $allfiles,$codebase,'modify').
13036: '</div></td>'.
13037: &end_data_table_row()."\n";
13038: $counter ++;
13039: } else {
13040: $upload_output .= &start_data_table_row().
1.1123 raeburn 13041: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13042: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13043: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13044: &Apache::loncommon::end_data_table_row()."\n";
13045: }
13046: }
13047: my $delidx = $counter;
13048: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13049: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13050: $delete_output .= &start_data_table_row().
13051: '<td><img src="'.&icon($oldfile).'" />'.
13052: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13053: '<td>'.$size.'</td>'.
13054: '<td>'.$mtime.'</td>'.
13055: '<td><label><input type="checkbox" name="del_upload_dep" '.
13056: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13057: &embedded_file_element('upload_embedded',$delidx,
13058: $oldfile,\%mapping,$allfiles,
13059: $codebase,'delete').'</td>'.
13060: &end_data_table_row()."\n";
13061: $numunused ++;
13062: $delidx ++;
1.987 raeburn 13063: }
13064: if ($upload_output) {
13065: $upload_output = &start_data_table().
13066: $upload_output.
13067: &end_data_table()."\n";
13068: }
1.1071 raeburn 13069: if ($modify_output) {
13070: $modify_output = &start_data_table().
13071: &start_data_table_header_row().
13072: '<th>'.&mt('File').'</th>'.
13073: '<th>'.&mt('Size (KB)').'</th>'.
13074: '<th>'.&mt('Modified').'</th>'.
13075: '<th>'.&mt('Upload replacement?').'</th>'.
13076: &end_data_table_header_row().
13077: $modify_output.
13078: &end_data_table()."\n";
13079: }
13080: if ($delete_output) {
13081: $delete_output = &start_data_table().
13082: &start_data_table_header_row().
13083: '<th>'.&mt('File').'</th>'.
13084: '<th>'.&mt('Size (KB)').'</th>'.
13085: '<th>'.&mt('Modified').'</th>'.
13086: '<th>'.&mt('Delete?').'</th>'.
13087: &end_data_table_header_row().
13088: $delete_output.
13089: &end_data_table()."\n";
13090: }
1.987 raeburn 13091: my $applies = 0;
13092: if ($numremref) {
13093: $applies ++;
13094: }
13095: if ($numinvalid) {
13096: $applies ++;
13097: }
13098: if ($numexisting) {
13099: $applies ++;
13100: }
1.1071 raeburn 13101: if ($counter || $numunused) {
1.987 raeburn 13102: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13103: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13104: $state.'<h3>'.$heading.'</h3>';
13105: if ($actionurl eq '/adm/dependencies') {
13106: if ($numnew) {
13107: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13108: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13109: $upload_output.'<br />'."\n";
13110: }
13111: if ($numexisting) {
13112: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13113: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13114: $modify_output.'<br />'."\n";
13115: $buttontext = &mt('Save changes');
13116: }
13117: if ($numunused) {
13118: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13119: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13120: $delete_output.'<br />'."\n";
13121: $buttontext = &mt('Save changes');
13122: }
13123: } else {
13124: $output .= $upload_output.'<br />'."\n";
13125: }
13126: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13127: $counter.'" />'."\n";
13128: if ($actionurl eq '/adm/dependencies') {
13129: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13130: $numnew.'" />'."\n";
13131: } elsif ($actionurl eq '') {
1.987 raeburn 13132: $output .= '<input type="hidden" name="phase" value="three" />';
13133: }
13134: } elsif ($applies) {
13135: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13136: if ($applies > 1) {
13137: $output .=
1.1123 raeburn 13138: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13139: if ($numremref) {
13140: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13141: }
13142: if ($numinvalid) {
13143: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13144: }
13145: if ($numexisting) {
13146: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13147: }
13148: $output .= '</ul><br />';
13149: } elsif ($numremref) {
13150: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13151: } elsif ($numinvalid) {
13152: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13153: } elsif ($numexisting) {
13154: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13155: }
13156: $output .= $upload_output.'<br />';
13157: }
13158: my ($pathchange_output,$chgcount);
1.1071 raeburn 13159: $chgcount = $counter;
1.987 raeburn 13160: if (keys(%pathchanges) > 0) {
13161: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13162: if ($counter) {
1.987 raeburn 13163: $output .= &embedded_file_element('pathchange',$chgcount,
13164: $embed_file,\%mapping,
1.1071 raeburn 13165: $allfiles,$codebase,'change');
1.987 raeburn 13166: } else {
13167: $pathchange_output .=
13168: &start_data_table_row().
13169: '<td><input type ="checkbox" name="namechange" value="'.
13170: $chgcount.'" checked="checked" /></td>'.
13171: '<td>'.$mapping{$embed_file}.'</td>'.
13172: '<td>'.$embed_file.
13173: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13174: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13175: '</td>'.&end_data_table_row();
1.660 raeburn 13176: }
1.987 raeburn 13177: $numpathchg ++;
13178: $chgcount ++;
1.660 raeburn 13179: }
13180: }
1.1127 raeburn 13181: if (($counter) || ($numunused)) {
1.987 raeburn 13182: if ($numpathchg) {
13183: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13184: $numpathchg.'" />'."\n";
13185: }
13186: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13187: ($actionurl eq '/adm/imsimport')) {
13188: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13189: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13190: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13191: } elsif ($actionurl eq '/adm/dependencies') {
13192: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13193: }
1.1123 raeburn 13194: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13195: } elsif ($numpathchg) {
13196: my %pathchange = ();
13197: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13198: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13199: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13200: }
1.987 raeburn 13201: }
1.1071 raeburn 13202: return ($output,$counter,$numpathchg);
1.987 raeburn 13203: }
13204:
1.1147 raeburn 13205: =pod
13206:
13207: =item * clean_path($name)
13208:
13209: Performs clean-up of directories, subdirectories and filename in an
13210: embedded object, referenced in an HTML file which is being uploaded
13211: to a course or portfolio, where
13212: "Upload embedded images/multimedia files if HTML file" checkbox was
13213: checked.
13214:
13215: Clean-up is similar to replacements in lonnet::clean_filename()
13216: except each / between sub-directory and next level is preserved.
13217:
13218: =cut
13219:
13220: sub clean_path {
13221: my ($embed_file) = @_;
13222: $embed_file =~s{^/+}{};
13223: my @contents;
13224: if ($embed_file =~ m{/}) {
13225: @contents = split(/\//,$embed_file);
13226: } else {
13227: @contents = ($embed_file);
13228: }
13229: my $lastidx = scalar(@contents)-1;
13230: for (my $i=0; $i<=$lastidx; $i++) {
13231: $contents[$i]=~s{\\}{/}g;
13232: $contents[$i]=~s/\s+/\_/g;
13233: $contents[$i]=~s{[^/\w\.\-]}{}g;
13234: if ($i == $lastidx) {
13235: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13236: }
13237: }
13238: if ($lastidx > 0) {
13239: return join('/',@contents);
13240: } else {
13241: return $contents[0];
13242: }
13243: }
13244:
1.987 raeburn 13245: sub embedded_file_element {
1.1071 raeburn 13246: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13247: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13248: (ref($codebase) eq 'HASH'));
13249: my $output;
1.1071 raeburn 13250: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13251: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13252: }
13253: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13254: &escape($embed_file).'" />';
13255: unless (($context eq 'upload_embedded') &&
13256: ($mapping->{$embed_file} eq $embed_file)) {
13257: $output .='
13258: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13259: }
13260: my $attrib;
13261: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13262: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13263: }
13264: $output .=
13265: "\n\t\t".
13266: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13267: $attrib.'" />';
13268: if (exists($codebase->{$mapping->{$embed_file}})) {
13269: $output .=
13270: "\n\t\t".
13271: '<input name="codebase_'.$num.'" type="hidden" value="'.
13272: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13273: }
1.987 raeburn 13274: return $output;
1.660 raeburn 13275: }
13276:
1.1071 raeburn 13277: sub get_dependency_details {
13278: my ($currfile,$currsubfile,$embed_file) = @_;
13279: my ($size,$mtime,$showsize,$showmtime);
13280: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13281: if ($embed_file =~ m{/}) {
13282: my ($path,$fname) = split(/\//,$embed_file);
13283: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13284: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13285: }
13286: } else {
13287: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13288: ($size,$mtime) = @{$currfile->{$embed_file}};
13289: }
13290: }
13291: $showsize = $size/1024.0;
13292: $showsize = sprintf("%.1f",$showsize);
13293: if ($mtime > 0) {
13294: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13295: }
13296: }
13297: return ($showsize,$showmtime);
13298: }
13299:
13300: sub ask_embedded_js {
13301: return <<"END";
13302: <script type="text/javascript"">
13303: // <![CDATA[
13304: function toggleBrowse(counter) {
13305: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13306: var fileid = document.getElementById('embedded_item_'+counter);
13307: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13308: if (chkboxid.checked == true) {
13309: uploaddivid.style.display='block';
13310: } else {
13311: uploaddivid.style.display='none';
13312: fileid.value = '';
13313: }
13314: }
13315: // ]]>
13316: </script>
13317:
13318: END
13319: }
13320:
1.661 raeburn 13321: sub upload_embedded {
13322: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13323: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13324: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13325: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13326: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13327: my $orig_uploaded_filename =
13328: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13329: foreach my $type ('orig','ref','attrib','codebase') {
13330: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13331: $env{'form.embedded_'.$type.'_'.$i} =
13332: &unescape($env{'form.embedded_'.$type.'_'.$i});
13333: }
13334: }
1.661 raeburn 13335: my ($path,$fname) =
13336: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13337: # no path, whole string is fname
13338: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13339: $fname = &Apache::lonnet::clean_filename($fname);
13340: # See if there is anything left
13341: next if ($fname eq '');
13342:
13343: # Check if file already exists as a file or directory.
13344: my ($state,$msg);
13345: if ($context eq 'portfolio') {
13346: my $port_path = $dirpath;
13347: if ($group ne '') {
13348: $port_path = "groups/$group/$port_path";
13349: }
1.987 raeburn 13350: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13351: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13352: $dir_root,$port_path,$disk_quota,
13353: $current_disk_usage,$uname,$udom);
13354: if ($state eq 'will_exceed_quota'
1.984 raeburn 13355: || $state eq 'file_locked') {
1.661 raeburn 13356: $output .= $msg;
13357: next;
13358: }
13359: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13360: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13361: if ($state eq 'exists') {
13362: $output .= $msg;
13363: next;
13364: }
13365: }
13366: # Check if extension is valid
13367: if (($fname =~ /\.(\w+)$/) &&
13368: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13369: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13370: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13371: next;
13372: } elsif (($fname =~ /\.(\w+)$/) &&
13373: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13374: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13375: next;
13376: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13377: $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 13378: next;
13379: }
13380: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13381: my $subdir = $path;
13382: $subdir =~ s{/+$}{};
1.661 raeburn 13383: if ($context eq 'portfolio') {
1.984 raeburn 13384: my $result;
13385: if ($state eq 'existingfile') {
13386: $result=
13387: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13388: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13389: } else {
1.984 raeburn 13390: $result=
13391: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13392: $dirpath.
1.1123 raeburn 13393: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13394: if ($result !~ m|^/uploaded/|) {
13395: $output .= '<span class="LC_error">'
13396: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13397: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13398: .'</span><br />';
13399: next;
13400: } else {
1.987 raeburn 13401: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13402: $path.$fname.'</span>').'<br />';
1.984 raeburn 13403: }
1.661 raeburn 13404: }
1.1123 raeburn 13405: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13406: my $extendedsubdir = $dirpath.'/'.$subdir;
13407: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13408: my $result =
1.1126 raeburn 13409: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13410: if ($result !~ m|^/uploaded/|) {
13411: $output .= '<span class="LC_error">'
13412: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13413: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13414: .'</span><br />';
13415: next;
13416: } else {
13417: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13418: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13419: if ($context eq 'syllabus') {
13420: &Apache::lonnet::make_public_indefinitely($result);
13421: }
1.987 raeburn 13422: }
1.661 raeburn 13423: } else {
13424: # Save the file
13425: my $target = $env{'form.embedded_item_'.$i};
13426: my $fullpath = $dir_root.$dirpath.'/'.$path;
13427: my $dest = $fullpath.$fname;
13428: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13429: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13430: my $count;
13431: my $filepath = $dir_root;
1.1027 raeburn 13432: foreach my $subdir (@parts) {
13433: $filepath .= "/$subdir";
13434: if (!-e $filepath) {
1.661 raeburn 13435: mkdir($filepath,0770);
13436: }
13437: }
13438: my $fh;
13439: if (!open($fh,'>'.$dest)) {
13440: &Apache::lonnet::logthis('Failed to create '.$dest);
13441: $output .= '<span class="LC_error">'.
1.1071 raeburn 13442: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13443: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13444: '</span><br />';
13445: } else {
13446: if (!print $fh $env{'form.embedded_item_'.$i}) {
13447: &Apache::lonnet::logthis('Failed to write to '.$dest);
13448: $output .= '<span class="LC_error">'.
1.1071 raeburn 13449: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13450: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13451: '</span><br />';
13452: } else {
1.987 raeburn 13453: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13454: $url.'</span>').'<br />';
13455: unless ($context eq 'testbank') {
13456: $footer .= &mt('View embedded file: [_1]',
13457: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13458: }
13459: }
13460: close($fh);
13461: }
13462: }
13463: if ($env{'form.embedded_ref_'.$i}) {
13464: $pathchange{$i} = 1;
13465: }
13466: }
13467: if ($output) {
13468: $output = '<p>'.$output.'</p>';
13469: }
13470: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13471: $returnflag = 'ok';
1.1071 raeburn 13472: my $numpathchgs = scalar(keys(%pathchange));
13473: if ($numpathchgs > 0) {
1.987 raeburn 13474: if ($context eq 'portfolio') {
13475: $output .= '<p>'.&mt('or').'</p>';
13476: } elsif ($context eq 'testbank') {
1.1071 raeburn 13477: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13478: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13479: $returnflag = 'modify_orightml';
13480: }
13481: }
1.1071 raeburn 13482: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13483: }
13484:
13485: sub modify_html_form {
13486: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13487: my $end = 0;
13488: my $modifyform;
13489: if ($context eq 'upload_embedded') {
13490: return unless (ref($pathchange) eq 'HASH');
13491: if ($env{'form.number_embedded_items'}) {
13492: $end += $env{'form.number_embedded_items'};
13493: }
13494: if ($env{'form.number_pathchange_items'}) {
13495: $end += $env{'form.number_pathchange_items'};
13496: }
13497: if ($end) {
13498: for (my $i=0; $i<$end; $i++) {
13499: if ($i < $env{'form.number_embedded_items'}) {
13500: next unless($pathchange->{$i});
13501: }
13502: $modifyform .=
13503: &start_data_table_row().
13504: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13505: 'checked="checked" /></td>'.
13506: '<td>'.$env{'form.embedded_ref_'.$i}.
13507: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13508: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13509: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13510: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13511: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13512: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13513: '<td>'.$env{'form.embedded_orig_'.$i}.
13514: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13515: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13516: &end_data_table_row();
1.1071 raeburn 13517: }
1.987 raeburn 13518: }
13519: } else {
13520: $modifyform = $pathchgtable;
13521: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13522: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13523: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13524: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13525: }
13526: }
13527: if ($modifyform) {
1.1071 raeburn 13528: if ($actionurl eq '/adm/dependencies') {
13529: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13530: }
1.987 raeburn 13531: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13532: '<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".
13533: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13534: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13535: '</ol></p>'."\n".'<p>'.
13536: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13537: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13538: &start_data_table()."\n".
13539: &start_data_table_header_row().
13540: '<th>'.&mt('Change?').'</th>'.
13541: '<th>'.&mt('Current reference').'</th>'.
13542: '<th>'.&mt('Required reference').'</th>'.
13543: &end_data_table_header_row()."\n".
13544: $modifyform.
13545: &end_data_table().'<br />'."\n".$hiddenstate.
13546: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13547: '</form>'."\n";
13548: }
13549: return;
13550: }
13551:
13552: sub modify_html_refs {
1.1123 raeburn 13553: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13554: my $container;
13555: if ($context eq 'portfolio') {
13556: $container = $env{'form.container'};
13557: } elsif ($context eq 'coursedoc') {
13558: $container = $env{'form.primaryurl'};
1.1071 raeburn 13559: } elsif ($context eq 'manage_dependencies') {
13560: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13561: $container = "/$container";
1.1123 raeburn 13562: } elsif ($context eq 'syllabus') {
13563: $container = $url;
1.987 raeburn 13564: } else {
1.1027 raeburn 13565: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13566: }
13567: my (%allfiles,%codebase,$output,$content);
13568: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13569: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13570: if (wantarray) {
13571: return ('',0,0);
13572: } else {
13573: return;
13574: }
13575: }
13576: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13577: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13578: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13579: if (wantarray) {
13580: return ('',0,0);
13581: } else {
13582: return;
13583: }
13584: }
1.987 raeburn 13585: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13586: if ($content eq '-1') {
13587: if (wantarray) {
13588: return ('',0,0);
13589: } else {
13590: return;
13591: }
13592: }
1.987 raeburn 13593: } else {
1.1071 raeburn 13594: unless ($container =~ /^\Q$dir_root\E/) {
13595: if (wantarray) {
13596: return ('',0,0);
13597: } else {
13598: return;
13599: }
13600: }
1.1317 raeburn 13601: if (open(my $fh,'<',$container)) {
1.987 raeburn 13602: $content = join('', <$fh>);
13603: close($fh);
13604: } else {
1.1071 raeburn 13605: if (wantarray) {
13606: return ('',0,0);
13607: } else {
13608: return;
13609: }
1.987 raeburn 13610: }
13611: }
13612: my ($count,$codebasecount) = (0,0);
13613: my $mm = new File::MMagic;
13614: my $mime_type = $mm->checktype_contents($content);
13615: if ($mime_type eq 'text/html') {
13616: my $parse_result =
13617: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13618: \%codebase,\$content);
13619: if ($parse_result eq 'ok') {
13620: foreach my $i (@changes) {
13621: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13622: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13623: if ($allfiles{$ref}) {
13624: my $newname = $orig;
13625: my ($attrib_regexp,$codebase);
1.1006 raeburn 13626: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13627: if ($attrib_regexp =~ /:/) {
13628: $attrib_regexp =~ s/\:/|/g;
13629: }
13630: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13631: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13632: $count += $numchg;
1.1123 raeburn 13633: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13634: delete($allfiles{$ref});
1.987 raeburn 13635: }
13636: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13637: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13638: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13639: $codebasecount ++;
13640: }
13641: }
13642: }
1.1123 raeburn 13643: my $skiprewrites;
1.987 raeburn 13644: if ($count || $codebasecount) {
13645: my $saveresult;
1.1071 raeburn 13646: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13647: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13648: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13649: if ($url eq $container) {
13650: my ($fname) = ($container =~ m{/([^/]+)$});
13651: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13652: $count,'<span class="LC_filename">'.
1.1071 raeburn 13653: $fname.'</span>').'</p>';
1.987 raeburn 13654: } else {
13655: $output = '<p class="LC_error">'.
13656: &mt('Error: update failed for: [_1].',
13657: '<span class="LC_filename">'.
13658: $container.'</span>').'</p>';
13659: }
1.1123 raeburn 13660: if ($context eq 'syllabus') {
13661: unless ($saveresult eq 'ok') {
13662: $skiprewrites = 1;
13663: }
13664: }
1.987 raeburn 13665: } else {
1.1317 raeburn 13666: if (open(my $fh,'>',$container)) {
1.987 raeburn 13667: print $fh $content;
13668: close($fh);
13669: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13670: $count,'<span class="LC_filename">'.
13671: $container.'</span>').'</p>';
1.661 raeburn 13672: } else {
1.987 raeburn 13673: $output = '<p class="LC_error">'.
13674: &mt('Error: could not update [_1].',
13675: '<span class="LC_filename">'.
13676: $container.'</span>').'</p>';
1.661 raeburn 13677: }
13678: }
13679: }
1.1123 raeburn 13680: if (($context eq 'syllabus') && (!$skiprewrites)) {
13681: my ($actionurl,$state);
13682: $actionurl = "/public/$udom/$uname/syllabus";
13683: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13684: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13685: \%codebase,
13686: {'context' => 'rewrites',
13687: 'ignore_remote_references' => 1,});
13688: if (ref($mapping) eq 'HASH') {
13689: my $rewrites = 0;
13690: foreach my $key (keys(%{$mapping})) {
13691: next if ($key =~ m{^https?://});
13692: my $ref = $mapping->{$key};
13693: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13694: my $attrib;
13695: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13696: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13697: }
13698: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13699: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13700: $rewrites += $numchg;
13701: }
13702: }
13703: if ($rewrites) {
13704: my $saveresult;
13705: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13706: if ($url eq $container) {
13707: my ($fname) = ($container =~ m{/([^/]+)$});
13708: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13709: $count,'<span class="LC_filename">'.
13710: $fname.'</span>').'</p>';
13711: } else {
13712: $output .= '<p class="LC_error">'.
13713: &mt('Error: could not update links in [_1].',
13714: '<span class="LC_filename">'.
13715: $container.'</span>').'</p>';
13716:
13717: }
13718: }
13719: }
13720: }
1.987 raeburn 13721: } else {
13722: &logthis('Failed to parse '.$container.
13723: ' to modify references: '.$parse_result);
1.661 raeburn 13724: }
13725: }
1.1071 raeburn 13726: if (wantarray) {
13727: return ($output,$count,$codebasecount);
13728: } else {
13729: return $output;
13730: }
1.661 raeburn 13731: }
13732:
13733: sub check_for_existing {
13734: my ($path,$fname,$element) = @_;
13735: my ($state,$msg);
13736: if (-d $path.'/'.$fname) {
13737: $state = 'exists';
13738: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13739: } elsif (-e $path.'/'.$fname) {
13740: $state = 'exists';
13741: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13742: }
13743: if ($state eq 'exists') {
13744: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13745: }
13746: return ($state,$msg);
13747: }
13748:
13749: sub check_for_upload {
13750: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13751: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13752: my $filesize = length($env{'form.'.$element});
13753: if (!$filesize) {
13754: my $msg = '<span class="LC_error">'.
13755: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13756: '<span class="LC_filename">'.$fname.'</span>',
13757: $filesize).'<br />'.
1.1007 raeburn 13758: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13759: '</span>';
13760: return ('zero_bytes',$msg);
13761: }
13762: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13763: my $getpropath = 1;
1.1021 raeburn 13764: my ($dirlistref,$listerror) =
13765: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13766: my $found_file = 0;
13767: my $locked_file = 0;
1.991 raeburn 13768: my @lockers;
13769: my $navmap;
13770: if ($env{'request.course.id'}) {
13771: $navmap = Apache::lonnavmaps::navmap->new();
13772: }
1.1021 raeburn 13773: if (ref($dirlistref) eq 'ARRAY') {
13774: foreach my $line (@{$dirlistref}) {
13775: my ($file_name,$rest)=split(/\&/,$line,2);
13776: if ($file_name eq $fname){
13777: $file_name = $path.$file_name;
13778: if ($group ne '') {
13779: $file_name = $group.$file_name;
13780: }
13781: $found_file = 1;
13782: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13783: foreach my $lock (@lockers) {
13784: if (ref($lock) eq 'ARRAY') {
13785: my ($symb,$crsid) = @{$lock};
13786: if ($crsid eq $env{'request.course.id'}) {
13787: if (ref($navmap)) {
13788: my $res = $navmap->getBySymb($symb);
13789: foreach my $part (@{$res->parts()}) {
13790: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13791: unless (($slot_status == $res->RESERVED) ||
13792: ($slot_status == $res->RESERVED_LOCATION)) {
13793: $locked_file = 1;
13794: }
1.991 raeburn 13795: }
1.1021 raeburn 13796: } else {
13797: $locked_file = 1;
1.991 raeburn 13798: }
13799: } else {
13800: $locked_file = 1;
13801: }
13802: }
1.1021 raeburn 13803: }
13804: } else {
13805: my @info = split(/\&/,$rest);
13806: my $currsize = $info[6]/1000;
13807: if ($currsize < $filesize) {
13808: my $extra = $filesize - $currsize;
13809: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13810: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13811: &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 13812: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13813: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13814: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13815: return ('will_exceed_quota',$msg);
13816: }
1.984 raeburn 13817: }
13818: }
1.661 raeburn 13819: }
13820: }
13821: }
13822: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13823: my $msg = '<p class="LC_warning">'.
13824: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13825: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13826: return ('will_exceed_quota',$msg);
13827: } elsif ($found_file) {
13828: if ($locked_file) {
1.1179 bisitz 13829: my $msg = '<p class="LC_warning">';
1.661 raeburn 13830: $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 13831: $msg .= '</p>';
1.661 raeburn 13832: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13833: return ('file_locked',$msg);
13834: } else {
1.1179 bisitz 13835: my $msg = '<p class="LC_error">';
1.984 raeburn 13836: $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 13837: $msg .= '</p>';
1.984 raeburn 13838: return ('existingfile',$msg);
1.661 raeburn 13839: }
13840: }
13841: }
13842:
1.987 raeburn 13843: sub check_for_traversal {
13844: my ($path,$url,$toplevel) = @_;
13845: my @parts=split(/\//,$path);
13846: my $cleanpath;
13847: my $fullpath = $url;
13848: for (my $i=0;$i<@parts;$i++) {
13849: next if ($parts[$i] eq '.');
13850: if ($parts[$i] eq '..') {
13851: $fullpath =~ s{([^/]+/)$}{};
13852: } else {
13853: $fullpath .= $parts[$i].'/';
13854: }
13855: }
13856: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13857: $cleanpath = $1;
13858: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13859: my $curr_toprel = $1;
13860: my @parts = split(/\//,$curr_toprel);
13861: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13862: my @urlparts = split(/\//,$url_toprel);
13863: my $doubledots;
13864: my $startdiff = -1;
13865: for (my $i=0; $i<@urlparts; $i++) {
13866: if ($startdiff == -1) {
13867: unless ($urlparts[$i] eq $parts[$i]) {
13868: $startdiff = $i;
13869: $doubledots .= '../';
13870: }
13871: } else {
13872: $doubledots .= '../';
13873: }
13874: }
13875: if ($startdiff > -1) {
13876: $cleanpath = $doubledots;
13877: for (my $i=$startdiff; $i<@parts; $i++) {
13878: $cleanpath .= $parts[$i].'/';
13879: }
13880: }
13881: }
13882: $cleanpath =~ s{(/)$}{};
13883: return $cleanpath;
13884: }
1.31 albertel 13885:
1.1053 raeburn 13886: sub is_archive_file {
13887: my ($mimetype) = @_;
13888: if (($mimetype eq 'application/octet-stream') ||
13889: ($mimetype eq 'application/x-stuffit') ||
13890: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13891: return 1;
13892: }
13893: return;
13894: }
13895:
13896: sub decompress_form {
1.1065 raeburn 13897: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13898: my %lt = &Apache::lonlocal::texthash (
13899: this => 'This file is an archive file.',
1.1067 raeburn 13900: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13901: itsc => 'Its contents are as follows:',
1.1053 raeburn 13902: youm => 'You may wish to extract its contents.',
13903: extr => 'Extract contents',
1.1067 raeburn 13904: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13905: proa => 'Process automatically?',
1.1053 raeburn 13906: yes => 'Yes',
13907: no => 'No',
1.1067 raeburn 13908: fold => 'Title for folder containing movie',
13909: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13910: );
1.1065 raeburn 13911: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13912: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13913: my $info = &list_archive_contents($fileloc,\@paths);
13914: if (@paths) {
13915: foreach my $path (@paths) {
13916: $path =~ s{^/}{};
1.1067 raeburn 13917: if ($path =~ m{^([^/]+)/$}) {
13918: $topdir = $1;
13919: }
1.1065 raeburn 13920: if ($path =~ m{^([^/]+)/}) {
13921: $toplevel{$1} = $path;
13922: } else {
13923: $toplevel{$path} = $path;
13924: }
13925: }
13926: }
1.1067 raeburn 13927: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13928: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13929: "$topdir/media/",
13930: "$topdir/media/$topdir.mp4",
13931: "$topdir/media/FirstFrame.png",
13932: "$topdir/media/player.swf",
13933: "$topdir/media/swfobject.js",
13934: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13935: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13936: "$topdir/$topdir.mp4",
13937: "$topdir/$topdir\_config.xml",
13938: "$topdir/$topdir\_controller.swf",
13939: "$topdir/$topdir\_embed.css",
13940: "$topdir/$topdir\_First_Frame.png",
13941: "$topdir/$topdir\_player.html",
13942: "$topdir/$topdir\_Thumbnails.png",
13943: "$topdir/playerProductInstall.swf",
13944: "$topdir/scripts/",
13945: "$topdir/scripts/config_xml.js",
13946: "$topdir/scripts/handlebars.js",
13947: "$topdir/scripts/jquery-1.7.1.min.js",
13948: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13949: "$topdir/scripts/modernizr.js",
13950: "$topdir/scripts/player-min.js",
13951: "$topdir/scripts/swfobject.js",
13952: "$topdir/skins/",
13953: "$topdir/skins/configuration_express.xml",
13954: "$topdir/skins/express_show/",
13955: "$topdir/skins/express_show/player-min.css",
13956: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13957: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13958: "$topdir/$topdir.mp4",
13959: "$topdir/$topdir\_config.xml",
13960: "$topdir/$topdir\_controller.swf",
13961: "$topdir/$topdir\_embed.css",
13962: "$topdir/$topdir\_First_Frame.png",
13963: "$topdir/$topdir\_player.html",
13964: "$topdir/$topdir\_Thumbnails.png",
13965: "$topdir/playerProductInstall.swf",
13966: "$topdir/scripts/",
13967: "$topdir/scripts/config_xml.js",
13968: "$topdir/scripts/techsmith-smart-player.min.js",
13969: "$topdir/skins/",
13970: "$topdir/skins/configuration_express.xml",
13971: "$topdir/skins/express_show/",
13972: "$topdir/skins/express_show/spritesheet.min.css",
13973: "$topdir/skins/express_show/spritesheet.png",
13974: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13975: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13976: if (@diffs == 0) {
1.1164 raeburn 13977: $is_camtasia = 6;
13978: } else {
1.1197 raeburn 13979: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13980: if (@diffs == 0) {
13981: $is_camtasia = 8;
1.1197 raeburn 13982: } else {
13983: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13984: if (@diffs == 0) {
13985: $is_camtasia = 8;
13986: }
1.1164 raeburn 13987: }
1.1067 raeburn 13988: }
13989: }
13990: my $output;
13991: if ($is_camtasia) {
13992: $output = <<"ENDCAM";
13993: <script type="text/javascript" language="Javascript">
13994: // <![CDATA[
13995:
13996: function camtasiaToggle() {
13997: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13998: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13999: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14000: document.getElementById('camtasia_titles').style.display='block';
14001: } else {
14002: document.getElementById('camtasia_titles').style.display='none';
14003: }
14004: }
14005: }
14006: return;
14007: }
14008:
14009: // ]]>
14010: </script>
14011: <p>$lt{'camt'}</p>
14012: ENDCAM
1.1065 raeburn 14013: } else {
1.1067 raeburn 14014: $output = '<p>'.$lt{'this'};
14015: if ($info eq '') {
14016: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14017: } else {
14018: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14019: '<div><pre>'.$info.'</pre></div>';
14020: }
1.1065 raeburn 14021: }
1.1067 raeburn 14022: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14023: my $duplicates;
14024: my $num = 0;
14025: if (ref($dirlist) eq 'ARRAY') {
14026: foreach my $item (@{$dirlist}) {
14027: if (ref($item) eq 'ARRAY') {
14028: if (exists($toplevel{$item->[0]})) {
14029: $duplicates .=
14030: &start_data_table_row().
14031: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14032: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14033: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14034: 'value="1" />'.&mt('Yes').'</label>'.
14035: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14036: '<td>'.$item->[0].'</td>';
14037: if ($item->[2]) {
14038: $duplicates .= '<td>'.&mt('Directory').'</td>';
14039: } else {
14040: $duplicates .= '<td>'.&mt('File').'</td>';
14041: }
14042: $duplicates .= '<td>'.$item->[3].'</td>'.
14043: '<td>'.
14044: &Apache::lonlocal::locallocaltime($item->[4]).
14045: '</td>'.
14046: &end_data_table_row();
14047: $num ++;
14048: }
14049: }
14050: }
14051: }
14052: my $itemcount;
14053: if (@paths > 0) {
14054: $itemcount = scalar(@paths);
14055: } else {
14056: $itemcount = 1;
14057: }
1.1067 raeburn 14058: if ($is_camtasia) {
14059: $output .= $lt{'auto'}.'<br />'.
14060: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14061: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14062: $lt{'yes'}.'</label> <label>'.
14063: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14064: $lt{'no'}.'</label></span><br />'.
14065: '<div id="camtasia_titles" style="display:block">'.
14066: &Apache::lonhtmlcommon::start_pick_box().
14067: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14068: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14069: &Apache::lonhtmlcommon::row_closure().
14070: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14071: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14072: &Apache::lonhtmlcommon::row_closure(1).
14073: &Apache::lonhtmlcommon::end_pick_box().
14074: '</div>';
14075: }
1.1065 raeburn 14076: $output .=
14077: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14078: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14079: "\n";
1.1065 raeburn 14080: if ($duplicates ne '') {
14081: $output .= '<p><span class="LC_warning">'.
14082: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14083: &start_data_table().
14084: &start_data_table_header_row().
14085: '<th>'.&mt('Overwrite?').'</th>'.
14086: '<th>'.&mt('Name').'</th>'.
14087: '<th>'.&mt('Type').'</th>'.
14088: '<th>'.&mt('Size').'</th>'.
14089: '<th>'.&mt('Last modified').'</th>'.
14090: &end_data_table_header_row().
14091: $duplicates.
14092: &end_data_table().
14093: '</p>';
14094: }
1.1067 raeburn 14095: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14096: if (ref($hiddenelements) eq 'HASH') {
14097: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14098: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14099: }
14100: }
14101: $output .= <<"END";
1.1067 raeburn 14102: <br />
1.1053 raeburn 14103: <input type="submit" name="decompress" value="$lt{'extr'}" />
14104: </form>
14105: $noextract
14106: END
14107: return $output;
14108: }
14109:
1.1065 raeburn 14110: sub decompression_utility {
14111: my ($program) = @_;
14112: my @utilities = ('tar','gunzip','bunzip2','unzip');
14113: my $location;
14114: if (grep(/^\Q$program\E$/,@utilities)) {
14115: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14116: '/usr/sbin/') {
14117: if (-x $dir.$program) {
14118: $location = $dir.$program;
14119: last;
14120: }
14121: }
14122: }
14123: return $location;
14124: }
14125:
14126: sub list_archive_contents {
14127: my ($file,$pathsref) = @_;
14128: my (@cmd,$output);
14129: my $needsregexp;
14130: if ($file =~ /\.zip$/) {
14131: @cmd = (&decompression_utility('unzip'),"-l");
14132: $needsregexp = 1;
14133: } elsif (($file =~ m/\.tar\.gz$/) ||
14134: ($file =~ /\.tgz$/)) {
14135: @cmd = (&decompression_utility('tar'),"-ztf");
14136: } elsif ($file =~ /\.tar\.bz2$/) {
14137: @cmd = (&decompression_utility('tar'),"-jtf");
14138: } elsif ($file =~ m|\.tar$|) {
14139: @cmd = (&decompression_utility('tar'),"-tf");
14140: }
14141: if (@cmd) {
14142: undef($!);
14143: undef($@);
14144: if (open(my $fh,"-|", @cmd, $file)) {
14145: while (my $line = <$fh>) {
14146: $output .= $line;
14147: chomp($line);
14148: my $item;
14149: if ($needsregexp) {
14150: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14151: } else {
14152: $item = $line;
14153: }
14154: if ($item ne '') {
14155: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14156: push(@{$pathsref},$item);
14157: }
14158: }
14159: }
14160: close($fh);
14161: }
14162: }
14163: return $output;
14164: }
14165:
1.1053 raeburn 14166: sub decompress_uploaded_file {
14167: my ($file,$dir) = @_;
14168: &Apache::lonnet::appenv({'cgi.file' => $file});
14169: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14170: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14171: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14172: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14173: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14174: my $decompressed = $env{'cgi.decompressed'};
14175: &Apache::lonnet::delenv('cgi.file');
14176: &Apache::lonnet::delenv('cgi.dir');
14177: &Apache::lonnet::delenv('cgi.decompressed');
14178: return ($decompressed,$result);
14179: }
14180:
1.1055 raeburn 14181: sub process_decompression {
14182: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14183: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14184: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14185: &mt('Unexpected file path.').'</p>'."\n";
14186: }
14187: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14188: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14189: &mt('Unexpected course context.').'</p>'."\n";
14190: }
1.1293 raeburn 14191: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14192: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14193: &mt('Filename contained unexpected characters.').'</p>'."\n";
14194: }
1.1055 raeburn 14195: my ($dir,$error,$warning,$output);
1.1180 raeburn 14196: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14197: $error = &mt('Filename not a supported archive file type.').
14198: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14199: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14200: } else {
14201: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14202: if ($docuhome eq 'no_host') {
14203: $error = &mt('Could not determine home server for course.');
14204: } else {
14205: my @ids=&Apache::lonnet::current_machine_ids();
14206: my $currdir = "$dir_root/$destination";
14207: if (grep(/^\Q$docuhome\E$/,@ids)) {
14208: $dir = &LONCAPA::propath($docudom,$docuname).
14209: "$dir_root/$destination";
14210: } else {
14211: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14212: "$dir_root/$docudom/$docuname/$destination";
14213: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14214: $error = &mt('Archive file not found.');
14215: }
14216: }
1.1065 raeburn 14217: my (@to_overwrite,@to_skip);
14218: if ($env{'form.archive_overwrite_total'} > 0) {
14219: my $total = $env{'form.archive_overwrite_total'};
14220: for (my $i=0; $i<$total; $i++) {
14221: if ($env{'form.archive_overwrite_'.$i} == 1) {
14222: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14223: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14224: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14225: }
14226: }
14227: }
14228: my $numskip = scalar(@to_skip);
1.1292 raeburn 14229: my $numoverwrite = scalar(@to_overwrite);
14230: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14231: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14232: } elsif ($dir eq '') {
1.1055 raeburn 14233: $error = &mt('Directory containing archive file unavailable.');
14234: } elsif (!$error) {
1.1065 raeburn 14235: my ($decompressed,$display);
1.1292 raeburn 14236: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14237: my $tempdir = time.'_'.$$.int(rand(10000));
14238: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14239: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14240: ($decompressed,$display) =
14241: &decompress_uploaded_file($file,"$dir/$tempdir");
14242: foreach my $item (@to_skip) {
14243: if (($item ne '') && ($item !~ /\.\./)) {
14244: if (-f "$dir/$tempdir/$item") {
14245: unlink("$dir/$tempdir/$item");
14246: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14247: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14248: }
14249: }
14250: }
14251: foreach my $item (@to_overwrite) {
14252: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14253: if (($item ne '') && ($item !~ /\.\./)) {
14254: if (-f "$dir/$item") {
14255: unlink("$dir/$item");
14256: } elsif (-d "$dir/$item") {
1.1300 raeburn 14257: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14258: }
14259: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14260: }
1.1065 raeburn 14261: }
14262: }
1.1292 raeburn 14263: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14264: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14265: }
1.1065 raeburn 14266: }
14267: } else {
14268: ($decompressed,$display) =
14269: &decompress_uploaded_file($file,$dir);
14270: }
1.1055 raeburn 14271: if ($decompressed eq 'ok') {
1.1065 raeburn 14272: $output = '<p class="LC_info">'.
14273: &mt('Files extracted successfully from archive.').
14274: '</p>'."\n";
1.1055 raeburn 14275: my ($warning,$result,@contents);
14276: my ($newdirlistref,$newlisterror) =
14277: &Apache::lonnet::dirlist($currdir,$docudom,
14278: $docuname,1);
14279: my (%is_dir,%changes,@newitems);
14280: my $dirptr = 16384;
1.1065 raeburn 14281: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14282: foreach my $dir_line (@{$newdirlistref}) {
14283: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14284: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14285: push(@newitems,$item);
14286: if ($dirptr&$testdir) {
14287: $is_dir{$item} = 1;
14288: }
14289: $changes{$item} = 1;
14290: }
14291: }
14292: }
14293: if (keys(%changes) > 0) {
14294: foreach my $item (sort(@newitems)) {
14295: if ($changes{$item}) {
14296: push(@contents,$item);
14297: }
14298: }
14299: }
14300: if (@contents > 0) {
1.1067 raeburn 14301: my $wantform;
14302: unless ($env{'form.autoextract_camtasia'}) {
14303: $wantform = 1;
14304: }
1.1056 raeburn 14305: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14306: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14307: $currdir,\%is_dir,
14308: \%children,\%parent,
1.1056 raeburn 14309: \@contents,\%dirorder,
14310: \%titles,$wantform);
1.1055 raeburn 14311: if ($datatable ne '') {
14312: $output .= &archive_options_form('decompressed',$datatable,
14313: $count,$hiddenelem);
1.1065 raeburn 14314: my $startcount = 6;
1.1055 raeburn 14315: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14316: \%titles,\%children);
1.1055 raeburn 14317: }
1.1067 raeburn 14318: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14319: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14320: my %displayed;
14321: my $total = 1;
14322: $env{'form.archive_directory'} = [];
14323: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14324: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14325: $path =~ s{/$}{};
14326: my $item;
14327: if ($path ne '') {
14328: $item = "$path/$titles{$i}";
14329: } else {
14330: $item = $titles{$i};
14331: }
14332: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14333: if ($item eq $contents[0]) {
14334: push(@{$env{'form.archive_directory'}},$i);
14335: $env{'form.archive_'.$i} = 'display';
14336: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14337: $displayed{'folder'} = $i;
1.1164 raeburn 14338: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14339: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14340: $env{'form.archive_'.$i} = 'display';
14341: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14342: $displayed{'web'} = $i;
14343: } else {
1.1164 raeburn 14344: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14345: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14346: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14347: push(@{$env{'form.archive_directory'}},$i);
14348: }
14349: $env{'form.archive_'.$i} = 'dependency';
14350: }
14351: $total ++;
14352: }
14353: for (my $i=1; $i<$total; $i++) {
14354: next if ($i == $displayed{'web'});
14355: next if ($i == $displayed{'folder'});
14356: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14357: }
14358: $env{'form.phase'} = 'decompress_cleanup';
14359: $env{'form.archivedelete'} = 1;
14360: $env{'form.archive_count'} = $total-1;
14361: $output .=
14362: &process_extracted_files('coursedocs',$docudom,
14363: $docuname,$destination,
14364: $dir_root,$hiddenelem);
14365: }
1.1055 raeburn 14366: } else {
14367: $warning = &mt('No new items extracted from archive file.');
14368: }
14369: } else {
14370: $output = $display;
14371: $error = &mt('An error occurred during extraction from the archive file.');
14372: }
14373: }
14374: }
14375: }
14376: if ($error) {
14377: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14378: $error.'</p>'."\n";
14379: }
14380: if ($warning) {
14381: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14382: }
14383: return $output;
14384: }
14385:
14386: sub get_extracted {
1.1056 raeburn 14387: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14388: $titles,$wantform) = @_;
1.1055 raeburn 14389: my $count = 0;
14390: my $depth = 0;
14391: my $datatable;
1.1056 raeburn 14392: my @hierarchy;
1.1055 raeburn 14393: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14394: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14395: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14396: foreach my $item (@{$contents}) {
14397: $count ++;
1.1056 raeburn 14398: @{$dirorder->{$count}} = @hierarchy;
14399: $titles->{$count} = $item;
1.1055 raeburn 14400: &archive_hierarchy($depth,$count,$parent,$children);
14401: if ($wantform) {
14402: $datatable .= &archive_row($is_dir->{$item},$item,
14403: $currdir,$depth,$count);
14404: }
14405: if ($is_dir->{$item}) {
14406: $depth ++;
1.1056 raeburn 14407: push(@hierarchy,$count);
14408: $parent->{$depth} = $count;
1.1055 raeburn 14409: $datatable .=
14410: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14411: \$depth,\$count,\@hierarchy,$dirorder,
14412: $children,$parent,$titles,$wantform);
1.1055 raeburn 14413: $depth --;
1.1056 raeburn 14414: pop(@hierarchy);
1.1055 raeburn 14415: }
14416: }
14417: return ($count,$datatable);
14418: }
14419:
14420: sub recurse_extracted_archive {
1.1056 raeburn 14421: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14422: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14423: my $result='';
1.1056 raeburn 14424: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14425: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14426: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14427: return $result;
14428: }
14429: my $dirptr = 16384;
14430: my ($newdirlistref,$newlisterror) =
14431: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14432: if (ref($newdirlistref) eq 'ARRAY') {
14433: foreach my $dir_line (@{$newdirlistref}) {
14434: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14435: unless ($item =~ /^\.+$/) {
14436: $$count ++;
1.1056 raeburn 14437: @{$dirorder->{$$count}} = @{$hierarchy};
14438: $titles->{$$count} = $item;
1.1055 raeburn 14439: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14440:
1.1055 raeburn 14441: my $is_dir;
14442: if ($dirptr&$testdir) {
14443: $is_dir = 1;
14444: }
14445: if ($wantform) {
14446: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14447: }
14448: if ($is_dir) {
14449: $$depth ++;
1.1056 raeburn 14450: push(@{$hierarchy},$$count);
14451: $parent->{$$depth} = $$count;
1.1055 raeburn 14452: $result .=
14453: &recurse_extracted_archive("$currdir/$item",$docudom,
14454: $docuname,$depth,$count,
1.1056 raeburn 14455: $hierarchy,$dirorder,$children,
14456: $parent,$titles,$wantform);
1.1055 raeburn 14457: $$depth --;
1.1056 raeburn 14458: pop(@{$hierarchy});
1.1055 raeburn 14459: }
14460: }
14461: }
14462: }
14463: return $result;
14464: }
14465:
14466: sub archive_hierarchy {
14467: my ($depth,$count,$parent,$children) =@_;
14468: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14469: if (exists($parent->{$depth})) {
14470: $children->{$parent->{$depth}} .= $count.':';
14471: }
14472: }
14473: return;
14474: }
14475:
14476: sub archive_row {
14477: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14478: my ($name) = ($item =~ m{([^/]+)$});
14479: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14480: 'display' => 'Add as file',
1.1055 raeburn 14481: 'dependency' => 'Include as dependency',
14482: 'discard' => 'Discard',
14483: );
14484: if ($is_dir) {
1.1059 raeburn 14485: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14486: }
1.1056 raeburn 14487: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14488: my $offset = 0;
1.1055 raeburn 14489: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14490: $offset ++;
1.1065 raeburn 14491: if ($action ne 'display') {
14492: $offset ++;
14493: }
1.1055 raeburn 14494: $output .= '<td><span class="LC_nobreak">'.
14495: '<label><input type="radio" name="archive_'.$count.
14496: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14497: my $text = $choices{$action};
14498: if ($is_dir) {
14499: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14500: if ($action eq 'display') {
1.1059 raeburn 14501: $text = &mt('Add as folder');
1.1055 raeburn 14502: }
1.1056 raeburn 14503: } else {
14504: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14505:
14506: }
14507: $output .= ' /> '.$choices{$action}.'</label></span>';
14508: if ($action eq 'dependency') {
14509: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14510: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14511: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14512: '<option value=""></option>'."\n".
14513: '</select>'."\n".
14514: '</div>';
1.1059 raeburn 14515: } elsif ($action eq 'display') {
14516: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14517: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14518: '</div>';
1.1055 raeburn 14519: }
1.1056 raeburn 14520: $output .= '</td>';
1.1055 raeburn 14521: }
14522: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14523: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14524: for (my $i=0; $i<$depth; $i++) {
14525: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14526: }
14527: if ($is_dir) {
14528: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14529: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14530: } else {
14531: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14532: }
14533: $output .= ' '.$name.'</td>'."\n".
14534: &end_data_table_row();
14535: return $output;
14536: }
14537:
14538: sub archive_options_form {
1.1065 raeburn 14539: my ($form,$display,$count,$hiddenelem) = @_;
14540: my %lt = &Apache::lonlocal::texthash(
14541: perm => 'Permanently remove archive file?',
14542: hows => 'How should each extracted item be incorporated in the course?',
14543: cont => 'Content actions for all',
14544: addf => 'Add as folder/file',
14545: incd => 'Include as dependency for a displayed file',
14546: disc => 'Discard',
14547: no => 'No',
14548: yes => 'Yes',
14549: save => 'Save',
14550: );
14551: my $output = <<"END";
14552: <form name="$form" method="post" action="">
14553: <p><span class="LC_nobreak">$lt{'perm'}
14554: <label>
14555: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14556: </label>
14557:
14558: <label>
14559: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14560: </span>
14561: </p>
14562: <input type="hidden" name="phase" value="decompress_cleanup" />
14563: <br />$lt{'hows'}
14564: <div class="LC_columnSection">
14565: <fieldset>
14566: <legend>$lt{'cont'}</legend>
14567: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14568: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14569: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14570: </fieldset>
14571: </div>
14572: END
14573: return $output.
1.1055 raeburn 14574: &start_data_table()."\n".
1.1065 raeburn 14575: $display."\n".
1.1055 raeburn 14576: &end_data_table()."\n".
14577: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14578: $hiddenelem.
1.1065 raeburn 14579: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14580: '</form>';
14581: }
14582:
14583: sub archive_javascript {
1.1056 raeburn 14584: my ($startcount,$numitems,$titles,$children) = @_;
14585: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14586: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14587: my $scripttag = <<START;
14588: <script type="text/javascript">
14589: // <![CDATA[
14590:
14591: function checkAll(form,prefix) {
14592: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14593: for (var i=0; i < form.elements.length; i++) {
14594: var id = form.elements[i].id;
14595: if ((id != '') && (id != undefined)) {
14596: if (idstr.test(id)) {
14597: if (form.elements[i].type == 'radio') {
14598: form.elements[i].checked = true;
1.1056 raeburn 14599: var nostart = i-$startcount;
1.1059 raeburn 14600: var offset = nostart%7;
14601: var count = (nostart-offset)/7;
1.1056 raeburn 14602: dependencyCheck(form,count,offset);
1.1055 raeburn 14603: }
14604: }
14605: }
14606: }
14607: }
14608:
14609: function propagateCheck(form,count) {
14610: if (count > 0) {
1.1059 raeburn 14611: var startelement = $startcount + ((count-1) * 7);
14612: for (var j=1; j<6; j++) {
14613: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14614: var item = startelement + j;
14615: if (form.elements[item].type == 'radio') {
14616: if (form.elements[item].checked) {
14617: containerCheck(form,count,j);
14618: break;
14619: }
1.1055 raeburn 14620: }
14621: }
14622: }
14623: }
14624: }
14625:
14626: numitems = $numitems
1.1056 raeburn 14627: var titles = new Array(numitems);
14628: var parents = new Array(numitems);
1.1055 raeburn 14629: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14630: parents[i] = new Array;
1.1055 raeburn 14631: }
1.1059 raeburn 14632: var maintitle = '$maintitle';
1.1055 raeburn 14633:
14634: START
14635:
1.1056 raeburn 14636: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14637: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14638: for (my $i=0; $i<@contents; $i ++) {
14639: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14640: }
14641: }
14642:
1.1056 raeburn 14643: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14644: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14645: }
14646:
1.1055 raeburn 14647: $scripttag .= <<END;
14648:
14649: function containerCheck(form,count,offset) {
14650: if (count > 0) {
1.1056 raeburn 14651: dependencyCheck(form,count,offset);
1.1059 raeburn 14652: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14653: form.elements[item].checked = true;
14654: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14655: if (parents[count].length > 0) {
14656: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14657: containerCheck(form,parents[count][j],offset);
14658: }
14659: }
14660: }
14661: }
14662: }
14663:
14664: function dependencyCheck(form,count,offset) {
14665: if (count > 0) {
1.1059 raeburn 14666: var chosen = (offset+$startcount)+7*(count-1);
14667: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14668: var currtype = form.elements[depitem].type;
14669: if (form.elements[chosen].value == 'dependency') {
14670: document.getElementById('arc_depon_'+count).style.display='block';
14671: form.elements[depitem].options.length = 0;
14672: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14673: for (var i=1; i<=numitems; i++) {
14674: if (i == count) {
14675: continue;
14676: }
1.1059 raeburn 14677: var startelement = $startcount + (i-1) * 7;
14678: for (var j=1; j<6; j++) {
14679: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14680: var item = startelement + j;
14681: if (form.elements[item].type == 'radio') {
14682: if (form.elements[item].checked) {
14683: if (form.elements[item].value == 'display') {
14684: var n = form.elements[depitem].options.length;
14685: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14686: }
14687: }
14688: }
14689: }
14690: }
14691: }
14692: } else {
14693: document.getElementById('arc_depon_'+count).style.display='none';
14694: form.elements[depitem].options.length = 0;
14695: form.elements[depitem].options[0] = new Option('Select','',true,true);
14696: }
1.1059 raeburn 14697: titleCheck(form,count,offset);
1.1056 raeburn 14698: }
14699: }
14700:
14701: function propagateSelect(form,count,offset) {
14702: if (count > 0) {
1.1065 raeburn 14703: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14704: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14705: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14706: if (parents[count].length > 0) {
14707: for (var j=0; j<parents[count].length; j++) {
14708: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14709: }
14710: }
14711: }
14712: }
14713: }
1.1056 raeburn 14714:
14715: function containerSelect(form,count,offset,picked) {
14716: if (count > 0) {
1.1065 raeburn 14717: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14718: if (form.elements[item].type == 'radio') {
14719: if (form.elements[item].value == 'dependency') {
14720: if (form.elements[item+1].type == 'select-one') {
14721: for (var i=0; i<form.elements[item+1].options.length; i++) {
14722: if (form.elements[item+1].options[i].value == picked) {
14723: form.elements[item+1].selectedIndex = i;
14724: break;
14725: }
14726: }
14727: }
14728: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14729: if (parents[count].length > 0) {
14730: for (var j=0; j<parents[count].length; j++) {
14731: containerSelect(form,parents[count][j],offset,picked);
14732: }
14733: }
14734: }
14735: }
14736: }
14737: }
14738: }
14739:
1.1059 raeburn 14740: function titleCheck(form,count,offset) {
14741: if (count > 0) {
14742: var chosen = (offset+$startcount)+7*(count-1);
14743: var depitem = $startcount + ((count-1) * 7) + 2;
14744: var currtype = form.elements[depitem].type;
14745: if (form.elements[chosen].value == 'display') {
14746: document.getElementById('arc_title_'+count).style.display='block';
14747: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14748: document.getElementById('archive_title_'+count).value=maintitle;
14749: }
14750: } else {
14751: document.getElementById('arc_title_'+count).style.display='none';
14752: if (currtype == 'text') {
14753: document.getElementById('archive_title_'+count).value='';
14754: }
14755: }
14756: }
14757: return;
14758: }
14759:
1.1055 raeburn 14760: // ]]>
14761: </script>
14762: END
14763: return $scripttag;
14764: }
14765:
14766: sub process_extracted_files {
1.1067 raeburn 14767: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14768: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14769: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14770: my @ids=&Apache::lonnet::current_machine_ids();
14771: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14772: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14773: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14774: if (grep(/^\Q$docuhome\E$/,@ids)) {
14775: $prefix = &LONCAPA::propath($docudom,$docuname);
14776: $pathtocheck = "$dir_root/$destination";
14777: $dir = $dir_root;
14778: $ishome = 1;
14779: } else {
14780: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14781: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14782: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14783: }
14784: my $currdir = "$dir_root/$destination";
14785: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14786: if ($env{'form.folderpath'}) {
14787: my @items = split('&',$env{'form.folderpath'});
14788: $folders{'0'} = $items[-2];
1.1099 raeburn 14789: if ($env{'form.folderpath'} =~ /\:1$/) {
14790: $containers{'0'}='page';
14791: } else {
14792: $containers{'0'}='sequence';
14793: }
1.1055 raeburn 14794: }
14795: my @archdirs = &get_env_multiple('form.archive_directory');
14796: if ($numitems) {
14797: for (my $i=1; $i<=$numitems; $i++) {
14798: my $path = $env{'form.archive_content_'.$i};
14799: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14800: my $item = $1;
14801: $toplevelitems{$item} = $i;
14802: if (grep(/^\Q$i\E$/,@archdirs)) {
14803: $is_dir{$item} = 1;
14804: }
14805: }
14806: }
14807: }
1.1067 raeburn 14808: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14809: if (keys(%toplevelitems) > 0) {
14810: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14811: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14812: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14813: }
1.1066 raeburn 14814: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14815: if ($numitems) {
14816: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14817: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14818: my $path = $env{'form.archive_content_'.$i};
14819: if ($path =~ /^\Q$pathtocheck\E/) {
14820: if ($env{'form.archive_'.$i} eq 'discard') {
14821: if ($prefix ne '' && $path ne '') {
14822: if (-e $prefix.$path) {
1.1066 raeburn 14823: if ((@archdirs > 0) &&
14824: (grep(/^\Q$i\E$/,@archdirs))) {
14825: $todeletedir{$prefix.$path} = 1;
14826: } else {
14827: $todelete{$prefix.$path} = 1;
14828: }
1.1055 raeburn 14829: }
14830: }
14831: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14832: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14833: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14834: $docstitle = $env{'form.archive_title_'.$i};
14835: if ($docstitle eq '') {
14836: $docstitle = $title;
14837: }
1.1055 raeburn 14838: $outer = 0;
1.1056 raeburn 14839: if (ref($dirorder{$i}) eq 'ARRAY') {
14840: if (@{$dirorder{$i}} > 0) {
14841: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14842: if ($env{'form.archive_'.$item} eq 'display') {
14843: $outer = $item;
14844: last;
14845: }
14846: }
14847: }
14848: }
14849: my ($errtext,$fatal) =
14850: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14851: '/'.$folders{$outer}.'.'.
14852: $containers{$outer});
14853: next if ($fatal);
14854: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14855: if ($context eq 'coursedocs') {
1.1056 raeburn 14856: $mapinner{$i} = time;
1.1055 raeburn 14857: $folders{$i} = 'default_'.$mapinner{$i};
14858: $containers{$i} = 'sequence';
14859: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14860: $folders{$i}.'.'.$containers{$i};
14861: my $newidx = &LONCAPA::map::getresidx();
14862: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14863: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14864: push(@LONCAPA::map::order,$newidx);
14865: my ($outtext,$errtext) =
14866: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14867: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14868: '.'.$containers{$outer},1,1);
1.1056 raeburn 14869: $newseqid{$i} = $newidx;
1.1067 raeburn 14870: unless ($errtext) {
1.1294 raeburn 14871: $result .= '<li>'.&mt('Folder: [_1] added to course',
14872: &HTML::Entities::encode($docstitle,'<>&"')).
14873: '</li>'."\n";
1.1067 raeburn 14874: }
1.1055 raeburn 14875: }
14876: } else {
14877: if ($context eq 'coursedocs') {
14878: my $newidx=&LONCAPA::map::getresidx();
14879: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14880: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14881: $title;
1.1392 raeburn 14882: if (($outer !~ /\D/) &&
14883: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14884: ($newidx !~ /\D/)) {
1.1294 raeburn 14885: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14886: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14887: }
14888: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14889: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14890: }
14891: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14892: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14893: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14894: unless ($ishome) {
14895: my $fetch = "$newdest{$i}/$title";
14896: $fetch =~ s/^\Q$prefix$dir\E//;
14897: $prompttofetch{$fetch} = 1;
14898: }
1.1292 raeburn 14899: }
1.1067 raeburn 14900: }
1.1294 raeburn 14901: $LONCAPA::map::resources[$newidx]=
14902: $docstitle.':'.$url.':false:normal:res';
14903: push(@LONCAPA::map::order, $newidx);
14904: my ($outtext,$errtext)=
14905: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14906: $docuname.'/'.$folders{$outer}.
14907: '.'.$containers{$outer},1,1);
14908: unless ($errtext) {
14909: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14910: $result .= '<li>'.&mt('File: [_1] added to course',
14911: &HTML::Entities::encode($docstitle,'<>&"')).
14912: '</li>'."\n";
14913: }
1.1067 raeburn 14914: }
1.1294 raeburn 14915: } else {
14916: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14917: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14918: }
1.1055 raeburn 14919: }
14920: }
1.1086 raeburn 14921: }
14922: } else {
1.1294 raeburn 14923: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14924: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14925: }
14926: }
14927: for (my $i=1; $i<=$numitems; $i++) {
14928: next unless ($env{'form.archive_'.$i} eq 'dependency');
14929: my $path = $env{'form.archive_content_'.$i};
14930: if ($path =~ /^\Q$pathtocheck\E/) {
14931: my ($title) = ($path =~ m{/([^/]+)$});
14932: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14933: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14934: if (ref($dirorder{$i}) eq 'ARRAY') {
14935: my ($itemidx,$fullpath,$relpath);
14936: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14937: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14938: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14939: if ($dirorder{$i}->[$j] eq $container) {
14940: $itemidx = $j;
1.1056 raeburn 14941: }
14942: }
1.1086 raeburn 14943: }
14944: if ($itemidx eq '') {
14945: $itemidx = 0;
14946: }
14947: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14948: if ($mapinner{$referrer{$i}}) {
14949: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14950: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14951: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14952: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14953: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14954: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14955: if (!-e $fullpath) {
14956: mkdir($fullpath,0755);
1.1056 raeburn 14957: }
14958: }
1.1086 raeburn 14959: } else {
14960: last;
1.1056 raeburn 14961: }
1.1086 raeburn 14962: }
14963: }
14964: } elsif ($newdest{$referrer{$i}}) {
14965: $fullpath = $newdest{$referrer{$i}};
14966: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14967: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14968: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14969: last;
14970: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14971: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14972: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14973: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14974: if (!-e $fullpath) {
14975: mkdir($fullpath,0755);
1.1056 raeburn 14976: }
14977: }
1.1086 raeburn 14978: } else {
14979: last;
1.1056 raeburn 14980: }
1.1055 raeburn 14981: }
14982: }
1.1086 raeburn 14983: if ($fullpath ne '') {
14984: if (-e "$prefix$path") {
1.1292 raeburn 14985: unless (rename("$prefix$path","$fullpath/$title")) {
14986: $warning .= &mt('Failed to rename dependency').'<br />';
14987: }
1.1086 raeburn 14988: }
14989: if (-e "$fullpath/$title") {
14990: my $showpath;
14991: if ($relpath ne '') {
14992: $showpath = "$relpath/$title";
14993: } else {
14994: $showpath = "/$title";
14995: }
1.1294 raeburn 14996: $result .= '<li>'.&mt('[_1] included as a dependency',
14997: &HTML::Entities::encode($showpath,'<>&"')).
14998: '</li>'."\n";
1.1292 raeburn 14999: unless ($ishome) {
15000: my $fetch = "$fullpath/$title";
15001: $fetch =~ s/^\Q$prefix$dir\E//;
15002: $prompttofetch{$fetch} = 1;
15003: }
1.1086 raeburn 15004: }
15005: }
1.1055 raeburn 15006: }
1.1086 raeburn 15007: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15008: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15009: &HTML::Entities::encode($path,'<>&"'),
15010: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15011: '<br />';
1.1055 raeburn 15012: }
15013: } else {
1.1294 raeburn 15014: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15015: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15016: }
15017: }
15018: if (keys(%todelete)) {
15019: foreach my $key (keys(%todelete)) {
15020: unlink($key);
1.1066 raeburn 15021: }
15022: }
15023: if (keys(%todeletedir)) {
15024: foreach my $key (keys(%todeletedir)) {
15025: rmdir($key);
15026: }
15027: }
15028: foreach my $dir (sort(keys(%is_dir))) {
15029: if (($pathtocheck ne '') && ($dir ne '')) {
15030: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15031: }
15032: }
1.1067 raeburn 15033: if ($result ne '') {
15034: $output .= '<ul>'."\n".
15035: $result."\n".
15036: '</ul>';
15037: }
15038: unless ($ishome) {
15039: my $replicationfail;
15040: foreach my $item (keys(%prompttofetch)) {
15041: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15042: unless ($fetchresult eq 'ok') {
15043: $replicationfail .= '<li>'.$item.'</li>'."\n";
15044: }
15045: }
15046: if ($replicationfail) {
15047: $output .= '<p class="LC_error">'.
15048: &mt('Course home server failed to retrieve:').'<ul>'.
15049: $replicationfail.
15050: '</ul></p>';
15051: }
15052: }
1.1055 raeburn 15053: } else {
15054: $warning = &mt('No items found in archive.');
15055: }
15056: if ($error) {
15057: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15058: $error.'</p>'."\n";
15059: }
15060: if ($warning) {
15061: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15062: }
15063: return $output;
15064: }
15065:
1.1066 raeburn 15066: sub cleanup_empty_dirs {
15067: my ($path) = @_;
15068: if (($path ne '') && (-d $path)) {
15069: if (opendir(my $dirh,$path)) {
15070: my @dircontents = grep(!/^\./,readdir($dirh));
15071: my $numitems = 0;
15072: foreach my $item (@dircontents) {
15073: if (-d "$path/$item") {
1.1111 raeburn 15074: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15075: if (-e "$path/$item") {
15076: $numitems ++;
15077: }
15078: } else {
15079: $numitems ++;
15080: }
15081: }
15082: if ($numitems == 0) {
15083: rmdir($path);
15084: }
15085: closedir($dirh);
15086: }
15087: }
15088: return;
15089: }
15090:
1.41 ng 15091: =pod
1.45 matthew 15092:
1.1162 raeburn 15093: =item * &get_folder_hierarchy()
1.1068 raeburn 15094:
15095: Provides hierarchy of names of folders/sub-folders containing the current
15096: item,
15097:
15098: Inputs: 3
15099: - $navmap - navmaps object
15100:
15101: - $map - url for map (either the trigger itself, or map containing
15102: the resource, which is the trigger).
15103:
15104: - $showitem - 1 => show title for map itself; 0 => do not show.
15105:
15106: Outputs: 1 @pathitems - array of folder/subfolder names.
15107:
15108: =cut
15109:
15110: sub get_folder_hierarchy {
15111: my ($navmap,$map,$showitem) = @_;
15112: my @pathitems;
15113: if (ref($navmap)) {
15114: my $mapres = $navmap->getResourceByUrl($map);
15115: if (ref($mapres)) {
15116: my $pcslist = $mapres->map_hierarchy();
15117: if ($pcslist ne '') {
15118: my @pcs = split(/,/,$pcslist);
15119: foreach my $pc (@pcs) {
15120: if ($pc == 1) {
1.1129 raeburn 15121: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15122: } else {
15123: my $res = $navmap->getByMapPc($pc);
15124: if (ref($res)) {
15125: my $title = $res->compTitle();
15126: $title =~ s/\W+/_/g;
15127: if ($title ne '') {
15128: push(@pathitems,$title);
15129: }
15130: }
15131: }
15132: }
15133: }
1.1071 raeburn 15134: if ($showitem) {
15135: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15136: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15137: } else {
15138: my $maptitle = $mapres->compTitle();
15139: $maptitle =~ s/\W+/_/g;
15140: if ($maptitle ne '') {
15141: push(@pathitems,$maptitle);
15142: }
1.1068 raeburn 15143: }
15144: }
15145: }
15146: }
15147: return @pathitems;
15148: }
15149:
15150: =pod
15151:
1.1015 raeburn 15152: =item * &get_turnedin_filepath()
15153:
15154: Determines path in a user's portfolio file for storage of files uploaded
15155: to a specific essayresponse or dropbox item.
15156:
15157: Inputs: 3 required + 1 optional.
15158: $symb is symb for resource, $uname and $udom are for current user (required).
15159: $caller is optional (can be "submission", if routine is called when storing
15160: an upoaded file when "Submit Answer" button was pressed).
15161:
15162: Returns array containing $path and $multiresp.
15163: $path is path in portfolio. $multiresp is 1 if this resource contains more
15164: than one file upload item. Callers of routine should append partid as a
15165: subdirectory to $path in cases where $multiresp is 1.
15166:
15167: Called by: homework/essayresponse.pm and homework/structuretags.pm
15168:
15169: =cut
15170:
15171: sub get_turnedin_filepath {
15172: my ($symb,$uname,$udom,$caller) = @_;
15173: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15174: my $turnindir;
15175: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15176: $turnindir = $userhash{'turnindir'};
15177: my ($path,$multiresp);
15178: if ($turnindir eq '') {
15179: if ($caller eq 'submission') {
15180: $turnindir = &mt('turned in');
15181: $turnindir =~ s/\W+/_/g;
15182: my %newhash = (
15183: 'turnindir' => $turnindir,
15184: );
15185: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15186: }
15187: }
15188: if ($turnindir ne '') {
15189: $path = '/'.$turnindir.'/';
15190: my ($multipart,$turnin,@pathitems);
15191: my $navmap = Apache::lonnavmaps::navmap->new();
15192: if (defined($navmap)) {
15193: my $mapres = $navmap->getResourceByUrl($map);
15194: if (ref($mapres)) {
15195: my $pcslist = $mapres->map_hierarchy();
15196: if ($pcslist ne '') {
15197: foreach my $pc (split(/,/,$pcslist)) {
15198: my $res = $navmap->getByMapPc($pc);
15199: if (ref($res)) {
15200: my $title = $res->compTitle();
15201: $title =~ s/\W+/_/g;
15202: if ($title ne '') {
1.1149 raeburn 15203: if (($pc > 1) && (length($title) > 12)) {
15204: $title = substr($title,0,12);
15205: }
1.1015 raeburn 15206: push(@pathitems,$title);
15207: }
15208: }
15209: }
15210: }
15211: my $maptitle = $mapres->compTitle();
15212: $maptitle =~ s/\W+/_/g;
15213: if ($maptitle ne '') {
1.1149 raeburn 15214: if (length($maptitle) > 12) {
15215: $maptitle = substr($maptitle,0,12);
15216: }
1.1015 raeburn 15217: push(@pathitems,$maptitle);
15218: }
15219: unless ($env{'request.state'} eq 'construct') {
15220: my $res = $navmap->getBySymb($symb);
15221: if (ref($res)) {
15222: my $partlist = $res->parts();
15223: my $totaluploads = 0;
15224: if (ref($partlist) eq 'ARRAY') {
15225: foreach my $part (@{$partlist}) {
15226: my @types = $res->responseType($part);
15227: my @ids = $res->responseIds($part);
15228: for (my $i=0; $i < scalar(@ids); $i++) {
15229: if ($types[$i] eq 'essay') {
15230: my $partid = $part.'_'.$ids[$i];
15231: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15232: $totaluploads ++;
15233: }
15234: }
15235: }
15236: }
15237: if ($totaluploads > 1) {
15238: $multiresp = 1;
15239: }
15240: }
15241: }
15242: }
15243: } else {
15244: return;
15245: }
15246: } else {
15247: return;
15248: }
15249: my $restitle=&Apache::lonnet::gettitle($symb);
15250: $restitle =~ s/\W+/_/g;
15251: if ($restitle eq '') {
15252: $restitle = ($resurl =~ m{/[^/]+$});
15253: if ($restitle eq '') {
15254: $restitle = time;
15255: }
15256: }
1.1149 raeburn 15257: if (length($restitle) > 12) {
15258: $restitle = substr($restitle,0,12);
15259: }
1.1015 raeburn 15260: push(@pathitems,$restitle);
15261: $path .= join('/',@pathitems);
15262: }
15263: return ($path,$multiresp);
15264: }
15265:
15266: =pod
15267:
1.464 albertel 15268: =back
1.41 ng 15269:
1.112 bowersj2 15270: =head1 CSV Upload/Handling functions
1.38 albertel 15271:
1.41 ng 15272: =over 4
15273:
1.648 raeburn 15274: =item * &upfile_store($r)
1.41 ng 15275:
15276: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15277: needs $env{'form.upfile'}
1.41 ng 15278: returns $datatoken to be put into hidden field
15279:
15280: =cut
1.31 albertel 15281:
15282: sub upfile_store {
15283: my $r=shift;
1.258 albertel 15284: $env{'form.upfile'}=~s/\r/\n/gs;
15285: $env{'form.upfile'}=~s/\f/\n/gs;
15286: $env{'form.upfile'}=~s/\n+/\n/gs;
15287: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15288:
1.1299 raeburn 15289: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15290: '_enroll_'.$env{'request.course.id'}.'_'.
15291: time.'_'.$$);
15292: return if ($datatoken eq '');
15293:
1.31 albertel 15294: {
1.158 raeburn 15295: my $datafile = $r->dir_config('lonDaemons').
15296: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15297: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15298: print $fh $env{'form.upfile'};
1.158 raeburn 15299: close($fh);
15300: }
1.31 albertel 15301: }
15302: return $datatoken;
15303: }
15304:
1.56 matthew 15305: =pod
15306:
1.1290 raeburn 15307: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15308:
15309: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15310: $datatoken is the name to assign to the temporary file.
1.258 albertel 15311: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15312:
15313: =cut
1.31 albertel 15314:
15315: sub load_tmp_file {
1.1290 raeburn 15316: my ($r,$datatoken) = @_;
15317: return if ($datatoken eq '');
1.31 albertel 15318: my @studentdata=();
15319: {
1.158 raeburn 15320: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15321: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15322: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15323: @studentdata=<$fh>;
15324: close($fh);
15325: }
1.31 albertel 15326: }
1.258 albertel 15327: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15328: }
15329:
1.1290 raeburn 15330: sub valid_datatoken {
15331: my ($datatoken) = @_;
1.1325 raeburn 15332: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15333: return $datatoken;
15334: }
15335: return;
15336: }
15337:
1.56 matthew 15338: =pod
15339:
1.648 raeburn 15340: =item * &upfile_record_sep()
1.41 ng 15341:
15342: Separate uploaded file into records
15343: returns array of records,
1.258 albertel 15344: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15345:
15346: =cut
1.31 albertel 15347:
15348: sub upfile_record_sep {
1.258 albertel 15349: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15350: } else {
1.248 albertel 15351: my @records;
1.258 albertel 15352: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15353: if ($line=~/^\s*$/) { next; }
15354: push(@records,$line);
15355: }
15356: return @records;
1.31 albertel 15357: }
15358: }
15359:
1.56 matthew 15360: =pod
15361:
1.648 raeburn 15362: =item * &record_sep($record)
1.41 ng 15363:
1.258 albertel 15364: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15365:
15366: =cut
15367:
1.263 www 15368: sub takeleft {
15369: my $index=shift;
15370: return substr('0000'.$index,-4,4);
15371: }
15372:
1.31 albertel 15373: sub record_sep {
15374: my $record=shift;
15375: my %components=();
1.258 albertel 15376: if ($env{'form.upfiletype'} eq 'xml') {
15377: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15378: my $i=0;
1.356 albertel 15379: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15380: $field=~s/^(\"|\')//;
15381: $field=~s/(\"|\')$//;
1.263 www 15382: $components{&takeleft($i)}=$field;
1.31 albertel 15383: $i++;
15384: }
1.258 albertel 15385: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15386: my $i=0;
1.356 albertel 15387: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15388: $field=~s/^(\"|\')//;
15389: $field=~s/(\"|\')$//;
1.263 www 15390: $components{&takeleft($i)}=$field;
1.31 albertel 15391: $i++;
15392: }
15393: } else {
1.561 www 15394: my $separator=',';
1.480 banghart 15395: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15396: $separator=';';
1.480 banghart 15397: }
1.31 albertel 15398: my $i=0;
1.561 www 15399: # the character we are looking for to indicate the end of a quote or a record
15400: my $looking_for=$separator;
15401: # do not add the characters to the fields
15402: my $ignore=0;
15403: # we just encountered a separator (or the beginning of the record)
15404: my $just_found_separator=1;
15405: # store the field we are working on here
15406: my $field='';
15407: # work our way through all characters in record
15408: foreach my $character ($record=~/(.)/g) {
15409: if ($character eq $looking_for) {
15410: if ($character ne $separator) {
15411: # Found the end of a quote, again looking for separator
15412: $looking_for=$separator;
15413: $ignore=1;
15414: } else {
15415: # Found a separator, store away what we got
15416: $components{&takeleft($i)}=$field;
15417: $i++;
15418: $just_found_separator=1;
15419: $ignore=0;
15420: $field='';
15421: }
15422: next;
15423: }
15424: # single or double quotation marks after a separator indicate beginning of a quote
15425: # we are now looking for the end of the quote and need to ignore separators
15426: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15427: $looking_for=$character;
15428: next;
15429: }
15430: # ignore would be true after we reached the end of a quote
15431: if ($ignore) { next; }
15432: if (($just_found_separator) && ($character=~/\s/)) { next; }
15433: $field.=$character;
15434: $just_found_separator=0;
1.31 albertel 15435: }
1.561 www 15436: # catch the very last entry, since we never encountered the separator
15437: $components{&takeleft($i)}=$field;
1.31 albertel 15438: }
15439: return %components;
15440: }
15441:
1.144 matthew 15442: ######################################################
15443: ######################################################
15444:
1.56 matthew 15445: =pod
15446:
1.648 raeburn 15447: =item * &upfile_select_html()
1.41 ng 15448:
1.144 matthew 15449: Return HTML code to select a file from the users machine and specify
15450: the file type.
1.41 ng 15451:
15452: =cut
15453:
1.144 matthew 15454: ######################################################
15455: ######################################################
1.31 albertel 15456: sub upfile_select_html {
1.144 matthew 15457: my %Types = (
15458: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15459: semisv => &mt('Semicolon separated values'),
1.144 matthew 15460: space => &mt('Space separated'),
15461: tab => &mt('Tabulator separated'),
15462: # xml => &mt('HTML/XML'),
15463: );
15464: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15465: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15466: foreach my $type (sort(keys(%Types))) {
15467: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15468: }
15469: $Str .= "</select>\n";
15470: return $Str;
1.31 albertel 15471: }
15472:
1.301 albertel 15473: sub get_samples {
15474: my ($records,$toget) = @_;
15475: my @samples=({});
15476: my $got=0;
15477: foreach my $rec (@$records) {
15478: my %temp = &record_sep($rec);
15479: if (! grep(/\S/, values(%temp))) { next; }
15480: if (%temp) {
15481: $samples[$got]=\%temp;
15482: $got++;
15483: if ($got == $toget) { last; }
15484: }
15485: }
15486: return \@samples;
15487: }
15488:
1.144 matthew 15489: ######################################################
15490: ######################################################
15491:
1.56 matthew 15492: =pod
15493:
1.648 raeburn 15494: =item * &csv_print_samples($r,$records)
1.41 ng 15495:
15496: Prints a table of sample values from each column uploaded $r is an
15497: Apache Request ref, $records is an arrayref from
15498: &Apache::loncommon::upfile_record_sep
15499:
15500: =cut
15501:
1.144 matthew 15502: ######################################################
15503: ######################################################
1.31 albertel 15504: sub csv_print_samples {
15505: my ($r,$records) = @_;
1.662 bisitz 15506: my $samples = &get_samples($records,5);
1.301 albertel 15507:
1.594 raeburn 15508: $r->print(&mt('Samples').'<br />'.&start_data_table().
15509: &start_data_table_header_row());
1.356 albertel 15510: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15511: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15512: $r->print(&end_data_table_header_row());
1.301 albertel 15513: foreach my $hash (@$samples) {
1.594 raeburn 15514: $r->print(&start_data_table_row());
1.356 albertel 15515: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15516: $r->print('<td>');
1.356 albertel 15517: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15518: $r->print('</td>');
15519: }
1.594 raeburn 15520: $r->print(&end_data_table_row());
1.31 albertel 15521: }
1.594 raeburn 15522: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15523: }
15524:
1.144 matthew 15525: ######################################################
15526: ######################################################
15527:
1.56 matthew 15528: =pod
15529:
1.648 raeburn 15530: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15531:
15532: Prints a table to create associations between values and table columns.
1.144 matthew 15533:
1.41 ng 15534: $r is an Apache Request ref,
15535: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15536: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15537:
15538: =cut
15539:
1.144 matthew 15540: ######################################################
15541: ######################################################
1.31 albertel 15542: sub csv_print_select_table {
15543: my ($r,$records,$d) = @_;
1.301 albertel 15544: my $i=0;
15545: my $samples = &get_samples($records,1);
1.144 matthew 15546: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15547: &start_data_table().&start_data_table_header_row().
1.144 matthew 15548: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15549: '<th>'.&mt('Column').'</th>'.
15550: &end_data_table_header_row()."\n");
1.356 albertel 15551: foreach my $array_ref (@$d) {
15552: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15553: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15554:
1.875 bisitz 15555: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15556: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15557: $r->print('<option value="none"></option>');
1.356 albertel 15558: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15559: $r->print('<option value="'.$sample.'"'.
15560: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15561: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15562: }
1.594 raeburn 15563: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15564: $i++;
15565: }
1.594 raeburn 15566: $r->print(&end_data_table());
1.31 albertel 15567: $i--;
15568: return $i;
15569: }
1.56 matthew 15570:
1.144 matthew 15571: ######################################################
15572: ######################################################
15573:
1.56 matthew 15574: =pod
1.31 albertel 15575:
1.648 raeburn 15576: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15577:
15578: Prints a table of sample values from the upload and can make associate samples to internal names.
15579:
15580: $r is an Apache Request ref,
15581: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15582: $d is an array of 2 element arrays (internal name, displayed name)
15583:
15584: =cut
15585:
1.144 matthew 15586: ######################################################
15587: ######################################################
1.31 albertel 15588: sub csv_samples_select_table {
15589: my ($r,$records,$d) = @_;
15590: my $i=0;
1.144 matthew 15591: #
1.662 bisitz 15592: my $max_samples = 5;
15593: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15594: $r->print(&start_data_table().
15595: &start_data_table_header_row().'<th>'.
15596: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15597: &end_data_table_header_row());
1.301 albertel 15598:
15599: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15600: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15601: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15602: foreach my $option (@$d) {
15603: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15604: $r->print('<option value="'.$value.'"'.
1.253 albertel 15605: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15606: $display.'</option>');
1.31 albertel 15607: }
15608: $r->print('</select></td><td>');
1.662 bisitz 15609: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15610: if (defined($samples->[$line]{$key})) {
15611: $r->print($samples->[$line]{$key}."<br />\n");
15612: }
15613: }
1.594 raeburn 15614: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15615: $i++;
15616: }
1.594 raeburn 15617: $r->print(&end_data_table());
1.31 albertel 15618: $i--;
15619: return($i);
1.115 matthew 15620: }
15621:
1.144 matthew 15622: ######################################################
15623: ######################################################
15624:
1.115 matthew 15625: =pod
15626:
1.648 raeburn 15627: =item * &clean_excel_name($name)
1.115 matthew 15628:
15629: Returns a replacement for $name which does not contain any illegal characters.
15630:
15631: =cut
15632:
1.144 matthew 15633: ######################################################
15634: ######################################################
1.115 matthew 15635: sub clean_excel_name {
15636: my ($name) = @_;
15637: $name =~ s/[:\*\?\/\\]//g;
15638: if (length($name) > 31) {
15639: $name = substr($name,0,31);
15640: }
15641: return $name;
1.25 albertel 15642: }
1.84 albertel 15643:
1.85 albertel 15644: =pod
15645:
1.648 raeburn 15646: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15647:
15648: Returns either 1 or undef
15649:
15650: 1 if the part is to be hidden, undef if it is to be shown
15651:
15652: Arguments are:
15653:
15654: $id the id of the part to be checked
15655: $symb, optional the symb of the resource to check
15656: $udom, optional the domain of the user to check for
15657: $uname, optional the username of the user to check for
15658:
15659: =cut
1.84 albertel 15660:
15661: sub check_if_partid_hidden {
15662: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15663: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15664: $symb,$udom,$uname);
1.141 albertel 15665: my $truth=1;
15666: #if the string starts with !, then the list is the list to show not hide
15667: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15668: my @hiddenlist=split(/,/,$hiddenparts);
15669: foreach my $checkid (@hiddenlist) {
1.141 albertel 15670: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15671: }
1.141 albertel 15672: return !$truth;
1.84 albertel 15673: }
1.127 matthew 15674:
1.138 matthew 15675:
15676: ############################################################
15677: ############################################################
15678:
15679: =pod
15680:
1.157 matthew 15681: =back
15682:
1.138 matthew 15683: =head1 cgi-bin script and graphing routines
15684:
1.157 matthew 15685: =over 4
15686:
1.648 raeburn 15687: =item * &get_cgi_id()
1.138 matthew 15688:
15689: Inputs: none
15690:
15691: Returns an id which can be used to pass environment variables
15692: to various cgi-bin scripts. These environment variables will
15693: be removed from the users environment after a given time by
15694: the routine &Apache::lonnet::transfer_profile_to_env.
15695:
15696: =cut
15697:
15698: ############################################################
15699: ############################################################
1.152 albertel 15700: my $uniq=0;
1.136 matthew 15701: sub get_cgi_id {
1.154 albertel 15702: $uniq=($uniq+1)%100000;
1.280 albertel 15703: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15704: }
15705:
1.127 matthew 15706: ############################################################
15707: ############################################################
15708:
15709: =pod
15710:
1.648 raeburn 15711: =item * &DrawBarGraph()
1.127 matthew 15712:
1.138 matthew 15713: Facilitates the plotting of data in a (stacked) bar graph.
15714: Puts plot definition data into the users environment in order for
15715: graph.png to plot it. Returns an <img> tag for the plot.
15716: The bars on the plot are labeled '1','2',...,'n'.
15717:
15718: Inputs:
15719:
15720: =over 4
15721:
15722: =item $Title: string, the title of the plot
15723:
15724: =item $xlabel: string, text describing the X-axis of the plot
15725:
15726: =item $ylabel: string, text describing the Y-axis of the plot
15727:
15728: =item $Max: scalar, the maximum Y value to use in the plot
15729: If $Max is < any data point, the graph will not be rendered.
15730:
1.140 matthew 15731: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15732: they are plotted. If undefined, default values will be used.
15733:
1.178 matthew 15734: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15735:
1.138 matthew 15736: =item @Values: An array of array references. Each array reference holds data
15737: to be plotted in a stacked bar chart.
15738:
1.239 matthew 15739: =item If the final element of @Values is a hash reference the key/value
15740: pairs will be added to the graph definition.
15741:
1.138 matthew 15742: =back
15743:
15744: Returns:
15745:
15746: An <img> tag which references graph.png and the appropriate identifying
15747: information for the plot.
15748:
1.127 matthew 15749: =cut
15750:
15751: ############################################################
15752: ############################################################
1.134 matthew 15753: sub DrawBarGraph {
1.178 matthew 15754: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15755: #
15756: if (! defined($colors)) {
15757: $colors = ['#33ff00',
15758: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15759: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15760: ];
15761: }
1.228 matthew 15762: my $extra_settings = {};
15763: if (ref($Values[-1]) eq 'HASH') {
15764: $extra_settings = pop(@Values);
15765: }
1.127 matthew 15766: #
1.136 matthew 15767: my $identifier = &get_cgi_id();
15768: my $id = 'cgi.'.$identifier;
1.129 matthew 15769: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15770: return '';
15771: }
1.225 matthew 15772: #
15773: my @Labels;
15774: if (defined($labels)) {
15775: @Labels = @$labels;
15776: } else {
15777: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15778: push(@Labels,$i+1);
1.225 matthew 15779: }
15780: }
15781: #
1.129 matthew 15782: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15783: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15784: my %ValuesHash;
15785: my $NumSets=1;
15786: foreach my $array (@Values) {
15787: next if (! ref($array));
1.136 matthew 15788: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15789: join(',',@$array);
1.129 matthew 15790: }
1.127 matthew 15791: #
1.136 matthew 15792: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15793: if ($NumBars < 3) {
15794: $width = 120+$NumBars*32;
1.220 matthew 15795: $xskip = 1;
1.225 matthew 15796: $bar_width = 30;
15797: } elsif ($NumBars < 5) {
15798: $width = 120+$NumBars*20;
15799: $xskip = 1;
15800: $bar_width = 20;
1.220 matthew 15801: } elsif ($NumBars < 10) {
1.136 matthew 15802: $width = 120+$NumBars*15;
15803: $xskip = 1;
15804: $bar_width = 15;
15805: } elsif ($NumBars <= 25) {
15806: $width = 120+$NumBars*11;
15807: $xskip = 5;
15808: $bar_width = 8;
15809: } elsif ($NumBars <= 50) {
15810: $width = 120+$NumBars*8;
15811: $xskip = 5;
15812: $bar_width = 4;
15813: } else {
15814: $width = 120+$NumBars*8;
15815: $xskip = 5;
15816: $bar_width = 4;
15817: }
15818: #
1.137 matthew 15819: $Max = 1 if ($Max < 1);
15820: if ( int($Max) < $Max ) {
15821: $Max++;
15822: $Max = int($Max);
15823: }
1.127 matthew 15824: $Title = '' if (! defined($Title));
15825: $xlabel = '' if (! defined($xlabel));
15826: $ylabel = '' if (! defined($ylabel));
1.369 www 15827: $ValuesHash{$id.'.title'} = &escape($Title);
15828: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15829: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15830: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15831: $ValuesHash{$id.'.NumBars'} = $NumBars;
15832: $ValuesHash{$id.'.NumSets'} = $NumSets;
15833: $ValuesHash{$id.'.PlotType'} = 'bar';
15834: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15835: $ValuesHash{$id.'.height'} = $height;
15836: $ValuesHash{$id.'.width'} = $width;
15837: $ValuesHash{$id.'.xskip'} = $xskip;
15838: $ValuesHash{$id.'.bar_width'} = $bar_width;
15839: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15840: #
1.228 matthew 15841: # Deal with other parameters
15842: while (my ($key,$value) = each(%$extra_settings)) {
15843: $ValuesHash{$id.'.'.$key} = $value;
15844: }
15845: #
1.646 raeburn 15846: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15847: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15848: }
15849:
15850: ############################################################
15851: ############################################################
15852:
15853: =pod
15854:
1.648 raeburn 15855: =item * &DrawXYGraph()
1.137 matthew 15856:
1.138 matthew 15857: Facilitates the plotting of data in an XY graph.
15858: Puts plot definition data into the users environment in order for
15859: graph.png to plot it. Returns an <img> tag for the plot.
15860:
15861: Inputs:
15862:
15863: =over 4
15864:
15865: =item $Title: string, the title of the plot
15866:
15867: =item $xlabel: string, text describing the X-axis of the plot
15868:
15869: =item $ylabel: string, text describing the Y-axis of the plot
15870:
15871: =item $Max: scalar, the maximum Y value to use in the plot
15872: If $Max is < any data point, the graph will not be rendered.
15873:
15874: =item $colors: Array ref containing the hex color codes for the data to be
15875: plotted in. If undefined, default values will be used.
15876:
15877: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15878:
15879: =item $Ydata: Array ref containing Array refs.
1.185 www 15880: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15881:
15882: =item %Values: hash indicating or overriding any default values which are
15883: passed to graph.png.
15884: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15885:
15886: =back
15887:
15888: Returns:
15889:
15890: An <img> tag which references graph.png and the appropriate identifying
15891: information for the plot.
15892:
1.137 matthew 15893: =cut
15894:
15895: ############################################################
15896: ############################################################
15897: sub DrawXYGraph {
15898: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15899: #
15900: # Create the identifier for the graph
15901: my $identifier = &get_cgi_id();
15902: my $id = 'cgi.'.$identifier;
15903: #
15904: $Title = '' if (! defined($Title));
15905: $xlabel = '' if (! defined($xlabel));
15906: $ylabel = '' if (! defined($ylabel));
15907: my %ValuesHash =
15908: (
1.369 www 15909: $id.'.title' => &escape($Title),
15910: $id.'.xlabel' => &escape($xlabel),
15911: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15912: $id.'.y_max_value'=> $Max,
15913: $id.'.labels' => join(',',@$Xlabels),
15914: $id.'.PlotType' => 'XY',
15915: );
15916: #
15917: if (defined($colors) && ref($colors) eq 'ARRAY') {
15918: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15919: }
15920: #
15921: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15922: return '';
15923: }
15924: my $NumSets=1;
1.138 matthew 15925: foreach my $array (@{$Ydata}){
1.137 matthew 15926: next if (! ref($array));
15927: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15928: }
1.138 matthew 15929: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15930: #
15931: # Deal with other parameters
15932: while (my ($key,$value) = each(%Values)) {
15933: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15934: }
15935: #
1.646 raeburn 15936: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15937: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15938: }
15939:
15940: ############################################################
15941: ############################################################
15942:
15943: =pod
15944:
1.648 raeburn 15945: =item * &DrawXYYGraph()
1.138 matthew 15946:
15947: Facilitates the plotting of data in an XY graph with two Y axes.
15948: Puts plot definition data into the users environment in order for
15949: graph.png to plot it. Returns an <img> tag for the plot.
15950:
15951: Inputs:
15952:
15953: =over 4
15954:
15955: =item $Title: string, the title of the plot
15956:
15957: =item $xlabel: string, text describing the X-axis of the plot
15958:
15959: =item $ylabel: string, text describing the Y-axis of the plot
15960:
15961: =item $colors: Array ref containing the hex color codes for the data to be
15962: plotted in. If undefined, default values will be used.
15963:
15964: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15965:
15966: =item $Ydata1: The first data set
15967:
15968: =item $Min1: The minimum value of the left Y-axis
15969:
15970: =item $Max1: The maximum value of the left Y-axis
15971:
15972: =item $Ydata2: The second data set
15973:
15974: =item $Min2: The minimum value of the right Y-axis
15975:
15976: =item $Max2: The maximum value of the left Y-axis
15977:
15978: =item %Values: hash indicating or overriding any default values which are
15979: passed to graph.png.
15980: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15981:
15982: =back
15983:
15984: Returns:
15985:
15986: An <img> tag which references graph.png and the appropriate identifying
15987: information for the plot.
1.136 matthew 15988:
15989: =cut
15990:
15991: ############################################################
15992: ############################################################
1.137 matthew 15993: sub DrawXYYGraph {
15994: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15995: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15996: #
15997: # Create the identifier for the graph
15998: my $identifier = &get_cgi_id();
15999: my $id = 'cgi.'.$identifier;
16000: #
16001: $Title = '' if (! defined($Title));
16002: $xlabel = '' if (! defined($xlabel));
16003: $ylabel = '' if (! defined($ylabel));
16004: my %ValuesHash =
16005: (
1.369 www 16006: $id.'.title' => &escape($Title),
16007: $id.'.xlabel' => &escape($xlabel),
16008: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16009: $id.'.labels' => join(',',@$Xlabels),
16010: $id.'.PlotType' => 'XY',
16011: $id.'.NumSets' => 2,
1.137 matthew 16012: $id.'.two_axes' => 1,
16013: $id.'.y1_max_value' => $Max1,
16014: $id.'.y1_min_value' => $Min1,
16015: $id.'.y2_max_value' => $Max2,
16016: $id.'.y2_min_value' => $Min2,
1.136 matthew 16017: );
16018: #
1.137 matthew 16019: if (defined($colors) && ref($colors) eq 'ARRAY') {
16020: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16021: }
16022: #
16023: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16024: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16025: return '';
16026: }
16027: my $NumSets=1;
1.137 matthew 16028: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16029: next if (! ref($array));
16030: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16031: }
16032: #
16033: # Deal with other parameters
16034: while (my ($key,$value) = each(%Values)) {
16035: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16036: }
16037: #
1.646 raeburn 16038: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16039: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16040: }
16041:
16042: ############################################################
16043: ############################################################
16044:
16045: =pod
16046:
1.157 matthew 16047: =back
16048:
1.139 matthew 16049: =head1 Statistics helper routines?
16050:
16051: Bad place for them but what the hell.
16052:
1.157 matthew 16053: =over 4
16054:
1.648 raeburn 16055: =item * &chartlink()
1.139 matthew 16056:
16057: Returns a link to the chart for a specific student.
16058:
16059: Inputs:
16060:
16061: =over 4
16062:
16063: =item $linktext: The text of the link
16064:
16065: =item $sname: The students username
16066:
16067: =item $sdomain: The students domain
16068:
16069: =back
16070:
1.157 matthew 16071: =back
16072:
1.139 matthew 16073: =cut
16074:
16075: ############################################################
16076: ############################################################
16077: sub chartlink {
16078: my ($linktext, $sname, $sdomain) = @_;
16079: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16080: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16081: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16082: '">'.$linktext.'</a>';
1.153 matthew 16083: }
16084:
16085: #######################################################
16086: #######################################################
16087:
16088: =pod
16089:
16090: =head1 Course Environment Routines
1.157 matthew 16091:
16092: =over 4
1.153 matthew 16093:
1.648 raeburn 16094: =item * &restore_course_settings()
1.153 matthew 16095:
1.648 raeburn 16096: =item * &store_course_settings()
1.153 matthew 16097:
16098: Restores/Store indicated form parameters from the course environment.
16099: Will not overwrite existing values of the form parameters.
16100:
16101: Inputs:
16102: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16103:
16104: a hash ref describing the data to be stored. For example:
16105:
16106: %Save_Parameters = ('Status' => 'scalar',
16107: 'chartoutputmode' => 'scalar',
16108: 'chartoutputdata' => 'scalar',
16109: 'Section' => 'array',
1.373 raeburn 16110: 'Group' => 'array',
1.153 matthew 16111: 'StudentData' => 'array',
16112: 'Maps' => 'array');
16113:
16114: Returns: both routines return nothing
16115:
1.631 raeburn 16116: =back
16117:
1.153 matthew 16118: =cut
16119:
16120: #######################################################
16121: #######################################################
16122: sub store_course_settings {
1.496 albertel 16123: return &store_settings($env{'request.course.id'},@_);
16124: }
16125:
16126: sub store_settings {
1.153 matthew 16127: # save to the environment
16128: # appenv the same items, just to be safe
1.300 albertel 16129: my $udom = $env{'user.domain'};
16130: my $uname = $env{'user.name'};
1.496 albertel 16131: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16132: my %SaveHash;
16133: my %AppHash;
16134: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16135: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16136: my $envname = 'environment.'.$basename;
1.258 albertel 16137: if (exists($env{'form.'.$setting})) {
1.153 matthew 16138: # Save this value away
16139: if ($type eq 'scalar' &&
1.258 albertel 16140: (! exists($env{$envname}) ||
16141: $env{$envname} ne $env{'form.'.$setting})) {
16142: $SaveHash{$basename} = $env{'form.'.$setting};
16143: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16144: } elsif ($type eq 'array') {
16145: my $stored_form;
1.258 albertel 16146: if (ref($env{'form.'.$setting})) {
1.153 matthew 16147: $stored_form = join(',',
16148: map {
1.369 www 16149: &escape($_);
1.258 albertel 16150: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16151: } else {
16152: $stored_form =
1.369 www 16153: &escape($env{'form.'.$setting});
1.153 matthew 16154: }
16155: # Determine if the array contents are the same.
1.258 albertel 16156: if ($stored_form ne $env{$envname}) {
1.153 matthew 16157: $SaveHash{$basename} = $stored_form;
16158: $AppHash{$envname} = $stored_form;
16159: }
16160: }
16161: }
16162: }
16163: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16164: $udom,$uname);
1.153 matthew 16165: if ($put_result !~ /^(ok|delayed)/) {
16166: &Apache::lonnet::logthis('unable to save form parameters, '.
16167: 'got error:'.$put_result);
16168: }
16169: # Make sure these settings stick around in this session, too
1.646 raeburn 16170: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16171: return;
16172: }
16173:
16174: sub restore_course_settings {
1.499 albertel 16175: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16176: }
16177:
16178: sub restore_settings {
16179: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16180: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16181: next if (exists($env{'form.'.$setting}));
1.496 albertel 16182: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16183: '.'.$setting;
1.258 albertel 16184: if (exists($env{$envname})) {
1.153 matthew 16185: if ($type eq 'scalar') {
1.258 albertel 16186: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16187: } elsif ($type eq 'array') {
1.258 albertel 16188: $env{'form.'.$setting} = [
1.153 matthew 16189: map {
1.369 www 16190: &unescape($_);
1.258 albertel 16191: } split(',',$env{$envname})
1.153 matthew 16192: ];
16193: }
16194: }
16195: }
1.127 matthew 16196: }
16197:
1.618 raeburn 16198: #######################################################
16199: #######################################################
16200:
16201: =pod
16202:
16203: =head1 Domain E-mail Routines
16204:
16205: =over 4
16206:
1.648 raeburn 16207: =item * &build_recipient_list()
1.618 raeburn 16208:
1.1144 raeburn 16209: Build recipient lists for following types of e-mail:
1.766 raeburn 16210: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16211: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16212: module change checking, student/employee ID conflict checks, as
16213: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16214: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16215:
16216: Inputs:
1.619 raeburn 16217: defmail (scalar - email address of default recipient),
1.1144 raeburn 16218: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16219: requestsmail, updatesmail, or idconflictsmail).
16220:
1.619 raeburn 16221: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16222:
1.619 raeburn 16223: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16224: i.e., predates configuration by DC via domainprefs.pm
16225:
16226: $requname username of requester (if mailing type is helpdeskmail)
16227:
16228: $requdom domain of requester (if mailing type is helpdeskmail)
16229:
16230: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16231:
1.618 raeburn 16232:
1.655 raeburn 16233: Returns: comma separated list of addresses to which to send e-mail.
16234:
16235: =back
1.618 raeburn 16236:
16237: =cut
16238:
16239: ############################################################
16240: ############################################################
16241: sub build_recipient_list {
1.1297 raeburn 16242: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16243: my @recipients;
1.1270 raeburn 16244: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16245: my %domconfig =
1.1270 raeburn 16246: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16247: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16248: if (exists($domconfig{'contacts'}{$mailing})) {
16249: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16250: my @contacts = ('adminemail','supportemail');
16251: foreach my $item (@contacts) {
16252: if ($domconfig{'contacts'}{$mailing}{$item}) {
16253: my $addr = $domconfig{'contacts'}{$item};
16254: if (!grep(/^\Q$addr\E$/,@recipients)) {
16255: push(@recipients,$addr);
16256: }
1.619 raeburn 16257: }
1.1270 raeburn 16258: }
16259: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16260: if ($mailing eq 'helpdeskmail') {
16261: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16262: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16263: my @ok_bccs;
16264: foreach my $bcc (@bccs) {
16265: $bcc =~ s/^\s+//g;
16266: $bcc =~ s/\s+$//g;
16267: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16268: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16269: push(@ok_bccs,$bcc);
16270: }
16271: }
16272: }
16273: if (@ok_bccs > 0) {
16274: $allbcc = join(', ',@ok_bccs);
16275: }
16276: }
16277: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16278: }
16279: }
1.766 raeburn 16280: } elsif ($origmail ne '') {
1.1270 raeburn 16281: $lastresort = $origmail;
1.618 raeburn 16282: }
1.1297 raeburn 16283: if ($mailing eq 'helpdeskmail') {
16284: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16285: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16286: my ($inststatus,$inststatus_checked);
16287: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16288: ($env{'user.domain'} ne 'public')) {
16289: $inststatus_checked = 1;
16290: $inststatus = $env{'environment.inststatus'};
16291: }
16292: unless ($inststatus_checked) {
16293: if (($requname ne '') && ($requdom ne '')) {
16294: if (($requname =~ /^$match_username$/) &&
16295: ($requdom =~ /^$match_domain$/) &&
16296: (&Apache::lonnet::domain($requdom))) {
16297: my $requhome = &Apache::lonnet::homeserver($requname,
16298: $requdom);
16299: unless ($requhome eq 'no_host') {
16300: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16301: $inststatus = $userenv{'inststatus'};
16302: $inststatus_checked = 1;
16303: }
16304: }
16305: }
16306: }
16307: unless ($inststatus_checked) {
16308: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16309: my %srch = (srchby => 'email',
16310: srchdomain => $defdom,
16311: srchterm => $reqemail,
16312: srchtype => 'exact');
16313: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16314: foreach my $uname (keys(%srch_results)) {
16315: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16316: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16317: $inststatus_checked = 1;
16318: last;
16319: }
16320: }
16321: unless ($inststatus_checked) {
16322: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16323: if ($dirsrchres eq 'ok') {
16324: foreach my $uname (keys(%srch_results)) {
16325: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16326: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16327: $inststatus_checked = 1;
16328: last;
16329: }
16330: }
16331: }
16332: }
16333: }
16334: }
16335: if ($inststatus ne '') {
16336: foreach my $status (split(/\:/,$inststatus)) {
16337: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16338: my @contacts = ('adminemail','supportemail');
16339: foreach my $item (@contacts) {
16340: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16341: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16342: if (!grep(/^\Q$addr\E$/,@recipients)) {
16343: push(@recipients,$addr);
16344: }
16345: }
16346: }
16347: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16348: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16349: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16350: my @ok_bccs;
16351: foreach my $bcc (@bccs) {
16352: $bcc =~ s/^\s+//g;
16353: $bcc =~ s/\s+$//g;
16354: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16355: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16356: push(@ok_bccs,$bcc);
16357: }
16358: }
16359: }
16360: if (@ok_bccs > 0) {
16361: $allbcc = join(', ',@ok_bccs);
16362: }
16363: }
16364: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16365: last;
16366: }
16367: }
16368: }
16369: }
16370: }
1.619 raeburn 16371: } elsif ($origmail ne '') {
1.1270 raeburn 16372: $lastresort = $origmail;
16373: }
1.1297 raeburn 16374: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16375: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16376: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16377: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16378: my %what = (
16379: perlvar => 1,
16380: );
16381: my $primary = &Apache::lonnet::domain($defdom,'primary');
16382: if ($primary) {
16383: my $gotaddr;
16384: my ($result,$returnhash) =
16385: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16386: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16387: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16388: $lastresort = $returnhash->{'lonSupportEMail'};
16389: $gotaddr = 1;
16390: }
16391: }
16392: unless ($gotaddr) {
16393: my $uintdom = &Apache::lonnet::internet_dom($primary);
16394: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16395: unless ($uintdom eq $intdom) {
16396: my %domconfig =
16397: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16398: if (ref($domconfig{'contacts'}) eq 'HASH') {
16399: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16400: my @contacts = ('adminemail','supportemail');
16401: foreach my $item (@contacts) {
16402: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16403: my $addr = $domconfig{'contacts'}{$item};
16404: if (!grep(/^\Q$addr\E$/,@recipients)) {
16405: push(@recipients,$addr);
16406: }
16407: }
16408: }
16409: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16410: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16411: }
16412: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16413: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16414: my @ok_bccs;
16415: foreach my $bcc (@bccs) {
16416: $bcc =~ s/^\s+//g;
16417: $bcc =~ s/\s+$//g;
16418: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16419: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16420: push(@ok_bccs,$bcc);
16421: }
16422: }
16423: }
16424: if (@ok_bccs > 0) {
16425: $allbcc = join(', ',@ok_bccs);
16426: }
16427: }
16428: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16429: }
16430: }
16431: }
16432: }
16433: }
16434: }
1.618 raeburn 16435: }
1.688 raeburn 16436: if (defined($defmail)) {
16437: if ($defmail ne '') {
16438: push(@recipients,$defmail);
16439: }
1.618 raeburn 16440: }
16441: if ($otheremails) {
1.619 raeburn 16442: my @others;
16443: if ($otheremails =~ /,/) {
16444: @others = split(/,/,$otheremails);
1.618 raeburn 16445: } else {
1.619 raeburn 16446: push(@others,$otheremails);
16447: }
16448: foreach my $addr (@others) {
16449: if (!grep(/^\Q$addr\E$/,@recipients)) {
16450: push(@recipients,$addr);
16451: }
1.618 raeburn 16452: }
16453: }
1.1298 raeburn 16454: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16455: if ((!@recipients) && ($lastresort ne '')) {
16456: push(@recipients,$lastresort);
16457: }
16458: } elsif ($lastresort ne '') {
16459: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16460: push(@recipients,$lastresort);
16461: }
16462: }
1.1271 raeburn 16463: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16464: if (wantarray) {
16465: return ($recipientlist,$allbcc,$addtext);
16466: } else {
16467: return $recipientlist;
16468: }
1.618 raeburn 16469: }
16470:
1.127 matthew 16471: ############################################################
16472: ############################################################
1.154 albertel 16473:
1.655 raeburn 16474: =pod
16475:
1.1224 musolffc 16476: =over 4
16477:
1.1223 musolffc 16478: =item * &mime_email()
16479:
16480: Sends an email with a possible attachment
16481:
16482: Inputs:
16483:
16484: =over 4
16485:
16486: from - Sender's email address
16487:
1.1343 raeburn 16488: replyto - Reply-To email address
16489:
1.1223 musolffc 16490: to - Email address of recipient
16491:
16492: subject - Subject of email
16493:
16494: body - Body of email
16495:
16496: cc_string - Carbon copy email address
16497:
16498: bcc - Blind carbon copy email address
16499:
16500: attachment_path - Path of file to be attached
16501:
16502: file_name - Name of file to be attached
16503:
16504: attachment_text - The body of an attachment of type "TEXT"
16505:
16506: =back
16507:
16508: =back
16509:
16510: =cut
16511:
16512: ############################################################
16513: ############################################################
16514:
16515: sub mime_email {
1.1343 raeburn 16516: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16517: $file_name,$attachment_text) = @_;
16518:
1.1223 musolffc 16519: my $msg = MIME::Lite->new(
16520: From => $from,
16521: To => $to,
16522: Subject => $subject,
16523: Type =>'TEXT',
16524: Data => $body,
16525: );
1.1343 raeburn 16526: if ($replyto ne '') {
16527: $msg->add("Reply-To" => $replyto);
16528: }
1.1223 musolffc 16529: if ($cc_string ne '') {
16530: $msg->add("Cc" => $cc_string);
16531: }
16532: if ($bcc ne '') {
16533: $msg->add("Bcc" => $bcc);
16534: }
16535: $msg->attr("content-type" => "text/plain");
16536: $msg->attr("content-type.charset" => "UTF-8");
16537: # Attach file if given
16538: if ($attachment_path) {
16539: unless ($file_name) {
16540: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16541: }
16542: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16543: $msg->attach(Type => $type,
16544: Path => $attachment_path,
16545: Filename => $file_name
16546: );
16547: # Otherwise attach text if given
16548: } elsif ($attachment_text) {
16549: $msg->attach(Type => 'TEXT',
16550: Data => $attachment_text);
16551: }
16552: # Send it
16553: $msg->send('sendmail');
16554: }
16555:
16556: ############################################################
16557: ############################################################
16558:
16559: =pod
16560:
1.655 raeburn 16561: =head1 Course Catalog Routines
16562:
16563: =over 4
16564:
16565: =item * &gather_categories()
16566:
16567: Converts category definitions - keys of categories hash stored in
16568: coursecategories in configuration.db on the primary library server in a
16569: domain - to an array. Also generates javascript and idx hash used to
16570: generate Domain Coordinator interface for editing Course Categories.
16571:
16572: Inputs:
1.663 raeburn 16573:
1.655 raeburn 16574: categories (reference to hash of category definitions).
1.663 raeburn 16575:
1.655 raeburn 16576: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16577: categories and subcategories).
1.663 raeburn 16578:
1.655 raeburn 16579: idx (reference to hash of counters used in Domain Coordinator interface for
16580: editing Course Categories).
1.663 raeburn 16581:
1.655 raeburn 16582: jsarray (reference to array of categories used to create Javascript arrays for
16583: Domain Coordinator interface for editing Course Categories).
16584:
16585: Returns: nothing
16586:
16587: Side effects: populates cats, idx and jsarray.
16588:
16589: =cut
16590:
16591: sub gather_categories {
16592: my ($categories,$cats,$idx,$jsarray) = @_;
16593: my %counters;
16594: my $num = 0;
16595: foreach my $item (keys(%{$categories})) {
16596: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16597: if ($container eq '' && $depth == 0) {
16598: $cats->[$depth][$categories->{$item}] = $cat;
16599: } else {
16600: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16601: }
16602: my ($escitem,$tail) = split(/:/,$item,2);
16603: if ($counters{$tail} eq '') {
16604: $counters{$tail} = $num;
16605: $num ++;
16606: }
16607: if (ref($idx) eq 'HASH') {
16608: $idx->{$item} = $counters{$tail};
16609: }
16610: if (ref($jsarray) eq 'ARRAY') {
16611: push(@{$jsarray->[$counters{$tail}]},$item);
16612: }
16613: }
16614: return;
16615: }
16616:
16617: =pod
16618:
16619: =item * &extract_categories()
16620:
16621: Used to generate breadcrumb trails for course categories.
16622:
16623: Inputs:
1.663 raeburn 16624:
1.655 raeburn 16625: categories (reference to hash of category definitions).
1.663 raeburn 16626:
1.655 raeburn 16627: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16628: categories and subcategories).
1.663 raeburn 16629:
1.655 raeburn 16630: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16631:
1.655 raeburn 16632: allitems (reference to hash - key is category key
16633: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16634:
1.655 raeburn 16635: idx (reference to hash of counters used in Domain Coordinator interface for
16636: editing Course Categories).
1.663 raeburn 16637:
1.655 raeburn 16638: jsarray (reference to array of categories used to create Javascript arrays for
16639: Domain Coordinator interface for editing Course Categories).
16640:
1.665 raeburn 16641: subcats (reference to hash of arrays containing all subcategories within each
16642: category, -recursive)
16643:
1.1321 raeburn 16644: maxd (reference to hash used to hold max depth for all top-level categories).
16645:
1.655 raeburn 16646: Returns: nothing
16647:
16648: Side effects: populates trails and allitems hash references.
16649:
16650: =cut
16651:
16652: sub extract_categories {
1.1321 raeburn 16653: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16654: if (ref($categories) eq 'HASH') {
16655: &gather_categories($categories,$cats,$idx,$jsarray);
16656: if (ref($cats->[0]) eq 'ARRAY') {
16657: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16658: my $name = $cats->[0][$i];
16659: my $item = &escape($name).'::0';
16660: my $trailstr;
16661: if ($name eq 'instcode') {
16662: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16663: } elsif ($name eq 'communities') {
16664: $trailstr = &mt('Communities');
1.1239 raeburn 16665: } elsif ($name eq 'placement') {
16666: $trailstr = &mt('Placement Tests');
1.655 raeburn 16667: } else {
16668: $trailstr = $name;
16669: }
16670: if ($allitems->{$item} eq '') {
16671: push(@{$trails},$trailstr);
16672: $allitems->{$item} = scalar(@{$trails})-1;
16673: }
16674: my @parents = ($name);
16675: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16676: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16677: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16678: if (ref($subcats) eq 'HASH') {
16679: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16680: }
1.1321 raeburn 16681: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16682: }
16683: } else {
16684: if (ref($subcats) eq 'HASH') {
16685: $subcats->{$item} = [];
1.655 raeburn 16686: }
1.1321 raeburn 16687: if (ref($maxd) eq 'HASH') {
16688: $maxd->{$name} = 1;
16689: }
1.655 raeburn 16690: }
16691: }
16692: }
16693: }
16694: return;
16695: }
16696:
16697: =pod
16698:
1.1162 raeburn 16699: =item * &recurse_categories()
1.655 raeburn 16700:
16701: Recursively used to generate breadcrumb trails for course categories.
16702:
16703: Inputs:
1.663 raeburn 16704:
1.655 raeburn 16705: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16706: categories and subcategories).
1.663 raeburn 16707:
1.655 raeburn 16708: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16709:
16710: category (current course category, for which breadcrumb trail is being generated).
16711:
16712: trails (reference to array of breadcrumb trails for each category).
16713:
1.655 raeburn 16714: allitems (reference to hash - key is category key
16715: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16716:
1.655 raeburn 16717: parents (array containing containers directories for current category,
16718: back to top level).
16719:
16720: Returns: nothing
16721:
16722: Side effects: populates trails and allitems hash references
16723:
16724: =cut
16725:
16726: sub recurse_categories {
1.1321 raeburn 16727: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16728: my $shallower = $depth - 1;
16729: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16730: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16731: my $name = $cats->[$depth]{$category}[$k];
16732: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16733: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16734: if ($allitems->{$item} eq '') {
16735: push(@{$trails},$trailstr);
16736: $allitems->{$item} = scalar(@{$trails})-1;
16737: }
16738: my $deeper = $depth+1;
16739: push(@{$parents},$category);
1.665 raeburn 16740: if (ref($subcats) eq 'HASH') {
16741: my $subcat = &escape($name).':'.$category.':'.$depth;
16742: for (my $j=@{$parents}; $j>=0; $j--) {
16743: my $higher;
16744: if ($j > 0) {
16745: $higher = &escape($parents->[$j]).':'.
16746: &escape($parents->[$j-1]).':'.$j;
16747: } else {
16748: $higher = &escape($parents->[$j]).'::'.$j;
16749: }
16750: push(@{$subcats->{$higher}},$subcat);
16751: }
16752: }
16753: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16754: $subcats,$maxd);
1.655 raeburn 16755: pop(@{$parents});
16756: }
16757: } else {
16758: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16759: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16760: if ($allitems->{$item} eq '') {
16761: push(@{$trails},$trailstr);
16762: $allitems->{$item} = scalar(@{$trails})-1;
16763: }
1.1321 raeburn 16764: if (ref($maxd) eq 'HASH') {
16765: if ($depth > $maxd->{$parents->[0]}) {
16766: $maxd->{$parents->[0]} = $depth;
16767: }
16768: }
1.655 raeburn 16769: }
16770: return;
16771: }
16772:
1.663 raeburn 16773: =pod
16774:
1.1162 raeburn 16775: =item * &assign_categories_table()
1.663 raeburn 16776:
16777: Create a datatable for display of hierarchical categories in a domain,
16778: with checkboxes to allow a course to be categorized.
16779:
16780: Inputs:
16781:
16782: cathash - reference to hash of categories defined for the domain (from
16783: configuration.db)
16784:
16785: currcat - scalar with an & separated list of categories assigned to a course.
16786:
1.919 raeburn 16787: type - scalar contains course type (Course or Community).
16788:
1.1260 raeburn 16789: disabled - scalar (optional) contains disabled="disabled" if input elements are
16790: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16791:
1.663 raeburn 16792: Returns: $output (markup to be displayed)
16793:
16794: =cut
16795:
16796: sub assign_categories_table {
1.1259 raeburn 16797: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16798: my $output;
16799: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16800: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16801: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16802: $maxdepth = scalar(@cats);
16803: if (@cats > 0) {
16804: my $itemcount = 0;
16805: if (ref($cats[0]) eq 'ARRAY') {
16806: my @currcategories;
16807: if ($currcat ne '') {
16808: @currcategories = split('&',$currcat);
16809: }
1.919 raeburn 16810: my $table;
1.663 raeburn 16811: for (my $i=0; $i<@{$cats[0]}; $i++) {
16812: my $parent = $cats[0][$i];
1.919 raeburn 16813: next if ($parent eq 'instcode');
16814: if ($type eq 'Community') {
16815: next unless ($parent eq 'communities');
1.1239 raeburn 16816: } elsif ($type eq 'Placement') {
16817: next unless ($parent eq 'placement');
1.919 raeburn 16818: } else {
1.1239 raeburn 16819: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16820: }
1.663 raeburn 16821: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16822: my $item = &escape($parent).'::0';
16823: my $checked = '';
16824: if (@currcategories > 0) {
16825: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16826: $checked = ' checked="checked"';
1.663 raeburn 16827: }
16828: }
1.919 raeburn 16829: my $parent_title = $parent;
16830: if ($parent eq 'communities') {
16831: $parent_title = &mt('Communities');
1.1239 raeburn 16832: } elsif ($parent eq 'placement') {
16833: $parent_title = &mt('Placement Tests');
1.919 raeburn 16834: }
16835: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16836: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16837: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16838: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16839: my $depth = 1;
16840: push(@path,$parent);
1.1259 raeburn 16841: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16842: pop(@path);
1.919 raeburn 16843: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16844: $itemcount ++;
16845: }
1.919 raeburn 16846: if ($itemcount) {
16847: $output = &Apache::loncommon::start_data_table().
16848: $table.
16849: &Apache::loncommon::end_data_table();
16850: }
1.663 raeburn 16851: }
16852: }
16853: }
16854: return $output;
16855: }
16856:
16857: =pod
16858:
1.1162 raeburn 16859: =item * &assign_category_rows()
1.663 raeburn 16860:
16861: Create a datatable row for display of nested categories in a domain,
16862: with checkboxes to allow a course to be categorized,called recursively.
16863:
16864: Inputs:
16865:
16866: itemcount - track row number for alternating colors
16867:
16868: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16869: categories and subcategories.
16870:
16871: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16872:
16873: parent - parent of current category item
16874:
16875: path - Array containing all categories back up through the hierarchy from the
16876: current category to the top level.
16877:
16878: currcategories - reference to array of current categories assigned to the course
16879:
1.1260 raeburn 16880: disabled - scalar (optional) contains disabled="disabled" if input elements are
16881: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16882:
1.663 raeburn 16883: Returns: $output (markup to be displayed).
16884:
16885: =cut
16886:
16887: sub assign_category_rows {
1.1259 raeburn 16888: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16889: my ($text,$name,$item,$chgstr);
16890: if (ref($cats) eq 'ARRAY') {
16891: my $maxdepth = scalar(@{$cats});
16892: if (ref($cats->[$depth]) eq 'HASH') {
16893: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16894: my $numchildren = @{$cats->[$depth]{$parent}};
16895: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16896: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16897: for (my $j=0; $j<$numchildren; $j++) {
16898: $name = $cats->[$depth]{$parent}[$j];
16899: $item = &escape($name).':'.&escape($parent).':'.$depth;
16900: my $deeper = $depth+1;
16901: my $checked = '';
16902: if (ref($currcategories) eq 'ARRAY') {
16903: if (@{$currcategories} > 0) {
16904: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16905: $checked = ' checked="checked"';
1.663 raeburn 16906: }
16907: }
16908: }
1.664 raeburn 16909: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16910: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16911: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16912: '<input type="hidden" name="catname" value="'.$name.'" />'.
16913: '</td><td>';
1.663 raeburn 16914: if (ref($path) eq 'ARRAY') {
16915: push(@{$path},$name);
1.1259 raeburn 16916: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16917: pop(@{$path});
16918: }
16919: $text .= '</td></tr>';
16920: }
16921: $text .= '</table></td>';
16922: }
16923: }
16924: }
16925: return $text;
16926: }
16927:
1.1181 raeburn 16928: =pod
16929:
16930: =back
16931:
16932: =cut
16933:
1.655 raeburn 16934: ############################################################
16935: ############################################################
16936:
16937:
1.443 albertel 16938: sub commit_customrole {
1.1408 raeburn 16939: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16940: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16941: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16942: $context,$othdomby,$requester);
1.630 raeburn 16943: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16944: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16945: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16946: if (wantarray) {
16947: return ($output,$result);
16948: } else {
16949: return $output;
16950: }
1.443 albertel 16951: }
16952:
16953: sub commit_standardrole {
1.1408 raeburn 16954: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16955: $othdomby,$requester) = @_;
1.1399 raeburn 16956: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16957: if ($context eq 'auto') {
16958: $linefeed = "\n";
16959: } else {
16960: $linefeed = "<br />\n";
16961: }
1.443 albertel 16962: if ($three eq 'st') {
1.1399 raeburn 16963: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16964: $one,$two,$sec,$context,$credits,$othdomby,
16965: $requester);
1.541 raeburn 16966: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16967: ($result eq 'unknown_course') || ($result eq 'refused')) {
16968: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16969: } else {
1.541 raeburn 16970: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16971: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16972: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16973: if ($context eq 'auto') {
16974: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16975: } else {
16976: $output .= '<b>'.$result.'</b>'.$linefeed.
16977: &mt('Add to classlist').': <b>ok</b>';
16978: }
16979: $output .= $linefeed;
1.443 albertel 16980: }
16981: } else {
16982: $output = &mt('Assigning').' '.$three.' in '.$url.
16983: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16984: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 16985: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
16986: '','',$context,$othdomby,$requester);
1.541 raeburn 16987: if ($context eq 'auto') {
16988: $output .= $result.$linefeed;
16989: } else {
16990: $output .= '<b>'.$result.'</b>'.$linefeed;
16991: }
1.443 albertel 16992: }
1.1399 raeburn 16993: if (wantarray) {
16994: return ($output,$result);
16995: } else {
16996: return $output;
16997: }
1.443 albertel 16998: }
16999:
17000: sub commit_studentrole {
1.1116 raeburn 17001: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17002: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17003: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17004: if ($context eq 'auto') {
17005: $linefeed = "\n";
17006: } else {
17007: $linefeed = '<br />'."\n";
17008: }
1.443 albertel 17009: if (defined($one) && defined($two)) {
17010: my $cid=$one.'_'.$two;
17011: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17012: my $secchange = 0;
17013: my $expire_role_result;
17014: my $modify_section_result;
1.628 raeburn 17015: if ($oldsec ne '-1') {
17016: if ($oldsec ne $sec) {
1.443 albertel 17017: $secchange = 1;
1.628 raeburn 17018: my $now = time;
1.443 albertel 17019: my $uurl='/'.$cid;
17020: $uurl=~s/\_/\//g;
17021: if ($oldsec) {
17022: $uurl.='/'.$oldsec;
17023: }
1.626 raeburn 17024: $oldsecurl = $uurl;
1.628 raeburn 17025: $expire_role_result =
1.1408 raeburn 17026: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17027: '','','',$context,$othdomby,$requester);
17028: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17029: if ($expire_role_result eq 'refused') {
17030: my @roles = ('st');
17031: my @statuses = ('previous');
17032: my @roledoms = ($one);
17033: my $withsec = 1;
17034: my %roleshash =
17035: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17036: \@statuses,\@roles,\@roledoms,$withsec);
17037: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17038: my ($oldstart,$oldend) =
17039: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17040: if ($oldend > 0 && $oldend <= $now) {
17041: $expire_role_result = 'ok';
17042: }
17043: }
17044: }
17045: }
1.443 albertel 17046: $result = $expire_role_result;
17047: }
17048: }
17049: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17050: $modify_section_result =
17051: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17052: undef,undef,undef,$sec,
17053: $end,$start,'','',$cid,
1.1408 raeburn 17054: '',$context,$credits,'',
17055: $othdomby,$requester);
1.443 albertel 17056: if ($modify_section_result =~ /^ok/) {
17057: if ($secchange == 1) {
1.628 raeburn 17058: if ($sec eq '') {
17059: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17060: } else {
17061: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17062: }
1.443 albertel 17063: } elsif ($oldsec eq '-1') {
1.628 raeburn 17064: if ($sec eq '') {
17065: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17066: } else {
17067: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17068: }
1.443 albertel 17069: } else {
1.628 raeburn 17070: if ($sec eq '') {
17071: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17072: } else {
17073: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17074: }
1.443 albertel 17075: }
17076: } else {
1.1115 raeburn 17077: if ($secchange) {
1.628 raeburn 17078: $$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;
17079: } else {
17080: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17081: }
1.443 albertel 17082: }
17083: $result = $modify_section_result;
17084: } elsif ($secchange == 1) {
1.628 raeburn 17085: if ($oldsec eq '') {
1.1103 raeburn 17086: $$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 17087: } else {
17088: $$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;
17089: }
1.626 raeburn 17090: if ($expire_role_result eq 'refused') {
17091: my $newsecurl = '/'.$cid;
17092: $newsecurl =~ s/\_/\//g;
17093: if ($sec ne '') {
17094: $newsecurl.='/'.$sec;
17095: }
17096: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17097: if ($sec eq '') {
17098: $$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;
17099: } else {
17100: $$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;
17101: }
17102: }
17103: }
1.443 albertel 17104: }
17105: } else {
1.626 raeburn 17106: $$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 17107: $result = "error: incomplete course id\n";
17108: }
17109: return $result;
17110: }
17111:
1.1108 raeburn 17112: sub show_role_extent {
17113: my ($scope,$context,$role) = @_;
17114: $scope =~ s{^/}{};
17115: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17116: push(@courseroles,'co');
17117: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17118: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17119: $scope =~ s{/}{_};
17120: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17121: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17122: my ($audom,$auname) = split(/\//,$scope);
17123: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17124: &Apache::loncommon::plainname($auname,$audom).'</span>');
17125: } else {
17126: $scope =~ s{/$}{};
17127: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17128: &Apache::lonnet::domain($scope,'description').'</span>');
17129: }
17130: }
17131:
1.443 albertel 17132: ############################################################
17133: ############################################################
17134:
1.566 albertel 17135: sub check_clone {
1.578 raeburn 17136: my ($args,$linefeed) = @_;
1.566 albertel 17137: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17138: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17139: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17140: my $clonetitle;
17141: my @clonemsg;
1.566 albertel 17142: my $can_clone = 0;
1.944 raeburn 17143: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17144: if ($lctype ne 'community') {
17145: $lctype = 'course';
17146: }
1.566 albertel 17147: if ($clonehome eq 'no_host') {
1.944 raeburn 17148: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17149: push(@clonemsg,({
17150: mt => 'No new community created.',
17151: args => [],
17152: },
17153: {
17154: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17155: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17156: }));
1.908 raeburn 17157: } else {
1.1344 raeburn 17158: push(@clonemsg,({
17159: mt => 'No new course created.',
17160: args => [],
17161: },
17162: {
17163: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17164: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17165: }));
17166: }
1.566 albertel 17167: } else {
17168: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17169: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17170: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17171: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17172: push(@clonemsg,({
17173: mt => 'No new community created.',
17174: args => [],
17175: },
17176: {
17177: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17178: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17179: }));
17180: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17181: }
17182: }
1.1262 raeburn 17183: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17184: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17185: $can_clone = 1;
17186: } else {
1.1221 raeburn 17187: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17188: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17189: if ($clonehash{'cloners'} eq '') {
17190: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17191: if ($domdefs{'canclone'}) {
17192: unless ($domdefs{'canclone'} eq 'none') {
17193: if ($domdefs{'canclone'} eq 'domain') {
17194: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17195: $can_clone = 1;
17196: }
17197: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17198: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17199: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17200: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17201: $can_clone = 1;
17202: }
17203: }
17204: }
17205: }
1.578 raeburn 17206: } else {
1.1221 raeburn 17207: my @cloners = split(/,/,$clonehash{'cloners'});
17208: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17209: $can_clone = 1;
1.1221 raeburn 17210: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17211: $can_clone = 1;
1.1225 raeburn 17212: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17213: $can_clone = 1;
1.1221 raeburn 17214: }
17215: unless ($can_clone) {
1.1225 raeburn 17216: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17217: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17218: my (%gotdomdefaults,%gotcodedefaults);
17219: foreach my $cloner (@cloners) {
17220: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17221: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17222: my (%codedefaults,@code_order);
17223: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17224: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17225: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17226: }
17227: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17228: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17229: }
17230: } else {
17231: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17232: \%codedefaults,
17233: \@code_order);
17234: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17235: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17236: }
17237: if (@code_order > 0) {
17238: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17239: $cloner,$clonehash{'internal.coursecode'},
17240: $args->{'crscode'})) {
17241: $can_clone = 1;
17242: last;
17243: }
17244: }
17245: }
17246: }
17247: }
1.1225 raeburn 17248: }
17249: }
17250: unless ($can_clone) {
17251: my $ccrole = 'cc';
17252: if ($args->{'crstype'} eq 'Community') {
17253: $ccrole = 'co';
17254: }
17255: my %roleshash =
17256: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17257: $args->{'ccdomain'},
17258: 'userroles',['active'],[$ccrole],
17259: [$args->{'clonedomain'}]);
17260: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17261: $can_clone = 1;
17262: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17263: $args->{'ccuname'},$args->{'ccdomain'})) {
17264: $can_clone = 1;
1.1221 raeburn 17265: }
17266: }
17267: unless ($can_clone) {
17268: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17269: push(@clonemsg,({
17270: mt => 'No new community created.',
17271: args => [],
17272: },
17273: {
17274: 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]).',
17275: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17276: }));
1.942 raeburn 17277: } else {
1.1344 raeburn 17278: push(@clonemsg,({
17279: mt => 'No new course created.',
17280: args => [],
17281: },
17282: {
17283: 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]).',
17284: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17285: }));
1.1221 raeburn 17286: }
1.566 albertel 17287: }
1.578 raeburn 17288: }
1.566 albertel 17289: }
1.1344 raeburn 17290: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17291: }
17292:
1.444 albertel 17293: sub construct_course {
1.1262 raeburn 17294: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17295: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17296: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17297: my $linefeed = '<br />'."\n";
17298: if ($context eq 'auto') {
17299: $linefeed = "\n";
17300: }
1.566 albertel 17301:
17302: #
17303: # Are we cloning?
17304: #
1.1344 raeburn 17305: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17306: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17307: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17308: if (!$can_clone) {
1.1344 raeburn 17309: return (0,$outcome,$clonemsgref);
1.566 albertel 17310: }
17311: }
17312:
1.444 albertel 17313: #
17314: # Open course
17315: #
1.1239 raeburn 17316: my $showncrstype;
17317: if ($args->{'crstype'} eq 'Placement') {
17318: $showncrstype = 'placement test';
17319: } else {
17320: $showncrstype = lc($args->{'crstype'});
17321: }
1.444 albertel 17322: my %cenv=();
17323: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17324: $args->{'cdescr'},
17325: $args->{'curl'},
17326: $args->{'course_home'},
17327: $args->{'nonstandard'},
17328: $args->{'crscode'},
17329: $args->{'ccuname'}.':'.
17330: $args->{'ccdomain'},
1.882 raeburn 17331: $args->{'crstype'},
1.1344 raeburn 17332: $cnum,$context,$category,
17333: $callercontext);
1.444 albertel 17334:
17335: # Note: The testing routines depend on this being output; see
17336: # Utils::Course. This needs to at least be output as a comment
17337: # if anyone ever decides to not show this, and Utils::Course::new
17338: # will need to be suitably modified.
1.1344 raeburn 17339: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17340: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17341: } else {
17342: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17343: }
1.943 raeburn 17344: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17345: return (0,$outcome,$clonemsgref);
1.943 raeburn 17346: }
17347:
1.444 albertel 17348: #
17349: # Check if created correctly
17350: #
1.479 albertel 17351: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17352: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17353: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17354: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17355: $outcome .= &mt_user($user_lh,
17356: 'Course creation failed, unrecognized course home server.');
17357: } else {
17358: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17359: }
17360: $outcome .= $linefeed;
17361: return (0,$outcome,$clonemsgref);
1.943 raeburn 17362: }
1.541 raeburn 17363: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17364:
1.444 albertel 17365: #
1.566 albertel 17366: # Do the cloning
17367: #
1.1344 raeburn 17368: my @clonemsg;
1.566 albertel 17369: if ($can_clone && $cloneid) {
1.1344 raeburn 17370: push(@clonemsg,
17371: {
17372: mt => 'Created [_1] by cloning from [_2]',
17373: args => [$showncrstype,$clonetitle],
17374: });
1.566 albertel 17375: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17376: # Copy all files
1.1344 raeburn 17377: my @info =
17378: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17379: $args->{'dateshift'},$args->{'crscode'},
17380: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17381: $args->{'tinyurls'});
17382: if (@info) {
17383: push(@clonemsg,@info);
17384: }
1.444 albertel 17385: # Restore URL
1.566 albertel 17386: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17387: # Restore title
1.566 albertel 17388: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17389: # Restore creation date, creator and creation context.
17390: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17391: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17392: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17393: # Mark as cloned
1.566 albertel 17394: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17395: # Need to clone grading mode
17396: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17397: $cenv{'grading'}=$newenv{'grading'};
17398: # Do not clone these environment entries
17399: &Apache::lonnet::del('environment',
17400: ['default_enrollment_start_date',
17401: 'default_enrollment_end_date',
17402: 'question.email',
17403: 'policy.email',
17404: 'comment.email',
17405: 'pch.users.denied',
1.725 raeburn 17406: 'plc.users.denied',
17407: 'hidefromcat',
1.1121 raeburn 17408: 'checkforpriv',
1.1355 raeburn 17409: 'categories'],
1.638 www 17410: $$crsudom,$$crsunum);
1.1170 raeburn 17411: if ($args->{'textbook'}) {
17412: $cenv{'internal.textbook'} = $args->{'textbook'};
17413: }
1.444 albertel 17414: }
1.566 albertel 17415:
1.444 albertel 17416: #
17417: # Set environment (will override cloned, if existing)
17418: #
17419: my @sections = ();
17420: my @xlists = ();
17421: if ($args->{'crstype'}) {
17422: $cenv{'type'}=$args->{'crstype'};
17423: }
1.1371 raeburn 17424: if ($args->{'lti'}) {
17425: $cenv{'internal.lti'}=$args->{'lti'};
17426: }
1.444 albertel 17427: if ($args->{'crsid'}) {
17428: $cenv{'courseid'}=$args->{'crsid'};
17429: }
17430: if ($args->{'crscode'}) {
17431: $cenv{'internal.coursecode'}=$args->{'crscode'};
17432: }
17433: if ($args->{'crsquota'} ne '') {
17434: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17435: } else {
17436: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17437: }
17438: if ($args->{'ccuname'}) {
17439: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17440: ':'.$args->{'ccdomain'};
17441: } else {
17442: $cenv{'internal.courseowner'} = $args->{'curruser'};
17443: }
1.1116 raeburn 17444: if ($args->{'defaultcredits'}) {
17445: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17446: }
1.444 albertel 17447: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17448: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17449: if ($args->{'crssections'}) {
17450: $cenv{'internal.sectionnums'} = '';
17451: if ($args->{'crssections'} =~ m/,/) {
17452: @sections = split/,/,$args->{'crssections'};
17453: } else {
17454: $sections[0] = $args->{'crssections'};
17455: }
17456: if (@sections > 0) {
17457: foreach my $item (@sections) {
17458: my ($sec,$gp) = split/:/,$item;
17459: my $class = $args->{'crscode'}.$sec;
17460: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17461: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17462: if ($addcheck eq 'ok') {
17463: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17464: push(@oklcsecs,$gp);
17465: }
17466: } else {
1.1263 raeburn 17467: push(@badclasses,$class);
1.444 albertel 17468: }
17469: }
17470: $cenv{'internal.sectionnums'} =~ s/,$//;
17471: }
17472: }
17473: # do not hide course coordinator from staff listing,
17474: # even if privileged
17475: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17476: # add course coordinator's domain to domains to check for privileged users
17477: # if different to course domain
17478: if ($$crsudom ne $args->{'ccdomain'}) {
17479: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17480: }
1.444 albertel 17481: # add crosslistings
17482: if ($args->{'crsxlist'}) {
17483: $cenv{'internal.crosslistings'}='';
17484: if ($args->{'crsxlist'} =~ m/,/) {
17485: @xlists = split/,/,$args->{'crsxlist'};
17486: } else {
17487: $xlists[0] = $args->{'crsxlist'};
17488: }
17489: if (@xlists > 0) {
17490: foreach my $item (@xlists) {
17491: my ($xl,$gp) = split/:/,$item;
17492: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17493: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17494: if ($addcheck eq 'ok') {
17495: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17496: push(@oklcsecs,$gp);
17497: }
17498: } else {
1.1263 raeburn 17499: push(@badclasses,$xl);
1.444 albertel 17500: }
17501: }
17502: $cenv{'internal.crosslistings'} =~ s/,$//;
17503: }
17504: }
17505: if ($args->{'autoadds'}) {
17506: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17507: }
17508: if ($args->{'autodrops'}) {
17509: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17510: }
17511: # check for notification of enrollment changes
17512: my @notified = ();
17513: if ($args->{'notify_owner'}) {
17514: if ($args->{'ccuname'} ne '') {
17515: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17516: }
17517: }
17518: if ($args->{'notify_dc'}) {
17519: if ($uname ne '') {
1.630 raeburn 17520: push(@notified,$uname.':'.$udom);
1.444 albertel 17521: }
17522: }
17523: if (@notified > 0) {
17524: my $notifylist;
17525: if (@notified > 1) {
17526: $notifylist = join(',',@notified);
17527: } else {
17528: $notifylist = $notified[0];
17529: }
17530: $cenv{'internal.notifylist'} = $notifylist;
17531: }
17532: if (@badclasses > 0) {
17533: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17534: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17535: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17536: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17537: );
1.1264 raeburn 17538: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17539: &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 17540: if ($context eq 'auto') {
17541: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17542: } else {
1.566 albertel 17543: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17544: }
17545: foreach my $item (@badclasses) {
1.541 raeburn 17546: if ($context eq 'auto') {
1.1261 raeburn 17547: $outcome .= " - $item\n";
1.541 raeburn 17548: } else {
1.1261 raeburn 17549: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17550: }
1.1261 raeburn 17551: }
17552: if ($context eq 'auto') {
17553: $outcome .= $linefeed;
17554: } else {
17555: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17556: }
1.444 albertel 17557: }
17558: if ($args->{'no_end_date'}) {
17559: $args->{'endaccess'} = 0;
17560: }
1.1412 raeburn 17561: # If an official course with institutional sections is created by cloning
17562: # an existing course, section-specific hiding of course totals in student's
17563: # view of grades as copied from cloned course, will be checked for valid
17564: # sections.
17565: if (($can_clone && $cloneid) &&
17566: ($cenv{'internal.coursecode'} ne '') &&
17567: ($cenv{'grading'} eq 'standard') &&
17568: ($cenv{'hidetotals'} ne '') &&
17569: ($cenv{'hidetotals'} ne 'all')) {
17570: my @hidesecs;
17571: my $deletehidetotals;
17572: if (@oklcsecs) {
17573: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17574: if (grep(/^\Q$sec$/,@oklcsecs)) {
17575: push(@hidesecs,$sec);
17576: }
17577: }
17578: if (@hidesecs) {
17579: $cenv{'hidetotals'} = join(',',@hidesecs);
17580: } else {
17581: $deletehidetotals = 1;
17582: }
17583: } else {
17584: $deletehidetotals = 1;
17585: }
17586: if ($deletehidetotals) {
17587: delete($cenv{'hidetotals'});
17588: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17589: }
17590: }
1.444 albertel 17591: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17592: $cenv{'internal.autoend'}=$args->{'enrollend'};
17593: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17594: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17595: if ($args->{'showphotos'}) {
17596: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17597: }
17598: $cenv{'internal.authtype'} = $args->{'authtype'};
17599: $cenv{'internal.autharg'} = $args->{'autharg'};
17600: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17601: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17602: 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');
17603: if ($context eq 'auto') {
17604: $outcome .= $krb_msg;
17605: } else {
1.566 albertel 17606: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17607: }
17608: $outcome .= $linefeed;
1.444 albertel 17609: }
17610: }
17611: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17612: if ($args->{'setpolicy'}) {
17613: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17614: }
17615: if ($args->{'setcontent'}) {
17616: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17617: }
1.1251 raeburn 17618: if ($args->{'setcomment'}) {
17619: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17620: }
1.444 albertel 17621: }
17622: if ($args->{'reshome'}) {
17623: $cenv{'reshome'}=$args->{'reshome'}.'/';
17624: $cenv{'reshome'}=~s/\/+$/\//;
17625: }
17626: #
17627: # course has keyed access
17628: #
17629: if ($args->{'setkeys'}) {
17630: $cenv{'keyaccess'}='yes';
17631: }
17632: # if specified, key authority is not course, but user
17633: # only active if keyaccess is yes
17634: if ($args->{'keyauth'}) {
1.487 albertel 17635: my ($user,$domain) = split(':',$args->{'keyauth'});
17636: $user = &LONCAPA::clean_username($user);
17637: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17638: if ($user ne '' && $domain ne '') {
1.487 albertel 17639: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17640: }
17641: }
17642:
1.1166 raeburn 17643: #
1.1167 raeburn 17644: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17645: #
17646: if ($args->{'uniquecode'}) {
17647: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17648: if ($code) {
17649: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17650: my %crsinfo =
17651: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17652: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17653: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17654: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17655: }
1.1166 raeburn 17656: if (ref($coderef)) {
17657: $$coderef = $code;
17658: }
17659: }
17660: }
17661:
1.444 albertel 17662: if ($args->{'disresdis'}) {
17663: $cenv{'pch.roles.denied'}='st';
17664: }
17665: if ($args->{'disablechat'}) {
17666: $cenv{'plc.roles.denied'}='st';
17667: }
17668:
17669: # Record we've not yet viewed the Course Initialization Helper for this
17670: # course
17671: $cenv{'course.helper.not.run'} = 1;
17672: #
17673: # Use new Randomseed
17674: #
17675: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17676: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17677: #
17678: # The encryption code and receipt prefix for this course
17679: #
17680: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17681: $cenv{'internal.encpref'}=100+int(9*rand(99));
17682: #
17683: # By default, use standard grading
17684: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17685:
1.541 raeburn 17686: $outcome .= $linefeed.&mt('Setting environment').': '.
17687: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17688: #
17689: # Open all assignments
17690: #
17691: if ($args->{'openall'}) {
1.1341 raeburn 17692: my $opendate = time;
17693: if ($args->{'openallfrom'} =~ /^\d+$/) {
17694: $opendate = $args->{'openallfrom'};
17695: }
1.444 albertel 17696: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17697: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17698: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17699: $outcome .= &mt('All assignments open starting [_1]',
17700: &Apache::lonlocal::locallocaltime($opendate)).': '.
17701: &Apache::lonnet::cput
17702: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17703: }
17704: #
17705: # Set first page
17706: #
17707: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17708: || ($cloneid)) {
17709: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17710:
17711: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17712: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17713:
1.444 albertel 17714: $outcome .= ($fatal?$errtext:'read ok').' - ';
17715: my $title; my $url;
17716: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17717: $title=&mt('Syllabus');
1.444 albertel 17718: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17719: } else {
1.963 raeburn 17720: $title=&mt('Table of Contents');
1.444 albertel 17721: $url='/adm/navmaps';
17722: }
1.445 albertel 17723:
17724: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17725: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17726:
17727: if ($errtext) { $fatal=2; }
1.541 raeburn 17728: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17729: }
1.566 albertel 17730:
1.1237 raeburn 17731: #
17732: # Set params for Placement Tests
17733: #
1.1239 raeburn 17734: if ($args->{'crstype'} eq 'Placement') {
17735: my %storecontent;
17736: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17737: my %defaults = (
17738: buttonshide => { value => 'yes',
17739: type => 'string_yesno',},
17740: type => { value => 'randomizetry',
17741: type => 'string_questiontype',},
17742: maxtries => { value => 1,
17743: type => 'int_pos',},
17744: problemstatus => { value => 'no',
17745: type => 'string_problemstatus',},
17746: );
17747: foreach my $key (keys(%defaults)) {
17748: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17749: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17750: }
1.1237 raeburn 17751: &Apache::lonnet::cput
17752: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17753: }
17754:
1.1344 raeburn 17755: return (1,$outcome,\@clonemsg);
1.444 albertel 17756: }
17757:
1.1166 raeburn 17758: sub make_unique_code {
17759: my ($cdom,$cnum) = @_;
17760: # get lock on uniquecodes db
17761: my $lockhash = {
17762: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17763: ':'.$env{'user.domain'},
17764: };
17765: my $tries = 0;
17766: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17767: my ($code,$error);
17768:
17769: while (($gotlock ne 'ok') && ($tries<3)) {
17770: $tries ++;
17771: sleep 1;
17772: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17773: }
17774: if ($gotlock eq 'ok') {
17775: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17776: my $gotcode;
17777: my $attempts = 0;
17778: while ((!$gotcode) && ($attempts < 100)) {
17779: $code = &generate_code();
17780: if (!exists($currcodes{$code})) {
17781: $gotcode = 1;
17782: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17783: $error = 'nostore';
17784: }
17785: }
17786: $attempts ++;
17787: }
17788: my @del_lock = ($cnum."\0".'uniquecodes');
17789: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17790: } else {
17791: $error = 'nolock';
17792: }
17793: return ($code,$error);
17794: }
17795:
17796: sub generate_code {
17797: my $code;
17798: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17799: for (my $i=0; $i<6; $i++) {
17800: my $lettnum = int (rand 2);
17801: my $item = '';
17802: if ($lettnum) {
17803: $item = $letts[int( rand(18) )];
17804: } else {
17805: $item = 1+int( rand(8) );
17806: }
17807: $code .= $item;
17808: }
17809: return $code;
17810: }
17811:
1.444 albertel 17812: ############################################################
17813: ############################################################
17814:
1.1237 raeburn 17815: # Community, Course and Placement Test
1.378 raeburn 17816: sub course_type {
17817: my ($cid) = @_;
17818: if (!defined($cid)) {
17819: $cid = $env{'request.course.id'};
17820: }
1.404 albertel 17821: if (defined($env{'course.'.$cid.'.type'})) {
17822: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17823: } else {
17824: return 'Course';
1.377 raeburn 17825: }
17826: }
1.156 albertel 17827:
1.406 raeburn 17828: sub group_term {
17829: my $crstype = &course_type();
17830: my %names = (
17831: 'Course' => 'group',
1.865 raeburn 17832: 'Community' => 'group',
1.1237 raeburn 17833: 'Placement' => 'group',
1.406 raeburn 17834: );
17835: return $names{$crstype};
17836: }
17837:
1.902 raeburn 17838: sub course_types {
1.1310 raeburn 17839: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17840: my %typename = (
17841: official => 'Official course',
17842: unofficial => 'Unofficial course',
17843: community => 'Community',
1.1165 raeburn 17844: textbook => 'Textbook course',
1.1237 raeburn 17845: placement => 'Placement test',
1.1310 raeburn 17846: lti => 'LTI provider',
1.902 raeburn 17847: );
17848: return (\@types,\%typename);
17849: }
17850:
1.156 albertel 17851: sub icon {
17852: my ($file)=@_;
1.505 albertel 17853: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17854: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17855: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17856: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17857: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17858: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17859: $curfext.".gif") {
17860: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17861: $curfext.".gif";
17862: }
17863: }
1.249 albertel 17864: return &lonhttpdurl($iconname);
1.154 albertel 17865: }
1.84 albertel 17866:
1.575 albertel 17867: sub lonhttpdurl {
1.692 www 17868: #
17869: # Had been used for "small fry" static images on separate port 8080.
17870: # Modify here if lightweight http functionality desired again.
17871: # Currently eliminated due to increasing firewall issues.
17872: #
1.575 albertel 17873: my ($url)=@_;
1.692 www 17874: return $url;
1.215 albertel 17875: }
17876:
1.213 albertel 17877: sub connection_aborted {
17878: my ($r)=@_;
17879: $r->print(" ");$r->rflush();
17880: my $c = $r->connection;
17881: return $c->aborted();
17882: }
17883:
1.221 foxr 17884: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17885: # strings as 'strings'.
17886: sub escape_single {
1.221 foxr 17887: my ($input) = @_;
1.223 albertel 17888: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17889: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17890: return $input;
17891: }
1.223 albertel 17892:
1.222 foxr 17893: # Same as escape_single, but escape's "'s This
17894: # can be used for "strings"
17895: sub escape_double {
17896: my ($input) = @_;
17897: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17898: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17899: return $input;
17900: }
1.223 albertel 17901:
1.222 foxr 17902: # Escapes the last element of a full URL.
17903: sub escape_url {
17904: my ($url) = @_;
1.238 raeburn 17905: my @urlslices = split(/\//, $url,-1);
1.369 www 17906: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17907: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17908: }
1.462 albertel 17909:
1.820 raeburn 17910: sub compare_arrays {
17911: my ($arrayref1,$arrayref2) = @_;
17912: my (@difference,%count);
17913: @difference = ();
17914: %count = ();
17915: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17916: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17917: foreach my $element (keys(%count)) {
17918: if ($count{$element} == 1) {
17919: push(@difference,$element);
17920: }
17921: }
17922: }
17923: return @difference;
17924: }
17925:
1.1322 raeburn 17926: sub lon_status_items {
17927: my %defaults = (
17928: E => 100,
17929: W => 4,
17930: N => 1,
1.1324 raeburn 17931: U => 5,
1.1322 raeburn 17932: threshold => 200,
17933: sysmail => 2500,
17934: );
17935: my %names = (
17936: E => 'Errors',
17937: W => 'Warnings',
17938: N => 'Notices',
1.1324 raeburn 17939: U => 'Unsent',
1.1322 raeburn 17940: );
17941: return (\%defaults,\%names);
17942: }
17943:
1.817 bisitz 17944: # -------------------------------------------------------- Initialize user login
1.462 albertel 17945: sub init_user_environment {
1.463 albertel 17946: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17947: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17948:
17949: my $public=($username eq 'public' && $domain eq 'public');
17950:
1.1415 raeburn 17951: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17952: $coauthorenv);
1.462 albertel 17953: my $now=time;
17954:
17955: if ($public) {
17956: my $max_public=100;
17957: my $oldest;
17958: my $oldest_time=0;
17959: for(my $next=1;$next<=$max_public;$next++) {
17960: if (-e $lonids."/publicuser_$next.id") {
17961: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17962: if ($mtime<$oldest_time || !$oldest_time) {
17963: $oldest_time=$mtime;
17964: $oldest=$next;
17965: }
17966: } else {
17967: $cookie="publicuser_$next";
17968: last;
17969: }
17970: }
17971: if (!$cookie) { $cookie="publicuser_$oldest"; }
17972: } else {
1.1275 raeburn 17973: # See if old ID present, if so, remove if this isn't a robot,
17974: # killing any existing non-robot sessions
1.463 albertel 17975: if (!$args->{'robot'}) {
17976: opendir(DIR,$lonids);
17977: while ($filename=readdir(DIR)) {
17978: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17979: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17980: &GDBM_READER(),0640)) {
1.1295 raeburn 17981: my $linkedfile;
1.1320 raeburn 17982: if (exists($oldenv{'user.linkedenv'})) {
17983: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17984: }
1.1320 raeburn 17985: untie(%oldenv);
17986: if (unlink("$lonids/$filename")) {
17987: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17988: if (-l "$lonids/$linkedfile.id") {
17989: unlink("$lonids/$linkedfile.id");
17990: }
1.1295 raeburn 17991: }
17992: }
17993: } else {
17994: unlink($lonids.'/'.$filename);
17995: }
1.463 albertel 17996: }
1.462 albertel 17997: }
1.463 albertel 17998: closedir(DIR);
1.1204 raeburn 17999: # If there is a undeleted lockfile for the user's paste buffer remove it.
18000: my $namespace = 'nohist_courseeditor';
18001: my $lockingkey = 'paste'."\0".'locked_num';
18002: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18003: $domain,$username);
18004: if (exists($lockhash{$lockingkey})) {
18005: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18006: unless ($delresult eq 'ok') {
18007: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18008: }
18009: }
1.462 albertel 18010: }
18011: # Give them a new cookie
1.463 albertel 18012: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18013: : $now.$$.int(rand(10000)));
1.463 albertel 18014: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18015:
18016: # Initialize roles
18017:
1.1414 raeburn 18018: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18019: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18020: }
18021: # ------------------------------------ Check browser type and MathML capability
18022:
1.1194 raeburn 18023: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18024: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18025:
18026: # ------------------------------------------------------------- Get environment
18027:
18028: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18029: my ($tmp) = keys(%userenv);
1.1275 raeburn 18030: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18031: undef(%userenv);
18032: }
18033: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18034: $form->{'interface'}=$userenv{'interface'};
18035: }
18036: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18037:
18038: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18039: foreach my $option ('interface','localpath','localres') {
18040: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18041: }
18042: # --------------------------------------------------------- Write first profile
18043:
18044: {
1.1350 raeburn 18045: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18046: my %initial_env =
18047: ("user.name" => $username,
18048: "user.domain" => $domain,
18049: "user.home" => $authhost,
18050: "browser.type" => $clientbrowser,
18051: "browser.version" => $clientversion,
18052: "browser.mathml" => $clientmathml,
18053: "browser.unicode" => $clientunicode,
18054: "browser.os" => $clientos,
1.1137 raeburn 18055: "browser.mobile" => $clientmobile,
1.1141 raeburn 18056: "browser.info" => $clientinfo,
1.1194 raeburn 18057: "browser.osversion" => $clientosversion,
1.462 albertel 18058: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18059: "request.course.fn" => '',
18060: "request.course.uri" => '',
18061: "request.course.sec" => '',
18062: "request.role" => 'cm',
18063: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18064: "request.host" => $ip,);
1.462 albertel 18065:
18066: if ($form->{'localpath'}) {
18067: $initial_env{"browser.localpath"} = $form->{'localpath'};
18068: $initial_env{"browser.localres"} = $form->{'localres'};
18069: }
18070:
18071: if ($form->{'interface'}) {
18072: $form->{'interface'}=~s/\W//gs;
18073: $initial_env{"browser.interface"} = $form->{'interface'};
18074: $env{'browser.interface'}=$form->{'interface'};
18075: }
18076:
1.1157 raeburn 18077: if ($form->{'iptoken'}) {
18078: my $lonhost = $r->dir_config('lonHostID');
18079: $initial_env{"user.noloadbalance"} = $lonhost;
18080: $env{'user.noloadbalance'} = $lonhost;
18081: }
18082:
1.1268 raeburn 18083: if ($form->{'noloadbalance'}) {
18084: my @hosts = &Apache::lonnet::current_machine_ids();
18085: my $hosthere = $form->{'noloadbalance'};
18086: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18087: $initial_env{"user.noloadbalance"} = $hosthere;
18088: $env{'user.noloadbalance'} = $hosthere;
18089: }
18090: }
18091:
1.1016 raeburn 18092: unless ($domain eq 'public') {
1.1273 raeburn 18093: my %is_adv = ( is_adv => $env{'user.adv'} );
18094: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18095:
1.1414 raeburn 18096: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18097: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18098: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18099: undef,\%userenv,\%domdef,\%is_adv);
18100: }
1.980 raeburn 18101:
1.1311 raeburn 18102: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18103: $userenv{'canrequest.'.$crstype} =
18104: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18105: 'reload','requestcourses',
18106: \%userenv,\%domdef,\%is_adv);
18107: }
1.724 raeburn 18108:
1.1418 raeburn 18109: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18110: (exists($userroles->{"user.role.au./$domain/"}))) {
18111: if ($userenv{'authoreditors'}) {
18112: $userenv{'editors'} = $userenv{'authoreditors'};
18113: } elsif ($domdef{'editors'} ne '') {
18114: $userenv{'editors'} = $domdef{'editors'};
18115: } else {
18116: $userenv{'editors'} = 'edit,xml';
18117: }
1.1431 raeburn 18118: if ($userenv{'authorarchive'}) {
18119: $userenv{'canarchive'} = 1;
18120: } elsif (($userenv{'authorarchive'} eq '') &&
18121: ($domdef{'archive'})) {
18122: $userenv{'canarchive'} = 1;
18123: }
1.1418 raeburn 18124: }
18125:
1.1273 raeburn 18126: $userenv{'canrequest.author'} =
18127: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18128: 'reload','requestauthor',
1.980 raeburn 18129: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18130: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18131: $domain,$username);
18132: my $reqstatus = $reqauthor{'author_status'};
18133: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18134: if (ref($reqauthor{'author'}) eq 'HASH') {
18135: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18136: $reqauthor{'author'}{'timestamp'};
18137: }
1.1092 raeburn 18138: }
1.1287 raeburn 18139: my ($types,$typename) = &course_types();
18140: if (ref($types) eq 'ARRAY') {
18141: my @options = ('approval','validate','autolimit');
18142: my $optregex = join('|',@options);
18143: my (%willtrust,%trustchecked);
18144: foreach my $type (@{$types}) {
18145: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18146: if ($dom_str ne '') {
18147: my $updatedstr = '';
18148: my @possdomains = split(',',$dom_str);
18149: foreach my $entry (@possdomains) {
18150: my ($extdom,$extopt) = split(':',$entry);
18151: unless ($trustchecked{$extdom}) {
18152: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18153: $trustchecked{$extdom} = 1;
18154: }
18155: if ($willtrust{$extdom}) {
18156: $updatedstr .= $entry.',';
18157: }
18158: }
18159: $updatedstr =~ s/,$//;
18160: if ($updatedstr) {
18161: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18162: } else {
18163: delete($userenv{'reqcrsotherdom.'.$type});
18164: }
18165: }
18166: }
18167: }
1.1092 raeburn 18168: }
1.462 albertel 18169: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18170:
1.462 albertel 18171: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18172: &GDBM_WRCREAT(),0640)) {
18173: &_add_to_env(\%disk_env,\%initial_env);
18174: &_add_to_env(\%disk_env,\%userenv,'environment.');
18175: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18176: if (ref($firstaccenv) eq 'HASH') {
18177: &_add_to_env(\%disk_env,$firstaccenv);
18178: }
18179: if (ref($timerintenv) eq 'HASH') {
18180: &_add_to_env(\%disk_env,$timerintenv);
18181: }
1.1414 raeburn 18182: if (ref($coauthorenv) eq 'HASH') {
18183: if (keys(%{$coauthorenv})) {
18184: &_add_to_env(\%disk_env,$coauthorenv);
18185: }
18186: }
1.463 albertel 18187: if (ref($args->{'extra_env'})) {
18188: &_add_to_env(\%disk_env,$args->{'extra_env'});
18189: }
1.462 albertel 18190: untie(%disk_env);
18191: } else {
1.705 tempelho 18192: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18193: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18194: return 'error: '.$!;
18195: }
18196: }
18197: $env{'request.role'}='cm';
18198: $env{'request.role.adv'}=$env{'user.adv'};
18199: $env{'browser.type'}=$clientbrowser;
18200:
18201: return $cookie;
18202:
18203: }
18204:
18205: sub _add_to_env {
18206: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18207: if (ref($env_data) eq 'HASH') {
18208: while (my ($key,$value) = each(%$env_data)) {
18209: $idf->{$prefix.$key} = $value;
18210: $env{$prefix.$key} = $value;
18211: }
1.462 albertel 18212: }
18213: }
18214:
1.685 tempelho 18215: # --- Get the symbolic name of a problem and the url
18216: sub get_symb {
18217: my ($request,$silent) = @_;
1.726 raeburn 18218: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18219: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18220: if ($symb eq '') {
18221: if (!$silent) {
1.1071 raeburn 18222: if (ref($request)) {
18223: $request->print("Unable to handle ambiguous references:$url:.");
18224: }
1.685 tempelho 18225: return ();
18226: }
18227: }
18228: &Apache::lonenc::check_decrypt(\$symb);
18229: return ($symb);
18230: }
18231:
18232: # --------------------------------------------------------------Get annotation
18233:
18234: sub get_annotation {
18235: my ($symb,$enc) = @_;
18236:
18237: my $key = $symb;
18238: if (!$enc) {
18239: $key =
18240: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18241: }
18242: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18243: return $annotation{$key};
18244: }
18245:
18246: sub clean_symb {
1.731 raeburn 18247: my ($symb,$delete_enc) = @_;
1.685 tempelho 18248:
18249: &Apache::lonenc::check_decrypt(\$symb);
18250: my $enc = $env{'request.enc'};
1.731 raeburn 18251: if ($delete_enc) {
1.730 raeburn 18252: delete($env{'request.enc'});
18253: }
1.685 tempelho 18254:
18255: return ($symb,$enc);
18256: }
1.462 albertel 18257:
1.1181 raeburn 18258: ############################################################
18259: ############################################################
18260:
18261: =pod
18262:
18263: =head1 Routines for building display used to search for courses
18264:
18265:
18266: =over 4
18267:
18268: =item * &build_filters()
18269:
18270: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18271: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18272: and quotacheck.pl
18273:
1.1181 raeburn 18274:
18275: Inputs:
18276:
18277: filterlist - anonymous array of fields to include as potential filters
18278:
18279: crstype - course type
18280:
18281: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18282: to pop-open a course selector (will contain "extra element").
18283:
18284: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18285:
18286: filter - anonymous hash of criteria and their values
18287:
18288: action - form action
18289:
18290: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18291:
1.1182 raeburn 18292: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18293:
18294: cloneruname - username of owner of new course who wants to clone
18295:
18296: clonerudom - domain of owner of new course who wants to clone
18297:
18298: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18299:
18300: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18301:
18302: codedom - domain
18303:
18304: formname - value of form element named "form".
18305:
18306: fixeddom - domain, if fixed.
18307:
18308: prevphase - value to assign to form element named "phase" when going back to the previous screen
18309:
18310: cnameelement - name of form element in form on opener page which will receive title of selected course
18311:
18312: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18313:
18314: cdomelement - name of form element in form on opener page which will receive domain of selected course
18315:
18316: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18317:
18318: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18319:
18320: clonewarning - warning message about missing information for intended course owner when DC creates a course
18321:
1.1182 raeburn 18322:
1.1181 raeburn 18323: Returns: $output - HTML for display of search criteria, and hidden form elements.
18324:
1.1182 raeburn 18325:
1.1181 raeburn 18326: Side Effects: None
18327:
18328: =cut
18329:
18330: # ---------------------------------------------- search for courses based on last activity etc.
18331:
18332: sub build_filters {
18333: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18334: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18335: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18336: $cnameelement,$cnumelement,$cdomelement,$setroles,
18337: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18338: my ($list,$jscript);
1.1181 raeburn 18339: my $onchange = 'javascript:updateFilters(this)';
18340: my ($domainselectform,$sincefilterform,$createdfilterform,
18341: $ownerdomselectform,$persondomselectform,$instcodeform,
18342: $typeselectform,$instcodetitle);
18343: if ($formname eq '') {
18344: $formname = $caller;
18345: }
18346: foreach my $item (@{$filterlist}) {
18347: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18348: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18349: if ($item eq 'domainfilter') {
18350: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18351: } elsif ($item eq 'coursefilter') {
18352: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18353: } elsif ($item eq 'ownerfilter') {
18354: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18355: } elsif ($item eq 'ownerdomfilter') {
18356: $filter->{'ownerdomfilter'} =
18357: &LONCAPA::clean_domain($filter->{$item});
18358: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18359: 'ownerdomfilter',1);
18360: } elsif ($item eq 'personfilter') {
18361: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18362: } elsif ($item eq 'persondomfilter') {
18363: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18364: 'persondomfilter',1);
18365: } else {
18366: $filter->{$item} =~ s/\W//g;
18367: }
18368: if (!$filter->{$item}) {
18369: $filter->{$item} = '';
18370: }
18371: }
18372: if ($item eq 'domainfilter') {
18373: my $allow_blank = 1;
18374: if ($formname eq 'portform') {
18375: $allow_blank=0;
18376: } elsif ($formname eq 'studentform') {
18377: $allow_blank=0;
18378: }
18379: if ($fixeddom) {
18380: $domainselectform = '<input type="hidden" name="domainfilter"'.
18381: ' value="'.$codedom.'" />'.
18382: &Apache::lonnet::domain($codedom,'description');
18383: } else {
18384: $domainselectform = &select_dom_form($filter->{$item},
18385: 'domainfilter',
18386: $allow_blank,'',$onchange);
18387: }
18388: } else {
18389: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18390: }
18391: }
18392:
18393: # last course activity filter and selection
18394: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18395:
18396: # course created filter and selection
18397: if (exists($filter->{'createdfilter'})) {
18398: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18399: }
18400:
1.1239 raeburn 18401: my $prefix = $crstype;
18402: if ($crstype eq 'Placement') {
18403: $prefix = 'Placement Test'
18404: }
1.1181 raeburn 18405: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18406: 'cac' => "$prefix Activity",
18407: 'ccr' => "$prefix Created",
18408: 'cde' => "$prefix Title",
18409: 'cdo' => "$prefix Domain",
1.1181 raeburn 18410: 'ins' => 'Institutional Code',
18411: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18412: 'cow' => "$prefix Owner/Co-owner",
18413: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18414: 'cog' => 'Type',
18415: );
18416:
18417: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18418: my $typeval = 'Course';
18419: if ($crstype eq 'Community') {
18420: $typeval = 'Community';
1.1239 raeburn 18421: } elsif ($crstype eq 'Placement') {
18422: $typeval = 'Placement';
1.1181 raeburn 18423: }
18424: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18425: } else {
18426: $typeselectform = '<select name="type" size="1"';
18427: if ($onchange) {
18428: $typeselectform .= ' onchange="'.$onchange.'"';
18429: }
18430: $typeselectform .= '>'."\n";
1.1237 raeburn 18431: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18432: my $shown;
18433: if ($posstype eq 'Placement') {
18434: $shown = &mt('Placement Test');
18435: } else {
18436: $shown = &mt($posstype);
18437: }
1.1181 raeburn 18438: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18439: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18440: }
18441: $typeselectform.="</select>";
18442: }
18443:
18444: my ($cloneableonlyform,$cloneabletitle);
18445: if (exists($filter->{'cloneableonly'})) {
18446: my $cloneableon = '';
18447: my $cloneableoff = ' checked="checked"';
18448: if ($filter->{'cloneableonly'}) {
18449: $cloneableon = $cloneableoff;
18450: $cloneableoff = '';
18451: }
18452: $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>';
18453: if ($formname eq 'ccrs') {
1.1187 bisitz 18454: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18455: } else {
18456: $cloneabletitle = &mt('Cloneable by you');
18457: }
18458: }
18459: my $officialjs;
18460: if ($crstype eq 'Course') {
18461: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18462: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18463: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18464: if ($codedom) {
1.1181 raeburn 18465: $officialjs = 1;
18466: ($instcodeform,$jscript,$$numtitlesref) =
18467: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18468: $officialjs,$codetitlesref);
18469: if ($jscript) {
1.1182 raeburn 18470: $jscript = '<script type="text/javascript">'."\n".
18471: '// <![CDATA['."\n".
18472: $jscript."\n".
18473: '// ]]>'."\n".
18474: '</script>'."\n";
1.1181 raeburn 18475: }
18476: }
18477: if ($instcodeform eq '') {
18478: $instcodeform =
18479: '<input type="text" name="instcodefilter" size="10" value="'.
18480: $list->{'instcodefilter'}.'" />';
18481: $instcodetitle = $lt{'ins'};
18482: } else {
18483: $instcodetitle = $lt{'inc'};
18484: }
18485: if ($fixeddom) {
18486: $instcodetitle .= '<br />('.$codedom.')';
18487: }
18488: }
18489: }
18490: my $output = qq|
18491: <form method="post" name="filterpicker" action="$action">
18492: <input type="hidden" name="form" value="$formname" />
18493: |;
18494: if ($formname eq 'modifycourse') {
18495: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18496: '<input type="hidden" name="prevphase" value="'.
18497: $prevphase.'" />'."\n";
1.1198 musolffc 18498: } elsif ($formname eq 'quotacheck') {
18499: $output .= qq|
18500: <input type="hidden" name="sortby" value="" />
18501: <input type="hidden" name="sortorder" value="" />
18502: |;
18503: } else {
1.1181 raeburn 18504: my $name_input;
18505: if ($cnameelement ne '') {
18506: $name_input = '<input type="hidden" name="cnameelement" value="'.
18507: $cnameelement.'" />';
18508: }
18509: $output .= qq|
1.1182 raeburn 18510: <input type="hidden" name="cnumelement" value="$cnumelement" />
18511: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18512: $name_input
18513: $roleelement
18514: $multelement
18515: $typeelement
18516: |;
18517: if ($formname eq 'portform') {
18518: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18519: }
18520: }
18521: if ($fixeddom) {
18522: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18523: }
18524: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18525: if ($sincefilterform) {
18526: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18527: .$sincefilterform
18528: .&Apache::lonhtmlcommon::row_closure();
18529: }
18530: if ($createdfilterform) {
18531: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18532: .$createdfilterform
18533: .&Apache::lonhtmlcommon::row_closure();
18534: }
18535: if ($domainselectform) {
18536: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18537: .$domainselectform
18538: .&Apache::lonhtmlcommon::row_closure();
18539: }
18540: if ($typeselectform) {
18541: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18542: $output .= $typeselectform;
18543: } else {
18544: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18545: .$typeselectform
18546: .&Apache::lonhtmlcommon::row_closure();
18547: }
18548: }
18549: if ($instcodeform) {
18550: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18551: .$instcodeform
18552: .&Apache::lonhtmlcommon::row_closure();
18553: }
18554: if (exists($filter->{'ownerfilter'})) {
18555: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18556: '<table><tr><td>'.&mt('Username').'<br />'.
18557: '<input type="text" name="ownerfilter" size="20" value="'.
18558: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18559: $ownerdomselectform.'</td></tr></table>'.
18560: &Apache::lonhtmlcommon::row_closure();
18561: }
18562: if (exists($filter->{'personfilter'})) {
18563: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18564: '<table><tr><td>'.&mt('Username').'<br />'.
18565: '<input type="text" name="personfilter" size="20" value="'.
18566: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18567: $persondomselectform.'</td></tr></table>'.
18568: &Apache::lonhtmlcommon::row_closure();
18569: }
18570: if (exists($filter->{'coursefilter'})) {
18571: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18572: .'<input type="text" name="coursefilter" size="25" value="'
18573: .$list->{'coursefilter'}.'" />'
18574: .&Apache::lonhtmlcommon::row_closure();
18575: }
18576: if ($cloneableonlyform) {
18577: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18578: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18579: }
18580: if (exists($filter->{'descriptfilter'})) {
18581: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18582: .'<input type="text" name="descriptfilter" size="40" value="'
18583: .$list->{'descriptfilter'}.'" />'
18584: .&Apache::lonhtmlcommon::row_closure(1);
18585: }
18586: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18587: '<input type="hidden" name="updater" value="" />'."\n".
18588: '<input type="submit" name="gosearch" value="'.
18589: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18590: return $jscript.$clonewarning.$output;
18591: }
18592:
18593: =pod
18594:
18595: =item * &timebased_select_form()
18596:
1.1182 raeburn 18597: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18598: filter e.g., Course Activity, Course Created, when searching for courses
18599: or communities
18600:
18601: Inputs:
18602:
18603: item - name of form element (sincefilter or createdfilter)
18604:
18605: filter - anonymous hash of criteria and their values
18606:
18607: Returns: HTML for a select box contained a blank, then six time selections,
18608: with value set in incoming form variables currently selected.
18609:
18610: Side Effects: None
18611:
18612: =cut
18613:
18614: sub timebased_select_form {
18615: my ($item,$filter) = @_;
18616: if (ref($filter) eq 'HASH') {
18617: $filter->{$item} =~ s/[^\d-]//g;
18618: if (!$filter->{$item}) { $filter->{$item}=-1; }
18619: return &select_form(
18620: $filter->{$item},
18621: $item,
18622: { '-1' => '',
18623: '86400' => &mt('today'),
18624: '604800' => &mt('last week'),
18625: '2592000' => &mt('last month'),
18626: '7776000' => &mt('last three months'),
18627: '15552000' => &mt('last six months'),
18628: '31104000' => &mt('last year'),
18629: 'select_form_order' =>
18630: ['-1','86400','604800','2592000','7776000',
18631: '15552000','31104000']});
18632: }
18633: }
18634:
18635: =pod
18636:
18637: =item * &js_changer()
18638:
18639: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18640: when course type or domain is changed, and also to hide 'Searching ...' on
18641: page load completion for page showing search result.
1.1181 raeburn 18642:
18643: Inputs: None
18644:
1.1183 raeburn 18645: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18646:
18647: Side Effects: None
18648:
18649: =cut
18650:
18651: sub js_changer {
18652: return <<ENDJS;
18653: <script type="text/javascript">
18654: // <![CDATA[
18655: function updateFilters(caller) {
18656: if (typeof(caller) != "undefined") {
18657: document.filterpicker.updater.value = caller.name;
18658: }
18659: document.filterpicker.submit();
18660: }
1.1183 raeburn 18661:
18662: function hideSearching() {
18663: if (document.getElementById('searching')) {
18664: document.getElementById('searching').style.display = 'none';
18665: }
18666: return;
18667: }
18668:
1.1181 raeburn 18669: // ]]>
18670: </script>
18671:
18672: ENDJS
18673: }
18674:
18675: =pod
18676:
1.1182 raeburn 18677: =item * &search_courses()
18678:
18679: Process selected filters form course search form and pass to lonnet::courseiddump
18680: to retrieve a hash for which keys are courseIDs which match the selected filters.
18681:
18682: Inputs:
18683:
18684: dom - domain being searched
18685:
18686: type - course type ('Course' or 'Community' or '.' if any).
18687:
18688: filter - anonymous hash of criteria and their values
18689:
18690: numtitles - for institutional codes - number of categories
18691:
18692: cloneruname - optional username of new course owner
18693:
18694: clonerudom - optional domain of new course owner
18695:
1.1221 raeburn 18696: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18697: (used when DC is using course creation form)
18698:
18699: codetitles - reference to array of titles of components in institutional codes (official courses).
18700:
1.1221 raeburn 18701: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18702: (and so can clone automatically)
18703:
18704: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18705:
18706: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18707: courses to clone
1.1182 raeburn 18708:
18709: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18710:
18711:
18712: Side Effects: None
18713:
18714: =cut
18715:
18716:
18717: sub search_courses {
1.1221 raeburn 18718: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18719: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18720: my (%courses,%showcourses,$cloner);
18721: if (($filter->{'ownerfilter'} ne '') ||
18722: ($filter->{'ownerdomfilter'} ne '')) {
18723: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18724: $filter->{'ownerdomfilter'};
18725: }
18726: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18727: if (!$filter->{$item}) {
18728: $filter->{$item}='.';
18729: }
18730: }
18731: my $now = time;
18732: my $timefilter =
18733: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18734: my ($createdbefore,$createdafter);
18735: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18736: $createdbefore = $now;
18737: $createdafter = $now-$filter->{'createdfilter'};
18738: }
18739: my ($instcodefilter,$regexpok);
18740: if ($numtitles) {
18741: if ($env{'form.official'} eq 'on') {
18742: $instcodefilter =
18743: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18744: $regexpok = 1;
18745: } elsif ($env{'form.official'} eq 'off') {
18746: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18747: unless ($instcodefilter eq '') {
18748: $regexpok = -1;
18749: }
18750: }
18751: } else {
18752: $instcodefilter = $filter->{'instcodefilter'};
18753: }
18754: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18755: if ($type eq '') { $type = '.'; }
18756:
18757: if (($clonerudom ne '') && ($cloneruname ne '')) {
18758: $cloner = $cloneruname.':'.$clonerudom;
18759: }
18760: %courses = &Apache::lonnet::courseiddump($dom,
18761: $filter->{'descriptfilter'},
18762: $timefilter,
18763: $instcodefilter,
18764: $filter->{'combownerfilter'},
18765: $filter->{'coursefilter'},
18766: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18767: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18768: $filter->{'cloneableonly'},
18769: $createdbefore,$createdafter,undef,
1.1221 raeburn 18770: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18771: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18772: my $ccrole;
18773: if ($type eq 'Community') {
18774: $ccrole = 'co';
18775: } else {
18776: $ccrole = 'cc';
18777: }
18778: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18779: $filter->{'persondomfilter'},
18780: 'userroles',undef,
18781: [$ccrole,'in','ad','ep','ta','cr'],
18782: $dom);
18783: foreach my $role (keys(%rolehash)) {
18784: my ($cnum,$cdom,$courserole) = split(':',$role);
18785: my $cid = $cdom.'_'.$cnum;
18786: if (exists($courses{$cid})) {
18787: if (ref($courses{$cid}) eq 'HASH') {
18788: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18789: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18790: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18791: }
18792: } else {
18793: $courses{$cid}{roles} = [$courserole];
18794: }
18795: $showcourses{$cid} = $courses{$cid};
18796: }
18797: }
18798: }
18799: %courses = %showcourses;
18800: }
18801: return %courses;
18802: }
18803:
18804: =pod
18805:
1.1181 raeburn 18806: =back
18807:
1.1207 raeburn 18808: =head1 Routines for version requirements for current course.
18809:
18810: =over 4
18811:
18812: =item * &check_release_required()
18813:
18814: Compares required LON-CAPA version with version on server, and
18815: if required version is newer looks for a server with the required version.
18816:
18817: Looks first at servers in user's owen domain; if none suitable, looks at
18818: servers in course's domain are permitted to host sessions for user's domain.
18819:
18820: Inputs:
18821:
18822: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18823:
18824: $courseid - Course ID of current course
18825:
18826: $rolecode - User's current role in course (for switchserver query string).
18827:
18828: $required - LON-CAPA version needed by course (format: Major.Minor).
18829:
18830:
18831: Returns:
18832:
18833: $switchserver - query string tp append to /adm/switchserver call (if
18834: current server's LON-CAPA version is too old.
18835:
18836: $warning - Message is displayed if no suitable server could be found.
18837:
18838: =cut
18839:
18840: sub check_release_required {
18841: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18842: my ($switchserver,$warning);
18843: if ($required ne '') {
18844: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18845: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18846: if ($reqdmajor ne '' && $reqdminor ne '') {
18847: my $otherserver;
18848: if (($major eq '' && $minor eq '') ||
18849: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18850: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18851: my $switchlcrev =
18852: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18853: $userdomserver);
18854: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18855: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18856: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18857: my $cdom = $env{'course.'.$courseid.'.domain'};
18858: if ($cdom ne $env{'user.domain'}) {
18859: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18860: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18861: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18862: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18863: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18864: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18865: my $canhost =
18866: &Apache::lonnet::can_host_session($env{'user.domain'},
18867: $coursedomserver,
18868: $remoterev,
18869: $udomdefaults{'remotesessions'},
18870: $defdomdefaults{'hostedsessions'});
18871:
18872: if ($canhost) {
18873: $otherserver = $coursedomserver;
18874: } else {
18875: $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.");
18876: }
18877: } else {
18878: $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).");
18879: }
18880: } else {
18881: $otherserver = $userdomserver;
18882: }
18883: }
18884: if ($otherserver ne '') {
18885: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18886: }
18887: }
18888: }
18889: return ($switchserver,$warning);
18890: }
18891:
18892: =pod
18893:
18894: =item * &check_release_result()
18895:
18896: Inputs:
18897:
18898: $switchwarning - Warning message if no suitable server found to host session.
18899:
18900: $switchserver - query string to append to /adm/switchserver containing lonHostID
18901: and current role.
18902:
18903: Returns: HTML to display with information about requirement to switch server.
18904: Either displaying warning with link to Roles/Courses screen or
18905: display link to switchserver.
18906:
1.1181 raeburn 18907: =cut
18908:
1.1207 raeburn 18909: sub check_release_result {
18910: my ($switchwarning,$switchserver) = @_;
18911: my $output = &start_page('Selected course unavailable on this server').
18912: '<p class="LC_warning">';
18913: if ($switchwarning) {
18914: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18915: if (&show_course()) {
18916: $output .= &mt('Display courses');
18917: } else {
18918: $output .= &mt('Display roles');
18919: }
18920: $output .= '</a>';
18921: } elsif ($switchserver) {
18922: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18923: '<br />'.
18924: '<a href="/adm/switchserver?'.$switchserver.'">'.
18925: &mt('Switch Server').
18926: '</a>';
18927: }
18928: $output .= '</p>'.&end_page();
18929: return $output;
18930: }
18931:
18932: =pod
18933:
18934: =item * &needs_coursereinit()
18935:
18936: Determine if course contents stored for user's session needs to be
18937: refreshed, because content has changed since "Big Hash" last tied.
18938:
18939: Check for change is made if time last checked is more than 10 minutes ago
18940: (by default).
18941:
18942: Inputs:
18943:
18944: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18945:
18946: $interval (optional) - Time which may elapse (in s) between last check for content
18947: change in current course. (default: 600 s).
18948:
18949: Returns: an array; first element is:
18950:
18951: =over 4
18952:
18953: 'switch' - if content updates mean user's session
18954: needs to be switched to a server running a newer LON-CAPA version
18955:
18956: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18957: on current server hosting user's session
18958:
18959: '' - if no action required.
18960:
18961: =back
18962:
18963: If first item element is 'switch':
18964:
18965: second item is $switchwarning - Warning message if no suitable server found to host session.
18966:
18967: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18968: and current role.
18969:
18970: otherwise: no other elements returned.
18971:
18972: =back
18973:
18974: =cut
18975:
18976: sub needs_coursereinit {
18977: my ($loncaparev,$interval) = @_;
18978: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18979: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18980: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18981: my $now = time;
18982: if ($interval eq '') {
18983: $interval = 600;
18984: }
18985: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18986: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18987: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18988: if ($blocked) {
18989: return ();
18990: }
1.1391 raeburn 18991: my $update;
18992: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18993: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
18994: if ($lastmainchange > $env{'request.course.tied'}) {
18995: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18996: if ($needswitch) {
18997: return ('switch',$switchwarning,$switchserver);
18998: }
18999: $update = 'main';
19000: }
19001: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19002: if ($update) {
19003: $update = 'both';
19004: } else {
19005: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19006: if ($needswitch) {
19007: return ('switch',$switchwarning,$switchserver);
19008: } else {
19009: $update = 'supp';
1.1207 raeburn 19010: }
19011: }
1.1391 raeburn 19012: return ($update);
19013: }
19014: }
19015: return ();
19016: }
19017:
19018: sub switch_for_update {
19019: my ($loncaparev,$cdom,$cnum) = @_;
19020: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19021: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19022: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19023: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19024: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19025: $curr_reqd_hash{'internal.releaserequired'}});
19026: my ($switchserver,$switchwarning) =
19027: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19028: $curr_reqd_hash{'internal.releaserequired'});
19029: if ($switchwarning ne '' || $switchserver ne '') {
19030: return ('switch',$switchwarning,$switchserver);
19031: }
1.1207 raeburn 19032: }
19033: }
19034: return ();
19035: }
1.1181 raeburn 19036:
1.1083 raeburn 19037: sub update_content_constraints {
1.1395 raeburn 19038: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19039: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19040: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19041: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19042: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19043: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19044: if ($item eq 'resourcetag') {
19045: if ($name eq 'responsetype') {
19046: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19047: }
1.1307 raeburn 19048: } elsif ($item eq 'course') {
19049: if ($name eq 'courserestype') {
19050: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19051: }
1.1083 raeburn 19052: }
19053: }
19054: my $navmap = Apache::lonnavmaps::navmap->new();
19055: if (defined($navmap)) {
1.1307 raeburn 19056: my (%allresponses,%allcrsrestypes);
19057: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19058: if ($res->is_tool()) {
19059: if ($allcrsrestypes{'exttool'}) {
19060: $allcrsrestypes{'exttool'} ++;
19061: } else {
19062: $allcrsrestypes{'exttool'} = 1;
19063: }
19064: next;
19065: }
1.1083 raeburn 19066: my %responses = $res->responseTypes();
19067: foreach my $key (keys(%responses)) {
19068: next unless(exists($checkresponsetypes{$key}));
19069: $allresponses{$key} += $responses{$key};
19070: }
19071: }
19072: foreach my $key (keys(%allresponses)) {
19073: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19074: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19075: ($reqdmajor,$reqdminor) = ($major,$minor);
19076: }
19077: }
1.1307 raeburn 19078: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19079: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19080: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19081: ($reqdmajor,$reqdminor) = ($major,$minor);
19082: }
19083: }
1.1083 raeburn 19084: undef($navmap);
19085: }
1.1391 raeburn 19086: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19087: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19088: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19089: ($reqdmajor,$reqdminor) = ($major,$minor);
19090: }
19091: }
1.1083 raeburn 19092: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19093: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19094: }
19095: return;
19096: }
19097:
1.1110 raeburn 19098: sub allmaps_incourse {
19099: my ($cdom,$cnum,$chome,$cid) = @_;
19100: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19101: $cid = $env{'request.course.id'};
19102: $cdom = $env{'course.'.$cid.'.domain'};
19103: $cnum = $env{'course.'.$cid.'.num'};
19104: $chome = $env{'course.'.$cid.'.home'};
19105: }
19106: my %allmaps = ();
19107: my $lastchange =
19108: &Apache::lonnet::get_coursechange($cdom,$cnum);
19109: if ($lastchange > $env{'request.course.tied'}) {
19110: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19111: unless ($ferr) {
1.1395 raeburn 19112: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19113: }
19114: }
19115: my $navmap = Apache::lonnavmaps::navmap->new();
19116: if (defined($navmap)) {
19117: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19118: $allmaps{$res->src()} = 1;
19119: }
19120: }
19121: return \%allmaps;
19122: }
19123:
1.1083 raeburn 19124: sub parse_supplemental_title {
19125: my ($title) = @_;
19126:
19127: my ($foldertitle,$renametitle);
19128: if ($title =~ /&&&/) {
19129: $title = &HTML::Entites::decode($title);
19130: }
19131: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19132: $renametitle=$4;
19133: my ($time,$uname,$udom) = ($1,$2,$3);
19134: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19135: my $name = &plainname($uname,$udom);
19136: $name = &HTML::Entities::encode($name,'"<>&\'');
19137: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19138: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19139: if ($foldertitle ne '') {
1.1401 raeburn 19140: $title .= ': <br />'.$foldertitle;
19141: }
1.1083 raeburn 19142: }
19143: if (wantarray) {
19144: return ($title,$foldertitle,$renametitle);
19145: }
19146: return $title;
19147: }
19148:
1.1395 raeburn 19149: sub get_supplemental {
19150: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19151: my $hashid=$cnum.':'.$cdom;
19152: my ($supplemental,$cached,$set_httprefs);
19153: unless ($ignorecache) {
19154: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19155: }
19156: unless (defined($cached)) {
19157: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19158: unless ($chome eq 'no_host') {
19159: my @order = @LONCAPA::map::order;
19160: my @resources = @LONCAPA::map::resources;
19161: my @resparms = @LONCAPA::map::resparms;
19162: my @zombies = @LONCAPA::map::zombies;
19163: my ($errors,%ids,%hidden);
19164: $errors =
19165: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19166: $errors,$possdel,\%ids,\%hidden);
19167: @LONCAPA::map::order = @order;
19168: @LONCAPA::map::resources = @resources;
19169: @LONCAPA::map::resparms = @resparms;
19170: @LONCAPA::map::zombies = @zombies;
19171: $set_httprefs = 1;
19172: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19173: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19174: }
19175: $supplemental = {
19176: ids => \%ids,
19177: hidden => \%hidden,
19178: };
19179: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19180: }
19181: }
19182: return ($supplemental,$set_httprefs);
19183: }
19184:
1.1143 raeburn 19185: sub recurse_supplemental {
1.1391 raeburn 19186: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19187: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19188: my $mapnum;
19189: if ($suppmap eq 'supplemental.sequence') {
19190: $mapnum = 0;
19191: } else {
19192: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19193: }
1.1143 raeburn 19194: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19195: if ($fatal) {
19196: $errors ++;
19197: } else {
1.1389 raeburn 19198: my @order = @LONCAPA::map::order;
19199: if (@order > 0) {
19200: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19201: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19202: foreach my $idx (@order) {
19203: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19204: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19205: my $id = $mapnum.':'.$idx;
19206: push(@{$suppids->{$src}},$id);
19207: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19208: $hiddensupp->{$id} = 1;
19209: }
1.1146 raeburn 19210: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19211: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19212: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19213: } else {
1.1391 raeburn 19214: my $allowed;
19215: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19216: $allowed = 1;
19217: } elsif ($possdel) {
19218: foreach my $item (@{$suppids->{$src}}) {
19219: next if ($item eq $id);
19220: unless ($hiddensupp->{$item}) {
19221: $allowed = 1;
19222: last;
19223: }
19224: }
19225: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19226: &Apache::lonnet::delenv('httpref.'.$src);
19227: }
19228: }
19229: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19230: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19231: }
1.1143 raeburn 19232: }
19233: }
19234: }
19235: }
19236: }
19237: }
1.1391 raeburn 19238: return $errors;
19239: }
19240:
19241: sub set_supp_httprefs {
19242: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19243: if (ref($supplemental) eq 'HASH') {
19244: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19245: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19246: next if ($src =~ /\.sequence$/);
19247: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19248: my $allowed;
19249: if ($env{'request.role.adv'}) {
19250: $allowed = 1;
19251: } else {
19252: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19253: unless ($supplemental->{'hidden'}->{$id}) {
19254: $allowed = 1;
19255: last;
19256: }
19257: }
19258: }
19259: if (exists($env{'httpref.'.$src})) {
19260: if ($possdel) {
19261: unless ($allowed) {
19262: &Apache::lonnet::delenv('httpref.'.$src);
19263: }
19264: }
19265: } elsif ($allowed) {
19266: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19267: }
19268: }
19269: }
19270: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19271: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19272: }
19273: }
19274: }
19275: }
19276:
19277: sub get_supp_parameter {
19278: my ($resparm,$name)=@_;
19279: return if ($resparm eq '');
19280: my $value=undef;
19281: my $ptype=undef;
19282: foreach (split('&&&',$resparm)) {
19283: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19284: if ($thisname eq $name) {
19285: $value=$thisvalue;
19286: $ptype=$thistype;
19287: }
19288: }
19289: return $value;
1.1143 raeburn 19290: }
19291:
1.1101 raeburn 19292: sub symb_to_docspath {
1.1267 raeburn 19293: my ($symb,$navmapref) = @_;
19294: return unless ($symb && ref($navmapref));
1.1101 raeburn 19295: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19296: if ($resurl=~/\.(sequence|page)$/) {
19297: $mapurl=$resurl;
19298: } elsif ($resurl eq 'adm/navmaps') {
19299: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19300: }
19301: my $mapresobj;
1.1267 raeburn 19302: unless (ref($$navmapref)) {
19303: $$navmapref = Apache::lonnavmaps::navmap->new();
19304: }
19305: if (ref($$navmapref)) {
19306: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19307: }
19308: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19309: my $type=$2;
19310: my $path;
19311: if (ref($mapresobj)) {
19312: my $pcslist = $mapresobj->map_hierarchy();
19313: if ($pcslist ne '') {
19314: foreach my $pc (split(/,/,$pcslist)) {
19315: next if ($pc <= 1);
1.1267 raeburn 19316: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19317: if (ref($res)) {
19318: my $thisurl = $res->src();
19319: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19320: my $thistitle = $res->title();
19321: $path .= '&'.
19322: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19323: &escape($thistitle).
1.1101 raeburn 19324: ':'.$res->randompick().
19325: ':'.$res->randomout().
19326: ':'.$res->encrypted().
19327: ':'.$res->randomorder().
19328: ':'.$res->is_page();
19329: }
19330: }
19331: }
19332: $path =~ s/^\&//;
19333: my $maptitle = $mapresobj->title();
19334: if ($mapurl eq 'default') {
1.1129 raeburn 19335: $maptitle = 'Main Content';
1.1101 raeburn 19336: }
19337: $path .= (($path ne '')? '&' : '').
19338: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19339: &escape($maptitle).
1.1101 raeburn 19340: ':'.$mapresobj->randompick().
19341: ':'.$mapresobj->randomout().
19342: ':'.$mapresobj->encrypted().
19343: ':'.$mapresobj->randomorder().
19344: ':'.$mapresobj->is_page();
19345: } else {
19346: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19347: my $ispage = (($type eq 'page')? 1 : '');
19348: if ($mapurl eq 'default') {
1.1129 raeburn 19349: $maptitle = 'Main Content';
1.1101 raeburn 19350: }
19351: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19352: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19353: }
19354: unless ($mapurl eq 'default') {
19355: $path = 'default&'.
1.1146 raeburn 19356: &escape('Main Content').
1.1101 raeburn 19357: ':::::&'.$path;
19358: }
19359: return $path;
19360: }
19361:
1.1393 raeburn 19362: sub validate_folderpath {
19363: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19364: if ($env{'form.folderpath'} ne '') {
19365: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19366: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19367: for (my $i=0; $i<@items; $i++) {
19368: my $odd = $i%2;
19369: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19370: $badpath = 1;
1.1394 raeburn 19371: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19372: my $idx = $i-1;
1.1394 raeburn 19373: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19374: my $esc_name = $1;
19375: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19376: $supppath .= '&'.$esc_name;
19377: $changed = 1;
19378: } else {
19379: $supppath .= '&'.$items[$i];
19380: }
19381: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19382: $changed = 1;
1.1393 raeburn 19383: my $is_hidden;
19384: unless ($got_supp) {
1.1395 raeburn 19385: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19386: if (ref($supplemental) eq 'HASH') {
19387: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19388: %supphidden = %{$supplemental->{'hidden'}};
19389: }
19390: if (ref($supplemental->{'ids'}) eq 'HASH') {
19391: %suppids = %{$supplemental->{'ids'}};
19392: }
19393: }
19394: $got_supp = 1;
19395: }
19396: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19397: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19398: if ($supphidden{$mapid}) {
19399: $is_hidden = 1;
19400: }
19401: }
1.1394 raeburn 19402: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19403: } else {
19404: $supppath .= '&'.$items[$i];
1.1393 raeburn 19405: }
19406: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19407: $badpath = 1;
1.1394 raeburn 19408: } elsif ($supplementalflag) {
1.1393 raeburn 19409: $supppath .= '&'.$items[$i];
19410: }
19411: last if ($badpath);
19412: }
19413: if ($badpath) {
19414: delete($env{'form.folderpath'});
1.1394 raeburn 19415: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19416: $supppath =~ s/^\&//;
19417: $env{'form.folderpath'} = $supppath;
19418: }
19419: }
19420: return;
19421: }
19422:
1.1094 raeburn 19423: sub captcha_display {
1.1327 raeburn 19424: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19425: my ($output,$error);
1.1234 raeburn 19426: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19427: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19428: if ($captcha eq 'original') {
1.1094 raeburn 19429: $output = &create_captcha();
19430: unless ($output) {
1.1172 raeburn 19431: $error = 'captcha';
1.1094 raeburn 19432: }
19433: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19434: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19435: unless ($output) {
1.1172 raeburn 19436: $error = 'recaptcha';
1.1094 raeburn 19437: }
19438: }
1.1234 raeburn 19439: return ($output,$error,$captcha,$version);
1.1094 raeburn 19440: }
19441:
19442: sub captcha_response {
1.1327 raeburn 19443: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19444: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19445: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19446: if ($captcha eq 'original') {
1.1094 raeburn 19447: ($captcha_chk,$captcha_error) = &check_captcha();
19448: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19449: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19450: } else {
19451: $captcha_chk = 1;
19452: }
19453: return ($captcha_chk,$captcha_error);
19454: }
19455:
19456: sub get_captcha_config {
1.1327 raeburn 19457: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19458: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19459: my $hostname = &Apache::lonnet::hostname($lonhost);
19460: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19461: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19462: if ($context eq 'usercreation') {
19463: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19464: if (ref($domconfig{$context}) eq 'HASH') {
19465: $hashtocheck = $domconfig{$context}{'cancreate'};
19466: if (ref($hashtocheck) eq 'HASH') {
19467: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19468: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19469: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19470: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19471: }
19472: if ($privkey && $pubkey) {
19473: $captcha = 'recaptcha';
1.1234 raeburn 19474: $version = $hashtocheck->{'recaptchaversion'};
19475: if ($version ne '2') {
19476: $version = 1;
19477: }
1.1095 raeburn 19478: } else {
19479: $captcha = 'original';
19480: }
19481: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19482: $captcha = 'original';
19483: }
1.1094 raeburn 19484: }
1.1095 raeburn 19485: } else {
19486: $captcha = 'captcha';
19487: }
19488: } elsif ($context eq 'login') {
19489: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19490: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19491: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19492: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19493: if ($privkey && $pubkey) {
19494: $captcha = 'recaptcha';
1.1234 raeburn 19495: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19496: if ($version ne '2') {
19497: $version = 1;
19498: }
1.1095 raeburn 19499: } else {
19500: $captcha = 'original';
1.1094 raeburn 19501: }
1.1095 raeburn 19502: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19503: $captcha = 'original';
1.1094 raeburn 19504: }
1.1327 raeburn 19505: } elsif ($context eq 'passwords') {
19506: if ($dom_in_effect) {
19507: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19508: if ($passwdconf{'captcha'} eq 'recaptcha') {
19509: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19510: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19511: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19512: }
19513: if ($privkey && $pubkey) {
19514: $captcha = 'recaptcha';
19515: $version = $passwdconf{'recaptchaversion'};
19516: if ($version ne '2') {
19517: $version = 1;
19518: }
19519: } else {
19520: $captcha = 'original';
19521: }
19522: } elsif ($passwdconf{'captcha'} ne 'notused') {
19523: $captcha = 'original';
19524: }
19525: }
19526: }
1.1234 raeburn 19527: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19528: }
19529:
19530: sub create_captcha {
19531: my %captcha_params = &captcha_settings();
19532: my ($output,$maxtries,$tries) = ('',10,0);
19533: while ($tries < $maxtries) {
19534: $tries ++;
19535: my $captcha = Authen::Captcha->new (
19536: output_folder => $captcha_params{'output_dir'},
19537: data_folder => $captcha_params{'db_dir'},
19538: );
19539: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19540:
19541: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19542: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19543: '<span class="LC_nobreak">'.
1.1094 raeburn 19544: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19545: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19546: '</span><br />'.
1.1176 raeburn 19547: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19548: last;
19549: }
19550: }
1.1323 raeburn 19551: if ($output eq '') {
19552: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19553: }
1.1094 raeburn 19554: return $output;
19555: }
19556:
19557: sub captcha_settings {
19558: my %captcha_params = (
19559: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19560: www_output_dir => "/captchaspool",
19561: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19562: numchars => '5',
19563: );
19564: return %captcha_params;
19565: }
19566:
19567: sub check_captcha {
19568: my ($captcha_chk,$captcha_error);
19569: my $code = $env{'form.code'};
19570: my $md5sum = $env{'form.crypt'};
19571: my %captcha_params = &captcha_settings();
19572: my $captcha = Authen::Captcha->new(
19573: output_folder => $captcha_params{'output_dir'},
19574: data_folder => $captcha_params{'db_dir'},
19575: );
1.1109 raeburn 19576: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19577: my %captcha_hash = (
19578: 0 => 'Code not checked (file error)',
19579: -1 => 'Failed: code expired',
19580: -2 => 'Failed: invalid code (not in database)',
19581: -3 => 'Failed: invalid code (code does not match crypt)',
19582: );
19583: if ($captcha_chk != 1) {
19584: $captcha_error = $captcha_hash{$captcha_chk}
19585: }
19586: return ($captcha_chk,$captcha_error);
19587: }
19588:
19589: sub create_recaptcha {
1.1234 raeburn 19590: my ($pubkey,$version) = @_;
19591: if ($version >= 2) {
1.1367 raeburn 19592: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19593: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19594: } else {
19595: my $use_ssl;
19596: if ($ENV{'SERVER_PORT'} == 443) {
19597: $use_ssl = 1;
19598: }
19599: my $captcha = Captcha::reCAPTCHA->new;
19600: return $captcha->get_options_setter({theme => 'white'})."\n".
19601: $captcha->get_html($pubkey,undef,$use_ssl).
19602: &mt('If the text is hard to read, [_1] will replace them.',
19603: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19604: '<br /><br />';
19605: }
1.1094 raeburn 19606: }
19607:
19608: sub check_recaptcha {
1.1234 raeburn 19609: my ($privkey,$version) = @_;
1.1094 raeburn 19610: my $captcha_chk;
1.1350 raeburn 19611: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19612: if ($version >= 2) {
19613: my %info = (
19614: secret => $privkey,
19615: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19616: remoteip => $ip,
1.1234 raeburn 19617: );
1.1280 raeburn 19618: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19619: $request->content(join('&',map {
19620: my $name = escape($_);
19621: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19622: ? join("&$name=", map {escape($_) } @{$info{$_}})
19623: : &escape($info{$_}) );
19624: } keys(%info)));
19625: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19626: if ($response->is_success) {
19627: my $data = JSON::DWIW->from_json($response->decoded_content);
19628: if (ref($data) eq 'HASH') {
19629: if ($data->{'success'}) {
19630: $captcha_chk = 1;
19631: }
19632: }
19633: }
19634: } else {
19635: my $captcha = Captcha::reCAPTCHA->new;
19636: my $captcha_result =
19637: $captcha->check_answer(
19638: $privkey,
1.1350 raeburn 19639: $ip,
1.1234 raeburn 19640: $env{'form.recaptcha_challenge_field'},
19641: $env{'form.recaptcha_response_field'},
19642: );
19643: if ($captcha_result->{is_valid}) {
19644: $captcha_chk = 1;
19645: }
1.1094 raeburn 19646: }
19647: return $captcha_chk;
19648: }
19649:
1.1174 raeburn 19650: sub emailusername_info {
1.1244 raeburn 19651: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19652: my %titles = &Apache::lonlocal::texthash (
19653: lastname => 'Last Name',
19654: firstname => 'First Name',
19655: institution => 'School/college/university',
19656: location => "School's city, state/province, country",
19657: web => "School's web address",
19658: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19659: id => 'Student/Employee ID',
1.1174 raeburn 19660: );
19661: return (\@fields,\%titles);
19662: }
19663:
1.1161 raeburn 19664: sub cleanup_html {
19665: my ($incoming) = @_;
19666: my $outgoing;
19667: if ($incoming ne '') {
19668: $outgoing = $incoming;
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: $outgoing =~ s/=/=/g;
19681: $outgoing =~ s/\\/\/g
19682: }
19683: return $outgoing;
19684: }
19685:
1.1190 musolffc 19686: # Checks for critical messages and returns a redirect url if one exists.
19687: # $interval indicates how often to check for messages.
1.1282 raeburn 19688: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19689: sub critical_redirect {
1.1282 raeburn 19690: my ($interval,$context) = @_;
1.1356 raeburn 19691: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19692: return ();
19693: }
1.1190 musolffc 19694: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19695: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19696: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19697: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19698: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19699: if ($blocked) {
19700: my $checkrole = "cm./$cdom/$cnum";
19701: if ($env{'request.course.sec'} ne '') {
19702: $checkrole .= "/$env{'request.course.sec'}";
19703: }
19704: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19705: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19706: return;
19707: }
19708: }
19709: }
1.1190 musolffc 19710: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19711: $env{'user.name'});
19712: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19713: my $redirecturl;
1.1190 musolffc 19714: if ($what[0]) {
1.1356 raeburn 19715: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19716: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19717: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19718: return (1, $url);
1.1190 musolffc 19719: }
1.1191 raeburn 19720: }
19721: }
19722: return ();
1.1190 musolffc 19723: }
19724:
1.1174 raeburn 19725: # Use:
19726: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19727: #
19728: ##################################################
19729: # password associated functions #
19730: ##################################################
19731: sub des_keys {
19732: # Make a new key for DES encryption.
19733: # Each key has two parts which are returned separately.
19734: # Please note: Each key must be passed through the &hex function
19735: # before it is output to the web browser. The hex versions cannot
19736: # be used to decrypt.
19737: my @hexstr=('0','1','2','3','4','5','6','7',
19738: '8','9','a','b','c','d','e','f');
19739: my $lkey='';
19740: for (0..7) {
19741: $lkey.=$hexstr[rand(15)];
19742: }
19743: my $ukey='';
19744: for (0..7) {
19745: $ukey.=$hexstr[rand(15)];
19746: }
19747: return ($lkey,$ukey);
19748: }
19749:
19750: sub des_decrypt {
19751: my ($key,$cyphertext) = @_;
19752: my $keybin=pack("H16",$key);
19753: my $cypher;
19754: if ($Crypt::DES::VERSION>=2.03) {
19755: $cypher=new Crypt::DES $keybin;
19756: } else {
19757: $cypher=new DES $keybin;
19758: }
1.1233 raeburn 19759: my $plaintext='';
19760: my $cypherlength = length($cyphertext);
19761: my $numchunks = int($cypherlength/32);
19762: for (my $j=0; $j<$numchunks; $j++) {
19763: my $start = $j*32;
19764: my $cypherblock = substr($cyphertext,$start,32);
19765: my $chunk =
19766: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19767: $chunk .=
19768: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19769: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19770: $plaintext .= $chunk;
19771: }
1.1174 raeburn 19772: return $plaintext;
19773: }
19774:
1.1344 raeburn 19775: sub get_requested_shorturls {
1.1309 raeburn 19776: my ($cdom,$cnum,$navmap) = @_;
19777: return unless (ref($navmap));
1.1344 raeburn 19778: my ($numnew,$errors);
1.1309 raeburn 19779: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19780: if (@toshorten) {
19781: my (%maps,%resources,%titles);
19782: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19783: 'shorturls',$cdom,$cnum);
19784: if (keys(%resources)) {
1.1344 raeburn 19785: my %tocreate;
1.1309 raeburn 19786: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19787: my $symb = $resources{$item};
19788: if ($symb) {
19789: $tocreate{$cnum.'&'.$symb} = 1;
19790: }
19791: }
1.1344 raeburn 19792: if (keys(%tocreate)) {
19793: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19794: \%tocreate);
19795: }
1.1309 raeburn 19796: }
1.1344 raeburn 19797: }
19798: return ($numnew,$errors);
19799: }
19800:
19801: sub make_short_symbs {
19802: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19803: my ($numnew,@errors);
19804: if (ref($tocreateref) eq 'HASH') {
19805: my %tocreate = %{$tocreateref};
1.1309 raeburn 19806: if (keys(%tocreate)) {
19807: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19808: my $su = Short::URL->new(no_vowels => 1);
19809: my $init = '';
19810: my (%newunique,%addcourse,%courseonly,%failed);
19811: # get lock on tiny db
19812: my $now = time;
1.1344 raeburn 19813: if ($lockuser eq '') {
19814: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19815: }
1.1309 raeburn 19816: my $lockhash = {
1.1344 raeburn 19817: "lock\0$now" => $lockuser,
1.1309 raeburn 19818: };
19819: my $tries = 0;
19820: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19821: my ($code,$error);
19822: while (($gotlock ne 'ok') && ($tries<3)) {
19823: $tries ++;
19824: sleep 1;
1.1319 raeburn 19825: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19826: }
19827: if ($gotlock eq 'ok') {
19828: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19829: \%addcourse,\%courseonly,\%failed);
19830: if (keys(%failed)) {
19831: my $numfailed = scalar(keys(%failed));
19832: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19833: }
19834: if (keys(%newunique)) {
19835: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19836: if ($putres eq 'ok') {
19837: $numnew = scalar(keys(%newunique));
19838: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19839: unless ($newputres eq 'ok') {
19840: push(@errors,&mt('error: could not store course look-up of short URLs'));
19841: }
19842: } else {
19843: push(@errors,&mt('error: could not store unique six character URLs'));
19844: }
19845: }
19846: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19847: unless ($dellockres eq 'ok') {
19848: push(@errors,&mt('error: could not release lockfile'));
19849: }
19850: } else {
19851: push(@errors,&mt('error: could not obtain lockfile'));
19852: }
19853: if (keys(%courseonly)) {
19854: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19855: if ($result ne 'ok') {
19856: push(@errors,&mt('error: could not update course look-up of short URLs'));
19857: }
19858: }
19859: }
19860: }
19861: return ($numnew,\@errors);
19862: }
19863:
19864: sub shorten_symbs {
19865: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19866: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19867: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19868: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19869: my (%possibles,%collisions);
19870: foreach my $key (keys(%{$tocreate})) {
19871: my $num = String::CRC32::crc32($key);
19872: my $tiny = $su->encode($num,$init);
19873: if ($tiny) {
19874: $possibles{$tiny} = $key;
19875: }
19876: }
19877: if (!$init) {
19878: $init = 1;
19879: } else {
19880: $init ++;
19881: }
19882: if (keys(%possibles)) {
19883: my @posstiny = keys(%possibles);
19884: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19885: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19886: if (keys(%currtiny)) {
19887: foreach my $key (keys(%currtiny)) {
19888: next if ($currtiny{$key} eq '');
19889: if ($currtiny{$key} eq $possibles{$key}) {
19890: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19891: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19892: $courseonly->{$tsymb} = $key;
19893: }
19894: } else {
19895: $collisions{$possibles{$key}} = 1;
19896: }
19897: delete($possibles{$key});
19898: }
19899: }
19900: foreach my $key (keys(%possibles)) {
19901: $newunique->{$key} = $possibles{$key};
19902: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19903: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19904: $addcourse->{$tsymb} = $key;
19905: }
19906: }
19907: }
19908: if (keys(%collisions)) {
19909: if ($init <5) {
19910: if (!$init) {
19911: $init = 1;
19912: } else {
19913: $init ++;
19914: }
19915: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19916: $newunique,$addcourse,$courseonly,$failed);
19917: } else {
19918: foreach my $key (keys(%collisions)) {
19919: $failed->{$key} = 1;
19920: }
19921: }
19922: }
19923: return $init;
19924: }
19925:
1.1328 raeburn 19926: sub is_nonframeable {
1.1329 raeburn 19927: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19928: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19929: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19930:
19931: $remprotocol = lc($remprotocol);
19932: $remhost = lc($remhost);
19933: my $remport = 80;
19934: if ($remprotocol eq 'https') {
19935: $remport = 443;
19936: }
1.1330 raeburn 19937: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19938: if ($cached) {
19939: unless ($nocache) {
19940: if ($result) {
19941: return 1;
19942: } else {
19943: return 0;
19944: }
19945: }
19946: }
1.1328 raeburn 19947: my $uselink;
19948: my $request = new HTTP::Request('HEAD',$url);
19949: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19950: if ($response->is_success()) {
19951: my $secpolicy = lc($response->header('content-security-policy'));
19952: my $xframeop = lc($response->header('x-frame-options'));
19953: $secpolicy =~ s/^\s+|\s+$//g;
19954: $xframeop =~ s/^\s+|\s+$//g;
19955: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19956: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19957: my ($origin,$protocol,$port);
19958: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19959: $port = $ENV{'SERVER_PORT'};
19960: } else {
19961: $port = 80;
19962: }
19963: if ($absolute eq '') {
19964: $protocol = 'http:';
19965: if ($port == 443) {
19966: $protocol = 'https:';
19967: }
19968: $origin = $protocol.'//'.lc($hostname);
19969: } else {
19970: $origin = lc($absolute);
19971: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19972: }
19973: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19974: my $framepolicy = $1;
19975: $framepolicy =~ s/^\s+|\s+$//g;
19976: my @policies = split(/\s+/,$framepolicy);
19977: if (@policies) {
19978: if (grep(/^\Q'none'\E$/,@policies)) {
19979: $uselink = 1;
19980: } else {
19981: $uselink = 1;
19982: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19983: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19984: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19985: undef($uselink);
19986: }
19987: if ($uselink) {
19988: if (grep(/^\Q'self'\E$/,@policies)) {
19989: if (($origin ne '') && ($remotehost eq $origin)) {
19990: undef($uselink);
19991: }
19992: }
19993: }
19994: if ($uselink) {
19995: my @possok;
19996: if ($ip ne '') {
19997: push(@possok,$ip);
19998: }
19999: my $hoststr = '';
20000: foreach my $part (reverse(split(/\./,$hostname))) {
20001: if ($hoststr eq '') {
20002: $hoststr = $part;
20003: } else {
20004: $hoststr = "$part.$hoststr";
20005: }
20006: if ($hoststr eq $hostname) {
20007: push(@possok,$hostname);
20008: } else {
20009: push(@possok,"*.$hoststr");
20010: }
20011: }
20012: if (@possok) {
20013: foreach my $poss (@possok) {
20014: last if (!$uselink);
20015: foreach my $policy (@policies) {
20016: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20017: undef($uselink);
20018: last;
20019: }
20020: }
20021: }
20022: }
20023: }
20024: }
20025: }
20026: } elsif ($xframeop ne '') {
20027: $uselink = 1;
20028: my @policies = split(/\s*,\s*/,$xframeop);
20029: if (@policies) {
20030: unless (grep(/^deny$/,@policies)) {
20031: if ($origin ne '') {
20032: if (grep(/^sameorigin$/,@policies)) {
20033: if ($remotehost eq $origin) {
20034: undef($uselink);
20035: }
20036: }
20037: if ($uselink) {
20038: foreach my $policy (@policies) {
20039: if ($policy =~ /^allow-from\s*(.+)$/) {
20040: my $allowfrom = $1;
20041: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20042: undef($uselink);
20043: last;
20044: }
20045: }
20046: }
20047: }
20048: }
20049: }
20050: }
20051: }
20052: }
20053: }
1.1329 raeburn 20054: if ($nocache) {
20055: if ($cached) {
20056: my $devalidate;
20057: if ($uselink && !$result) {
20058: $devalidate = 1;
20059: } elsif (!$uselink && $result) {
20060: $devalidate = 1;
20061: }
20062: if ($devalidate) {
20063: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20064: }
20065: }
20066: } else {
20067: if ($uselink) {
20068: $result = 1;
20069: } else {
20070: $result = 0;
20071: }
20072: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20073: }
1.1328 raeburn 20074: return $uselink;
20075: }
20076:
1.1359 raeburn 20077: sub page_menu {
20078: my ($menucolls,$menunum) = @_;
20079: my %menu;
20080: foreach my $item (split(/;/,$menucolls)) {
20081: my ($num,$value) = split(/\%/,$item);
20082: if ($num eq $menunum) {
20083: my @entries = split(/\&/,$value);
20084: foreach my $entry (@entries) {
20085: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20086: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20087: $menu{$name} = $fields;
20088: } else {
20089: my @shown;
20090: if ($fields =~ /,/) {
20091: @shown = split(/,/,$fields);
20092: } else {
20093: @shown = ($fields);
20094: }
20095: if (@shown) {
20096: foreach my $field (@shown) {
20097: next if ($field eq '');
20098: $menu{$field} = 1;
20099: }
20100: }
20101: }
20102: }
20103: }
20104: }
20105: return %menu;
20106: }
20107:
1.112 bowersj2 20108: 1;
20109: __END__;
1.41 ng 20110:
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