Annotation of loncom/interface/loncommon.pm, revision 1.1436
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1436 ! raeburn 4: # $Id: loncommon.pm,v 1.1435 2024/09/10 20:34:41 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.1130 raeburn 7003: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 7004: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 7005:
1.1427 raeburn 7006: my $collapsible;
1.1423 raeburn 7007: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7008: $collapsible = 1;
7009: my ($menustate,$tiptext,$divclass);
7010: if ($args->{'start_collapsed'}) {
7011: $menustate = 'collapsed';
7012: $tiptext = 'display';
7013: $divclass = 'hidden';
7014: } else {
7015: $menustate = 'expanded';
7016: $tiptext = 'hide';
7017: $divclass = 'shown';
7018: }
7019: my $alttext = &mt('menu state: '.$menustate);
7020: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7021: $bodytag .= <<"END";
7022: <div id="LC_expandingContainer" style="display:inline;">
7023: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7024: <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>
7025: <div class="LC_menus_content $divclass">
1.1421 raeburn 7026: END
7027: }
1.1318 raeburn 7028: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7029: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7030: $args->{'links_disabled'},
1.1421 raeburn 7031: $args->{'links_target'},
1.1427 raeburn 7032: $collapsible);
1.359 albertel 7033:
1.1318 raeburn 7034: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7035: if ($dc_info) {
7036: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7037: }
7038: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7039: <em>$realm</em> $dc_info</div>|;
7040: return $bodytag;
7041: }
1.894 droeschl 7042:
1.1318 raeburn 7043: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7044: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7045: }
1.916 droeschl 7046:
1.1318 raeburn 7047: $bodytag .= $right;
1.852 droeschl 7048:
1.1318 raeburn 7049: if ($dc_info) {
7050: $dc_info = &dc_courseid_toggle($dc_info);
7051: }
7052: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7053: }
1.916 droeschl 7054:
1.1169 raeburn 7055: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7056: if ($args->{'no_secondary_menu'}) {
7057: return $bodytag;
7058: }
1.1169 raeburn 7059: #don't show menus for public users
1.954 raeburn 7060: if (!$public){
1.1318 raeburn 7061: unless ($args->{'no_inline_menu'}) {
7062: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7063: $args->{'no_primary_menu'},
1.1369 raeburn 7064: $menucoll,$menuref,
1.1380 raeburn 7065: $args->{'links_disabled'},
7066: $args->{'links_target'});
1.1318 raeburn 7067: }
1.903 droeschl 7068: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 7069: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7070: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7071: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7072: $args->{'bread_crumbs'},'','',$hostname,
7073: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7074: } elsif ($forcereg) {
7075: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7076: $args->{'group'},$args->{'hide_buttons'},
7077: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7078: } else {
7079: $bodytag .=
7080: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7081: $forcereg,$args->{'group'},
7082: $args->{'bread_crumbs'},
1.1274 raeburn 7083: $advtoolsref,'',$hostname);
1.920 raeburn 7084: }
1.903 droeschl 7085: }else{
7086: # this is to seperate menu from content when there's no secondary
7087: # menu. Especially needed for public accessible ressources.
7088: $bodytag .= '<hr style="clear:both" />';
7089: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 7090: }
1.1423 raeburn 7091: if ($args->{'collapsible_header'} ne '') {
7092: $bodytag .= $args->{'collapsible_header'}.
7093: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7094: '</div></div>';
7095: }
1.235 raeburn 7096: return $bodytag;
1.182 matthew 7097: }
7098:
1.917 raeburn 7099: sub dc_courseid_toggle {
7100: my ($dc_info) = @_;
1.980 raeburn 7101: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7102: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7103: &mt('(More ...)').'</a></span>'.
7104: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7105: }
7106:
1.330 albertel 7107: sub make_attr_string {
7108: my ($register,$attr_ref) = @_;
7109:
7110: if ($attr_ref && !ref($attr_ref)) {
7111: die("addentries Must be a hash ref ".
7112: join(':',caller(1))." ".
7113: join(':',caller(0))." ");
7114: }
7115:
7116: if ($register) {
1.339 albertel 7117: my ($on_load,$on_unload);
7118: foreach my $key (keys(%{$attr_ref})) {
7119: if (lc($key) eq 'onload') {
7120: $on_load.=$attr_ref->{$key}.';';
7121: delete($attr_ref->{$key});
7122:
7123: } elsif (lc($key) eq 'onunload') {
7124: $on_unload.=$attr_ref->{$key}.';';
7125: delete($attr_ref->{$key});
7126: }
7127: }
1.953 droeschl 7128: $attr_ref->{'onload'} = $on_load;
7129: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7130: }
1.339 albertel 7131:
1.330 albertel 7132: my $attr_string;
1.1159 raeburn 7133: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7134: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7135: }
7136: return $attr_string;
7137: }
7138:
7139:
1.182 matthew 7140: ###############################################
1.251 albertel 7141: ###############################################
7142:
7143: =pod
7144:
7145: =item * &endbodytag()
7146:
7147: Returns a uniform footer for LON-CAPA web pages.
7148:
1.635 raeburn 7149: Inputs: 1 - optional reference to an args hash
7150: If in the hash, key for noredirectlink has a value which evaluates to true,
7151: a 'Continue' link is not displayed if the page contains an
7152: internal redirect in the <head></head> section,
7153: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7154:
7155: =cut
7156:
7157: sub endbodytag {
1.635 raeburn 7158: my ($args) = @_;
1.1080 raeburn 7159: my $endbodytag;
7160: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7161: $endbodytag='</body>';
7162: }
1.315 albertel 7163: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7164: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7165: my ($endbodyjs,$idattr);
7166: if ($env{'internal.head.to_opener'}) {
7167: my $linkid = 'LC_continue_link';
7168: $idattr = ' id="'.$linkid.'"';
7169: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7170: $endbodyjs=<<ENDJS;
7171: <script type="text/javascript">
7172: // <![CDATA[
7173: function ebFunction(evt) {
7174: evt.preventDefault();
7175: var dest = '$redirect_for_js';
7176: if (window.opener != null && !window.opener.closed) {
7177: window.opener.location.href=dest;
7178: window.close();
7179: } else {
7180: window.location.href=dest;
7181: }
7182: return false;
7183: }
7184:
7185: \$(document).ready(function () {
7186: if (document.getElementById('$linkid')) {
7187: var clickelem = document.getElementById('$linkid');
7188: clickelem.addEventListener('click',ebFunction,false);
7189: }
7190: });
7191: // ]]>
7192: </script>
7193: ENDJS
7194: }
1.635 raeburn 7195: $endbodytag=
1.1386 raeburn 7196: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7197: &mt('Continue').'</a>'.
7198: $endbodytag;
7199: }
1.315 albertel 7200: }
1.1411 raeburn 7201: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7202: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7203: }
1.251 albertel 7204: return $endbodytag;
7205: }
7206:
1.352 albertel 7207: =pod
7208:
7209: =item * &standard_css()
7210:
7211: Returns a style sheet
7212:
7213: Inputs: (all optional)
7214: domain -> force to color decorate a page for a specific
7215: domain
7216: function -> force usage of a specific rolish color scheme
7217: bgcolor -> override the default page bgcolor
7218:
7219: =cut
7220:
1.343 albertel 7221: sub standard_css {
1.345 albertel 7222: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7223: $function = &get_users_function() if (!$function);
7224: my $img = &designparm($function.'.img', $domain);
7225: my $tabbg = &designparm($function.'.tabbg', $domain);
7226: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7227: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7228: #second colour for later usage
1.345 albertel 7229: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7230: my $pgbg_or_bgcolor =
7231: $bgcolor ||
1.352 albertel 7232: &designparm($function.'.pgbg', $domain);
1.382 albertel 7233: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7234: my $alink = &designparm($function.'.alink', $domain);
7235: my $vlink = &designparm($function.'.vlink', $domain);
7236: my $link = &designparm($function.'.link', $domain);
7237:
1.602 albertel 7238: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7239: my $mono = 'monospace';
1.850 bisitz 7240: my $data_table_head = $sidebg;
7241: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7242: my $data_table_dark = '#E0E0E0';
1.470 banghart 7243: my $data_table_darker = '#CCCCCC';
1.349 albertel 7244: my $data_table_highlight = '#FFFF00';
1.352 albertel 7245: my $mail_new = '#FFBB77';
7246: my $mail_new_hover = '#DD9955';
7247: my $mail_read = '#BBBB77';
7248: my $mail_read_hover = '#999944';
7249: my $mail_replied = '#AAAA88';
7250: my $mail_replied_hover = '#888855';
7251: my $mail_other = '#99BBBB';
7252: my $mail_other_hover = '#669999';
1.391 albertel 7253: my $table_header = '#DDDDDD';
1.489 raeburn 7254: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7255: my $lg_border_color = '#C8C8C8';
1.952 onken 7256: my $button_hover = '#BF2317';
1.392 albertel 7257:
1.608 albertel 7258: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7259: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7260: : '0 3px 0 4px';
1.448 albertel 7261:
1.523 albertel 7262:
1.343 albertel 7263: return <<END;
1.947 droeschl 7264:
7265: /* needed for iframe to allow 100% height in FF */
7266: body, html {
7267: margin: 0;
7268: padding: 0 0.5%;
7269: height: 99%; /* to avoid scrollbars */
7270: }
7271:
1.795 www 7272: body {
1.911 bisitz 7273: font-family: $sans;
7274: line-height:130%;
7275: font-size:0.83em;
7276: color:$font;
1.1436 ! raeburn 7277: background-color: $pgbg_or_bgcolor;
1.795 www 7278: }
7279:
1.959 onken 7280: a:focus,
7281: a:focus img {
1.795 www 7282: color: red;
7283: }
1.698 harmsja 7284:
1.911 bisitz 7285: form, .inline {
7286: display: inline;
1.795 www 7287: }
1.721 harmsja 7288:
1.1421 raeburn 7289: .LC_menus_content.shown{
1.1428 raeburn 7290: display: block;
1.1421 raeburn 7291: }
7292:
7293: .LC_menus_content.hidden {
7294: display: none;
7295: }
7296:
1.795 www 7297: .LC_right {
1.911 bisitz 7298: text-align:right;
1.795 www 7299: }
7300:
7301: .LC_middle {
1.911 bisitz 7302: vertical-align:middle;
1.795 www 7303: }
1.721 harmsja 7304:
1.1130 raeburn 7305: .LC_floatleft {
7306: float: left;
7307: }
7308:
7309: .LC_floatright {
7310: float: right;
7311: }
7312:
1.911 bisitz 7313: .LC_400Box {
7314: width:400px;
7315: }
1.721 harmsja 7316:
1.1421 raeburn 7317: #LC_collapsible_separator {
7318: border: 1px solid black;
7319: width: 99.9%;
7320: height: 0px;
7321: }
7322:
1.947 droeschl 7323: .LC_iframecontainer {
7324: width: 98%;
7325: margin: 0;
7326: position: fixed;
7327: top: 8.5em;
7328: bottom: 0;
7329: }
7330:
7331: .LC_iframecontainer iframe{
7332: border: none;
7333: width: 100%;
7334: height: 100%;
7335: }
7336:
1.778 bisitz 7337: .LC_filename {
7338: font-family: $mono;
7339: white-space:pre;
1.921 bisitz 7340: font-size: 120%;
1.778 bisitz 7341: }
7342:
7343: .LC_fileicon {
7344: border: none;
7345: height: 1.3em;
7346: vertical-align: text-bottom;
7347: margin-right: 0.3em;
7348: text-decoration:none;
7349: }
7350:
1.1008 www 7351: .LC_setting {
7352: text-decoration:underline;
7353: }
7354:
1.350 albertel 7355: .LC_error {
7356: color: red;
7357: }
1.795 www 7358:
1.1097 bisitz 7359: .LC_warning {
7360: color: darkorange;
7361: }
7362:
1.457 albertel 7363: .LC_diff_removed {
1.733 bisitz 7364: color: red;
1.394 albertel 7365: }
1.532 albertel 7366:
7367: .LC_info,
1.457 albertel 7368: .LC_success,
7369: .LC_diff_added {
1.350 albertel 7370: color: green;
7371: }
1.795 www 7372:
1.802 bisitz 7373: div.LC_confirm_box {
7374: background-color: #FAFAFA;
7375: border: 1px solid $lg_border_color;
7376: margin-right: 0;
7377: padding: 5px;
7378: }
7379:
7380: div.LC_confirm_box .LC_error img,
7381: div.LC_confirm_box .LC_success img {
7382: vertical-align: middle;
7383: }
7384:
1.1242 raeburn 7385: .LC_maxwidth {
7386: max-width: 100%;
7387: height: auto;
7388: }
7389:
1.1243 raeburn 7390: .LC_textsize_mobile {
7391: \@media only screen and (max-device-width: 480px) {
7392: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7393: }
7394: }
7395:
1.440 albertel 7396: .LC_icon {
1.771 droeschl 7397: border: none;
1.790 droeschl 7398: vertical-align: middle;
1.771 droeschl 7399: }
7400:
1.543 albertel 7401: .LC_docs_spacer {
7402: width: 25px;
7403: height: 1px;
1.771 droeschl 7404: border: none;
1.543 albertel 7405: }
1.346 albertel 7406:
1.532 albertel 7407: .LC_internal_info {
1.735 bisitz 7408: color: #999999;
1.532 albertel 7409: }
7410:
1.794 www 7411: .LC_discussion {
1.1050 www 7412: background: $data_table_dark;
1.911 bisitz 7413: border: 1px solid black;
7414: margin: 2px;
1.794 www 7415: }
7416:
7417: .LC_disc_action_left {
1.1050 www 7418: background: $sidebg;
1.911 bisitz 7419: text-align: left;
1.1050 www 7420: padding: 4px;
7421: margin: 2px;
1.794 www 7422: }
7423:
7424: .LC_disc_action_right {
1.1050 www 7425: background: $sidebg;
1.911 bisitz 7426: text-align: right;
1.1050 www 7427: padding: 4px;
7428: margin: 2px;
1.794 www 7429: }
7430:
7431: .LC_disc_new_item {
1.911 bisitz 7432: background: white;
7433: border: 2px solid red;
1.1050 www 7434: margin: 4px;
7435: padding: 4px;
1.794 www 7436: }
7437:
7438: .LC_disc_old_item {
1.911 bisitz 7439: background: white;
1.1050 www 7440: margin: 4px;
7441: padding: 4px;
1.794 www 7442: }
7443:
1.458 albertel 7444: table.LC_pastsubmission {
7445: border: 1px solid black;
7446: margin: 2px;
7447: }
7448:
1.924 bisitz 7449: table#LC_menubuttons {
1.345 albertel 7450: width: 100%;
7451: background: $pgbg;
1.392 albertel 7452: border: 2px;
1.402 albertel 7453: border-collapse: separate;
1.803 bisitz 7454: padding: 0;
1.345 albertel 7455: }
1.392 albertel 7456:
1.801 tempelho 7457: table#LC_title_bar a {
7458: color: $fontmenu;
7459: }
1.836 bisitz 7460:
1.807 droeschl 7461: table#LC_title_bar {
1.819 tempelho 7462: clear: both;
1.836 bisitz 7463: display: none;
1.807 droeschl 7464: }
7465:
1.795 www 7466: table#LC_title_bar,
1.933 droeschl 7467: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7468: table#LC_title_bar.LC_with_remote {
1.359 albertel 7469: width: 100%;
1.392 albertel 7470: border-color: $pgbg;
7471: border-style: solid;
7472: border-width: $border;
1.379 albertel 7473: background: $pgbg;
1.801 tempelho 7474: color: $fontmenu;
1.392 albertel 7475: border-collapse: collapse;
1.803 bisitz 7476: padding: 0;
1.819 tempelho 7477: margin: 0;
1.359 albertel 7478: }
1.795 www 7479:
1.933 droeschl 7480: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7481: margin: 0;
7482: padding: 0;
1.933 droeschl 7483: position: relative;
7484: list-style: none;
1.913 droeschl 7485: }
1.933 droeschl 7486: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7487: display: inline;
7488: }
1.933 droeschl 7489:
7490: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7491: padding: 0;
1.933 droeschl 7492: margin: 0;
7493: float: left;
1.913 droeschl 7494: }
1.933 droeschl 7495: .LC_breadcrumb_tools_tools {
7496: padding: 0;
7497: margin: 0;
1.913 droeschl 7498: float: right;
7499: }
7500:
1.1240 raeburn 7501: .LC_placement_prog {
7502: padding-right: 20px;
7503: font-weight: bold;
7504: font-size: 90%;
7505: }
7506:
1.359 albertel 7507: table#LC_title_bar td {
7508: background: $tabbg;
7509: }
1.795 www 7510:
1.911 bisitz 7511: table#LC_menubuttons img {
1.803 bisitz 7512: border: none;
1.346 albertel 7513: }
1.795 www 7514:
1.842 droeschl 7515: .LC_breadcrumbs_component {
1.911 bisitz 7516: float: right;
7517: margin: 0 1em;
1.357 albertel 7518: }
1.842 droeschl 7519: .LC_breadcrumbs_component img {
1.911 bisitz 7520: vertical-align: middle;
1.777 tempelho 7521: }
1.795 www 7522:
1.1243 raeburn 7523: .LC_breadcrumbs_hoverable {
7524: background: $sidebg;
7525: }
7526:
1.383 albertel 7527: td.LC_table_cell_checkbox {
7528: text-align: center;
7529: }
1.795 www 7530:
7531: .LC_fontsize_small {
1.911 bisitz 7532: font-size: 70%;
1.705 tempelho 7533: }
7534:
1.844 bisitz 7535: #LC_breadcrumbs {
1.911 bisitz 7536: clear:both;
7537: background: $sidebg;
7538: border-bottom: 1px solid $lg_border_color;
7539: line-height: 2.5em;
1.933 droeschl 7540: overflow: hidden;
1.911 bisitz 7541: margin: 0;
7542: padding: 0;
1.995 raeburn 7543: text-align: left;
1.819 tempelho 7544: }
1.862 bisitz 7545:
1.1098 bisitz 7546: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7547: clear:both;
7548: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7549: border: 1px solid $sidebg;
1.1098 bisitz 7550: margin: 0 0 10px 0;
1.966 bisitz 7551: padding: 3px;
1.995 raeburn 7552: text-align: left;
1.822 bisitz 7553: }
7554:
1.795 www 7555: .LC_fontsize_medium {
1.911 bisitz 7556: font-size: 85%;
1.705 tempelho 7557: }
7558:
1.795 www 7559: .LC_fontsize_large {
1.911 bisitz 7560: font-size: 120%;
1.705 tempelho 7561: }
7562:
1.346 albertel 7563: .LC_menubuttons_inline_text {
7564: color: $font;
1.698 harmsja 7565: font-size: 90%;
1.701 harmsja 7566: padding-left:3px;
1.346 albertel 7567: }
7568:
1.934 droeschl 7569: .LC_menubuttons_inline_text img{
7570: vertical-align: middle;
7571: }
7572:
1.1051 www 7573: li.LC_menubuttons_inline_text img {
1.951 onken 7574: cursor:pointer;
1.1002 droeschl 7575: text-decoration: none;
1.951 onken 7576: }
7577:
1.526 www 7578: .LC_menubuttons_link {
7579: text-decoration: none;
7580: }
1.795 www 7581:
1.522 albertel 7582: .LC_menubuttons_category {
1.521 www 7583: color: $font;
1.526 www 7584: background: $pgbg;
1.521 www 7585: font-size: larger;
7586: font-weight: bold;
7587: }
7588:
1.346 albertel 7589: td.LC_menubuttons_text {
1.911 bisitz 7590: color: $font;
1.346 albertel 7591: }
1.706 harmsja 7592:
1.346 albertel 7593: .LC_current_location {
7594: background: $tabbg;
7595: }
1.795 www 7596:
1.1286 raeburn 7597: td.LC_zero_height {
7598: line-height: 0;
7599: cellpadding: 0;
7600: }
7601:
1.938 bisitz 7602: table.LC_data_table {
1.347 albertel 7603: border: 1px solid #000000;
1.402 albertel 7604: border-collapse: separate;
1.426 albertel 7605: border-spacing: 1px;
1.610 albertel 7606: background: $pgbg;
1.347 albertel 7607: }
1.795 www 7608:
1.422 albertel 7609: .LC_data_table_dense {
7610: font-size: small;
7611: }
1.795 www 7612:
1.507 raeburn 7613: table.LC_nested_outer {
7614: border: 1px solid #000000;
1.589 raeburn 7615: border-collapse: collapse;
1.803 bisitz 7616: border-spacing: 0;
1.507 raeburn 7617: width: 100%;
7618: }
1.795 www 7619:
1.879 raeburn 7620: table.LC_innerpickbox,
1.507 raeburn 7621: table.LC_nested {
1.803 bisitz 7622: border: none;
1.589 raeburn 7623: border-collapse: collapse;
1.803 bisitz 7624: border-spacing: 0;
1.507 raeburn 7625: width: 100%;
7626: }
1.795 www 7627:
1.911 bisitz 7628: table.LC_data_table tr th,
7629: table.LC_calendar tr th,
1.879 raeburn 7630: table.LC_prior_tries tr th,
7631: table.LC_innerpickbox tr th {
1.349 albertel 7632: font-weight: bold;
7633: background-color: $data_table_head;
1.801 tempelho 7634: color:$fontmenu;
1.701 harmsja 7635: font-size:90%;
1.347 albertel 7636: }
1.795 www 7637:
1.879 raeburn 7638: table.LC_innerpickbox tr th,
7639: table.LC_innerpickbox tr td {
7640: vertical-align: top;
7641: }
7642:
1.711 raeburn 7643: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7644: background-color: #CCCCCC;
1.711 raeburn 7645: font-weight: bold;
7646: text-align: left;
7647: }
1.795 www 7648:
1.912 bisitz 7649: table.LC_data_table tr.LC_odd_row > td {
7650: background-color: $data_table_light;
7651: padding: 2px;
7652: vertical-align: top;
7653: }
7654:
1.809 bisitz 7655: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7656: background-color: $data_table_light;
1.912 bisitz 7657: vertical-align: top;
7658: }
7659:
7660: table.LC_data_table tr.LC_even_row > td {
7661: background-color: $data_table_dark;
1.425 albertel 7662: padding: 2px;
1.900 bisitz 7663: vertical-align: top;
1.347 albertel 7664: }
1.795 www 7665:
1.809 bisitz 7666: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7667: background-color: $data_table_dark;
1.900 bisitz 7668: vertical-align: top;
1.347 albertel 7669: }
1.795 www 7670:
1.425 albertel 7671: table.LC_data_table tr.LC_data_table_highlight td {
7672: background-color: $data_table_darker;
7673: }
1.795 www 7674:
1.639 raeburn 7675: table.LC_data_table tr td.LC_leftcol_header {
7676: background-color: $data_table_head;
7677: font-weight: bold;
7678: }
1.795 www 7679:
1.451 albertel 7680: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7681: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7682: font-weight: bold;
7683: font-style: italic;
7684: text-align: center;
7685: padding: 8px;
1.347 albertel 7686: }
1.795 www 7687:
1.1114 raeburn 7688: table.LC_data_table tr.LC_empty_row td,
7689: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7690: background-color: $sidebg;
7691: }
7692:
7693: table.LC_nested tr.LC_empty_row td {
7694: background-color: #FFFFFF;
7695: }
7696:
1.890 droeschl 7697: table.LC_caption {
7698: }
7699:
1.507 raeburn 7700: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7701: padding: 4ex
7702: }
1.795 www 7703:
1.507 raeburn 7704: table.LC_nested_outer tr th {
7705: font-weight: bold;
1.801 tempelho 7706: color:$fontmenu;
1.507 raeburn 7707: background-color: $data_table_head;
1.701 harmsja 7708: font-size: small;
1.507 raeburn 7709: border-bottom: 1px solid #000000;
7710: }
1.795 www 7711:
1.507 raeburn 7712: table.LC_nested_outer tr td.LC_subheader {
7713: background-color: $data_table_head;
7714: font-weight: bold;
7715: font-size: small;
7716: border-bottom: 1px solid #000000;
7717: text-align: right;
1.451 albertel 7718: }
1.795 www 7719:
1.507 raeburn 7720: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7721: background-color: #CCCCCC;
1.451 albertel 7722: font-weight: bold;
7723: font-size: small;
1.507 raeburn 7724: text-align: center;
7725: }
1.795 www 7726:
1.589 raeburn 7727: table.LC_nested tr.LC_info_row td.LC_left_item,
7728: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7729: text-align: left;
1.451 albertel 7730: }
1.795 www 7731:
1.507 raeburn 7732: table.LC_nested td {
1.735 bisitz 7733: background-color: #FFFFFF;
1.451 albertel 7734: font-size: small;
1.507 raeburn 7735: }
1.795 www 7736:
1.507 raeburn 7737: table.LC_nested_outer tr th.LC_right_item,
7738: table.LC_nested tr.LC_info_row td.LC_right_item,
7739: table.LC_nested tr.LC_odd_row td.LC_right_item,
7740: table.LC_nested tr td.LC_right_item {
1.451 albertel 7741: text-align: right;
7742: }
7743:
1.507 raeburn 7744: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7745: background-color: #EEEEEE;
1.451 albertel 7746: }
7747:
1.473 raeburn 7748: table.LC_createuser {
7749: }
7750:
7751: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7752: font-size: small;
1.473 raeburn 7753: }
7754:
7755: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7756: background-color: #CCCCCC;
1.473 raeburn 7757: font-weight: bold;
7758: text-align: center;
7759: }
7760:
1.349 albertel 7761: table.LC_calendar {
7762: border: 1px solid #000000;
7763: border-collapse: collapse;
1.917 raeburn 7764: width: 98%;
1.349 albertel 7765: }
1.795 www 7766:
1.349 albertel 7767: table.LC_calendar_pickdate {
7768: font-size: xx-small;
7769: }
1.795 www 7770:
1.349 albertel 7771: table.LC_calendar tr td {
7772: border: 1px solid #000000;
7773: vertical-align: top;
1.917 raeburn 7774: width: 14%;
1.349 albertel 7775: }
1.795 www 7776:
1.349 albertel 7777: table.LC_calendar tr td.LC_calendar_day_empty {
7778: background-color: $data_table_dark;
7779: }
1.795 www 7780:
1.779 bisitz 7781: table.LC_calendar tr td.LC_calendar_day_current {
7782: background-color: $data_table_highlight;
1.777 tempelho 7783: }
1.795 www 7784:
1.938 bisitz 7785: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7786: background-color: $mail_new;
7787: }
1.795 www 7788:
1.938 bisitz 7789: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7790: background-color: $mail_new_hover;
7791: }
1.795 www 7792:
1.938 bisitz 7793: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7794: background-color: $mail_read;
7795: }
1.795 www 7796:
1.938 bisitz 7797: /*
7798: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7799: background-color: $mail_read_hover;
7800: }
1.938 bisitz 7801: */
1.795 www 7802:
1.938 bisitz 7803: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7804: background-color: $mail_replied;
7805: }
1.795 www 7806:
1.938 bisitz 7807: /*
7808: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7809: background-color: $mail_replied_hover;
7810: }
1.938 bisitz 7811: */
1.795 www 7812:
1.938 bisitz 7813: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7814: background-color: $mail_other;
7815: }
1.795 www 7816:
1.938 bisitz 7817: /*
7818: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7819: background-color: $mail_other_hover;
7820: }
1.938 bisitz 7821: */
1.494 raeburn 7822:
1.777 tempelho 7823: table.LC_data_table tr > td.LC_browser_file,
7824: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7825: background: #AAEE77;
1.389 albertel 7826: }
1.795 www 7827:
1.777 tempelho 7828: table.LC_data_table tr > td.LC_browser_file_locked,
7829: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7830: background: #FFAA99;
1.387 albertel 7831: }
1.795 www 7832:
1.777 tempelho 7833: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7834: background: #888888;
1.779 bisitz 7835: }
1.795 www 7836:
1.777 tempelho 7837: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7838: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7839: background: #F8F866;
1.777 tempelho 7840: }
1.795 www 7841:
1.696 bisitz 7842: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7843: background: #E0E8FF;
1.387 albertel 7844: }
1.696 bisitz 7845:
1.707 bisitz 7846: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7847: /* background: #77FF77; */
1.707 bisitz 7848: }
1.795 www 7849:
1.707 bisitz 7850: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7851: border-right: 8px solid #FFFF77;
1.707 bisitz 7852: }
1.795 www 7853:
1.707 bisitz 7854: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7855: border-right: 8px solid #FFAA77;
1.707 bisitz 7856: }
1.795 www 7857:
1.707 bisitz 7858: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7859: border-right: 8px solid #FF7777;
1.707 bisitz 7860: }
1.795 www 7861:
1.707 bisitz 7862: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7863: border-right: 8px solid #AAFF77;
1.707 bisitz 7864: }
1.795 www 7865:
1.707 bisitz 7866: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7867: border-right: 8px solid #11CC55;
1.707 bisitz 7868: }
7869:
1.388 albertel 7870: span.LC_current_location {
1.701 harmsja 7871: font-size:larger;
1.388 albertel 7872: background: $pgbg;
7873: }
1.387 albertel 7874:
1.1029 www 7875: span.LC_current_nav_location {
7876: font-weight:bold;
7877: background: $sidebg;
7878: }
7879:
1.395 albertel 7880: span.LC_parm_menu_item {
7881: font-size: larger;
7882: }
1.795 www 7883:
1.395 albertel 7884: span.LC_parm_scope_all {
7885: color: red;
7886: }
1.795 www 7887:
1.395 albertel 7888: span.LC_parm_scope_folder {
7889: color: green;
7890: }
1.795 www 7891:
1.395 albertel 7892: span.LC_parm_scope_resource {
7893: color: orange;
7894: }
1.795 www 7895:
1.395 albertel 7896: span.LC_parm_part {
7897: color: blue;
7898: }
1.795 www 7899:
1.911 bisitz 7900: span.LC_parm_folder,
7901: span.LC_parm_symb {
1.395 albertel 7902: font-size: x-small;
7903: font-family: $mono;
7904: color: #AAAAAA;
7905: }
7906:
1.977 bisitz 7907: ul.LC_parm_parmlist li {
7908: display: inline-block;
7909: padding: 0.3em 0.8em;
7910: vertical-align: top;
7911: width: 150px;
7912: border-top:1px solid $lg_border_color;
7913: }
7914:
1.795 www 7915: td.LC_parm_overview_level_menu,
7916: td.LC_parm_overview_map_menu,
7917: td.LC_parm_overview_parm_selectors,
7918: td.LC_parm_overview_restrictions {
1.396 albertel 7919: border: 1px solid black;
7920: border-collapse: collapse;
7921: }
1.795 www 7922:
1.1285 raeburn 7923: span.LC_parm_recursive,
7924: td.LC_parm_recursive {
7925: font-weight: bold;
7926: font-size: smaller;
7927: }
7928:
1.396 albertel 7929: table.LC_parm_overview_restrictions td {
7930: border-width: 1px 4px 1px 4px;
7931: border-style: solid;
7932: border-color: $pgbg;
7933: text-align: center;
7934: }
1.795 www 7935:
1.396 albertel 7936: table.LC_parm_overview_restrictions th {
7937: background: $tabbg;
7938: border-width: 1px 4px 1px 4px;
7939: border-style: solid;
7940: border-color: $pgbg;
7941: }
1.795 www 7942:
1.398 albertel 7943: table#LC_helpmenu {
1.803 bisitz 7944: border: none;
1.398 albertel 7945: height: 55px;
1.803 bisitz 7946: border-spacing: 0;
1.398 albertel 7947: }
7948:
7949: table#LC_helpmenu fieldset legend {
7950: font-size: larger;
7951: }
1.795 www 7952:
1.397 albertel 7953: table#LC_helpmenu_links {
7954: width: 100%;
7955: border: 1px solid black;
7956: background: $pgbg;
1.803 bisitz 7957: padding: 0;
1.397 albertel 7958: border-spacing: 1px;
7959: }
1.795 www 7960:
1.397 albertel 7961: table#LC_helpmenu_links tr td {
7962: padding: 1px;
7963: background: $tabbg;
1.399 albertel 7964: text-align: center;
7965: font-weight: bold;
1.397 albertel 7966: }
1.396 albertel 7967:
1.795 www 7968: table#LC_helpmenu_links a:link,
7969: table#LC_helpmenu_links a:visited,
1.397 albertel 7970: table#LC_helpmenu_links a:active {
7971: text-decoration: none;
7972: color: $font;
7973: }
1.795 www 7974:
1.397 albertel 7975: table#LC_helpmenu_links a:hover {
7976: text-decoration: underline;
7977: color: $vlink;
7978: }
1.396 albertel 7979:
1.417 albertel 7980: .LC_chrt_popup_exists {
7981: border: 1px solid #339933;
7982: margin: -1px;
7983: }
1.795 www 7984:
1.417 albertel 7985: .LC_chrt_popup_up {
7986: border: 1px solid yellow;
7987: margin: -1px;
7988: }
1.795 www 7989:
1.417 albertel 7990: .LC_chrt_popup {
7991: border: 1px solid #8888FF;
7992: background: #CCCCFF;
7993: }
1.795 www 7994:
1.421 albertel 7995: table.LC_pick_box {
7996: border-collapse: separate;
7997: background: white;
7998: border: 1px solid black;
7999: border-spacing: 1px;
8000: }
1.795 www 8001:
1.421 albertel 8002: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8003: background: $sidebg;
1.421 albertel 8004: font-weight: bold;
1.900 bisitz 8005: text-align: left;
1.740 bisitz 8006: vertical-align: top;
1.421 albertel 8007: width: 184px;
8008: padding: 8px;
8009: }
1.795 www 8010:
1.579 raeburn 8011: table.LC_pick_box td.LC_pick_box_value {
8012: text-align: left;
8013: padding: 8px;
8014: }
1.795 www 8015:
1.579 raeburn 8016: table.LC_pick_box td.LC_pick_box_select {
8017: text-align: left;
8018: padding: 8px;
8019: }
1.795 www 8020:
1.424 albertel 8021: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8022: padding: 0;
1.421 albertel 8023: height: 1px;
8024: background: black;
8025: }
1.795 www 8026:
1.421 albertel 8027: table.LC_pick_box td.LC_pick_box_submit {
8028: text-align: right;
8029: }
1.795 www 8030:
1.579 raeburn 8031: table.LC_pick_box td.LC_evenrow_value {
8032: text-align: left;
8033: padding: 8px;
8034: background-color: $data_table_light;
8035: }
1.795 www 8036:
1.579 raeburn 8037: table.LC_pick_box td.LC_oddrow_value {
8038: text-align: left;
8039: padding: 8px;
8040: background-color: $data_table_light;
8041: }
1.795 www 8042:
1.579 raeburn 8043: span.LC_helpform_receipt_cat {
8044: font-weight: bold;
8045: }
1.795 www 8046:
1.424 albertel 8047: table.LC_group_priv_box {
8048: background: white;
8049: border: 1px solid black;
8050: border-spacing: 1px;
8051: }
1.795 www 8052:
1.424 albertel 8053: table.LC_group_priv_box td.LC_pick_box_title {
8054: background: $tabbg;
8055: font-weight: bold;
8056: text-align: right;
8057: width: 184px;
8058: }
1.795 www 8059:
1.424 albertel 8060: table.LC_group_priv_box td.LC_groups_fixed {
8061: background: $data_table_light;
8062: text-align: center;
8063: }
1.795 www 8064:
1.424 albertel 8065: table.LC_group_priv_box td.LC_groups_optional {
8066: background: $data_table_dark;
8067: text-align: center;
8068: }
1.795 www 8069:
1.424 albertel 8070: table.LC_group_priv_box td.LC_groups_functionality {
8071: background: $data_table_darker;
8072: text-align: center;
8073: font-weight: bold;
8074: }
1.795 www 8075:
1.424 albertel 8076: table.LC_group_priv td {
8077: text-align: left;
1.803 bisitz 8078: padding: 0;
1.424 albertel 8079: }
8080:
8081: .LC_navbuttons {
8082: margin: 2ex 0ex 2ex 0ex;
8083: }
1.795 www 8084:
1.423 albertel 8085: .LC_topic_bar {
8086: font-weight: bold;
8087: background: $tabbg;
1.918 wenzelju 8088: margin: 1em 0em 1em 2em;
1.805 bisitz 8089: padding: 3px;
1.918 wenzelju 8090: font-size: 1.2em;
1.423 albertel 8091: }
1.795 www 8092:
1.423 albertel 8093: .LC_topic_bar span {
1.918 wenzelju 8094: left: 0.5em;
8095: position: absolute;
1.423 albertel 8096: vertical-align: middle;
1.918 wenzelju 8097: font-size: 1.2em;
1.423 albertel 8098: }
1.795 www 8099:
1.423 albertel 8100: table.LC_course_group_status {
8101: margin: 20px;
8102: }
1.795 www 8103:
1.423 albertel 8104: table.LC_status_selector td {
8105: vertical-align: top;
8106: text-align: center;
1.424 albertel 8107: padding: 4px;
8108: }
1.795 www 8109:
1.599 albertel 8110: div.LC_feedback_link {
1.616 albertel 8111: clear: both;
1.829 kalberla 8112: background: $sidebg;
1.779 bisitz 8113: width: 100%;
1.829 kalberla 8114: padding-bottom: 10px;
8115: border: 1px $tabbg solid;
1.833 kalberla 8116: height: 22px;
8117: line-height: 22px;
8118: padding-top: 5px;
8119: }
8120:
8121: div.LC_feedback_link img {
8122: height: 22px;
1.867 kalberla 8123: vertical-align:middle;
1.829 kalberla 8124: }
8125:
1.911 bisitz 8126: div.LC_feedback_link a {
1.829 kalberla 8127: text-decoration: none;
1.489 raeburn 8128: }
1.795 www 8129:
1.867 kalberla 8130: div.LC_comblock {
1.911 bisitz 8131: display:inline;
1.867 kalberla 8132: color:$font;
8133: font-size:90%;
8134: }
8135:
8136: div.LC_feedback_link div.LC_comblock {
8137: padding-left:5px;
8138: }
8139:
8140: div.LC_feedback_link div.LC_comblock a {
8141: color:$font;
8142: }
8143:
1.489 raeburn 8144: span.LC_feedback_link {
1.858 bisitz 8145: /* background: $feedback_link_bg; */
1.599 albertel 8146: font-size: larger;
8147: }
1.795 www 8148:
1.599 albertel 8149: span.LC_message_link {
1.858 bisitz 8150: /* background: $feedback_link_bg; */
1.599 albertel 8151: font-size: larger;
8152: position: absolute;
8153: right: 1em;
1.489 raeburn 8154: }
1.421 albertel 8155:
1.515 albertel 8156: table.LC_prior_tries {
1.524 albertel 8157: border: 1px solid #000000;
8158: border-collapse: separate;
8159: border-spacing: 1px;
1.515 albertel 8160: }
1.523 albertel 8161:
1.515 albertel 8162: table.LC_prior_tries td {
1.524 albertel 8163: padding: 2px;
1.515 albertel 8164: }
1.523 albertel 8165:
8166: .LC_answer_correct {
1.795 www 8167: background: lightgreen;
8168: color: darkgreen;
8169: padding: 6px;
1.523 albertel 8170: }
1.795 www 8171:
1.523 albertel 8172: .LC_answer_charged_try {
1.797 www 8173: background: #FFAAAA;
1.795 www 8174: color: darkred;
8175: padding: 6px;
1.523 albertel 8176: }
1.795 www 8177:
1.779 bisitz 8178: .LC_answer_not_charged_try,
1.523 albertel 8179: .LC_answer_no_grade,
8180: .LC_answer_late {
1.795 www 8181: background: lightyellow;
1.523 albertel 8182: color: black;
1.795 www 8183: padding: 6px;
1.523 albertel 8184: }
1.795 www 8185:
1.523 albertel 8186: .LC_answer_previous {
1.795 www 8187: background: lightblue;
8188: color: darkblue;
8189: padding: 6px;
1.523 albertel 8190: }
1.795 www 8191:
1.779 bisitz 8192: .LC_answer_no_message {
1.777 tempelho 8193: background: #FFFFFF;
8194: color: black;
1.795 www 8195: padding: 6px;
1.779 bisitz 8196: }
1.795 www 8197:
1.1334 raeburn 8198: .LC_answer_unknown,
8199: .LC_answer_warning {
1.779 bisitz 8200: background: orange;
8201: color: black;
1.795 www 8202: padding: 6px;
1.777 tempelho 8203: }
1.795 www 8204:
1.529 albertel 8205: span.LC_prior_numerical,
8206: span.LC_prior_string,
8207: span.LC_prior_custom,
8208: span.LC_prior_reaction,
8209: span.LC_prior_math {
1.925 bisitz 8210: font-family: $mono;
1.523 albertel 8211: white-space: pre;
8212: }
8213:
1.525 albertel 8214: span.LC_prior_string {
1.925 bisitz 8215: font-family: $mono;
1.525 albertel 8216: white-space: pre;
8217: }
8218:
1.523 albertel 8219: table.LC_prior_option {
8220: width: 100%;
8221: border-collapse: collapse;
8222: }
1.795 www 8223:
1.911 bisitz 8224: table.LC_prior_rank,
1.795 www 8225: table.LC_prior_match {
1.528 albertel 8226: border-collapse: collapse;
8227: }
1.795 www 8228:
1.528 albertel 8229: table.LC_prior_option tr td,
8230: table.LC_prior_rank tr td,
8231: table.LC_prior_match tr td {
1.524 albertel 8232: border: 1px solid #000000;
1.515 albertel 8233: }
8234:
1.855 bisitz 8235: .LC_nobreak {
1.544 albertel 8236: white-space: nowrap;
1.519 raeburn 8237: }
8238:
1.576 raeburn 8239: span.LC_cusr_emph {
8240: font-style: italic;
8241: }
8242:
1.633 raeburn 8243: span.LC_cusr_subheading {
8244: font-weight: normal;
8245: font-size: 85%;
8246: }
8247:
1.861 bisitz 8248: div.LC_docs_entry_move {
1.859 bisitz 8249: border: 1px solid #BBBBBB;
1.545 albertel 8250: background: #DDDDDD;
1.861 bisitz 8251: width: 22px;
1.859 bisitz 8252: padding: 1px;
8253: margin: 0;
1.545 albertel 8254: }
8255:
1.861 bisitz 8256: table.LC_data_table tr > td.LC_docs_entry_commands,
8257: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8258: font-size: x-small;
8259: }
1.795 www 8260:
1.861 bisitz 8261: .LC_docs_entry_parameter {
8262: white-space: nowrap;
8263: }
8264:
1.544 albertel 8265: .LC_docs_copy {
1.545 albertel 8266: color: #000099;
1.544 albertel 8267: }
1.795 www 8268:
1.544 albertel 8269: .LC_docs_cut {
1.545 albertel 8270: color: #550044;
1.544 albertel 8271: }
1.795 www 8272:
1.544 albertel 8273: .LC_docs_rename {
1.545 albertel 8274: color: #009900;
1.544 albertel 8275: }
1.795 www 8276:
1.544 albertel 8277: .LC_docs_remove {
1.545 albertel 8278: color: #990000;
8279: }
8280:
1.1284 raeburn 8281: .LC_docs_alias {
8282: color: #440055;
8283: }
8284:
1.1286 raeburn 8285: .LC_domprefs_email,
1.1284 raeburn 8286: .LC_docs_alias_name,
1.547 albertel 8287: .LC_docs_reinit_warn,
8288: .LC_docs_ext_edit {
8289: font-size: x-small;
8290: }
8291:
1.545 albertel 8292: table.LC_docs_adddocs td,
8293: table.LC_docs_adddocs th {
8294: border: 1px solid #BBBBBB;
8295: padding: 4px;
8296: background: #DDDDDD;
1.543 albertel 8297: }
8298:
1.584 albertel 8299: table.LC_sty_begin {
8300: background: #BBFFBB;
8301: }
1.795 www 8302:
1.584 albertel 8303: table.LC_sty_end {
8304: background: #FFBBBB;
8305: }
8306:
1.589 raeburn 8307: table.LC_double_column {
1.803 bisitz 8308: border-width: 0;
1.589 raeburn 8309: border-collapse: collapse;
8310: width: 100%;
8311: padding: 2px;
8312: }
8313:
8314: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8315: top: 2px;
1.589 raeburn 8316: left: 2px;
8317: width: 47%;
8318: vertical-align: top;
8319: }
8320:
8321: table.LC_double_column tr td.LC_right_col {
8322: top: 2px;
1.779 bisitz 8323: right: 2px;
1.589 raeburn 8324: width: 47%;
8325: vertical-align: top;
8326: }
8327:
1.591 raeburn 8328: div.LC_left_float {
8329: float: left;
8330: padding-right: 5%;
1.597 albertel 8331: padding-bottom: 4px;
1.591 raeburn 8332: }
8333:
8334: div.LC_clear_float_header {
1.597 albertel 8335: padding-bottom: 2px;
1.591 raeburn 8336: }
8337:
8338: div.LC_clear_float_footer {
1.597 albertel 8339: padding-top: 10px;
1.591 raeburn 8340: clear: both;
8341: }
8342:
1.597 albertel 8343: div.LC_grade_show_user {
1.941 bisitz 8344: /* border-left: 5px solid $sidebg; */
8345: border-top: 5px solid #000000;
8346: margin: 50px 0 0 0;
1.936 bisitz 8347: padding: 15px 0 5px 10px;
1.597 albertel 8348: }
1.795 www 8349:
1.936 bisitz 8350: div.LC_grade_show_user_odd_row {
1.941 bisitz 8351: /* border-left: 5px solid #000000; */
8352: }
8353:
8354: div.LC_grade_show_user div.LC_Box {
8355: margin-right: 50px;
1.597 albertel 8356: }
8357:
8358: div.LC_grade_submissions,
8359: div.LC_grade_message_center,
1.936 bisitz 8360: div.LC_grade_info_links {
1.597 albertel 8361: margin: 5px;
8362: width: 99%;
8363: background: #FFFFFF;
8364: }
1.795 www 8365:
1.597 albertel 8366: div.LC_grade_submissions_header,
1.936 bisitz 8367: div.LC_grade_message_center_header {
1.705 tempelho 8368: font-weight: bold;
8369: font-size: large;
1.597 albertel 8370: }
1.795 www 8371:
1.597 albertel 8372: div.LC_grade_submissions_body,
1.936 bisitz 8373: div.LC_grade_message_center_body {
1.597 albertel 8374: border: 1px solid black;
8375: width: 99%;
8376: background: #FFFFFF;
8377: }
1.795 www 8378:
1.613 albertel 8379: table.LC_scantron_action {
8380: width: 100%;
8381: }
1.795 www 8382:
1.613 albertel 8383: table.LC_scantron_action tr th {
1.698 harmsja 8384: font-weight:bold;
8385: font-style:normal;
1.613 albertel 8386: }
1.795 www 8387:
1.779 bisitz 8388: .LC_edit_problem_header,
1.614 albertel 8389: div.LC_edit_problem_footer {
1.705 tempelho 8390: font-weight: normal;
8391: font-size: medium;
1.602 albertel 8392: margin: 2px;
1.1060 bisitz 8393: background-color: $sidebg;
1.600 albertel 8394: }
1.795 www 8395:
1.600 albertel 8396: div.LC_edit_problem_header,
1.602 albertel 8397: div.LC_edit_problem_header div,
1.614 albertel 8398: div.LC_edit_problem_footer,
8399: div.LC_edit_problem_footer div,
1.602 albertel 8400: div.LC_edit_problem_editxml_header,
8401: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8402: z-index: 100;
1.600 albertel 8403: }
1.795 www 8404:
1.600 albertel 8405: div.LC_edit_problem_header_title {
1.705 tempelho 8406: font-weight: bold;
8407: font-size: larger;
1.602 albertel 8408: background: $tabbg;
8409: padding: 3px;
1.1060 bisitz 8410: margin: 0 0 5px 0;
1.602 albertel 8411: }
1.795 www 8412:
1.602 albertel 8413: table.LC_edit_problem_header_title {
8414: width: 100%;
1.600 albertel 8415: background: $tabbg;
1.602 albertel 8416: }
8417:
1.1205 golterma 8418: div.LC_edit_actionbar {
8419: background-color: $sidebg;
1.1218 droeschl 8420: margin: 0;
8421: padding: 0;
8422: line-height: 200%;
1.602 albertel 8423: }
1.795 www 8424:
1.1218 droeschl 8425: div.LC_edit_actionbar div{
8426: padding: 0;
8427: margin: 0;
8428: display: inline-block;
1.600 albertel 8429: }
1.795 www 8430:
1.1124 bisitz 8431: .LC_edit_opt {
8432: padding-left: 1em;
8433: white-space: nowrap;
8434: }
8435:
1.1152 golterma 8436: .LC_edit_problem_latexhelper{
8437: text-align: right;
8438: }
8439:
8440: #LC_edit_problem_colorful div{
8441: margin-left: 40px;
8442: }
8443:
1.1205 golterma 8444: #LC_edit_problem_codemirror div{
8445: margin-left: 0px;
8446: }
8447:
1.911 bisitz 8448: img.stift {
1.803 bisitz 8449: border-width: 0;
8450: vertical-align: middle;
1.677 riegler 8451: }
1.680 riegler 8452:
1.923 bisitz 8453: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8454: vertical-align: top;
1.777 tempelho 8455: }
1.795 www 8456:
1.716 raeburn 8457: div.LC_createcourse {
1.911 bisitz 8458: margin: 10px 10px 10px 10px;
1.716 raeburn 8459: }
8460:
1.917 raeburn 8461: .LC_dccid {
1.1130 raeburn 8462: float: right;
1.917 raeburn 8463: margin: 0.2em 0 0 0;
8464: padding: 0;
8465: font-size: 90%;
8466: display:none;
8467: }
8468:
1.897 wenzelju 8469: ol.LC_primary_menu a:hover,
1.721 harmsja 8470: ol#LC_MenuBreadcrumbs a:hover,
8471: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8472: ul#LC_secondary_menu a:hover,
1.721 harmsja 8473: .LC_FormSectionClearButton input:hover
1.795 www 8474: ul.LC_TabContent li:hover a {
1.952 onken 8475: color:$button_hover;
1.911 bisitz 8476: text-decoration:none;
1.693 droeschl 8477: }
8478:
1.779 bisitz 8479: h1 {
1.911 bisitz 8480: padding: 0;
8481: line-height:130%;
1.693 droeschl 8482: }
1.698 harmsja 8483:
1.911 bisitz 8484: h2,
8485: h3,
8486: h4,
8487: h5,
8488: h6 {
8489: margin: 5px 0 5px 0;
8490: padding: 0;
8491: line-height:130%;
1.693 droeschl 8492: }
1.795 www 8493:
8494: .LC_hcell {
1.911 bisitz 8495: padding:3px 15px 3px 15px;
8496: margin: 0;
8497: background-color:$tabbg;
8498: color:$fontmenu;
8499: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8500: }
1.795 www 8501:
1.840 bisitz 8502: .LC_Box > .LC_hcell {
1.911 bisitz 8503: margin: 0 -10px 10px -10px;
1.835 bisitz 8504: }
8505:
1.721 harmsja 8506: .LC_noBorder {
1.911 bisitz 8507: border: 0;
1.698 harmsja 8508: }
1.693 droeschl 8509:
1.721 harmsja 8510: .LC_FormSectionClearButton input {
1.911 bisitz 8511: background-color:transparent;
8512: border: none;
8513: cursor:pointer;
8514: text-decoration:underline;
1.693 droeschl 8515: }
1.763 bisitz 8516:
8517: .LC_help_open_topic {
1.911 bisitz 8518: color: #FFFFFF;
8519: background-color: #EEEEFF;
8520: margin: 1px;
8521: padding: 4px;
8522: border: 1px solid #000033;
8523: white-space: nowrap;
8524: /* vertical-align: middle; */
1.759 neumanie 8525: }
1.693 droeschl 8526:
1.911 bisitz 8527: dl,
8528: ul,
8529: div,
8530: fieldset {
8531: margin: 10px 10px 10px 0;
8532: /* overflow: hidden; */
1.693 droeschl 8533: }
1.795 www 8534:
1.1404 raeburn 8535: fieldset#LC_selectuser {
8536: margin: 0;
8537: padding: 0;
8538: }
8539:
1.1211 raeburn 8540: article.geogebraweb div {
8541: margin: 0;
8542: }
8543:
1.838 bisitz 8544: fieldset > legend {
1.911 bisitz 8545: font-weight: bold;
8546: padding: 0 5px 0 5px;
1.838 bisitz 8547: }
8548:
1.813 bisitz 8549: #LC_nav_bar {
1.911 bisitz 8550: float: left;
1.995 raeburn 8551: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8552: margin: 0 0 2px 0;
1.807 droeschl 8553: }
8554:
1.916 droeschl 8555: #LC_realm {
8556: margin: 0.2em 0 0 0;
8557: padding: 0;
8558: font-weight: bold;
8559: text-align: center;
1.995 raeburn 8560: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8561: }
8562:
1.911 bisitz 8563: #LC_nav_bar em {
8564: font-weight: bold;
8565: font-style: normal;
1.807 droeschl 8566: }
8567:
1.897 wenzelju 8568: ol.LC_primary_menu {
1.934 droeschl 8569: margin: 0;
1.1076 raeburn 8570: padding: 0;
1.807 droeschl 8571: }
8572:
1.852 droeschl 8573: ol#LC_PathBreadcrumbs {
1.911 bisitz 8574: margin: 0;
1.693 droeschl 8575: }
8576:
1.897 wenzelju 8577: ol.LC_primary_menu li {
1.1076 raeburn 8578: color: RGB(80, 80, 80);
8579: vertical-align: middle;
8580: text-align: left;
8581: list-style: none;
1.1205 golterma 8582: position: relative;
1.1076 raeburn 8583: float: left;
1.1205 golterma 8584: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8585: line-height: 1.5em;
1.1076 raeburn 8586: }
8587:
1.1205 golterma 8588: ol.LC_primary_menu li a,
8589: ol.LC_primary_menu li p {
1.1076 raeburn 8590: display: block;
8591: margin: 0;
8592: padding: 0 5px 0 10px;
8593: text-decoration: none;
8594: }
8595:
1.1205 golterma 8596: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8597: display: inline-block;
8598: width: 95%;
8599: text-align: left;
8600: }
8601:
8602: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8603: display: inline-block;
8604: width: 5%;
8605: float: right;
8606: text-align: right;
8607: font-size: 70%;
8608: }
8609:
8610: ol.LC_primary_menu ul {
1.1076 raeburn 8611: display: none;
1.1205 golterma 8612: width: 15em;
1.1076 raeburn 8613: background-color: $data_table_light;
1.1205 golterma 8614: position: absolute;
8615: top: 100%;
1.1076 raeburn 8616: }
8617:
1.1205 golterma 8618: ol.LC_primary_menu ul ul {
8619: left: 100%;
8620: top: 0;
8621: }
8622:
8623: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8624: display: block;
8625: position: absolute;
8626: margin: 0;
8627: padding: 0;
1.1078 raeburn 8628: z-index: 2;
1.1076 raeburn 8629: }
8630:
8631: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8632: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8633: font-size: 90%;
1.911 bisitz 8634: vertical-align: top;
1.1076 raeburn 8635: float: none;
1.1079 raeburn 8636: border-left: 1px solid black;
8637: border-right: 1px solid black;
1.1205 golterma 8638: /* A dark bottom border to visualize different menu options;
8639: overwritten in the create_submenu routine for the last border-bottom of the menu */
8640: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8641: }
8642:
1.1205 golterma 8643: ol.LC_primary_menu li li p:hover {
8644: color:$button_hover;
8645: text-decoration:none;
8646: background-color:$data_table_dark;
1.1076 raeburn 8647: }
8648:
8649: ol.LC_primary_menu li li a:hover {
8650: color:$button_hover;
8651: background-color:$data_table_dark;
1.693 droeschl 8652: }
8653:
1.1205 golterma 8654: /* Font-size equal to the size of the predecessors*/
8655: ol.LC_primary_menu li:hover li li {
8656: font-size: 100%;
8657: }
8658:
1.897 wenzelju 8659: ol.LC_primary_menu li img {
1.911 bisitz 8660: vertical-align: bottom;
1.934 droeschl 8661: height: 1.1em;
1.1077 raeburn 8662: margin: 0.2em 0 0 0;
1.693 droeschl 8663: }
8664:
1.897 wenzelju 8665: ol.LC_primary_menu a {
1.911 bisitz 8666: color: RGB(80, 80, 80);
8667: text-decoration: none;
1.693 droeschl 8668: }
1.795 www 8669:
1.949 droeschl 8670: ol.LC_primary_menu a.LC_new_message {
8671: font-weight:bold;
8672: color: darkred;
8673: }
8674:
1.975 raeburn 8675: ol.LC_docs_parameters {
8676: margin-left: 0;
8677: padding: 0;
8678: list-style: none;
8679: }
8680:
8681: ol.LC_docs_parameters li {
8682: margin: 0;
8683: padding-right: 20px;
8684: display: inline;
8685: }
8686:
1.976 raeburn 8687: ol.LC_docs_parameters li:before {
8688: content: "\\002022 \\0020";
8689: }
8690:
8691: li.LC_docs_parameters_title {
8692: font-weight: bold;
8693: }
8694:
8695: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8696: content: "";
8697: }
8698:
1.897 wenzelju 8699: ul#LC_secondary_menu {
1.1107 raeburn 8700: clear: right;
1.911 bisitz 8701: color: $fontmenu;
8702: background: $tabbg;
8703: list-style: none;
8704: padding: 0;
8705: margin: 0;
8706: width: 100%;
1.995 raeburn 8707: text-align: left;
1.1107 raeburn 8708: float: left;
1.808 droeschl 8709: }
8710:
1.897 wenzelju 8711: ul#LC_secondary_menu li {
1.911 bisitz 8712: font-weight: bold;
8713: line-height: 1.8em;
1.1107 raeburn 8714: border-right: 1px solid black;
8715: float: left;
8716: }
8717:
8718: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8719: background-color: $data_table_light;
8720: }
8721:
8722: ul#LC_secondary_menu li a {
1.911 bisitz 8723: padding: 0 0.8em;
1.1107 raeburn 8724: }
8725:
8726: ul#LC_secondary_menu li ul {
8727: display: none;
8728: }
8729:
8730: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8731: display: block;
8732: position: absolute;
8733: margin: 0;
8734: padding: 0;
8735: list-style:none;
8736: float: none;
8737: background-color: $data_table_light;
8738: z-index: 2;
8739: margin-left: -1px;
8740: }
8741:
8742: ul#LC_secondary_menu li ul li {
8743: font-size: 90%;
8744: vertical-align: top;
8745: border-left: 1px solid black;
1.911 bisitz 8746: border-right: 1px solid black;
1.1119 raeburn 8747: background-color: $data_table_light;
1.1107 raeburn 8748: list-style:none;
8749: float: none;
8750: }
8751:
8752: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8753: background-color: $data_table_dark;
1.807 droeschl 8754: }
8755:
1.847 tempelho 8756: ul.LC_TabContent {
1.911 bisitz 8757: display:block;
8758: background: $sidebg;
8759: border-bottom: solid 1px $lg_border_color;
8760: list-style:none;
1.1020 raeburn 8761: margin: -1px -10px 0 -10px;
1.911 bisitz 8762: padding: 0;
1.693 droeschl 8763: }
8764:
1.795 www 8765: ul.LC_TabContent li,
8766: ul.LC_TabContentBigger li {
1.911 bisitz 8767: float:left;
1.741 harmsja 8768: }
1.795 www 8769:
1.897 wenzelju 8770: ul#LC_secondary_menu li a {
1.911 bisitz 8771: color: $fontmenu;
8772: text-decoration: none;
1.693 droeschl 8773: }
1.795 www 8774:
1.721 harmsja 8775: ul.LC_TabContent {
1.952 onken 8776: min-height:20px;
1.721 harmsja 8777: }
1.795 www 8778:
8779: ul.LC_TabContent li {
1.911 bisitz 8780: vertical-align:middle;
1.959 onken 8781: padding: 0 16px 0 10px;
1.911 bisitz 8782: background-color:$tabbg;
8783: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8784: border-left: solid 1px $font;
1.721 harmsja 8785: }
1.795 www 8786:
1.847 tempelho 8787: ul.LC_TabContent .right {
1.911 bisitz 8788: float:right;
1.847 tempelho 8789: }
8790:
1.911 bisitz 8791: ul.LC_TabContent li a,
8792: ul.LC_TabContent li {
8793: color:rgb(47,47,47);
8794: text-decoration:none;
8795: font-size:95%;
8796: font-weight:bold;
1.952 onken 8797: min-height:20px;
8798: }
8799:
1.959 onken 8800: ul.LC_TabContent li a:hover,
8801: ul.LC_TabContent li a:focus {
1.952 onken 8802: color: $button_hover;
1.959 onken 8803: background:none;
8804: outline:none;
1.952 onken 8805: }
8806:
8807: ul.LC_TabContent li:hover {
8808: color: $button_hover;
8809: cursor:pointer;
1.721 harmsja 8810: }
1.795 www 8811:
1.911 bisitz 8812: ul.LC_TabContent li.active {
1.952 onken 8813: color: $font;
1.911 bisitz 8814: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8815: border-bottom:solid 1px #FFFFFF;
8816: cursor: default;
1.744 ehlerst 8817: }
1.795 www 8818:
1.959 onken 8819: ul.LC_TabContent li.active a {
8820: color:$font;
8821: background:#FFFFFF;
8822: outline: none;
8823: }
1.1047 raeburn 8824:
8825: ul.LC_TabContent li.goback {
8826: float: left;
8827: border-left: none;
8828: }
8829:
1.870 tempelho 8830: #maincoursedoc {
1.911 bisitz 8831: clear:both;
1.870 tempelho 8832: }
8833:
8834: ul.LC_TabContentBigger {
1.911 bisitz 8835: display:block;
8836: list-style:none;
8837: padding: 0;
1.870 tempelho 8838: }
8839:
1.795 www 8840: ul.LC_TabContentBigger li {
1.911 bisitz 8841: vertical-align:bottom;
8842: height: 30px;
8843: font-size:110%;
8844: font-weight:bold;
8845: color: #737373;
1.841 tempelho 8846: }
8847:
1.957 onken 8848: ul.LC_TabContentBigger li.active {
8849: position: relative;
8850: top: 1px;
8851: }
8852:
1.870 tempelho 8853: ul.LC_TabContentBigger li a {
1.911 bisitz 8854: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8855: height: 30px;
8856: line-height: 30px;
8857: text-align: center;
8858: display: block;
8859: text-decoration: none;
1.958 onken 8860: outline: none;
1.741 harmsja 8861: }
1.795 www 8862:
1.870 tempelho 8863: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8864: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8865: color:$font;
1.744 ehlerst 8866: }
1.795 www 8867:
1.870 tempelho 8868: ul.LC_TabContentBigger li b {
1.911 bisitz 8869: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8870: display: block;
8871: float: left;
8872: padding: 0 30px;
1.957 onken 8873: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8874: }
8875:
1.956 onken 8876: ul.LC_TabContentBigger li:hover b {
8877: color:$button_hover;
8878: }
8879:
1.870 tempelho 8880: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8881: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8882: color:$font;
1.957 onken 8883: border: 0;
1.741 harmsja 8884: }
1.693 droeschl 8885:
1.870 tempelho 8886:
1.862 bisitz 8887: ul.LC_CourseBreadcrumbs {
8888: background: $sidebg;
1.1020 raeburn 8889: height: 2em;
1.862 bisitz 8890: padding-left: 10px;
1.1020 raeburn 8891: margin: 0;
1.862 bisitz 8892: list-style-position: inside;
8893: }
8894:
1.911 bisitz 8895: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8896: ol#LC_PathBreadcrumbs {
1.911 bisitz 8897: padding-left: 10px;
8898: margin: 0;
1.933 droeschl 8899: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8900: }
8901:
1.911 bisitz 8902: ol#LC_MenuBreadcrumbs li,
8903: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8904: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8905: display: inline;
1.933 droeschl 8906: white-space: normal;
1.693 droeschl 8907: }
8908:
1.823 bisitz 8909: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8910: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8911: text-decoration: none;
8912: font-size:90%;
1.693 droeschl 8913: }
1.795 www 8914:
1.969 droeschl 8915: ol#LC_MenuBreadcrumbs h1 {
8916: display: inline;
8917: font-size: 90%;
8918: line-height: 2.5em;
8919: margin: 0;
8920: padding: 0;
8921: }
8922:
1.795 www 8923: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8924: text-decoration:none;
8925: font-size:100%;
8926: font-weight:bold;
1.693 droeschl 8927: }
1.795 www 8928:
1.840 bisitz 8929: .LC_Box {
1.911 bisitz 8930: border: solid 1px $lg_border_color;
8931: padding: 0 10px 10px 10px;
1.746 neumanie 8932: }
1.795 www 8933:
1.1020 raeburn 8934: .LC_DocsBox {
8935: border: solid 1px $lg_border_color;
8936: padding: 0 0 10px 10px;
8937: }
8938:
1.795 www 8939: .LC_AboutMe_Image {
1.911 bisitz 8940: float:left;
8941: margin-right:10px;
1.747 neumanie 8942: }
1.795 www 8943:
8944: .LC_Clear_AboutMe_Image {
1.911 bisitz 8945: clear:left;
1.747 neumanie 8946: }
1.795 www 8947:
1.721 harmsja 8948: dl.LC_ListStyleClean dt {
1.911 bisitz 8949: padding-right: 5px;
8950: display: table-header-group;
1.693 droeschl 8951: }
8952:
1.721 harmsja 8953: dl.LC_ListStyleClean dd {
1.911 bisitz 8954: display: table-row;
1.693 droeschl 8955: }
8956:
1.721 harmsja 8957: .LC_ListStyleClean,
8958: .LC_ListStyleSimple,
8959: .LC_ListStyleNormal,
1.795 www 8960: .LC_ListStyleSpecial {
1.911 bisitz 8961: /* display:block; */
8962: list-style-position: inside;
8963: list-style-type: none;
8964: overflow: hidden;
8965: padding: 0;
1.693 droeschl 8966: }
8967:
1.721 harmsja 8968: .LC_ListStyleSimple li,
8969: .LC_ListStyleSimple dd,
8970: .LC_ListStyleNormal li,
8971: .LC_ListStyleNormal dd,
8972: .LC_ListStyleSpecial li,
1.795 www 8973: .LC_ListStyleSpecial dd {
1.911 bisitz 8974: margin: 0;
8975: padding: 5px 5px 5px 10px;
8976: clear: both;
1.693 droeschl 8977: }
8978:
1.721 harmsja 8979: .LC_ListStyleClean li,
8980: .LC_ListStyleClean dd {
1.911 bisitz 8981: padding-top: 0;
8982: padding-bottom: 0;
1.693 droeschl 8983: }
8984:
1.721 harmsja 8985: .LC_ListStyleSimple dd,
1.795 www 8986: .LC_ListStyleSimple li {
1.911 bisitz 8987: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8988: }
8989:
1.721 harmsja 8990: .LC_ListStyleSpecial li,
8991: .LC_ListStyleSpecial dd {
1.911 bisitz 8992: list-style-type: none;
8993: background-color: RGB(220, 220, 220);
8994: margin-bottom: 4px;
1.693 droeschl 8995: }
8996:
1.721 harmsja 8997: table.LC_SimpleTable {
1.911 bisitz 8998: margin:5px;
8999: border:solid 1px $lg_border_color;
1.795 www 9000: }
1.693 droeschl 9001:
1.721 harmsja 9002: table.LC_SimpleTable tr {
1.911 bisitz 9003: padding: 0;
9004: border:solid 1px $lg_border_color;
1.693 droeschl 9005: }
1.795 www 9006:
9007: table.LC_SimpleTable thead {
1.911 bisitz 9008: background:rgb(220,220,220);
1.693 droeschl 9009: }
9010:
1.721 harmsja 9011: div.LC_columnSection {
1.911 bisitz 9012: display: block;
9013: clear: both;
9014: overflow: hidden;
9015: margin: 0;
1.693 droeschl 9016: }
9017:
1.721 harmsja 9018: div.LC_columnSection>* {
1.911 bisitz 9019: float: left;
9020: margin: 10px 20px 10px 0;
9021: overflow:hidden;
1.693 droeschl 9022: }
1.721 harmsja 9023:
1.795 www 9024: table em {
1.911 bisitz 9025: font-weight: bold;
9026: font-style: normal;
1.748 schulted 9027: }
1.795 www 9028:
1.779 bisitz 9029: table.LC_tableBrowseRes,
1.795 www 9030: table.LC_tableOfContent {
1.911 bisitz 9031: border:none;
9032: border-spacing: 1px;
9033: padding: 3px;
9034: background-color: #FFFFFF;
9035: font-size: 90%;
1.753 droeschl 9036: }
1.789 droeschl 9037:
1.911 bisitz 9038: table.LC_tableOfContent {
9039: border-collapse: collapse;
1.789 droeschl 9040: }
9041:
1.771 droeschl 9042: table.LC_tableBrowseRes a,
1.768 schulted 9043: table.LC_tableOfContent a {
1.911 bisitz 9044: background-color: transparent;
9045: text-decoration: none;
1.753 droeschl 9046: }
9047:
1.795 www 9048: table.LC_tableOfContent img {
1.911 bisitz 9049: border: none;
9050: height: 1.3em;
9051: vertical-align: text-bottom;
9052: margin-right: 0.3em;
1.753 droeschl 9053: }
1.757 schulted 9054:
1.795 www 9055: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9056: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9057: }
9058:
1.795 www 9059: a#LC_content_toolbar_everything {
1.911 bisitz 9060: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9061: }
9062:
1.795 www 9063: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9064: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9065: }
9066:
1.795 www 9067: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9068: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9069: }
9070:
1.795 www 9071: a#LC_content_toolbar_changefolder {
1.911 bisitz 9072: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9073: }
9074:
1.795 www 9075: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9076: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9077: }
9078:
1.1043 raeburn 9079: a#LC_content_toolbar_edittoplevel {
9080: background-image:url(/res/adm/pages/edittoplevel.gif);
9081: }
9082:
1.1384 raeburn 9083: a#LC_content_toolbar_printout {
9084: background-image:url(/res/adm/pages/printout.gif);
9085: }
9086:
1.795 www 9087: ul#LC_toolbar li a:hover {
1.911 bisitz 9088: background-position: bottom center;
1.757 schulted 9089: }
9090:
1.795 www 9091: ul#LC_toolbar {
1.911 bisitz 9092: padding: 0;
9093: margin: 2px;
9094: list-style:none;
9095: position:relative;
9096: background-color:white;
1.1082 raeburn 9097: overflow: auto;
1.757 schulted 9098: }
9099:
1.795 www 9100: ul#LC_toolbar li {
1.911 bisitz 9101: border:1px solid white;
9102: padding: 0;
9103: margin: 0;
9104: float: left;
9105: display:inline;
9106: vertical-align:middle;
1.1082 raeburn 9107: white-space: nowrap;
1.911 bisitz 9108: }
1.757 schulted 9109:
1.783 amueller 9110:
1.795 www 9111: a.LC_toolbarItem {
1.911 bisitz 9112: display:block;
9113: padding: 0;
9114: margin: 0;
9115: height: 32px;
9116: width: 32px;
9117: color:white;
9118: border: none;
9119: background-repeat:no-repeat;
9120: background-color:transparent;
1.757 schulted 9121: }
9122:
1.915 droeschl 9123: ul.LC_funclist {
9124: margin: 0;
9125: padding: 0.5em 1em 0.5em 0;
9126: }
9127:
1.933 droeschl 9128: ul.LC_funclist > li:first-child {
9129: font-weight:bold;
9130: margin-left:0.8em;
9131: }
9132:
1.915 droeschl 9133: ul.LC_funclist + ul.LC_funclist {
9134: /*
9135: left border as a seperator if we have more than
9136: one list
9137: */
9138: border-left: 1px solid $sidebg;
9139: /*
9140: this hides the left border behind the border of the
9141: outer box if element is wrapped to the next 'line'
9142: */
9143: margin-left: -1px;
9144: }
9145:
1.843 bisitz 9146: ul.LC_funclist li {
1.915 droeschl 9147: display: inline;
1.782 bisitz 9148: white-space: nowrap;
1.915 droeschl 9149: margin: 0 0 0 25px;
9150: line-height: 150%;
1.782 bisitz 9151: }
9152:
1.974 wenzelju 9153: .LC_hidden {
9154: display: none;
9155: }
9156:
1.1030 www 9157: .LCmodal-overlay {
9158: position:fixed;
9159: top:0;
9160: right:0;
9161: bottom:0;
9162: left:0;
9163: height:100%;
9164: width:100%;
9165: margin:0;
9166: padding:0;
9167: background:#999;
9168: opacity:.75;
9169: filter: alpha(opacity=75);
9170: -moz-opacity: 0.75;
9171: z-index:101;
9172: }
9173:
9174: * html .LCmodal-overlay {
9175: position: absolute;
9176: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9177: }
9178:
9179: .LCmodal-window {
9180: position:fixed;
9181: top:50%;
9182: left:50%;
9183: margin:0;
9184: padding:0;
9185: z-index:102;
9186: }
9187:
9188: * html .LCmodal-window {
9189: position:absolute;
9190: }
9191:
9192: .LCclose-window {
9193: position:absolute;
9194: width:32px;
9195: height:32px;
9196: right:8px;
9197: top:8px;
9198: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9199: text-indent:-99999px;
9200: overflow:hidden;
9201: cursor:pointer;
9202: }
9203:
1.1369 raeburn 9204: .LCisDisabled {
9205: cursor: not-allowed;
9206: opacity: 0.5;
9207: }
9208:
9209: a[aria-disabled="true"] {
9210: color: currentColor;
9211: display: inline-block; /* For IE11/ MS Edge bug */
9212: pointer-events: none;
9213: text-decoration: none;
9214: }
9215:
1.1335 raeburn 9216: pre.LC_wordwrap {
9217: white-space: pre-wrap;
9218: white-space: -moz-pre-wrap;
9219: white-space: -pre-wrap;
9220: white-space: -o-pre-wrap;
9221: word-wrap: break-word;
9222: }
9223:
1.1100 raeburn 9224: /*
1.1231 damieng 9225: styles used for response display
9226: */
9227: div.LC_radiofoil, div.LC_rankfoil {
9228: margin: .5em 0em .5em 0em;
9229: }
9230: table.LC_itemgroup {
9231: margin-top: 1em;
9232: }
9233:
9234: /*
1.1100 raeburn 9235: styles used by TTH when "Default set of options to pass to tth/m
9236: when converting TeX" in course settings has been set
9237:
9238: option passed: -t
9239:
9240: */
9241:
9242: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9243: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9244: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9245: td div.norm {line-height:normal;}
9246:
9247: /*
9248: option passed -y3
9249: */
9250:
9251: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9252: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9253: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9254:
1.1230 damieng 9255: /*
9256: sections with roles, for content only
9257: */
9258: section[class^="role-"] {
9259: padding-left: 10px;
9260: padding-right: 5px;
9261: margin-top: 8px;
9262: margin-bottom: 8px;
9263: border: 1px solid #2A4;
9264: border-radius: 5px;
9265: box-shadow: 0px 1px 1px #BBB;
9266: }
9267: section[class^="role-"]>h1 {
9268: position: relative;
9269: margin: 0px;
9270: padding-top: 10px;
9271: padding-left: 40px;
9272: }
9273: section[class^="role-"]>h1:before {
9274: position: absolute;
9275: left: -5px;
9276: top: 5px;
9277: }
9278: section.role-activity>h1:before {
9279: content:url('/adm/daxe/images/section_icons/activity.png');
9280: }
9281: section.role-advice>h1:before {
9282: content:url('/adm/daxe/images/section_icons/advice.png');
9283: }
9284: section.role-bibliography>h1:before {
9285: content:url('/adm/daxe/images/section_icons/bibliography.png');
9286: }
9287: section.role-citation>h1:before {
9288: content:url('/adm/daxe/images/section_icons/citation.png');
9289: }
9290: section.role-conclusion>h1:before {
9291: content:url('/adm/daxe/images/section_icons/conclusion.png');
9292: }
9293: section.role-definition>h1:before {
9294: content:url('/adm/daxe/images/section_icons/definition.png');
9295: }
9296: section.role-demonstration>h1:before {
9297: content:url('/adm/daxe/images/section_icons/demonstration.png');
9298: }
9299: section.role-example>h1:before {
9300: content:url('/adm/daxe/images/section_icons/example.png');
9301: }
9302: section.role-explanation>h1:before {
9303: content:url('/adm/daxe/images/section_icons/explanation.png');
9304: }
9305: section.role-introduction>h1:before {
9306: content:url('/adm/daxe/images/section_icons/introduction.png');
9307: }
9308: section.role-method>h1:before {
9309: content:url('/adm/daxe/images/section_icons/method.png');
9310: }
9311: section.role-more_information>h1:before {
9312: content:url('/adm/daxe/images/section_icons/more_information.png');
9313: }
9314: section.role-objectives>h1:before {
9315: content:url('/adm/daxe/images/section_icons/objectives.png');
9316: }
9317: section.role-prerequisites>h1:before {
9318: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9319: }
9320: section.role-remark>h1:before {
9321: content:url('/adm/daxe/images/section_icons/remark.png');
9322: }
9323: section.role-reminder>h1:before {
9324: content:url('/adm/daxe/images/section_icons/reminder.png');
9325: }
9326: section.role-summary>h1:before {
9327: content:url('/adm/daxe/images/section_icons/summary.png');
9328: }
9329: section.role-syntax>h1:before {
9330: content:url('/adm/daxe/images/section_icons/syntax.png');
9331: }
9332: section.role-warning>h1:before {
9333: content:url('/adm/daxe/images/section_icons/warning.png');
9334: }
9335:
1.1269 raeburn 9336: #LC_minitab_header {
9337: float:left;
9338: width:100%;
9339: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9340: font-size:93%;
9341: line-height:normal;
9342: margin: 0.5em 0 0.5em 0;
9343: }
9344: #LC_minitab_header ul {
9345: margin:0;
9346: padding:10px 10px 0;
9347: list-style:none;
9348: }
9349: #LC_minitab_header li {
9350: float:left;
9351: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9352: margin:0;
9353: padding:0 0 0 9px;
9354: }
9355: #LC_minitab_header a {
9356: display:block;
9357: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9358: padding:5px 15px 4px 6px;
9359: }
9360: #LC_minitab_header #LC_current_minitab {
9361: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9362: }
9363: #LC_minitab_header #LC_current_minitab a {
9364: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9365: padding-bottom:5px;
9366: }
9367:
9368:
1.343 albertel 9369: END
9370: }
9371:
1.306 albertel 9372: =pod
9373:
9374: =item * &headtag()
9375:
9376: Returns a uniform footer for LON-CAPA web pages.
9377:
1.307 albertel 9378: Inputs: $title - optional title for the head
9379: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9380: $args - optional arguments
1.319 albertel 9381: force_register - if is true call registerurl so the remote is
9382: informed
1.415 albertel 9383: redirect -> array ref of
9384: 1- seconds before redirect occurs
9385: 2- url to redirect to
9386: 3- whether the side effect should occur
1.315 albertel 9387: (side effect of setting
9388: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9389: redirected to)
9390: 4- whether the redirect target should be
9391: the opener of the current (pop-up)
9392: window (side effect of setting
9393: $env{'internal.head.to_opener'} to
9394: 1, if true.
1.1388 raeburn 9395: 5- whether encrypt check should be skipped
1.352 albertel 9396: domain -> force to color decorate a page for a specific
9397: domain
9398: function -> force usage of a specific rolish color scheme
9399: bgcolor -> override the default page bgcolor
1.460 albertel 9400: no_auto_mt_title
9401: -> prevent &mt()ing the title arg
1.464 albertel 9402:
1.306 albertel 9403: =cut
9404:
9405: sub headtag {
1.313 albertel 9406: my ($title,$head_extra,$args) = @_;
1.306 albertel 9407:
1.363 albertel 9408: my $function = $args->{'function'} || &get_users_function();
9409: my $domain = $args->{'domain'} || &determinedomain();
9410: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9411: my $httphost = $args->{'use_absolute'};
1.418 albertel 9412: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9413: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9414: #time(),
1.418 albertel 9415: $env{'environment.color.timestamp'},
1.363 albertel 9416: $function,$domain,$bgcolor);
9417:
1.369 www 9418: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9419:
1.308 albertel 9420: my $result =
9421: '<head>'.
1.1160 raeburn 9422: &font_settings($args);
1.319 albertel 9423:
1.1188 raeburn 9424: my $inhibitprint;
9425: if ($args->{'print_suppress'}) {
9426: $inhibitprint = &print_suppression();
9427: }
1.1064 raeburn 9428:
1.461 albertel 9429: if (!$args->{'frameset'}) {
9430: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9431: }
1.962 droeschl 9432: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9433: $result .= Apache::lonxml::display_title();
1.319 albertel 9434: }
1.436 albertel 9435: if (!$args->{'no_nav_bar'}
9436: && !$args->{'only_body'}
9437: && !$args->{'frameset'}) {
1.1154 raeburn 9438: $result .= &help_menu_js($httphost);
1.1032 www 9439: $result.=&modal_window();
1.1038 www 9440: $result.=&togglebox_script();
1.1034 www 9441: $result.=&wishlist_window();
1.1041 www 9442: $result.=&LCprogressbarUpdate_script();
1.1034 www 9443: } else {
9444: if ($args->{'add_modal'}) {
9445: $result.=&modal_window();
9446: }
9447: if ($args->{'add_wishlist'}) {
9448: $result.=&wishlist_window();
9449: }
1.1038 www 9450: if ($args->{'add_togglebox'}) {
9451: $result.=&togglebox_script();
9452: }
1.1041 www 9453: if ($args->{'add_progressbar'}) {
9454: $result.=&LCprogressbarUpdate_script();
9455: }
1.436 albertel 9456: }
1.314 albertel 9457: if (ref($args->{'redirect'})) {
1.1388 raeburn 9458: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9459: if (!$skip_enc_check) {
9460: $url = &Apache::lonenc::check_encrypt($url);
9461: }
1.414 albertel 9462: if (!$inhibit_continue) {
9463: $env{'internal.head.redirect'} = $url;
9464: }
1.1386 raeburn 9465: $result.=<<"ADDMETA";
1.313 albertel 9466: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9467: ADDMETA
9468: if ($to_opener) {
9469: $env{'internal.head.to_opener'} = 1;
9470: my $dest = &js_escape($url);
9471: my $timeout = int($time * 1000);
9472: $result .=<<"ENDJS";
9473: <script type="text/javascript">
9474: // <![CDATA[
9475: function LC_To_Opener() {
9476: var dest = '$dest';
9477: if (dest != '') {
9478: if (window.opener != null && !window.opener.closed) {
9479: window.opener.location.href=dest;
9480: window.close();
9481: } else {
9482: window.location.href=dest;
9483: }
9484: }
9485: }
9486: \$(document).ready(function () {
9487: setTimeout('LC_To_Opener()',$timeout);
9488: });
9489: // ]]>
9490: </script>
9491: ENDJS
9492: } else {
9493: $result.=<<"ADDMETA";
1.344 albertel 9494: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9495: ADDMETA
1.1386 raeburn 9496: }
1.1210 raeburn 9497: } else {
9498: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9499: my $requrl = $env{'request.uri'};
9500: if ($requrl eq '') {
9501: $requrl = $ENV{'REQUEST_URI'};
9502: $requrl =~ s/\?.+$//;
9503: }
9504: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9505: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9506: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9507: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9508: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9509: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9510: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9511: my ($offload,$offloadoth);
1.1210 raeburn 9512: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9513: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9514: $offload = 1;
1.1353 raeburn 9515: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9516: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9517: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9518: $offloadoth = 1;
9519: $dom_in_use = $env{'user.domain'};
9520: }
9521: }
1.1340 raeburn 9522: }
9523: }
9524: unless ($offload) {
9525: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9526: if ($domdefs{'offloadoth'}{$lonhost}) {
9527: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9528: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9529: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9530: $offload = 1;
1.1352 raeburn 9531: $offloadoth = 1;
1.1340 raeburn 9532: $dom_in_use = $env{'user.domain'};
9533: }
1.1210 raeburn 9534: }
1.1340 raeburn 9535: }
9536: }
9537: }
9538: if ($offload) {
1.1358 raeburn 9539: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9540: if (($newserver eq '') && ($offloadoth)) {
9541: my @domains = &Apache::lonnet::current_machine_domains();
9542: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9543: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9544: }
9545: }
1.1340 raeburn 9546: if (($newserver) && ($newserver ne $lonhost)) {
9547: my $numsec = 5;
9548: my $timeout = $numsec * 1000;
9549: my ($newurl,$locknum,%locks,$msg);
9550: if ($env{'request.role.adv'}) {
9551: ($locknum,%locks) = &Apache::lonnet::get_locks();
9552: }
9553: my $disable_submit = 0;
9554: if ($requrl =~ /$LONCAPA::assess_re/) {
9555: $disable_submit = 1;
9556: }
9557: if ($locknum) {
9558: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9559: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9560: join(", ",sort(values(%locks)))."\n";
9561: if (&show_course()) {
9562: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9563: } else {
9564: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9565: }
1.1340 raeburn 9566: } else {
9567: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9568: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9569: }
9570: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9571: $newurl = '/adm/switchserver?otherserver='.$newserver;
9572: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9573: $newurl .= '&role='.$env{'request.role'};
9574: }
9575: if ($env{'request.symb'}) {
9576: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9577: if ($shownsymb =~ m{^/enc/}) {
9578: my $reqdmajor = 2;
9579: my $reqdminor = 11;
9580: my $reqdsubminor = 3;
9581: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9582: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9583: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9584: if (($major eq '' && $minor eq '') ||
9585: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9586: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9587: ($reqdsubminor > $subminor))))) {
9588: undef($shownsymb);
9589: }
1.1210 raeburn 9590: }
1.1340 raeburn 9591: if ($shownsymb) {
9592: &js_escape(\$shownsymb);
9593: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9594: }
1.1340 raeburn 9595: } else {
9596: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9597: &js_escape(\$shownurl);
9598: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9599: }
1.1340 raeburn 9600: }
9601: &js_escape(\$msg);
9602: $result.=<<OFFLOAD
1.1210 raeburn 9603: <meta http-equiv="pragma" content="no-cache" />
9604: <script type="text/javascript">
1.1215 raeburn 9605: // <![CDATA[
1.1210 raeburn 9606: function LC_Offload_Now() {
9607: var dest = "$newurl";
9608: if (dest != '') {
9609: window.location.href="$newurl";
9610: }
9611: }
1.1214 raeburn 9612: \$(document).ready(function () {
9613: window.alert('$msg');
9614: if ($disable_submit) {
1.1210 raeburn 9615: \$(".LC_hwk_submit").prop("disabled", true);
9616: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9617: }
9618: setTimeout('LC_Offload_Now()', $timeout);
9619: });
1.1215 raeburn 9620: // ]]>
1.1210 raeburn 9621: </script>
9622: OFFLOAD
9623: }
9624: }
9625: }
9626: }
9627: }
1.313 albertel 9628: }
1.306 albertel 9629: if (!defined($title)) {
9630: $title = 'The LearningOnline Network with CAPA';
9631: }
1.460 albertel 9632: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9633: if ($title =~ /^LON-CAPA\s+/) {
9634: $result .= '<title> '.$title.'</title>';
9635: } else {
9636: $result .= '<title> LON-CAPA '.$title.'</title>';
9637: }
9638: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9639: if (!$args->{'frameset'}) {
9640: $result .= ' /';
9641: }
9642: $result .= '>'
1.1064 raeburn 9643: .$inhibitprint
1.414 albertel 9644: .$head_extra;
1.1242 raeburn 9645: my $clientmobile;
9646: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9647: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9648: } else {
9649: $clientmobile = $env{'browser.mobile'};
9650: }
9651: if ($clientmobile) {
1.1137 raeburn 9652: $result .= '
1.1435 raeburn 9653: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9654: <meta name="apple-mobile-web-app-capable" content="yes" />';
9655: }
1.1278 raeburn 9656: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9657: return $result.'</head>';
1.306 albertel 9658: }
9659:
9660: =pod
9661:
1.340 albertel 9662: =item * &font_settings()
9663:
9664: Returns neccessary <meta> to set the proper encoding
9665:
1.1160 raeburn 9666: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9667:
9668: =cut
9669:
9670: sub font_settings {
1.1160 raeburn 9671: my ($args) = @_;
1.340 albertel 9672: my $headerstring='';
1.1160 raeburn 9673: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9674: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9675: $headerstring.=
9676: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9677: if (!$args->{'frameset'}) {
9678: $headerstring.= ' /';
9679: }
9680: $headerstring .= '>'."\n";
1.340 albertel 9681: }
9682: return $headerstring;
9683: }
9684:
1.341 albertel 9685: =pod
9686:
1.1064 raeburn 9687: =item * &print_suppression()
9688:
9689: In course context returns css which causes the body to be blank when media="print",
9690: if printout generation is unavailable for the current resource.
9691:
9692: This could be because:
9693:
9694: (a) printstartdate is in the future
9695:
9696: (b) printenddate is in the past
9697:
9698: (c) there is an active exam block with "printout"
9699: functionality blocked
9700:
9701: Users with pav, pfo or evb privileges are exempt.
9702:
9703: Inputs: none
9704:
9705: =cut
9706:
9707:
9708: sub print_suppression {
9709: my $noprint;
9710: if ($env{'request.course.id'}) {
9711: my $scope = $env{'request.course.id'};
9712: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9713: (&Apache::lonnet::allowed('pfo',$scope))) {
9714: return;
9715: }
9716: if ($env{'request.course.sec'} ne '') {
9717: $scope .= "/$env{'request.course.sec'}";
9718: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9719: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9720: return;
1.1064 raeburn 9721: }
9722: }
9723: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9724: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9725: my $clientip = &Apache::lonnet::get_requestor_ip();
9726: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9727: if ($blocked) {
9728: my $checkrole = "cm./$cdom/$cnum";
9729: if ($env{'request.course.sec'} ne '') {
9730: $checkrole .= "/$env{'request.course.sec'}";
9731: }
9732: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9733: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9734: $noprint = 1;
9735: }
9736: }
9737: unless ($noprint) {
9738: my $symb = &Apache::lonnet::symbread();
9739: if ($symb ne '') {
9740: my $navmap = Apache::lonnavmaps::navmap->new();
9741: if (ref($navmap)) {
9742: my $res = $navmap->getBySymb($symb);
9743: if (ref($res)) {
9744: if (!$res->resprintable()) {
9745: $noprint = 1;
9746: }
9747: }
9748: }
9749: }
9750: }
9751: if ($noprint) {
9752: return <<"ENDSTYLE";
9753: <style type="text/css" media="print">
9754: body { display:none }
9755: </style>
9756: ENDSTYLE
9757: }
9758: }
9759: return;
9760: }
9761:
9762: =pod
9763:
1.341 albertel 9764: =item * &xml_begin()
9765:
9766: Returns the needed doctype and <html>
9767:
9768: Inputs: none
9769:
9770: =cut
9771:
9772: sub xml_begin {
1.1168 raeburn 9773: my ($is_frameset) = @_;
1.341 albertel 9774: my $output='';
9775:
9776: if ($env{'browser.mathml'}) {
9777: $output='<?xml version="1.0"?>'
9778: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9779: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9780:
9781: # .'<!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">] >'
9782: .'<!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">'
9783: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9784: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9785: } elsif ($is_frameset) {
9786: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9787: '<html>'."\n";
1.341 albertel 9788: } else {
1.1168 raeburn 9789: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9790: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9791: }
9792: return $output;
9793: }
1.340 albertel 9794:
9795: =pod
9796:
1.306 albertel 9797: =item * &start_page()
9798:
9799: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9800:
1.648 raeburn 9801: Inputs:
9802:
9803: =over 4
9804:
9805: $title - optional title for the page
9806:
9807: $head_extra - optional extra HTML to incude inside the <head>
9808:
9809: $args - additional optional args supported are:
9810:
9811: =over 8
9812:
9813: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9814: arg on
1.814 bisitz 9815: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9816: add_entries -> additional attributes to add to the <body>
9817: domain -> force to color decorate a page for a
1.317 albertel 9818: specific domain
1.648 raeburn 9819: function -> force usage of a specific rolish color
1.317 albertel 9820: scheme
1.648 raeburn 9821: redirect -> see &headtag()
9822: bgcolor -> override the default page bg color
9823: js_ready -> return a string ready for being used in
1.317 albertel 9824: a javascript writeln
1.648 raeburn 9825: html_encode -> return a string ready for being used in
1.320 albertel 9826: a html attribute
1.648 raeburn 9827: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9828: $forcereg arg
1.648 raeburn 9829: frameset -> if true will start with a <frameset>
1.330 albertel 9830: rather than <body>
1.648 raeburn 9831: skip_phases -> hash ref of
1.338 albertel 9832: head -> skip the <html><head> generation
9833: body -> skip all <body> generation
1.648 raeburn 9834: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9835: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9836: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 9837: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9838: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9839: group -> includes the current group, if page is for a
1.1274 raeburn 9840: specific group
9841: use_absolute -> for request for external resource or syllabus, this
9842: will contain https://<hostname> if server uses
9843: https (as per hosts.tab), but request is for http
9844: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9845: links_disabled -> Links in primary and secondary menus are disabled
9846: (Can enable them once page has loaded - see lonroles.pm
9847: for an example).
1.1380 raeburn 9848: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9849:
1.648 raeburn 9850: =back
1.460 albertel 9851:
1.648 raeburn 9852: =back
1.562 albertel 9853:
1.306 albertel 9854: =cut
9855:
9856: sub start_page {
1.309 albertel 9857: my ($title,$head_extra,$args) = @_;
1.318 albertel 9858: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9859:
1.315 albertel 9860: $env{'internal.start_page'}++;
1.1359 raeburn 9861: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9862:
1.338 albertel 9863: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9864: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9865: }
1.1316 raeburn 9866:
9867: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9868: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9869: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9870: $args->{'no_primary_menu'} = 1;
9871: }
9872: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9873: $args->{'no_inline_menu'} = 1;
9874: }
9875: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9876: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9877: }
9878: } else {
9879: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9880: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9881: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9882: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9883: $args->{'no_primary_menu'} = 1;
9884: }
9885: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9886: $args->{'no_inline_menu'} = 1;
9887: }
9888: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9889: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9890: }
9891: }
9892: }
1.1316 raeburn 9893: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9894: $env{'course.'.$env{'request.course.id'}.'.domain'},
9895: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9896: } elsif ($env{'request.course.id'}) {
9897: my $expiretime=600;
9898: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9899: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9900: }
9901: my ($deeplinkmenu,$menuref);
9902: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9903: if ($menucoll) {
9904: if (ref($menuref) eq 'HASH') {
9905: %menu = %{$menuref};
9906: }
9907: if ($menu{'top'} eq 'n') {
9908: $args->{'no_primary_menu'} = 1;
9909: }
9910: if ($menu{'inline'} eq 'n') {
9911: unless (&Apache::lonnet::allowed('opa')) {
9912: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9913: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9914: my $crstype = &course_type();
9915: my $now = time;
9916: my $ccrole;
9917: if ($crstype eq 'Community') {
9918: $ccrole = 'co';
9919: } else {
9920: $ccrole = 'cc';
9921: }
9922: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9923: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9924: if ((($start) && ($start<0)) ||
9925: (($end) && ($end<$now)) ||
9926: (($start) && ($now<$start))) {
9927: $args->{'no_inline_menu'} = 1;
9928: }
9929: } else {
9930: $args->{'no_inline_menu'} = 1;
9931: }
9932: }
9933: }
9934: }
1.1316 raeburn 9935: }
1.1359 raeburn 9936:
1.1385 raeburn 9937: my $showncrumbs;
1.338 albertel 9938: if (! exists($args->{'skip_phases'}{'body'}) ) {
9939: if ($args->{'frameset'}) {
9940: my $attr_string = &make_attr_string($args->{'force_register'},
9941: $args->{'add_entries'});
9942: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9943: } else {
9944: $result .=
9945: &bodytag($title,
9946: $args->{'function'}, $args->{'add_entries'},
9947: $args->{'only_body'}, $args->{'domain'},
9948: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9949: $args->{'bgcolor'}, $args,
1.1385 raeburn 9950: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9951: \%menu,\$showncrumbs);
1.831 bisitz 9952: }
1.330 albertel 9953: }
1.338 albertel 9954:
1.315 albertel 9955: if ($args->{'js_ready'}) {
1.713 kaisler 9956: $result = &js_ready($result);
1.315 albertel 9957: }
1.320 albertel 9958: if ($args->{'html_encode'}) {
1.713 kaisler 9959: $result = &html_encode($result);
9960: }
9961:
1.813 bisitz 9962: # Preparation for new and consistent functionlist at top of screen
9963: # if ($args->{'functionlist'}) {
9964: # $result .= &build_functionlist();
9965: #}
9966:
1.964 droeschl 9967: # Don't add anything more if only_body wanted or in const space
9968: return $result if $args->{'only_body'}
9969: || $env{'request.state'} eq 'construct';
1.813 bisitz 9970:
9971: #Breadcrumbs
1.758 kaisler 9972: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 9973: unless ($showncrumbs) {
1.758 kaisler 9974: &Apache::lonhtmlcommon::clear_breadcrumbs();
9975: #if any br links exists, add them to the breadcrumbs
9976: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9977: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9978: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9979: }
9980: }
1.1096 raeburn 9981: # if @advtools array contains items add then to the breadcrumbs
9982: if (@advtools > 0) {
9983: &Apache::lonmenu::advtools_crumbs(@advtools);
9984: }
1.1272 raeburn 9985: my $menulink;
9986: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9987: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9988: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9989: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9990: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9991: (!$env{'request.role.adv'}))) {
9992: $menulink = 0;
9993: } else {
9994: undef($menulink);
9995: }
1.1385 raeburn 9996: my $linkprotout;
9997: if ($env{'request.deeplink.login'}) {
9998: my $linkprotout = &Apache::lonmenu::linkprot_exit();
9999: if ($linkprotout) {
10000: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10001: }
10002: }
1.758 kaisler 10003: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10004: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 10005: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 10006: } else {
1.1272 raeburn 10007: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 10008: }
1.1385 raeburn 10009: }
1.320 albertel 10010: }
1.315 albertel 10011: return $result;
1.306 albertel 10012: }
10013:
10014: sub end_page {
1.315 albertel 10015: my ($args) = @_;
10016: $env{'internal.end_page'}++;
1.330 albertel 10017: my $result;
1.335 albertel 10018: if ($args->{'discussion'}) {
10019: my ($target,$parser);
10020: if (ref($args->{'discussion'})) {
10021: ($target,$parser) =($args->{'discussion'}{'target'},
10022: $args->{'discussion'}{'parser'});
10023: }
10024: $result .= &Apache::lonxml::xmlend($target,$parser);
10025: }
1.330 albertel 10026: if ($args->{'frameset'}) {
10027: $result .= '</frameset>';
10028: } else {
1.635 raeburn 10029: $result .= &endbodytag($args);
1.330 albertel 10030: }
1.1080 raeburn 10031: unless ($args->{'notbody'}) {
10032: $result .= "\n</html>";
10033: }
1.330 albertel 10034:
1.315 albertel 10035: if ($args->{'js_ready'}) {
1.317 albertel 10036: $result = &js_ready($result);
1.315 albertel 10037: }
1.335 albertel 10038:
1.320 albertel 10039: if ($args->{'html_encode'}) {
10040: $result = &html_encode($result);
10041: }
1.335 albertel 10042:
1.315 albertel 10043: return $result;
10044: }
10045:
1.1359 raeburn 10046: sub menucoll_in_effect {
10047: my ($menucoll,$deeplinkmenu,%menu);
10048: if ($env{'request.course.id'}) {
10049: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10050: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10051: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10052: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10053: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10054: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10055: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10056: my $navmap = Apache::lonnavmaps::navmap->new();
10057: if (ref($navmap)) {
10058: $deeplink = $navmap->get_mapparam(undef,
10059: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10060: '0.deeplink');
1.1370 raeburn 10061: } else {
10062: $check_login_symb = 1;
1.1362 raeburn 10063: }
10064: } else {
1.1370 raeburn 10065: my $symb = &Apache::lonnet::symbread();
10066: if ($symb) {
10067: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10068: } else {
10069: $check_login_symb = 1;
10070: }
1.1362 raeburn 10071: }
10072: } else {
1.1370 raeburn 10073: $check_login_symb = 1;
10074: }
10075: if ($check_login_symb) {
1.1362 raeburn 10076: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10077: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10078: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10079: my $navmap = Apache::lonnavmaps::navmap->new();
10080: if (ref($navmap)) {
10081: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10082: }
10083: } else {
10084: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10085: }
10086: }
1.1359 raeburn 10087: if ($deeplink ne '') {
1.1378 raeburn 10088: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10089: if ($display =~ /^\d+$/) {
10090: $deeplinkmenu = 1;
10091: $menucoll = $display;
10092: }
10093: }
10094: }
10095: if ($menucoll) {
10096: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10097: }
10098: }
10099: return ($menucoll,$deeplinkmenu,\%menu);
10100: }
10101:
1.1362 raeburn 10102: sub deeplink_login_symb {
10103: my ($cnum,$cdom) = @_;
10104: my $login_symb;
10105: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10106: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10107: }
10108: return $login_symb;
10109: }
10110:
10111: sub symb_from_tinyurl {
10112: my ($url,$cnum,$cdom) = @_;
10113: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10114: my $key = $1;
10115: my ($tinyurl,$login);
10116: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10117: if (defined($cached)) {
10118: $tinyurl = $result;
10119: } else {
10120: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10121: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10122: if ($currtiny{$key} ne '') {
10123: $tinyurl = $currtiny{$key};
10124: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10125: }
1.1364 raeburn 10126: }
10127: if ($tinyurl ne '') {
10128: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10129: if (wantarray) {
10130: return ($cnumreq,$symb);
10131: } elsif ($cnumreq eq $cnum) {
10132: return $symb;
1.1362 raeburn 10133: }
10134: }
10135: }
1.1364 raeburn 10136: if (wantarray) {
10137: return ();
10138: } else {
10139: return;
10140: }
1.1362 raeburn 10141: }
10142:
1.1405 raeburn 10143: sub usable_exttools {
10144: my %tooltypes;
10145: if ($env{'request.course.id'}) {
10146: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10147: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10148: %tooltypes = (
10149: crs => 1,
10150: dom => 1,
10151: );
10152: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10153: $tooltypes{'crs'} = 1;
10154: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10155: $tooltypes{'dom'} = 1;
10156: }
10157: } else {
10158: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10159: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10160: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10161: if ($crstype eq '') {
10162: $crstype = 'course';
10163: }
10164: if ($crstype eq 'course') {
10165: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10166: $crstype = 'official';
10167: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10168: $crstype = 'textbook';
10169: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10170: $crstype = 'lti';
10171: } else {
10172: $crstype = 'unofficial';
10173: }
10174: }
10175: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10176: if ($domdefaults{$crstype.'domexttool'}) {
10177: $tooltypes{'dom'} = 1;
10178: }
10179: if ($domdefaults{$crstype.'exttool'}) {
10180: $tooltypes{'crs'} = 1;
10181: }
10182: }
10183: }
10184: return %tooltypes;
10185: }
10186:
1.1034 www 10187: sub wishlist_window {
10188: return(<<'ENDWISHLIST');
1.1046 raeburn 10189: <script type="text/javascript">
1.1034 www 10190: // <![CDATA[
10191: // <!-- BEGIN LON-CAPA Internal
10192: function set_wishlistlink(title, path) {
10193: if (!title) {
10194: title = document.title;
10195: title = title.replace(/^LON-CAPA /,'');
10196: }
1.1175 raeburn 10197: title = encodeURIComponent(title);
1.1203 raeburn 10198: title = title.replace("'","\\\'");
1.1034 www 10199: if (!path) {
10200: path = location.pathname;
10201: }
1.1175 raeburn 10202: path = encodeURIComponent(path);
1.1203 raeburn 10203: path = path.replace("'","\\\'");
1.1034 www 10204: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10205: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10206: }
10207: // END LON-CAPA Internal -->
10208: // ]]>
10209: </script>
10210: ENDWISHLIST
10211: }
10212:
1.1030 www 10213: sub modal_window {
10214: return(<<'ENDMODAL');
1.1046 raeburn 10215: <script type="text/javascript">
1.1030 www 10216: // <![CDATA[
10217: // <!-- BEGIN LON-CAPA Internal
10218: var modalWindow = {
10219: parent:"body",
10220: windowId:null,
10221: content:null,
10222: width:null,
10223: height:null,
10224: close:function()
10225: {
10226: $(".LCmodal-window").remove();
10227: $(".LCmodal-overlay").remove();
10228: },
10229: open:function()
10230: {
10231: var modal = "";
10232: modal += "<div class=\"LCmodal-overlay\"></div>";
10233: 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;\">";
10234: modal += this.content;
10235: modal += "</div>";
10236:
10237: $(this.parent).append(modal);
10238:
10239: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10240: $(".LCclose-window").click(function(){modalWindow.close();});
10241: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10242: }
10243: };
1.1140 raeburn 10244: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10245: {
1.1266 raeburn 10246: source = source.replace(/'/g,"'");
1.1030 www 10247: modalWindow.windowId = "myModal";
10248: modalWindow.width = width;
10249: modalWindow.height = height;
1.1196 raeburn 10250: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10251: modalWindow.open();
1.1208 raeburn 10252: };
1.1030 www 10253: // END LON-CAPA Internal -->
10254: // ]]>
10255: </script>
10256: ENDMODAL
10257: }
10258:
10259: sub modal_link {
1.1140 raeburn 10260: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10261: unless ($width) { $width=480; }
10262: unless ($height) { $height=400; }
1.1031 www 10263: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10264: unless ($transparency) { $transparency='true'; }
10265:
1.1074 raeburn 10266: my $target_attr;
10267: if (defined($target)) {
10268: $target_attr = 'target="'.$target.'"';
10269: }
10270: return <<"ENDLINK";
1.1336 raeburn 10271: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10272: ENDLINK
1.1030 www 10273: }
10274:
1.1032 www 10275: sub modal_adhoc_script {
1.1365 raeburn 10276: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10277: my $mathjax;
10278: if ($possmathjax) {
10279: $mathjax = <<'ENDJAX';
10280: if (typeof MathJax == 'object') {
10281: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10282: }
10283: ENDJAX
10284: }
1.1032 www 10285: return (<<ENDADHOC);
1.1046 raeburn 10286: <script type="text/javascript">
1.1032 www 10287: // <![CDATA[
10288: var $funcname = function()
10289: {
10290: modalWindow.windowId = "myModal";
10291: modalWindow.width = $width;
10292: modalWindow.height = $height;
10293: modalWindow.content = '$content';
10294: modalWindow.open();
1.1365 raeburn 10295: $mathjax
1.1032 www 10296: };
10297: // ]]>
10298: </script>
10299: ENDADHOC
10300: }
10301:
1.1041 www 10302: sub modal_adhoc_inner {
1.1365 raeburn 10303: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10304: my $innerwidth=$width-20;
10305: $content=&js_ready(
1.1140 raeburn 10306: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10307: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10308: $content.
1.1041 www 10309: &end_scrollbox().
1.1140 raeburn 10310: &end_page()
1.1041 www 10311: );
1.1365 raeburn 10312: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10313: }
10314:
10315: sub modal_adhoc_window {
1.1365 raeburn 10316: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10317: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10318: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10319: }
10320:
10321: sub modal_adhoc_launch {
10322: my ($funcname,$width,$height,$content)=@_;
10323: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10324: <script type="text/javascript">
10325: // <![CDATA[
10326: $funcname();
10327: // ]]>
10328: </script>
10329: ENDLAUNCH
10330: }
10331:
10332: sub modal_adhoc_close {
10333: return (<<ENDCLOSE);
10334: <script type="text/javascript">
10335: // <![CDATA[
10336: modalWindow.close();
10337: // ]]>
10338: </script>
10339: ENDCLOSE
10340: }
10341:
1.1038 www 10342: sub togglebox_script {
10343: return(<<ENDTOGGLE);
10344: <script type="text/javascript">
10345: // <![CDATA[
10346: function LCtoggleDisplay(id,hidetext,showtext) {
10347: link = document.getElementById(id + "link").childNodes[0];
10348: with (document.getElementById(id).style) {
10349: if (display == "none" ) {
10350: display = "inline";
10351: link.nodeValue = hidetext;
10352: } else {
10353: display = "none";
10354: link.nodeValue = showtext;
10355: }
10356: }
10357: }
10358: // ]]>
10359: </script>
10360: ENDTOGGLE
10361: }
10362:
1.1039 www 10363: sub start_togglebox {
10364: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10365: unless ($heading) { $heading=''; } else { $heading.=' '; }
10366: unless ($showtext) { $showtext=&mt('show'); }
10367: unless ($hidetext) { $hidetext=&mt('hide'); }
10368: unless ($headerbg) { $headerbg='#FFFFFF'; }
10369: return &start_data_table().
10370: &start_data_table_header_row().
10371: '<td bgcolor="'.$headerbg.'">'.$heading.
10372: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10373: $showtext.'\')">'.$showtext.'</a>]</td>'.
10374: &end_data_table_header_row().
10375: '<tr id="'.$id.'" style="display:none""><td>';
10376: }
10377:
10378: sub end_togglebox {
10379: return '</td></tr>'.&end_data_table();
10380: }
10381:
1.1041 www 10382: sub LCprogressbar_script {
1.1302 raeburn 10383: my ($id,$number_to_do)=@_;
10384: if ($number_to_do) {
10385: return(<<ENDPROGRESS);
1.1041 www 10386: <script type="text/javascript">
10387: // <![CDATA[
1.1045 www 10388: \$('#progressbar$id').progressbar({
1.1041 www 10389: value: 0,
10390: change: function(event, ui) {
10391: var newVal = \$(this).progressbar('option', 'value');
10392: \$('.pblabel', this).text(LCprogressTxt);
10393: }
10394: });
10395: // ]]>
10396: </script>
10397: ENDPROGRESS
1.1302 raeburn 10398: } else {
10399: return(<<ENDPROGRESS);
10400: <script type="text/javascript">
10401: // <![CDATA[
10402: \$('#progressbar$id').progressbar({
10403: value: false,
10404: create: function(event, ui) {
10405: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10406: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10407: }
10408: });
10409: // ]]>
10410: </script>
10411: ENDPROGRESS
10412: }
1.1041 www 10413: }
10414:
10415: sub LCprogressbarUpdate_script {
10416: return(<<ENDPROGRESSUPDATE);
10417: <style type="text/css">
10418: .ui-progressbar { position:relative; }
1.1302 raeburn 10419: .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 10420: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10421: </style>
10422: <script type="text/javascript">
10423: // <![CDATA[
1.1045 www 10424: var LCprogressTxt='---';
10425:
1.1302 raeburn 10426: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10427: LCprogressTxt=progresstext;
1.1302 raeburn 10428: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10429: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10430: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10431: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10432: } else {
10433: \$('#progressbar'+id).progressbar('value',percent);
10434: }
1.1041 www 10435: }
10436: // ]]>
10437: </script>
10438: ENDPROGRESSUPDATE
10439: }
10440:
1.1042 www 10441: my $LClastpercent;
1.1045 www 10442: my $LCidcnt;
10443: my $LCcurrentid;
1.1042 www 10444:
1.1041 www 10445: sub LCprogressbar {
1.1302 raeburn 10446: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10447: $LClastpercent=0;
1.1045 www 10448: $LCidcnt++;
10449: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10450: my ($starting,$content);
10451: if ($number_to_do) {
10452: $starting=&mt('Starting');
10453: $content=(<<ENDPROGBAR);
10454: $preamble
1.1045 www 10455: <div id="progressbar$LCcurrentid">
1.1041 www 10456: <span class="pblabel">$starting</span>
10457: </div>
10458: ENDPROGBAR
1.1302 raeburn 10459: } else {
10460: $starting=&mt('Loading...');
10461: $LClastpercent='false';
10462: $content=(<<ENDPROGBAR);
10463: $preamble
10464: <div id="progressbar$LCcurrentid">
10465: <div class="progress-label">$starting</div>
10466: </div>
10467: ENDPROGBAR
10468: }
10469: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10470: }
10471:
10472: sub LCprogressbarUpdate {
1.1302 raeburn 10473: my ($r,$val,$text,$number_to_do)=@_;
10474: if ($number_to_do) {
10475: unless ($val) {
10476: if ($LClastpercent) {
10477: $val=$LClastpercent;
10478: } else {
10479: $val=0;
10480: }
10481: }
10482: if ($val<0) { $val=0; }
10483: if ($val>100) { $val=0; }
10484: $LClastpercent=$val;
10485: unless ($text) { $text=$val.'%'; }
10486: } else {
10487: $val = 'false';
1.1042 www 10488: }
1.1041 www 10489: $text=&js_ready($text);
1.1044 www 10490: &r_print($r,<<ENDUPDATE);
1.1041 www 10491: <script type="text/javascript">
10492: // <![CDATA[
1.1302 raeburn 10493: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10494: // ]]>
10495: </script>
10496: ENDUPDATE
1.1035 www 10497: }
10498:
1.1042 www 10499: sub LCprogressbarClose {
10500: my ($r)=@_;
10501: $LClastpercent=0;
1.1044 www 10502: &r_print($r,<<ENDCLOSE);
1.1042 www 10503: <script type="text/javascript">
10504: // <![CDATA[
1.1045 www 10505: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10506: // ]]>
10507: </script>
10508: ENDCLOSE
1.1044 www 10509: }
10510:
10511: sub r_print {
10512: my ($r,$to_print)=@_;
10513: if ($r) {
10514: $r->print($to_print);
10515: $r->rflush();
10516: } else {
10517: print($to_print);
10518: }
1.1042 www 10519: }
10520:
1.320 albertel 10521: sub html_encode {
10522: my ($result) = @_;
10523:
1.322 albertel 10524: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10525:
10526: return $result;
10527: }
1.1044 www 10528:
1.317 albertel 10529: sub js_ready {
10530: my ($result) = @_;
10531:
1.323 albertel 10532: $result =~ s/[\n\r]/ /xmsg;
10533: $result =~ s/\\/\\\\/xmsg;
10534: $result =~ s/'/\\'/xmsg;
1.372 albertel 10535: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10536:
10537: return $result;
10538: }
10539:
1.315 albertel 10540: sub validate_page {
10541: if ( exists($env{'internal.start_page'})
1.316 albertel 10542: && $env{'internal.start_page'} > 1) {
10543: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10544: $env{'internal.start_page'}.' '.
1.316 albertel 10545: $ENV{'request.filename'});
1.315 albertel 10546: }
10547: if ( exists($env{'internal.end_page'})
1.316 albertel 10548: && $env{'internal.end_page'} > 1) {
10549: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10550: $env{'internal.end_page'}.' '.
1.316 albertel 10551: $env{'request.filename'});
1.315 albertel 10552: }
10553: if ( exists($env{'internal.start_page'})
10554: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10555: &Apache::lonnet::logthis('start_page called without end_page '.
10556: $env{'request.filename'});
1.315 albertel 10557: }
10558: if ( ! exists($env{'internal.start_page'})
10559: && exists($env{'internal.end_page'})) {
1.316 albertel 10560: &Apache::lonnet::logthis('end_page called without start_page'.
10561: $env{'request.filename'});
1.315 albertel 10562: }
1.306 albertel 10563: }
1.315 albertel 10564:
1.996 www 10565:
10566: sub start_scrollbox {
1.1140 raeburn 10567: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10568: unless ($outerwidth) { $outerwidth='520px'; }
10569: unless ($width) { $width='500px'; }
10570: unless ($height) { $height='200px'; }
1.1075 raeburn 10571: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10572: if ($id ne '') {
1.1140 raeburn 10573: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10574: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10575: }
1.1075 raeburn 10576: if ($bgcolor ne '') {
10577: $tdcol = "background-color: $bgcolor;";
10578: }
1.1137 raeburn 10579: my $nicescroll_js;
10580: if ($env{'browser.mobile'}) {
1.1140 raeburn 10581: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10582: }
10583: return <<"END";
10584: $nicescroll_js
10585:
10586: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10587: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10588: END
10589: }
10590:
10591: sub end_scrollbox {
10592: return '</div></td></tr></table>';
10593: }
10594:
10595: sub nicescroll_javascript {
10596: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10597: my %options;
10598: if (ref($cursor) eq 'HASH') {
10599: %options = %{$cursor};
10600: }
10601: unless ($options{'railalign'} =~ /^left|right$/) {
10602: $options{'railalign'} = 'left';
10603: }
10604: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10605: my $function = &get_users_function();
10606: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10607: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10608: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10609: }
1.1140 raeburn 10610: }
10611: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10612: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10613: $options{'cursoropacity'}='1.0';
10614: }
1.1140 raeburn 10615: } else {
10616: $options{'cursoropacity'}='1.0';
10617: }
10618: if ($options{'cursorfixedheight'} eq 'none') {
10619: delete($options{'cursorfixedheight'});
10620: } else {
10621: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10622: }
10623: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10624: delete($options{'railoffset'});
10625: }
10626: my @niceoptions;
10627: while (my($key,$value) = each(%options)) {
10628: if ($value =~ /^\{.+\}$/) {
10629: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10630: } else {
1.1140 raeburn 10631: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10632: }
1.1140 raeburn 10633: }
10634: my $nicescroll_js = '
1.1137 raeburn 10635: $(document).ready(
1.1140 raeburn 10636: function() {
10637: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10638: }
1.1137 raeburn 10639: );
10640: ';
1.1140 raeburn 10641: if ($framecheck) {
10642: $nicescroll_js .= '
10643: function expand_div(caller) {
10644: if (top === self) {
10645: document.getElementById("'.$id.'").style.width = "auto";
10646: document.getElementById("'.$id.'").style.height = "auto";
10647: } else {
10648: try {
10649: if (parent.frames) {
10650: if (parent.frames.length > 1) {
10651: var framesrc = parent.frames[1].location.href;
10652: var currsrc = framesrc.replace(/\#.*$/,"");
10653: if ((caller == "search") || (currsrc == "'.$location.'")) {
10654: document.getElementById("'.$id.'").style.width = "auto";
10655: document.getElementById("'.$id.'").style.height = "auto";
10656: }
10657: }
10658: }
10659: } catch (e) {
10660: return;
10661: }
1.1137 raeburn 10662: }
1.1140 raeburn 10663: return;
1.996 www 10664: }
1.1140 raeburn 10665: ';
10666: }
10667: if ($needjsready) {
10668: $nicescroll_js = '
10669: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10670: } else {
10671: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10672: }
10673: return $nicescroll_js;
1.996 www 10674: }
10675:
1.318 albertel 10676: sub simple_error_page {
1.1150 bisitz 10677: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10678: my %displayargs;
1.1151 raeburn 10679: if (ref($args) eq 'HASH') {
10680: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10681: if ($args->{'only_body'}) {
10682: $displayargs{'only_body'} = 1;
10683: }
10684: if ($args->{'no_nav_bar'}) {
10685: $displayargs{'no_nav_bar'} = 1;
10686: }
1.1151 raeburn 10687: } else {
10688: $msg = &mt($msg);
10689: }
1.1150 bisitz 10690:
1.318 albertel 10691: my $page =
1.1304 raeburn 10692: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10693: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10694: &Apache::loncommon::end_page();
10695: if (ref($r)) {
10696: $r->print($page);
1.327 albertel 10697: return;
1.318 albertel 10698: }
10699: return $page;
10700: }
1.347 albertel 10701:
10702: {
1.610 albertel 10703: my @row_count;
1.961 onken 10704:
10705: sub start_data_table_count {
10706: unshift(@row_count, 0);
10707: return;
10708: }
10709:
10710: sub end_data_table_count {
10711: shift(@row_count);
10712: return;
10713: }
10714:
1.347 albertel 10715: sub start_data_table {
1.1018 raeburn 10716: my ($add_class,$id) = @_;
1.422 albertel 10717: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10718: my $table_id;
10719: if (defined($id)) {
10720: $table_id = ' id="'.$id.'"';
10721: }
1.961 onken 10722: &start_data_table_count();
1.1018 raeburn 10723: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10724: }
10725:
10726: sub end_data_table {
1.961 onken 10727: &end_data_table_count();
1.389 albertel 10728: return '</table>'."\n";;
1.347 albertel 10729: }
10730:
10731: sub start_data_table_row {
1.974 wenzelju 10732: my ($add_class, $id) = @_;
1.610 albertel 10733: $row_count[0]++;
10734: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10735: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10736: $id = (' id="'.$id.'"') unless ($id eq '');
10737: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10738: }
1.471 banghart 10739:
10740: sub continue_data_table_row {
1.974 wenzelju 10741: my ($add_class, $id) = @_;
1.610 albertel 10742: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10743: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10744: $id = (' id="'.$id.'"') unless ($id eq '');
10745: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10746: }
1.347 albertel 10747:
10748: sub end_data_table_row {
1.389 albertel 10749: return '</tr>'."\n";;
1.347 albertel 10750: }
1.367 www 10751:
1.421 albertel 10752: sub start_data_table_empty_row {
1.707 bisitz 10753: # $row_count[0]++;
1.421 albertel 10754: return '<tr class="LC_empty_row" >'."\n";;
10755: }
10756:
10757: sub end_data_table_empty_row {
10758: return '</tr>'."\n";;
10759: }
10760:
1.367 www 10761: sub start_data_table_header_row {
1.389 albertel 10762: return '<tr class="LC_header_row">'."\n";;
1.367 www 10763: }
10764:
10765: sub end_data_table_header_row {
1.389 albertel 10766: return '</tr>'."\n";;
1.367 www 10767: }
1.890 droeschl 10768:
10769: sub data_table_caption {
10770: my $caption = shift;
10771: return "<caption class=\"LC_caption\">$caption</caption>";
10772: }
1.347 albertel 10773: }
10774:
1.548 albertel 10775: =pod
10776:
10777: =item * &inhibit_menu_check($arg)
10778:
10779: Checks for a inhibitmenu state and generates output to preserve it
10780:
10781: Inputs: $arg - can be any of
10782: - undef - in which case the return value is a string
10783: to add into arguments list of a uri
10784: - 'input' - in which case the return value is a HTML
10785: <form> <input> field of type hidden to
10786: preserve the value
10787: - a url - in which case the return value is the url with
10788: the neccesary cgi args added to preserve the
10789: inhibitmenu state
10790: - a ref to a url - no return value, but the string is
10791: updated to include the neccessary cgi
10792: args to preserve the inhibitmenu state
10793:
10794: =cut
10795:
10796: sub inhibit_menu_check {
10797: my ($arg) = @_;
10798: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10799: if ($arg eq 'input') {
10800: if ($env{'form.inhibitmenu'}) {
10801: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10802: } else {
10803: return
10804: }
10805: }
10806: if ($env{'form.inhibitmenu'}) {
10807: if (ref($arg)) {
10808: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10809: } elsif ($arg eq '') {
10810: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10811: } else {
10812: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10813: }
10814: }
10815: if (!ref($arg)) {
10816: return $arg;
10817: }
10818: }
10819:
1.251 albertel 10820: ###############################################
1.182 matthew 10821:
10822: =pod
10823:
1.549 albertel 10824: =back
10825:
10826: =head1 User Information Routines
10827:
10828: =over 4
10829:
1.405 albertel 10830: =item * &get_users_function()
1.182 matthew 10831:
10832: Used by &bodytag to determine the current users primary role.
10833: Returns either 'student','coordinator','admin', or 'author'.
10834:
10835: =cut
10836:
10837: ###############################################
10838: sub get_users_function {
1.815 tempelho 10839: my $function = 'norole';
1.818 tempelho 10840: if ($env{'request.role'}=~/^(st)/) {
10841: $function='student';
10842: }
1.907 raeburn 10843: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10844: $function='coordinator';
10845: }
1.258 albertel 10846: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10847: $function='admin';
10848: }
1.826 bisitz 10849: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10850: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10851: $function='author';
10852: }
10853: return $function;
1.54 www 10854: }
1.99 www 10855:
10856: ###############################################
10857:
1.233 raeburn 10858: =pod
10859:
1.821 raeburn 10860: =item * &show_course()
10861:
10862: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10863: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10864:
10865: Inputs:
10866: None
10867:
10868: Outputs:
10869: Scalar: 1 if 'Course' to be used, 0 otherwise.
10870:
10871: =cut
10872:
10873: ###############################################
10874: sub show_course {
1.1408 raeburn 10875: my ($udom,$uname) = @_;
10876: if (($udom ne '') && ($uname ne '')) {
10877: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10878: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10879: return 0;
10880: } else {
10881: return 1;
10882: }
10883: }
10884: }
1.821 raeburn 10885: my $course = !$env{'user.adv'};
10886: if (!$env{'user.adv'}) {
10887: foreach my $env (keys(%env)) {
10888: next if ($env !~ m/^user\.priv\./);
10889: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10890: $course = 0;
10891: last;
10892: }
10893: }
10894: }
10895: return $course;
10896: }
10897:
10898: ###############################################
10899:
10900: =pod
10901:
1.542 raeburn 10902: =item * &check_user_status()
1.274 raeburn 10903:
10904: Determines current status of supplied role for a
10905: specific user. Roles can be active, previous or future.
10906:
10907: Inputs:
10908: user's domain, user's username, course's domain,
1.375 raeburn 10909: course's number, optional section ID.
1.274 raeburn 10910:
10911: Outputs:
10912: role status: active, previous or future.
10913:
10914: =cut
10915:
10916: sub check_user_status {
1.412 raeburn 10917: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10918: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10919: my @uroles = keys(%userinfo);
1.274 raeburn 10920: my $srchstr;
10921: my $active_chk = 'none';
1.412 raeburn 10922: my $now = time;
1.274 raeburn 10923: if (@uroles > 0) {
1.908 raeburn 10924: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10925: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10926: } else {
1.412 raeburn 10927: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10928: }
10929: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10930: my $role_end = 0;
10931: my $role_start = 0;
10932: $active_chk = 'active';
1.412 raeburn 10933: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10934: $role_end = $1;
10935: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10936: $role_start = $1;
1.274 raeburn 10937: }
10938: }
10939: if ($role_start > 0) {
1.412 raeburn 10940: if ($now < $role_start) {
1.274 raeburn 10941: $active_chk = 'future';
10942: }
10943: }
10944: if ($role_end > 0) {
1.412 raeburn 10945: if ($now > $role_end) {
1.274 raeburn 10946: $active_chk = 'previous';
10947: }
10948: }
10949: }
10950: }
10951: return $active_chk;
10952: }
10953:
10954: ###############################################
10955:
10956: =pod
10957:
1.405 albertel 10958: =item * &get_sections()
1.233 raeburn 10959:
10960: Determines all the sections for a course including
10961: sections with students and sections containing other roles.
1.419 raeburn 10962: Incoming parameters:
10963:
10964: 1. domain
10965: 2. course number
10966: 3. reference to array containing roles for which sections should
10967: be gathered (optional).
10968: 4. reference to array containing status types for which sections
10969: should be gathered (optional).
10970:
10971: If the third argument is undefined, sections are gathered for any role.
10972: If the fourth argument is undefined, sections are gathered for any status.
10973: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10974:
1.374 raeburn 10975: Returns section hash (keys are section IDs, values are
10976: number of users in each section), subject to the
1.419 raeburn 10977: optional roles filter, optional status filter
1.233 raeburn 10978:
10979: =cut
10980:
10981: ###############################################
10982: sub get_sections {
1.419 raeburn 10983: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 10984: if (!defined($cdom) || !defined($cnum)) {
10985: my $cid = $env{'request.course.id'};
10986:
10987: return if (!defined($cid));
10988:
10989: $cdom = $env{'course.'.$cid.'.domain'};
10990: $cnum = $env{'course.'.$cid.'.num'};
10991: }
10992:
10993: my %sectioncount;
1.419 raeburn 10994: my $now = time;
1.240 albertel 10995:
1.1118 raeburn 10996: my $check_students = 1;
10997: my $only_students = 0;
10998: if (ref($possible_roles) eq 'ARRAY') {
10999: if (grep(/^st$/,@{$possible_roles})) {
11000: if (@{$possible_roles} == 1) {
11001: $only_students = 1;
11002: }
11003: } else {
11004: $check_students = 0;
11005: }
11006: }
11007:
11008: if ($check_students) {
1.276 albertel 11009: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11010: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11011: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11012: my $start_index = &Apache::loncoursedata::CL_START();
11013: my $end_index = &Apache::loncoursedata::CL_END();
11014: my $status;
1.366 albertel 11015: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11016: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11017: $data->[$status_index],
11018: $data->[$start_index],
11019: $data->[$end_index]);
11020: if ($stu_status eq 'Active') {
11021: $status = 'active';
11022: } elsif ($end < $now) {
11023: $status = 'previous';
11024: } elsif ($start > $now) {
11025: $status = 'future';
11026: }
11027: if ($section ne '-1' && $section !~ /^\s*$/) {
11028: if ((!defined($possible_status)) || (($status ne '') &&
11029: (grep/^\Q$status\E$/,@{$possible_status}))) {
11030: $sectioncount{$section}++;
11031: }
1.240 albertel 11032: }
11033: }
11034: }
1.1118 raeburn 11035: if ($only_students) {
11036: return %sectioncount;
11037: }
1.240 albertel 11038: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11039: foreach my $user (sort(keys(%courseroles))) {
11040: if ($user !~ /^(\w{2})/) { next; }
11041: my ($role) = ($user =~ /^(\w{2})/);
11042: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11043: my ($section,$status);
1.240 albertel 11044: if ($role eq 'cr' &&
11045: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11046: $section=$1;
11047: }
11048: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11049: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11050: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11051: if ($end == -1 && $start == -1) {
11052: next; #deleted role
11053: }
11054: if (!defined($possible_status)) {
11055: $sectioncount{$section}++;
11056: } else {
11057: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11058: $status = 'active';
11059: } elsif ($end < $now) {
11060: $status = 'future';
11061: } elsif ($start > $now) {
11062: $status = 'previous';
11063: }
11064: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11065: $sectioncount{$section}++;
11066: }
11067: }
1.233 raeburn 11068: }
1.366 albertel 11069: return %sectioncount;
1.233 raeburn 11070: }
11071:
1.274 raeburn 11072: ###############################################
1.294 raeburn 11073:
11074: =pod
1.405 albertel 11075:
11076: =item * &get_course_users()
11077:
1.275 raeburn 11078: Retrieves usernames:domains for users in the specified course
11079: with specific role(s), and access status.
11080:
11081: Incoming parameters:
1.277 albertel 11082: 1. course domain
11083: 2. course number
11084: 3. access status: users must have - either active,
1.275 raeburn 11085: previous, future, or all.
1.277 albertel 11086: 4. reference to array of permissible roles
1.288 raeburn 11087: 5. reference to array of section restrictions (optional)
11088: 6. reference to results object (hash of hashes).
11089: 7. reference to optional userdata hash
1.609 raeburn 11090: 8. reference to optional statushash
1.630 raeburn 11091: 9. flag if privileged users (except those set to unhide in
11092: course settings) should be excluded
1.609 raeburn 11093: Keys of top level results hash are roles.
1.275 raeburn 11094: Keys of inner hashes are username:domain, with
11095: values set to access type.
1.288 raeburn 11096: Optional userdata hash returns an array with arguments in the
11097: same order as loncoursedata::get_classlist() for student data.
11098:
1.609 raeburn 11099: Optional statushash returns
11100:
1.288 raeburn 11101: Entries for end, start, section and status are blank because
11102: of the possibility of multiple values for non-student roles.
11103:
1.275 raeburn 11104: =cut
1.405 albertel 11105:
1.275 raeburn 11106: ###############################################
1.405 albertel 11107:
1.275 raeburn 11108: sub get_course_users {
1.630 raeburn 11109: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11110: my %idx = ();
1.419 raeburn 11111: my %seclists;
1.288 raeburn 11112:
11113: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11114: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11115: $idx{end} = &Apache::loncoursedata::CL_END();
11116: $idx{start} = &Apache::loncoursedata::CL_START();
11117: $idx{id} = &Apache::loncoursedata::CL_ID();
11118: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11119: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11120: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11121:
1.290 albertel 11122: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11123: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11124: my $now = time;
1.277 albertel 11125: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11126: my $match = 0;
1.412 raeburn 11127: my $secmatch = 0;
1.419 raeburn 11128: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11129: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11130: if ($section eq '') {
11131: $section = 'none';
11132: }
1.291 albertel 11133: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11134: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11135: $secmatch = 1;
11136: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11137: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11138: $secmatch = 1;
11139: }
11140: } else {
1.419 raeburn 11141: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11142: $secmatch = 1;
11143: }
1.290 albertel 11144: }
1.412 raeburn 11145: if (!$secmatch) {
11146: next;
11147: }
1.419 raeburn 11148: }
1.275 raeburn 11149: if (defined($$types{'active'})) {
1.288 raeburn 11150: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11151: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11152: $match = 1;
1.275 raeburn 11153: }
11154: }
11155: if (defined($$types{'previous'})) {
1.609 raeburn 11156: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11157: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11158: $match = 1;
1.275 raeburn 11159: }
11160: }
11161: if (defined($$types{'future'})) {
1.609 raeburn 11162: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11163: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11164: $match = 1;
1.275 raeburn 11165: }
11166: }
1.609 raeburn 11167: if ($match) {
11168: push(@{$seclists{$student}},$section);
11169: if (ref($userdata) eq 'HASH') {
11170: $$userdata{$student} = $$classlist{$student};
11171: }
11172: if (ref($statushash) eq 'HASH') {
11173: $statushash->{$student}{'st'}{$section} = $status;
11174: }
1.288 raeburn 11175: }
1.275 raeburn 11176: }
11177: }
1.412 raeburn 11178: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11179: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11180: my $now = time;
1.609 raeburn 11181: my %displaystatus = ( previous => 'Expired',
11182: active => 'Active',
11183: future => 'Future',
11184: );
1.1121 raeburn 11185: my (%nothide,@possdoms);
1.630 raeburn 11186: if ($hidepriv) {
11187: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11188: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11189: if ($user !~ /:/) {
11190: $nothide{join(':',split(/[\@]/,$user))}=1;
11191: } else {
11192: $nothide{$user} = 1;
11193: }
11194: }
1.1121 raeburn 11195: my @possdoms = ($cdom);
11196: if ($coursehash{'checkforpriv'}) {
11197: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11198: }
1.630 raeburn 11199: }
1.439 raeburn 11200: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11201: my $match = 0;
1.412 raeburn 11202: my $secmatch = 0;
1.439 raeburn 11203: my $status;
1.412 raeburn 11204: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11205: $user =~ s/:$//;
1.439 raeburn 11206: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11207: if ($end == -1 || $start == -1) {
11208: next;
11209: }
11210: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11211: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11212: my ($uname,$udom) = split(/:/,$user);
11213: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11214: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11215: $secmatch = 1;
11216: } elsif ($usec eq '') {
1.420 albertel 11217: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11218: $secmatch = 1;
11219: }
11220: } else {
11221: if (grep(/^\Q$usec\E$/,@{$sections})) {
11222: $secmatch = 1;
11223: }
11224: }
11225: if (!$secmatch) {
11226: next;
11227: }
1.288 raeburn 11228: }
1.419 raeburn 11229: if ($usec eq '') {
11230: $usec = 'none';
11231: }
1.275 raeburn 11232: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11233: if ($hidepriv) {
1.1121 raeburn 11234: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11235: (!$nothide{$uname.':'.$udom})) {
11236: next;
11237: }
11238: }
1.503 raeburn 11239: if ($end > 0 && $end < $now) {
1.439 raeburn 11240: $status = 'previous';
11241: } elsif ($start > $now) {
11242: $status = 'future';
11243: } else {
11244: $status = 'active';
11245: }
1.277 albertel 11246: foreach my $type (keys(%{$types})) {
1.275 raeburn 11247: if ($status eq $type) {
1.420 albertel 11248: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11249: push(@{$$users{$role}{$user}},$type);
11250: }
1.288 raeburn 11251: $match = 1;
11252: }
11253: }
1.419 raeburn 11254: if (($match) && (ref($userdata) eq 'HASH')) {
11255: if (!exists($$userdata{$uname.':'.$udom})) {
11256: &get_user_info($udom,$uname,\%idx,$userdata);
11257: }
1.420 albertel 11258: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11259: push(@{$seclists{$uname.':'.$udom}},$usec);
11260: }
1.609 raeburn 11261: if (ref($statushash) eq 'HASH') {
11262: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11263: }
1.275 raeburn 11264: }
11265: }
11266: }
11267: }
1.290 albertel 11268: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11269: if ((defined($cdom)) && (defined($cnum))) {
11270: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11271: if ( defined($csettings{'internal.courseowner'}) ) {
11272: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11273: next if ($owner eq '');
11274: my ($ownername,$ownerdom);
11275: if ($owner =~ /^([^:]+):([^:]+)$/) {
11276: $ownername = $1;
11277: $ownerdom = $2;
11278: } else {
11279: $ownername = $owner;
11280: $ownerdom = $cdom;
11281: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11282: }
11283: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11284: if (defined($userdata) &&
1.609 raeburn 11285: !exists($$userdata{$owner})) {
11286: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11287: if (!grep(/^none$/,@{$seclists{$owner}})) {
11288: push(@{$seclists{$owner}},'none');
11289: }
11290: if (ref($statushash) eq 'HASH') {
11291: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11292: }
1.290 albertel 11293: }
1.279 raeburn 11294: }
11295: }
11296: }
1.419 raeburn 11297: foreach my $user (keys(%seclists)) {
11298: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11299: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11300: }
1.275 raeburn 11301: }
11302: return;
11303: }
11304:
1.288 raeburn 11305: sub get_user_info {
11306: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11307: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11308: &plainname($uname,$udom,'lastname');
1.291 albertel 11309: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11310: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11311: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11312: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11313: return;
11314: }
1.275 raeburn 11315:
1.472 raeburn 11316: ###############################################
11317:
11318: =pod
11319:
11320: =item * &get_user_quota()
11321:
1.1134 raeburn 11322: Retrieves quota assigned for storage of user files.
11323: Default is to report quota for portfolio files.
1.472 raeburn 11324:
11325: Incoming parameters:
11326: 1. user's username
11327: 2. user's domain
1.1134 raeburn 11328: 3. quota name - portfolio, author, or course
1.1136 raeburn 11329: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11330: 4. crstype - official, unofficial, textbook, placement or community,
11331: if quota name is course
1.472 raeburn 11332:
11333: Returns:
1.1163 raeburn 11334: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11335: 2. (Optional) Type of setting: custom or default
11336: (individually assigned or default for user's
11337: institutional status).
11338: 3. (Optional) - User's institutional status (e.g., faculty, staff
11339: or student - types as defined in localenroll::inst_usertypes
11340: for user's domain, which determines default quota for user.
11341: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11342:
11343: If a value has been stored in the user's environment,
1.536 raeburn 11344: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11345: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11346:
11347: =cut
11348:
11349: ###############################################
11350:
11351:
11352: sub get_user_quota {
1.1136 raeburn 11353: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11354: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11355: if (!defined($udom)) {
11356: $udom = $env{'user.domain'};
11357: }
11358: if (!defined($uname)) {
11359: $uname = $env{'user.name'};
11360: }
11361: if (($udom eq '' || $uname eq '') ||
11362: ($udom eq 'public') && ($uname eq 'public')) {
11363: $quota = 0;
1.536 raeburn 11364: $quotatype = 'default';
11365: $defquota = 0;
1.472 raeburn 11366: } else {
1.536 raeburn 11367: my $inststatus;
1.1134 raeburn 11368: if ($quotaname eq 'course') {
11369: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11370: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11371: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11372: } else {
11373: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11374: $quota = $cenv{'internal.uploadquota'};
11375: }
1.536 raeburn 11376: } else {
1.1134 raeburn 11377: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11378: if ($quotaname eq 'author') {
11379: $quota = $env{'environment.authorquota'};
11380: } else {
11381: $quota = $env{'environment.portfolioquota'};
11382: }
11383: $inststatus = $env{'environment.inststatus'};
11384: } else {
11385: my %userenv =
11386: &Apache::lonnet::get('environment',['portfolioquota',
11387: 'authorquota','inststatus'],$udom,$uname);
11388: my ($tmp) = keys(%userenv);
11389: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11390: if ($quotaname eq 'author') {
11391: $quota = $userenv{'authorquota'};
11392: } else {
11393: $quota = $userenv{'portfolioquota'};
11394: }
11395: $inststatus = $userenv{'inststatus'};
11396: } else {
11397: undef(%userenv);
11398: }
11399: }
11400: }
11401: if ($quota eq '' || wantarray) {
11402: if ($quotaname eq 'course') {
11403: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11404: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11405: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11406: ($crstype eq 'placement')) {
1.1136 raeburn 11407: $defquota = $domdefs{$crstype.'quota'};
11408: }
11409: if ($defquota eq '') {
11410: $defquota = 500;
11411: }
1.1134 raeburn 11412: } else {
11413: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11414: }
11415: if ($quota eq '') {
11416: $quota = $defquota;
11417: $quotatype = 'default';
11418: } else {
11419: $quotatype = 'custom';
11420: }
1.472 raeburn 11421: }
11422: }
1.536 raeburn 11423: if (wantarray) {
11424: return ($quota,$quotatype,$settingstatus,$defquota);
11425: } else {
11426: return $quota;
11427: }
1.472 raeburn 11428: }
11429:
11430: ###############################################
11431:
11432: =pod
11433:
11434: =item * &default_quota()
11435:
1.536 raeburn 11436: Retrieves default quota assigned for storage of user portfolio files,
11437: given an (optional) user's institutional status.
1.472 raeburn 11438:
11439: Incoming parameters:
1.1142 raeburn 11440:
1.472 raeburn 11441: 1. domain
1.536 raeburn 11442: 2. (Optional) institutional status(es). This is a : separated list of
11443: status types (e.g., faculty, staff, student etc.)
11444: which apply to the user for whom the default is being retrieved.
11445: If the institutional status string in undefined, the domain
1.1134 raeburn 11446: default quota will be returned.
11447: 3. quota name - portfolio, author, or course
11448: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11449:
11450: Returns:
1.1142 raeburn 11451:
1.1163 raeburn 11452: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11453: 2. (Optional) institutional type which determined the value of the
11454: default quota.
1.472 raeburn 11455:
11456: If a value has been stored in the domain's configuration db,
11457: it will return that, otherwise it returns 20 (for backwards
11458: compatibility with domains which have not set up a configuration
1.1163 raeburn 11459: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11460:
1.536 raeburn 11461: If the user's status includes multiple types (e.g., staff and student),
11462: the largest default quota which applies to the user determines the
11463: default quota returned.
11464:
1.472 raeburn 11465: =cut
11466:
11467: ###############################################
11468:
11469:
11470: sub default_quota {
1.1134 raeburn 11471: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11472: my ($defquota,$settingstatus);
11473: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11474: ['quotas'],$udom);
1.1134 raeburn 11475: my $key = 'defaultquota';
11476: if ($quotaname eq 'author') {
11477: $key = 'authorquota';
11478: }
1.622 raeburn 11479: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11480: if ($inststatus ne '') {
1.765 raeburn 11481: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11482: foreach my $item (@statuses) {
1.1134 raeburn 11483: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11484: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11485: if ($defquota eq '') {
1.1134 raeburn 11486: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11487: $settingstatus = $item;
1.1134 raeburn 11488: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11489: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11490: $settingstatus = $item;
11491: }
11492: }
1.1134 raeburn 11493: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11494: if ($quotahash{'quotas'}{$item} ne '') {
11495: if ($defquota eq '') {
11496: $defquota = $quotahash{'quotas'}{$item};
11497: $settingstatus = $item;
11498: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11499: $defquota = $quotahash{'quotas'}{$item};
11500: $settingstatus = $item;
11501: }
1.536 raeburn 11502: }
11503: }
11504: }
11505: }
11506: if ($defquota eq '') {
1.1134 raeburn 11507: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11508: $defquota = $quotahash{'quotas'}{$key}{'default'};
11509: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11510: $defquota = $quotahash{'quotas'}{'default'};
11511: }
1.536 raeburn 11512: $settingstatus = 'default';
1.1139 raeburn 11513: if ($defquota eq '') {
11514: if ($quotaname eq 'author') {
11515: $defquota = 500;
11516: }
11517: }
1.536 raeburn 11518: }
11519: } else {
11520: $settingstatus = 'default';
1.1134 raeburn 11521: if ($quotaname eq 'author') {
11522: $defquota = 500;
11523: } else {
11524: $defquota = 20;
11525: }
1.536 raeburn 11526: }
11527: if (wantarray) {
11528: return ($defquota,$settingstatus);
1.472 raeburn 11529: } else {
1.536 raeburn 11530: return $defquota;
1.472 raeburn 11531: }
11532: }
11533:
1.1135 raeburn 11534: ###############################################
11535:
11536: =pod
11537:
1.1136 raeburn 11538: =item * &excess_filesize_warning()
1.1135 raeburn 11539:
11540: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11541: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11542: space to be exceeded.
1.1136 raeburn 11543:
11544: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11545: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11546:
1.1165 raeburn 11547: Inputs: 7
1.1136 raeburn 11548: 1. username or coursenum
1.1135 raeburn 11549: 2. domain
1.1136 raeburn 11550: 3. context ('author' or 'course')
1.1135 raeburn 11551: 4. filename of file for which action is being requested
11552: 5. filesize (kB) of file
11553: 6. action being taken: copy or upload.
1.1237 raeburn 11554: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11555:
11556: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11557: otherwise return null.
11558:
11559: =back
1.1135 raeburn 11560:
11561: =cut
11562:
1.1136 raeburn 11563: sub excess_filesize_warning {
1.1165 raeburn 11564: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11565: my $current_disk_usage = 0;
1.1165 raeburn 11566: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11567: if ($context eq 'author') {
11568: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11569: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11570: } else {
11571: foreach my $subdir ('docs','supplemental') {
11572: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11573: }
11574: }
1.1135 raeburn 11575: $disk_quota = int($disk_quota * 1000);
11576: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11577: return '<p class="LC_warning">'.
1.1135 raeburn 11578: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11579: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11580: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11581: $disk_quota,$current_disk_usage).
11582: '</p>';
11583: }
11584: return;
11585: }
11586:
11587: ###############################################
11588:
11589:
1.1136 raeburn 11590:
11591:
1.384 raeburn 11592: sub get_secgrprole_info {
11593: my ($cdom,$cnum,$needroles,$type) = @_;
11594: my %sections_count = &get_sections($cdom,$cnum);
11595: my @sections = (sort {$a <=> $b} keys(%sections_count));
11596: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11597: my @groups = sort(keys(%curr_groups));
11598: my $allroles = [];
11599: my $rolehash;
11600: my $accesshash = {
11601: active => 'Currently has access',
11602: future => 'Will have future access',
11603: previous => 'Previously had access',
11604: };
11605: if ($needroles) {
11606: $rolehash = {'all' => 'all'};
1.385 albertel 11607: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11608: if (&Apache::lonnet::error(%user_roles)) {
11609: undef(%user_roles);
11610: }
11611: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11612: my ($role)=split(/\:/,$item,2);
11613: if ($role eq 'cr') { next; }
11614: if ($role =~ /^cr/) {
11615: $$rolehash{$role} = (split('/',$role))[3];
11616: } else {
11617: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11618: }
11619: }
11620: foreach my $key (sort(keys(%{$rolehash}))) {
11621: push(@{$allroles},$key);
11622: }
11623: push (@{$allroles},'st');
11624: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11625: }
11626: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11627: }
11628:
1.555 raeburn 11629: sub user_picker {
1.1279 raeburn 11630: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11631: my $currdom = $dom;
1.1253 raeburn 11632: my @alldoms = &Apache::lonnet::all_domains();
11633: if (@alldoms == 1) {
11634: my %domsrch = &Apache::lonnet::get_dom('configuration',
11635: ['directorysrch'],$alldoms[0]);
11636: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11637: my $showdom = $domdesc;
11638: if ($showdom eq '') {
11639: $showdom = $dom;
11640: }
11641: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11642: if ((!$domsrch{'directorysrch'}{'available'}) &&
11643: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11644: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11645: }
11646: }
11647: }
1.555 raeburn 11648: my %curr_selected = (
11649: srchin => 'dom',
1.580 raeburn 11650: srchby => 'lastname',
1.555 raeburn 11651: );
11652: my $srchterm;
1.625 raeburn 11653: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11654: if ($srch->{'srchby'} ne '') {
11655: $curr_selected{'srchby'} = $srch->{'srchby'};
11656: }
11657: if ($srch->{'srchin'} ne '') {
11658: $curr_selected{'srchin'} = $srch->{'srchin'};
11659: }
11660: if ($srch->{'srchtype'} ne '') {
11661: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11662: }
11663: if ($srch->{'srchdomain'} ne '') {
11664: $currdom = $srch->{'srchdomain'};
11665: }
11666: $srchterm = $srch->{'srchterm'};
11667: }
1.1222 damieng 11668: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11669: 'usr' => 'Search criteria',
1.563 raeburn 11670: 'doma' => 'Domain/institution to search',
1.558 albertel 11671: 'uname' => 'username',
11672: 'lastname' => 'last name',
1.555 raeburn 11673: 'lastfirst' => 'last name, first name',
1.558 albertel 11674: 'crs' => 'in this course',
1.576 raeburn 11675: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11676: 'alc' => 'all LON-CAPA',
1.573 raeburn 11677: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11678: 'exact' => 'is',
11679: 'contains' => 'contains',
1.569 raeburn 11680: 'begins' => 'begins with',
1.1222 damieng 11681: );
11682: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11683: 'youm' => "You must include some text to search for.",
11684: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11685: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11686: 'yomc' => "You must choose a domain when using an institutional directory search.",
11687: 'ymcd' => "You must choose a domain when using a domain search.",
11688: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11689: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11690: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11691: );
1.1222 damieng 11692: &html_escape(\%html_lt);
11693: &js_escape(\%js_lt);
1.1255 raeburn 11694: my $domform;
1.1277 raeburn 11695: my $allow_blank = 1;
1.1255 raeburn 11696: if ($fixeddom) {
1.1277 raeburn 11697: $allow_blank = 0;
11698: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11699: } else {
1.1287 raeburn 11700: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11701: my ($trusted,$untrusted);
1.1287 raeburn 11702: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11703: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11704: } elsif ($context eq 'author') {
1.1288 raeburn 11705: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11706: } elsif ($context eq 'domain') {
1.1288 raeburn 11707: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11708: }
1.1288 raeburn 11709: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11710: }
1.563 raeburn 11711: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11712:
11713: my @srchins = ('crs','dom','alc','instd');
11714:
11715: foreach my $option (@srchins) {
11716: # FIXME 'alc' option unavailable until
11717: # loncreateuser::print_user_query_page()
11718: # has been completed.
11719: next if ($option eq 'alc');
1.880 raeburn 11720: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11721: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11722: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11723: if ($curr_selected{'srchin'} eq $option) {
11724: $srchinsel .= '
1.1222 damieng 11725: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11726: } else {
11727: $srchinsel .= '
1.1222 damieng 11728: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11729: }
1.555 raeburn 11730: }
1.563 raeburn 11731: $srchinsel .= "\n </select>\n";
1.555 raeburn 11732:
11733: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11734: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11735: if ($curr_selected{'srchby'} eq $option) {
11736: $srchbysel .= '
1.1222 damieng 11737: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11738: } else {
11739: $srchbysel .= '
1.1222 damieng 11740: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11741: }
11742: }
11743: $srchbysel .= "\n </select>\n";
11744:
11745: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11746: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11747: if ($curr_selected{'srchtype'} eq $option) {
11748: $srchtypesel .= '
1.1222 damieng 11749: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11750: } else {
11751: $srchtypesel .= '
1.1222 damieng 11752: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11753: }
11754: }
11755: $srchtypesel .= "\n </select>\n";
11756:
1.558 albertel 11757: my ($newuserscript,$new_user_create);
1.994 raeburn 11758: my $context_dom = $env{'request.role.domain'};
11759: if ($context eq 'requestcrs') {
11760: if ($env{'form.coursedom'} ne '') {
11761: $context_dom = $env{'form.coursedom'};
11762: }
11763: }
1.556 raeburn 11764: if ($forcenewuser) {
1.576 raeburn 11765: if (ref($srch) eq 'HASH') {
1.994 raeburn 11766: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11767: if ($cancreate) {
11768: $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>';
11769: } else {
1.799 bisitz 11770: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11771: my %usertypetext = (
11772: official => 'institutional',
11773: unofficial => 'non-institutional',
11774: );
1.799 bisitz 11775: $new_user_create = '<p class="LC_warning">'
11776: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11777: .' '
11778: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11779: ,'<a href="'.$helplink.'">','</a>')
11780: .'</p><br />';
1.627 raeburn 11781: }
1.576 raeburn 11782: }
11783: }
11784:
1.556 raeburn 11785: $newuserscript = <<"ENDSCRIPT";
11786:
1.570 raeburn 11787: function setSearch(createnew,callingForm) {
1.556 raeburn 11788: if (createnew == 1) {
1.570 raeburn 11789: for (var i=0; i<callingForm.srchby.length; i++) {
11790: if (callingForm.srchby.options[i].value == 'uname') {
11791: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11792: }
11793: }
1.570 raeburn 11794: for (var i=0; i<callingForm.srchin.length; i++) {
11795: if ( callingForm.srchin.options[i].value == 'dom') {
11796: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11797: }
11798: }
1.570 raeburn 11799: for (var i=0; i<callingForm.srchtype.length; i++) {
11800: if (callingForm.srchtype.options[i].value == 'exact') {
11801: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11802: }
11803: }
1.570 raeburn 11804: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11805: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11806: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11807: }
11808: }
11809: }
11810: }
11811: ENDSCRIPT
1.558 albertel 11812:
1.556 raeburn 11813: }
11814:
1.555 raeburn 11815: my $output = <<"END_BLOCK";
1.556 raeburn 11816: <script type="text/javascript">
1.824 bisitz 11817: // <![CDATA[
1.570 raeburn 11818: function validateEntry(callingForm) {
1.558 albertel 11819:
1.556 raeburn 11820: var checkok = 1;
1.558 albertel 11821: var srchin;
1.570 raeburn 11822: for (var i=0; i<callingForm.srchin.length; i++) {
11823: if ( callingForm.srchin[i].checked ) {
11824: srchin = callingForm.srchin[i].value;
1.558 albertel 11825: }
11826: }
11827:
1.570 raeburn 11828: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11829: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11830: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11831: var srchterm = callingForm.srchterm.value;
11832: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11833: var msg = "";
11834:
11835: if (srchterm == "") {
11836: checkok = 0;
1.1222 damieng 11837: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11838: }
11839:
1.569 raeburn 11840: if (srchtype== 'begins') {
11841: if (srchterm.length < 2) {
11842: checkok = 0;
1.1222 damieng 11843: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11844: }
11845: }
11846:
1.556 raeburn 11847: if (srchtype== 'contains') {
11848: if (srchterm.length < 3) {
11849: checkok = 0;
1.1222 damieng 11850: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11851: }
11852: }
11853: if (srchin == 'instd') {
11854: if (srchdomain == '') {
11855: checkok = 0;
1.1222 damieng 11856: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11857: }
11858: }
11859: if (srchin == 'dom') {
11860: if (srchdomain == '') {
11861: checkok = 0;
1.1222 damieng 11862: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11863: }
11864: }
11865: if (srchby == 'lastfirst') {
11866: if (srchterm.indexOf(",") == -1) {
11867: checkok = 0;
1.1222 damieng 11868: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11869: }
11870: if (srchterm.indexOf(",") == srchterm.length -1) {
11871: checkok = 0;
1.1222 damieng 11872: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11873: }
11874: }
11875: if (checkok == 0) {
1.1222 damieng 11876: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11877: return;
11878: }
11879: if (checkok == 1) {
1.570 raeburn 11880: callingForm.submit();
1.556 raeburn 11881: }
11882: }
11883:
11884: $newuserscript
11885:
1.824 bisitz 11886: // ]]>
1.556 raeburn 11887: </script>
1.558 albertel 11888:
11889: $new_user_create
11890:
1.555 raeburn 11891: END_BLOCK
1.558 albertel 11892:
1.876 raeburn 11893: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11894: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11895: $domform.
11896: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11897: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11898: $srchbysel.
11899: $srchtypesel.
11900: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11901: $srchinsel.
11902: &Apache::lonhtmlcommon::row_closure(1).
11903: &Apache::lonhtmlcommon::end_pick_box().
11904: '<br />';
1.1253 raeburn 11905: return ($output,1);
1.555 raeburn 11906: }
11907:
1.612 raeburn 11908: sub user_rule_check {
1.615 raeburn 11909: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11910: my ($response,%inst_response);
1.612 raeburn 11911: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11912: if (keys(%{$usershash}) > 1) {
11913: my (%by_username,%by_id,%userdoms);
11914: my $checkid;
11915: if (ref($checks) eq 'HASH') {
11916: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11917: $checkid = 1;
11918: }
11919: }
11920: foreach my $user (keys(%{$usershash})) {
11921: my ($uname,$udom) = split(/:/,$user);
11922: if ($checkid) {
11923: if (ref($usershash->{$user}) eq 'HASH') {
11924: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11925: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11926: $userdoms{$udom} = 1;
1.1227 raeburn 11927: if (ref($inst_results) eq 'HASH') {
11928: $inst_results->{$uname.':'.$udom} = {};
11929: }
1.1226 raeburn 11930: }
11931: }
11932: } else {
11933: $by_username{$udom}{$uname} = 1;
11934: $userdoms{$udom} = 1;
1.1227 raeburn 11935: if (ref($inst_results) eq 'HASH') {
11936: $inst_results->{$uname.':'.$udom} = {};
11937: }
1.1226 raeburn 11938: }
11939: }
11940: foreach my $udom (keys(%userdoms)) {
11941: if (!$got_rules->{$udom}) {
11942: my %domconfig = &Apache::lonnet::get_dom('configuration',
11943: ['usercreation'],$udom);
11944: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11945: foreach my $item ('username','id') {
11946: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11947: $$curr_rules{$udom}{$item} =
11948: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11949: }
11950: }
11951: }
11952: $got_rules->{$udom} = 1;
11953: }
1.612 raeburn 11954: }
1.1226 raeburn 11955: if ($checkid) {
11956: foreach my $udom (keys(%by_id)) {
11957: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11958: if ($outcome eq 'ok') {
1.1227 raeburn 11959: foreach my $id (keys(%{$by_id{$udom}})) {
11960: my $uname = $by_id{$udom}{$id};
11961: $inst_response{$uname.':'.$udom} = $outcome;
11962: }
1.1226 raeburn 11963: if (ref($results) eq 'HASH') {
11964: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11965: if (exists($inst_response{$uname.':'.$udom})) {
11966: $inst_response{$uname.':'.$udom} = $outcome;
11967: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11968: }
1.1226 raeburn 11969: }
11970: }
11971: }
1.612 raeburn 11972: }
1.615 raeburn 11973: } else {
1.1226 raeburn 11974: foreach my $udom (keys(%by_username)) {
11975: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11976: if ($outcome eq 'ok') {
1.1227 raeburn 11977: foreach my $uname (keys(%{$by_username{$udom}})) {
11978: $inst_response{$uname.':'.$udom} = $outcome;
11979: }
1.1226 raeburn 11980: if (ref($results) eq 'HASH') {
11981: foreach my $uname (keys(%{$results})) {
11982: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11983: }
11984: }
11985: }
11986: }
1.612 raeburn 11987: }
1.1226 raeburn 11988: } elsif (keys(%{$usershash}) == 1) {
11989: my $user = (keys(%{$usershash}))[0];
11990: my ($uname,$udom) = split(/:/,$user);
11991: if (($udom ne '') && ($uname ne '')) {
11992: if (ref($usershash->{$user}) eq 'HASH') {
11993: if (ref($checks) eq 'HASH') {
11994: if (defined($checks->{'username'})) {
11995: ($inst_response{$user},%{$inst_results->{$user}}) =
11996: &Apache::lonnet::get_instuser($udom,$uname);
11997: } elsif (defined($checks->{'id'})) {
11998: if ($usershash->{$user}->{'id'} ne '') {
11999: ($inst_response{$user},%{$inst_results->{$user}}) =
12000: &Apache::lonnet::get_instuser($udom,undef,
12001: $usershash->{$user}->{'id'});
12002: } else {
12003: ($inst_response{$user},%{$inst_results->{$user}}) =
12004: &Apache::lonnet::get_instuser($udom,$uname);
12005: }
1.585 raeburn 12006: }
1.1226 raeburn 12007: } else {
12008: ($inst_response{$user},%{$inst_results->{$user}}) =
12009: &Apache::lonnet::get_instuser($udom,$uname);
12010: return;
12011: }
12012: if (!$got_rules->{$udom}) {
12013: my %domconfig = &Apache::lonnet::get_dom('configuration',
12014: ['usercreation'],$udom);
12015: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12016: foreach my $item ('username','id') {
12017: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12018: $$curr_rules{$udom}{$item} =
12019: $domconfig{'usercreation'}{$item.'_rule'};
12020: }
12021: }
12022: }
12023: $got_rules->{$udom} = 1;
1.585 raeburn 12024: }
12025: }
1.1226 raeburn 12026: } else {
12027: return;
12028: }
12029: } else {
12030: return;
12031: }
12032: foreach my $user (keys(%{$usershash})) {
12033: my ($uname,$udom) = split(/:/,$user);
12034: next if (($udom eq '') || ($uname eq ''));
12035: my $id;
1.1227 raeburn 12036: if (ref($inst_results) eq 'HASH') {
12037: if (ref($inst_results->{$user}) eq 'HASH') {
12038: $id = $inst_results->{$user}->{'id'};
12039: }
12040: }
12041: if ($id eq '') {
12042: if (ref($usershash->{$user})) {
12043: $id = $usershash->{$user}->{'id'};
12044: }
1.585 raeburn 12045: }
1.612 raeburn 12046: foreach my $item (keys(%{$checks})) {
12047: if (ref($$curr_rules{$udom}) eq 'HASH') {
12048: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12049: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12050: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12051: $$curr_rules{$udom}{$item});
1.612 raeburn 12052: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12053: if ($rule_check{$rule}) {
12054: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12055: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12056: if (ref($inst_results) eq 'HASH') {
12057: if (ref($inst_results->{$user}) eq 'HASH') {
12058: if (keys(%{$inst_results->{$user}}) == 0) {
12059: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12060: } elsif ($item eq 'id') {
12061: if ($inst_results->{$user}->{'id'} eq '') {
12062: $$alerts{$item}{$udom}{$uname} = 1;
12063: }
1.615 raeburn 12064: }
1.612 raeburn 12065: }
12066: }
1.615 raeburn 12067: }
12068: last;
1.585 raeburn 12069: }
12070: }
12071: }
12072: }
12073: }
12074: }
12075: }
12076: }
1.612 raeburn 12077: return;
12078: }
12079:
12080: sub user_rule_formats {
12081: my ($domain,$domdesc,$curr_rules,$check) = @_;
12082: my %text = (
12083: 'username' => 'Usernames',
12084: 'id' => 'IDs',
12085: );
12086: my $output;
12087: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12088: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12089: if (@{$ruleorder} > 0) {
1.1102 raeburn 12090: $output = '<br />'.
12091: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12092: '<span class="LC_cusr_emph">','</span>',$domdesc).
12093: ' <ul>';
1.612 raeburn 12094: foreach my $rule (@{$ruleorder}) {
12095: if (ref($curr_rules) eq 'ARRAY') {
12096: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12097: if (ref($rules->{$rule}) eq 'HASH') {
12098: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12099: $rules->{$rule}{'desc'}.'</li>';
12100: }
12101: }
12102: }
12103: }
12104: $output .= '</ul>';
12105: }
12106: }
12107: return $output;
12108: }
12109:
12110: sub instrule_disallow_msg {
1.615 raeburn 12111: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12112: my $response;
12113: my %text = (
12114: item => 'username',
12115: items => 'usernames',
12116: match => 'matches',
12117: do => 'does',
12118: action => 'a username',
12119: one => 'one',
12120: );
12121: if ($count > 1) {
12122: $text{'item'} = 'usernames';
12123: $text{'match'} ='match';
12124: $text{'do'} = 'do';
12125: $text{'action'} = 'usernames',
12126: $text{'one'} = 'ones';
12127: }
12128: if ($checkitem eq 'id') {
12129: $text{'items'} = 'IDs';
12130: $text{'item'} = 'ID';
12131: $text{'action'} = 'an ID';
1.615 raeburn 12132: if ($count > 1) {
12133: $text{'item'} = 'IDs';
12134: $text{'action'} = 'IDs';
12135: }
1.612 raeburn 12136: }
1.674 bisitz 12137: $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 12138: if ($mode eq 'upload') {
12139: if ($checkitem eq 'username') {
12140: $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'}.");
12141: } elsif ($checkitem eq 'id') {
1.674 bisitz 12142: $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 12143: }
1.669 raeburn 12144: } elsif ($mode eq 'selfcreate') {
12145: if ($checkitem eq 'id') {
12146: $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.");
12147: }
1.615 raeburn 12148: } else {
12149: if ($checkitem eq 'username') {
12150: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12151: } elsif ($checkitem eq 'id') {
12152: $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.");
12153: }
1.612 raeburn 12154: }
12155: return $response;
1.585 raeburn 12156: }
12157:
1.624 raeburn 12158: sub personal_data_fieldtitles {
12159: my %fieldtitles = &Apache::lonlocal::texthash (
12160: id => 'Student/Employee ID',
12161: permanentemail => 'E-mail address',
12162: lastname => 'Last Name',
12163: firstname => 'First Name',
12164: middlename => 'Middle Name',
12165: generation => 'Generation',
12166: gen => 'Generation',
1.765 raeburn 12167: inststatus => 'Affiliation',
1.624 raeburn 12168: );
12169: return %fieldtitles;
12170: }
12171:
1.642 raeburn 12172: sub sorted_inst_types {
12173: my ($dom) = @_;
1.1185 raeburn 12174: my ($usertypes,$order);
12175: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12176: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12177: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12178: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12179: } else {
12180: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12181: }
1.642 raeburn 12182: my $othertitle = &mt('All users');
12183: if ($env{'request.course.id'}) {
1.668 raeburn 12184: $othertitle = &mt('Any users');
1.642 raeburn 12185: }
12186: my @types;
12187: if (ref($order) eq 'ARRAY') {
12188: @types = @{$order};
12189: }
12190: if (@types == 0) {
12191: if (ref($usertypes) eq 'HASH') {
12192: @types = sort(keys(%{$usertypes}));
12193: }
12194: }
12195: if (keys(%{$usertypes}) > 0) {
12196: $othertitle = &mt('Other users');
12197: }
12198: return ($othertitle,$usertypes,\@types);
12199: }
12200:
1.645 raeburn 12201: sub get_institutional_codes {
1.1361 raeburn 12202: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12203: # Get complete list of course sections to update
12204: my @currsections = ();
12205: my @currxlists = ();
1.1361 raeburn 12206: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12207: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12208: my $crskey = $crs.':'.$coursecode;
12209: @{$unclutteredsec{$crskey}} = ();
12210: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12211:
12212: if ($$settings{'internal.sectionnums'} ne '') {
12213: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12214: }
12215:
12216: if ($$settings{'internal.crosslistings'} ne '') {
12217: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12218: }
12219:
12220: if (@currxlists > 0) {
1.1361 raeburn 12221: foreach my $xl (@currxlists) {
12222: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12223: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12224: push(@{$allcourses},$1);
1.645 raeburn 12225: $$LC_code{$1} = $2;
12226: }
12227: }
12228: }
12229: }
1.1361 raeburn 12230:
1.645 raeburn 12231: if (@currsections > 0) {
1.1361 raeburn 12232: foreach my $sec (@currsections) {
12233: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12234: my $instsec = $1;
1.645 raeburn 12235: my $lc_sec = $2;
1.1361 raeburn 12236: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12237: push(@{$unclutteredsec{$crskey}},$instsec);
12238: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12239: }
12240: }
12241: }
12242: }
12243:
12244: if (@{$unclutteredsec{$crskey}} > 0) {
12245: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12246: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12247: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12248: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12249: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12250: push(@{$allcourses},$sec);
1.1361 raeburn 12251: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12252: }
12253: }
12254: }
12255: }
12256: return;
12257: }
12258:
1.971 raeburn 12259: sub get_standard_codeitems {
12260: return ('Year','Semester','Department','Number','Section');
12261: }
12262:
1.112 bowersj2 12263: =pod
12264:
1.780 raeburn 12265: =head1 Slot Helpers
12266:
12267: =over 4
12268:
12269: =item * sorted_slots()
12270:
1.1040 raeburn 12271: Sorts an array of slot names in order of an optional sort key,
12272: default sort is by slot start time (earliest first).
1.780 raeburn 12273:
12274: Inputs:
12275:
12276: =over 4
12277:
12278: slotsarr - Reference to array of unsorted slot names.
12279:
12280: slots - Reference to hash of hash, where outer hash keys are slot names.
12281:
1.1040 raeburn 12282: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12283:
1.549 albertel 12284: =back
12285:
1.780 raeburn 12286: Returns:
12287:
12288: =over 4
12289:
1.1040 raeburn 12290: sorted - An array of slot names sorted by a specified sort key
12291: (default sort key is start time of the slot).
1.780 raeburn 12292:
12293: =back
12294:
12295: =cut
12296:
12297:
12298: sub sorted_slots {
1.1040 raeburn 12299: my ($slotsarr,$slots,$sortkey) = @_;
12300: if ($sortkey eq '') {
12301: $sortkey = 'starttime';
12302: }
1.780 raeburn 12303: my @sorted;
12304: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12305: @sorted =
12306: sort {
12307: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12308: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12309: }
12310: if (ref($slots->{$a})) { return -1;}
12311: if (ref($slots->{$b})) { return 1;}
12312: return 0;
12313: } @{$slotsarr};
12314: }
12315: return @sorted;
12316: }
12317:
1.1040 raeburn 12318: =pod
12319:
12320: =item * get_future_slots()
12321:
12322: Inputs:
12323:
12324: =over 4
12325:
12326: cnum - course number
12327:
12328: cdom - course domain
12329:
12330: now - current UNIX time
12331:
12332: symb - optional symb
12333:
12334: =back
12335:
12336: Returns:
12337:
12338: =over 4
12339:
12340: sorted_reservable - ref to array of student_schedulable slots currently
12341: reservable, ordered by end date of reservation period.
12342:
12343: reservable_now - ref to hash of student_schedulable slots currently
12344: reservable.
12345:
12346: Keys in inner hash are:
12347: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12348: (b) endreserve: end date of reservation period.
12349: (c) uniqueperiod: start,end dates when slot is to be uniquely
12350: selected.
1.1040 raeburn 12351:
12352: sorted_future - ref to array of student_schedulable slots reservable in
12353: the future, ordered by start date of reservation period.
12354:
12355: future_reservable - ref to hash of student_schedulable slots reservable
12356: in the future.
12357:
12358: Keys in inner hash are:
12359: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12360: (b) startreserve: start date of reservation period.
12361: (c) uniqueperiod: start,end dates when slot is to be uniquely
12362: selected.
1.1040 raeburn 12363:
12364: =back
12365:
12366: =cut
12367:
12368: sub get_future_slots {
12369: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12370: my $map;
12371: if ($symb) {
12372: ($map) = &Apache::lonnet::decode_symb($symb);
12373: }
1.1040 raeburn 12374: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12375: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12376: foreach my $slot (keys(%slots)) {
12377: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12378: if ($symb) {
1.1229 raeburn 12379: if ($slots{$slot}->{'symb'} ne '') {
12380: my $canuse;
12381: my %oksymbs;
12382: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12383: map { $oksymbs{$_} = 1; } @slotsymbs;
12384: if ($oksymbs{$symb}) {
12385: $canuse = 1;
12386: } else {
12387: foreach my $item (@slotsymbs) {
12388: if ($item =~ /\.(page|sequence)$/) {
12389: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12390: if (($map ne '') && ($map eq $sloturl)) {
12391: $canuse = 1;
12392: last;
12393: }
12394: }
12395: }
12396: }
12397: next unless ($canuse);
12398: }
1.1040 raeburn 12399: }
12400: if (($slots{$slot}->{'starttime'} > $now) &&
12401: ($slots{$slot}->{'endtime'} > $now)) {
12402: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12403: my $userallowed = 0;
12404: if ($slots{$slot}->{'allowedsections'}) {
12405: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12406: if (!defined($env{'request.role.sec'})
12407: && grep(/^No section assigned$/,@allowed_sec)) {
12408: $userallowed=1;
12409: } else {
12410: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12411: $userallowed=1;
12412: }
12413: }
12414: unless ($userallowed) {
12415: if (defined($env{'request.course.groups'})) {
12416: my @groups = split(/:/,$env{'request.course.groups'});
12417: foreach my $group (@groups) {
12418: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12419: $userallowed=1;
12420: last;
12421: }
12422: }
12423: }
12424: }
12425: }
12426: if ($slots{$slot}->{'allowedusers'}) {
12427: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12428: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12429: if (grep(/^\Q$user\E$/,@allowed_users)) {
12430: $userallowed = 1;
12431: }
12432: }
12433: next unless($userallowed);
12434: }
12435: my $startreserve = $slots{$slot}->{'startreserve'};
12436: my $endreserve = $slots{$slot}->{'endreserve'};
12437: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12438: my $uniqueperiod;
12439: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12440: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12441: }
1.1040 raeburn 12442: if (($startreserve < $now) &&
12443: (!$endreserve || $endreserve > $now)) {
12444: my $lastres = $endreserve;
12445: if (!$lastres) {
12446: $lastres = $slots{$slot}->{'starttime'};
12447: }
12448: $reservable_now{$slot} = {
12449: symb => $symb,
1.1250 raeburn 12450: endreserve => $lastres,
12451: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12452: };
12453: } elsif (($startreserve > $now) &&
12454: (!$endreserve || $endreserve > $startreserve)) {
12455: $future_reservable{$slot} = {
12456: symb => $symb,
1.1250 raeburn 12457: startreserve => $startreserve,
12458: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12459: };
12460: }
12461: }
12462: }
12463: my @unsorted_reservable = keys(%reservable_now);
12464: if (@unsorted_reservable > 0) {
12465: @sorted_reservable =
12466: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12467: }
12468: my @unsorted_future = keys(%future_reservable);
12469: if (@unsorted_future > 0) {
12470: @sorted_future =
12471: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12472: }
12473: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12474: }
1.780 raeburn 12475:
12476: =pod
12477:
1.1057 foxr 12478: =back
12479:
1.549 albertel 12480: =head1 HTTP Helpers
12481:
12482: =over 4
12483:
1.648 raeburn 12484: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12485:
1.258 albertel 12486: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12487: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12488: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12489:
12490: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12491: $possible_names is an ref to an array of form element names. As an example:
12492: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12493: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12494:
12495: =cut
1.1 albertel 12496:
1.6 albertel 12497: sub get_unprocessed_cgi {
1.25 albertel 12498: my ($query,$possible_names)= @_;
1.26 matthew 12499: # $Apache::lonxml::debug=1;
1.356 albertel 12500: foreach my $pair (split(/&/,$query)) {
12501: my ($name, $value) = split(/=/,$pair);
1.369 www 12502: $name = &unescape($name);
1.25 albertel 12503: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12504: $value =~ tr/+/ /;
12505: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12506: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12507: }
1.16 harris41 12508: }
1.6 albertel 12509: }
12510:
1.112 bowersj2 12511: =pod
12512:
1.648 raeburn 12513: =item * &cacheheader()
1.112 bowersj2 12514:
12515: returns cache-controlling header code
12516:
12517: =cut
12518:
1.7 albertel 12519: sub cacheheader {
1.258 albertel 12520: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12521: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12522: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12523: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12524: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12525: return $output;
1.7 albertel 12526: }
12527:
1.112 bowersj2 12528: =pod
12529:
1.648 raeburn 12530: =item * &no_cache($r)
1.112 bowersj2 12531:
12532: specifies header code to not have cache
12533:
12534: =cut
12535:
1.9 albertel 12536: sub no_cache {
1.216 albertel 12537: my ($r) = @_;
12538: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12539: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12540: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12541: $r->no_cache(1);
12542: $r->header_out("Expires" => $date);
12543: $r->header_out("Pragma" => "no-cache");
1.123 www 12544: }
12545:
12546: sub content_type {
1.181 albertel 12547: my ($r,$type,$charset) = @_;
1.299 foxr 12548: if ($r) {
12549: # Note that printout.pl calls this with undef for $r.
12550: &no_cache($r);
12551: }
1.258 albertel 12552: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12553: unless ($charset) {
12554: $charset=&Apache::lonlocal::current_encoding;
12555: }
12556: if ($charset) { $type.='; charset='.$charset; }
12557: if ($r) {
12558: $r->content_type($type);
12559: } else {
12560: print("Content-type: $type\n\n");
12561: }
1.9 albertel 12562: }
1.25 albertel 12563:
1.112 bowersj2 12564: =pod
12565:
1.648 raeburn 12566: =item * &add_to_env($name,$value)
1.112 bowersj2 12567:
1.258 albertel 12568: adds $name to the %env hash with value
1.112 bowersj2 12569: $value, if $name already exists, the entry is converted to an array
12570: reference and $value is added to the array.
12571:
12572: =cut
12573:
1.25 albertel 12574: sub add_to_env {
12575: my ($name,$value)=@_;
1.258 albertel 12576: if (defined($env{$name})) {
12577: if (ref($env{$name})) {
1.25 albertel 12578: #already have multiple values
1.258 albertel 12579: push(@{ $env{$name} },$value);
1.25 albertel 12580: } else {
12581: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12582: my $first=$env{$name};
12583: undef($env{$name});
12584: push(@{ $env{$name} },$first,$value);
1.25 albertel 12585: }
12586: } else {
1.258 albertel 12587: $env{$name}=$value;
1.25 albertel 12588: }
1.31 albertel 12589: }
1.149 albertel 12590:
12591: =pod
12592:
1.648 raeburn 12593: =item * &get_env_multiple($name)
1.149 albertel 12594:
1.258 albertel 12595: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12596: values may be defined and end up as an array ref.
12597:
12598: returns an array of values
12599:
12600: =cut
12601:
12602: sub get_env_multiple {
12603: my ($name) = @_;
12604: my @values;
1.258 albertel 12605: if (defined($env{$name})) {
1.149 albertel 12606: # exists is it an array
1.258 albertel 12607: if (ref($env{$name})) {
12608: @values=@{ $env{$name} };
1.149 albertel 12609: } else {
1.258 albertel 12610: $values[0]=$env{$name};
1.149 albertel 12611: }
12612: }
12613: return(@values);
12614: }
12615:
1.1249 damieng 12616: # Looks at given dependencies, and returns something depending on the context.
12617: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12618: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12619: # For all other contexts, returns ($output, $counter, $numpathchg).
12620: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12621: # $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.
12622: # $numpathchg: integer with the number of cleaned up dependency paths.
12623: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12624: # \%mapping: hash reference clean path -> original path for all dependencies.
12625: # @param {string} actionurl - The path to the handler, indicative of the context.
12626: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12627: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12628: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12629: # @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)
12630: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12631: sub ask_for_embedded_content {
1.1249 damieng 12632: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12633: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12634: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12635: %currsubfile,%unused,$rem);
1.1071 raeburn 12636: my $counter = 0;
12637: my $numnew = 0;
1.987 raeburn 12638: my $numremref = 0;
12639: my $numinvalid = 0;
12640: my $numpathchg = 0;
12641: my $numexisting = 0;
1.1071 raeburn 12642: my $numunused = 0;
12643: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12644: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12645: my $heading = &mt('Upload embedded files');
12646: my $buttontext = &mt('Upload');
12647:
1.1249 damieng 12648: # fills these variables based on the context:
12649: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12650: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12651: if ($env{'request.course.id'}) {
1.1123 raeburn 12652: if ($actionurl eq '/adm/dependencies') {
12653: $navmap = Apache::lonnavmaps::navmap->new();
12654: }
12655: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12656: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12657: }
1.1123 raeburn 12658: if (($actionurl eq '/adm/portfolio') ||
12659: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12660: my $current_path='/';
12661: if ($env{'form.currentpath'}) {
12662: $current_path = $env{'form.currentpath'};
12663: }
12664: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12665: $udom = $cdom;
12666: $uname = $cnum;
1.984 raeburn 12667: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12668: } else {
12669: $udom = $env{'user.domain'};
12670: $uname = $env{'user.name'};
12671: $url = '/userfiles/portfolio';
12672: }
1.987 raeburn 12673: $toplevel = $url.'/';
1.984 raeburn 12674: $url .= $current_path;
12675: $getpropath = 1;
1.987 raeburn 12676: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12677: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12678: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12679: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12680: $toplevel = $url;
1.984 raeburn 12681: if ($rest ne '') {
1.987 raeburn 12682: $url .= $rest;
12683: }
12684: } elsif ($actionurl eq '/adm/coursedocs') {
12685: if (ref($args) eq 'HASH') {
1.1071 raeburn 12686: $url = $args->{'docs_url'};
12687: $toplevel = $url;
1.1084 raeburn 12688: if ($args->{'context'} eq 'paste') {
12689: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12690: ($path) =
12691: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12692: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12693: $fileloc =~ s{^/}{};
12694: }
1.1071 raeburn 12695: }
1.1084 raeburn 12696: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12697: if ($env{'request.course.id'} ne '') {
12698: if (ref($args) eq 'HASH') {
12699: $url = $args->{'docs_url'};
12700: $title = $args->{'docs_title'};
1.1126 raeburn 12701: $toplevel = $url;
12702: unless ($toplevel =~ m{^/}) {
12703: $toplevel = "/$url";
12704: }
1.1085 raeburn 12705: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12706: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12707: $path = $1;
12708: } else {
12709: ($path) =
12710: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12711: }
1.1195 raeburn 12712: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12713: $fileloc = $toplevel;
12714: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12715: my ($udom,$uname,$fname) =
12716: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12717: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12718: } else {
12719: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12720: }
1.1071 raeburn 12721: $fileloc =~ s{^/}{};
12722: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12723: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12724: }
1.987 raeburn 12725: }
1.1123 raeburn 12726: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12727: $udom = $cdom;
12728: $uname = $cnum;
12729: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12730: $toplevel = $url;
12731: $path = $url;
12732: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12733: $fileloc =~ s{^/}{};
1.987 raeburn 12734: }
1.1249 damieng 12735:
12736: # parses the dependency paths to get some info
12737: # fills $newfiles, $mapping, $subdependencies, $dependencies
12738: # $newfiles: hash URL -> 1 for new files or external URLs
12739: # (will be completed later)
12740: # $mapping:
12741: # for external URLs: external URL -> external URL
12742: # for relative paths: clean path -> original path
12743: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12744: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12745: foreach my $file (keys(%{$allfiles})) {
12746: my $embed_file;
12747: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12748: $embed_file = $1;
12749: } else {
12750: $embed_file = $file;
12751: }
1.1158 raeburn 12752: my ($absolutepath,$cleaned_file);
12753: if ($embed_file =~ m{^\w+://}) {
12754: $cleaned_file = $embed_file;
1.1147 raeburn 12755: $newfiles{$cleaned_file} = 1;
12756: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12757: } else {
1.1158 raeburn 12758: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12759: if ($embed_file =~ m{^/}) {
12760: $absolutepath = $embed_file;
12761: }
1.1147 raeburn 12762: if ($cleaned_file =~ m{/}) {
12763: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12764: $path = &check_for_traversal($path,$url,$toplevel);
12765: my $item = $fname;
12766: if ($path ne '') {
12767: $item = $path.'/'.$fname;
12768: $subdependencies{$path}{$fname} = 1;
12769: } else {
12770: $dependencies{$item} = 1;
12771: }
12772: if ($absolutepath) {
12773: $mapping{$item} = $absolutepath;
12774: } else {
12775: $mapping{$item} = $embed_file;
12776: }
12777: } else {
12778: $dependencies{$embed_file} = 1;
12779: if ($absolutepath) {
1.1147 raeburn 12780: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12781: } else {
1.1147 raeburn 12782: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12783: }
12784: }
1.984 raeburn 12785: }
12786: }
1.1249 damieng 12787:
12788: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12789: # and lists
12790: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12791: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12792: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12793: # the path had to be cleaned up
12794: # $existing: hash clean path -> 1 if the file exists
12795: # $numexisting: number of keys in $existing
12796: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12797: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12798: # dependency subdirectories that are
12799: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12800: my $dirptr = 16384;
1.984 raeburn 12801: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12802: $currsubfile{$path} = {};
1.1123 raeburn 12803: if (($actionurl eq '/adm/portfolio') ||
12804: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12805: my ($sublistref,$listerror) =
12806: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12807: if (ref($sublistref) eq 'ARRAY') {
12808: foreach my $line (@{$sublistref}) {
12809: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12810: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12811: }
1.984 raeburn 12812: }
1.987 raeburn 12813: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12814: if (opendir(my $dir,$url.'/'.$path)) {
12815: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12816: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12817: }
1.1084 raeburn 12818: } elsif (($actionurl eq '/adm/dependencies') ||
12819: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12820: ($args->{'context'} eq 'paste')) ||
12821: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12822: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12823: my $dir;
12824: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12825: $dir = $fileloc;
12826: } else {
12827: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12828: }
1.1071 raeburn 12829: if ($dir ne '') {
12830: my ($sublistref,$listerror) =
12831: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12832: if (ref($sublistref) eq 'ARRAY') {
12833: foreach my $line (@{$sublistref}) {
12834: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12835: undef,$mtime)=split(/\&/,$line,12);
12836: unless (($testdir&$dirptr) ||
12837: ($file_name =~ /^\.\.?$/)) {
12838: $currsubfile{$path}{$file_name} = [$size,$mtime];
12839: }
12840: }
12841: }
12842: }
1.984 raeburn 12843: }
12844: }
12845: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12846: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12847: my $item = $path.'/'.$file;
12848: unless ($mapping{$item} eq $item) {
12849: $pathchanges{$item} = 1;
12850: }
12851: $existing{$item} = 1;
12852: $numexisting ++;
12853: } else {
12854: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12855: }
12856: }
1.1071 raeburn 12857: if ($actionurl eq '/adm/dependencies') {
12858: foreach my $path (keys(%currsubfile)) {
12859: if (ref($currsubfile{$path}) eq 'HASH') {
12860: foreach my $file (keys(%{$currsubfile{$path}})) {
12861: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12862: next if (($rem ne '') &&
12863: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12864: (ref($navmap) &&
12865: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12866: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12867: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12868: $unused{$path.'/'.$file} = 1;
12869: }
12870: }
12871: }
12872: }
12873: }
1.984 raeburn 12874: }
1.1249 damieng 12875:
12876: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12877: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12878: my %currfile;
1.1123 raeburn 12879: if (($actionurl eq '/adm/portfolio') ||
12880: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12881: my ($dirlistref,$listerror) =
12882: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12883: if (ref($dirlistref) eq 'ARRAY') {
12884: foreach my $line (@{$dirlistref}) {
12885: my ($file_name,$rest) = split(/\&/,$line,2);
12886: $currfile{$file_name} = 1;
12887: }
1.984 raeburn 12888: }
1.987 raeburn 12889: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12890: if (opendir(my $dir,$url)) {
1.987 raeburn 12891: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12892: map {$currfile{$_} = 1;} @dir_list;
12893: }
1.1084 raeburn 12894: } elsif (($actionurl eq '/adm/dependencies') ||
12895: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12896: ($args->{'context'} eq 'paste')) ||
12897: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12898: if ($env{'request.course.id'} ne '') {
12899: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12900: if ($dir ne '') {
12901: my ($dirlistref,$listerror) =
12902: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12903: if (ref($dirlistref) eq 'ARRAY') {
12904: foreach my $line (@{$dirlistref}) {
12905: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12906: $size,undef,$mtime)=split(/\&/,$line,12);
12907: unless (($testdir&$dirptr) ||
12908: ($file_name =~ /^\.\.?$/)) {
12909: $currfile{$file_name} = [$size,$mtime];
12910: }
12911: }
12912: }
12913: }
12914: }
1.984 raeburn 12915: }
1.1249 damieng 12916: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12917: # are not in subdirectories, using $currfile
1.984 raeburn 12918: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12919: if (exists($currfile{$file})) {
1.987 raeburn 12920: unless ($mapping{$file} eq $file) {
12921: $pathchanges{$file} = 1;
12922: }
12923: $existing{$file} = 1;
12924: $numexisting ++;
12925: } else {
1.984 raeburn 12926: $newfiles{$file} = 1;
12927: }
12928: }
1.1071 raeburn 12929: foreach my $file (keys(%currfile)) {
12930: unless (($file eq $filename) ||
12931: ($file eq $filename.'.bak') ||
12932: ($dependencies{$file})) {
1.1085 raeburn 12933: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12934: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12935: next if (($rem ne '') &&
12936: (($env{"httpref.$rem".$file} ne '') ||
12937: (ref($navmap) &&
12938: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12939: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12940: ($navmap->getResourceByUrl($rem.$1)))))));
12941: }
1.1085 raeburn 12942: }
1.1071 raeburn 12943: $unused{$file} = 1;
12944: }
12945: }
1.1249 damieng 12946:
12947: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12948: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12949: ($args->{'context'} eq 'paste')) {
12950: $counter = scalar(keys(%existing));
12951: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12952: return ($output,$counter,$numpathchg,\%existing);
12953: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12954: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12955: $counter = scalar(keys(%existing));
12956: $numpathchg = scalar(keys(%pathchanges));
12957: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12958: }
1.1249 damieng 12959:
12960: # returns HTML otherwise, with dependency results and to ask for more uploads
12961:
12962: # $upload_output: missing dependencies (with upload form)
12963: # $modify_output: uploaded dependencies (in use)
12964: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12965: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12966: if ($actionurl eq '/adm/dependencies') {
12967: next if ($embed_file =~ m{^\w+://});
12968: }
1.660 raeburn 12969: $upload_output .= &start_data_table_row().
1.1123 raeburn 12970: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12971: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12972: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12973: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12974: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12975: }
1.1123 raeburn 12976: $upload_output .= '</td>';
1.1071 raeburn 12977: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 12978: $upload_output.='<td align="right">'.
12979: '<span class="LC_info LC_fontsize_medium">'.
12980: &mt("URL points to web address").'</span>';
1.987 raeburn 12981: $numremref++;
1.660 raeburn 12982: } elsif ($args->{'error_on_invalid_names'}
12983: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 12984: $upload_output.='<td align="right"><span class="LC_warning">'.
12985: &mt('Invalid characters').'</span>';
1.987 raeburn 12986: $numinvalid++;
1.660 raeburn 12987: } else {
1.1123 raeburn 12988: $upload_output .= '<td>'.
12989: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 12990: $embed_file,\%mapping,
1.1071 raeburn 12991: $allfiles,$codebase,'upload');
12992: $counter ++;
12993: $numnew ++;
1.987 raeburn 12994: }
12995: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
12996: }
12997: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 12998: if ($actionurl eq '/adm/dependencies') {
12999: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13000: $modify_output .= &start_data_table_row().
13001: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13002: '<img src="'.&icon($embed_file).'" border="0" />'.
13003: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13004: '<td>'.$size.'</td>'.
13005: '<td>'.$mtime.'</td>'.
13006: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13007: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13008: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13009: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13010: &embedded_file_element('upload_embedded',$counter,
13011: $embed_file,\%mapping,
13012: $allfiles,$codebase,'modify').
13013: '</div></td>'.
13014: &end_data_table_row()."\n";
13015: $counter ++;
13016: } else {
13017: $upload_output .= &start_data_table_row().
1.1123 raeburn 13018: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13019: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13020: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13021: &Apache::loncommon::end_data_table_row()."\n";
13022: }
13023: }
13024: my $delidx = $counter;
13025: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13026: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13027: $delete_output .= &start_data_table_row().
13028: '<td><img src="'.&icon($oldfile).'" />'.
13029: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13030: '<td>'.$size.'</td>'.
13031: '<td>'.$mtime.'</td>'.
13032: '<td><label><input type="checkbox" name="del_upload_dep" '.
13033: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13034: &embedded_file_element('upload_embedded',$delidx,
13035: $oldfile,\%mapping,$allfiles,
13036: $codebase,'delete').'</td>'.
13037: &end_data_table_row()."\n";
13038: $numunused ++;
13039: $delidx ++;
1.987 raeburn 13040: }
13041: if ($upload_output) {
13042: $upload_output = &start_data_table().
13043: $upload_output.
13044: &end_data_table()."\n";
13045: }
1.1071 raeburn 13046: if ($modify_output) {
13047: $modify_output = &start_data_table().
13048: &start_data_table_header_row().
13049: '<th>'.&mt('File').'</th>'.
13050: '<th>'.&mt('Size (KB)').'</th>'.
13051: '<th>'.&mt('Modified').'</th>'.
13052: '<th>'.&mt('Upload replacement?').'</th>'.
13053: &end_data_table_header_row().
13054: $modify_output.
13055: &end_data_table()."\n";
13056: }
13057: if ($delete_output) {
13058: $delete_output = &start_data_table().
13059: &start_data_table_header_row().
13060: '<th>'.&mt('File').'</th>'.
13061: '<th>'.&mt('Size (KB)').'</th>'.
13062: '<th>'.&mt('Modified').'</th>'.
13063: '<th>'.&mt('Delete?').'</th>'.
13064: &end_data_table_header_row().
13065: $delete_output.
13066: &end_data_table()."\n";
13067: }
1.987 raeburn 13068: my $applies = 0;
13069: if ($numremref) {
13070: $applies ++;
13071: }
13072: if ($numinvalid) {
13073: $applies ++;
13074: }
13075: if ($numexisting) {
13076: $applies ++;
13077: }
1.1071 raeburn 13078: if ($counter || $numunused) {
1.987 raeburn 13079: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13080: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13081: $state.'<h3>'.$heading.'</h3>';
13082: if ($actionurl eq '/adm/dependencies') {
13083: if ($numnew) {
13084: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13085: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13086: $upload_output.'<br />'."\n";
13087: }
13088: if ($numexisting) {
13089: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13090: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13091: $modify_output.'<br />'."\n";
13092: $buttontext = &mt('Save changes');
13093: }
13094: if ($numunused) {
13095: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13096: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13097: $delete_output.'<br />'."\n";
13098: $buttontext = &mt('Save changes');
13099: }
13100: } else {
13101: $output .= $upload_output.'<br />'."\n";
13102: }
13103: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13104: $counter.'" />'."\n";
13105: if ($actionurl eq '/adm/dependencies') {
13106: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13107: $numnew.'" />'."\n";
13108: } elsif ($actionurl eq '') {
1.987 raeburn 13109: $output .= '<input type="hidden" name="phase" value="three" />';
13110: }
13111: } elsif ($applies) {
13112: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13113: if ($applies > 1) {
13114: $output .=
1.1123 raeburn 13115: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13116: if ($numremref) {
13117: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13118: }
13119: if ($numinvalid) {
13120: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13121: }
13122: if ($numexisting) {
13123: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13124: }
13125: $output .= '</ul><br />';
13126: } elsif ($numremref) {
13127: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13128: } elsif ($numinvalid) {
13129: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13130: } elsif ($numexisting) {
13131: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13132: }
13133: $output .= $upload_output.'<br />';
13134: }
13135: my ($pathchange_output,$chgcount);
1.1071 raeburn 13136: $chgcount = $counter;
1.987 raeburn 13137: if (keys(%pathchanges) > 0) {
13138: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13139: if ($counter) {
1.987 raeburn 13140: $output .= &embedded_file_element('pathchange',$chgcount,
13141: $embed_file,\%mapping,
1.1071 raeburn 13142: $allfiles,$codebase,'change');
1.987 raeburn 13143: } else {
13144: $pathchange_output .=
13145: &start_data_table_row().
13146: '<td><input type ="checkbox" name="namechange" value="'.
13147: $chgcount.'" checked="checked" /></td>'.
13148: '<td>'.$mapping{$embed_file}.'</td>'.
13149: '<td>'.$embed_file.
13150: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13151: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13152: '</td>'.&end_data_table_row();
1.660 raeburn 13153: }
1.987 raeburn 13154: $numpathchg ++;
13155: $chgcount ++;
1.660 raeburn 13156: }
13157: }
1.1127 raeburn 13158: if (($counter) || ($numunused)) {
1.987 raeburn 13159: if ($numpathchg) {
13160: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13161: $numpathchg.'" />'."\n";
13162: }
13163: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13164: ($actionurl eq '/adm/imsimport')) {
13165: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13166: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13167: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13168: } elsif ($actionurl eq '/adm/dependencies') {
13169: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13170: }
1.1123 raeburn 13171: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13172: } elsif ($numpathchg) {
13173: my %pathchange = ();
13174: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13175: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13176: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13177: }
1.987 raeburn 13178: }
1.1071 raeburn 13179: return ($output,$counter,$numpathchg);
1.987 raeburn 13180: }
13181:
1.1147 raeburn 13182: =pod
13183:
13184: =item * clean_path($name)
13185:
13186: Performs clean-up of directories, subdirectories and filename in an
13187: embedded object, referenced in an HTML file which is being uploaded
13188: to a course or portfolio, where
13189: "Upload embedded images/multimedia files if HTML file" checkbox was
13190: checked.
13191:
13192: Clean-up is similar to replacements in lonnet::clean_filename()
13193: except each / between sub-directory and next level is preserved.
13194:
13195: =cut
13196:
13197: sub clean_path {
13198: my ($embed_file) = @_;
13199: $embed_file =~s{^/+}{};
13200: my @contents;
13201: if ($embed_file =~ m{/}) {
13202: @contents = split(/\//,$embed_file);
13203: } else {
13204: @contents = ($embed_file);
13205: }
13206: my $lastidx = scalar(@contents)-1;
13207: for (my $i=0; $i<=$lastidx; $i++) {
13208: $contents[$i]=~s{\\}{/}g;
13209: $contents[$i]=~s/\s+/\_/g;
13210: $contents[$i]=~s{[^/\w\.\-]}{}g;
13211: if ($i == $lastidx) {
13212: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13213: }
13214: }
13215: if ($lastidx > 0) {
13216: return join('/',@contents);
13217: } else {
13218: return $contents[0];
13219: }
13220: }
13221:
1.987 raeburn 13222: sub embedded_file_element {
1.1071 raeburn 13223: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13224: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13225: (ref($codebase) eq 'HASH'));
13226: my $output;
1.1071 raeburn 13227: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13228: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13229: }
13230: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13231: &escape($embed_file).'" />';
13232: unless (($context eq 'upload_embedded') &&
13233: ($mapping->{$embed_file} eq $embed_file)) {
13234: $output .='
13235: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13236: }
13237: my $attrib;
13238: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13239: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13240: }
13241: $output .=
13242: "\n\t\t".
13243: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13244: $attrib.'" />';
13245: if (exists($codebase->{$mapping->{$embed_file}})) {
13246: $output .=
13247: "\n\t\t".
13248: '<input name="codebase_'.$num.'" type="hidden" value="'.
13249: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13250: }
1.987 raeburn 13251: return $output;
1.660 raeburn 13252: }
13253:
1.1071 raeburn 13254: sub get_dependency_details {
13255: my ($currfile,$currsubfile,$embed_file) = @_;
13256: my ($size,$mtime,$showsize,$showmtime);
13257: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13258: if ($embed_file =~ m{/}) {
13259: my ($path,$fname) = split(/\//,$embed_file);
13260: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13261: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13262: }
13263: } else {
13264: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13265: ($size,$mtime) = @{$currfile->{$embed_file}};
13266: }
13267: }
13268: $showsize = $size/1024.0;
13269: $showsize = sprintf("%.1f",$showsize);
13270: if ($mtime > 0) {
13271: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13272: }
13273: }
13274: return ($showsize,$showmtime);
13275: }
13276:
13277: sub ask_embedded_js {
13278: return <<"END";
13279: <script type="text/javascript"">
13280: // <![CDATA[
13281: function toggleBrowse(counter) {
13282: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13283: var fileid = document.getElementById('embedded_item_'+counter);
13284: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13285: if (chkboxid.checked == true) {
13286: uploaddivid.style.display='block';
13287: } else {
13288: uploaddivid.style.display='none';
13289: fileid.value = '';
13290: }
13291: }
13292: // ]]>
13293: </script>
13294:
13295: END
13296: }
13297:
1.661 raeburn 13298: sub upload_embedded {
13299: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13300: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13301: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13302: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13303: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13304: my $orig_uploaded_filename =
13305: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13306: foreach my $type ('orig','ref','attrib','codebase') {
13307: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13308: $env{'form.embedded_'.$type.'_'.$i} =
13309: &unescape($env{'form.embedded_'.$type.'_'.$i});
13310: }
13311: }
1.661 raeburn 13312: my ($path,$fname) =
13313: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13314: # no path, whole string is fname
13315: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13316: $fname = &Apache::lonnet::clean_filename($fname);
13317: # See if there is anything left
13318: next if ($fname eq '');
13319:
13320: # Check if file already exists as a file or directory.
13321: my ($state,$msg);
13322: if ($context eq 'portfolio') {
13323: my $port_path = $dirpath;
13324: if ($group ne '') {
13325: $port_path = "groups/$group/$port_path";
13326: }
1.987 raeburn 13327: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13328: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13329: $dir_root,$port_path,$disk_quota,
13330: $current_disk_usage,$uname,$udom);
13331: if ($state eq 'will_exceed_quota'
1.984 raeburn 13332: || $state eq 'file_locked') {
1.661 raeburn 13333: $output .= $msg;
13334: next;
13335: }
13336: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13337: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13338: if ($state eq 'exists') {
13339: $output .= $msg;
13340: next;
13341: }
13342: }
13343: # Check if extension is valid
13344: if (($fname =~ /\.(\w+)$/) &&
13345: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13346: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13347: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13348: next;
13349: } elsif (($fname =~ /\.(\w+)$/) &&
13350: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13351: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13352: next;
13353: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13354: $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 13355: next;
13356: }
13357: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13358: my $subdir = $path;
13359: $subdir =~ s{/+$}{};
1.661 raeburn 13360: if ($context eq 'portfolio') {
1.984 raeburn 13361: my $result;
13362: if ($state eq 'existingfile') {
13363: $result=
13364: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13365: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13366: } else {
1.984 raeburn 13367: $result=
13368: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13369: $dirpath.
1.1123 raeburn 13370: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13371: if ($result !~ m|^/uploaded/|) {
13372: $output .= '<span class="LC_error">'
13373: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13374: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13375: .'</span><br />';
13376: next;
13377: } else {
1.987 raeburn 13378: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13379: $path.$fname.'</span>').'<br />';
1.984 raeburn 13380: }
1.661 raeburn 13381: }
1.1123 raeburn 13382: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13383: my $extendedsubdir = $dirpath.'/'.$subdir;
13384: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13385: my $result =
1.1126 raeburn 13386: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13387: if ($result !~ m|^/uploaded/|) {
13388: $output .= '<span class="LC_error">'
13389: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13390: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13391: .'</span><br />';
13392: next;
13393: } else {
13394: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13395: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13396: if ($context eq 'syllabus') {
13397: &Apache::lonnet::make_public_indefinitely($result);
13398: }
1.987 raeburn 13399: }
1.661 raeburn 13400: } else {
13401: # Save the file
13402: my $target = $env{'form.embedded_item_'.$i};
13403: my $fullpath = $dir_root.$dirpath.'/'.$path;
13404: my $dest = $fullpath.$fname;
13405: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13406: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13407: my $count;
13408: my $filepath = $dir_root;
1.1027 raeburn 13409: foreach my $subdir (@parts) {
13410: $filepath .= "/$subdir";
13411: if (!-e $filepath) {
1.661 raeburn 13412: mkdir($filepath,0770);
13413: }
13414: }
13415: my $fh;
13416: if (!open($fh,'>'.$dest)) {
13417: &Apache::lonnet::logthis('Failed to create '.$dest);
13418: $output .= '<span class="LC_error">'.
1.1071 raeburn 13419: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13420: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13421: '</span><br />';
13422: } else {
13423: if (!print $fh $env{'form.embedded_item_'.$i}) {
13424: &Apache::lonnet::logthis('Failed to write to '.$dest);
13425: $output .= '<span class="LC_error">'.
1.1071 raeburn 13426: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13427: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13428: '</span><br />';
13429: } else {
1.987 raeburn 13430: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13431: $url.'</span>').'<br />';
13432: unless ($context eq 'testbank') {
13433: $footer .= &mt('View embedded file: [_1]',
13434: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13435: }
13436: }
13437: close($fh);
13438: }
13439: }
13440: if ($env{'form.embedded_ref_'.$i}) {
13441: $pathchange{$i} = 1;
13442: }
13443: }
13444: if ($output) {
13445: $output = '<p>'.$output.'</p>';
13446: }
13447: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13448: $returnflag = 'ok';
1.1071 raeburn 13449: my $numpathchgs = scalar(keys(%pathchange));
13450: if ($numpathchgs > 0) {
1.987 raeburn 13451: if ($context eq 'portfolio') {
13452: $output .= '<p>'.&mt('or').'</p>';
13453: } elsif ($context eq 'testbank') {
1.1071 raeburn 13454: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13455: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13456: $returnflag = 'modify_orightml';
13457: }
13458: }
1.1071 raeburn 13459: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13460: }
13461:
13462: sub modify_html_form {
13463: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13464: my $end = 0;
13465: my $modifyform;
13466: if ($context eq 'upload_embedded') {
13467: return unless (ref($pathchange) eq 'HASH');
13468: if ($env{'form.number_embedded_items'}) {
13469: $end += $env{'form.number_embedded_items'};
13470: }
13471: if ($env{'form.number_pathchange_items'}) {
13472: $end += $env{'form.number_pathchange_items'};
13473: }
13474: if ($end) {
13475: for (my $i=0; $i<$end; $i++) {
13476: if ($i < $env{'form.number_embedded_items'}) {
13477: next unless($pathchange->{$i});
13478: }
13479: $modifyform .=
13480: &start_data_table_row().
13481: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13482: 'checked="checked" /></td>'.
13483: '<td>'.$env{'form.embedded_ref_'.$i}.
13484: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13485: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13486: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13487: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13488: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13489: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13490: '<td>'.$env{'form.embedded_orig_'.$i}.
13491: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13492: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13493: &end_data_table_row();
1.1071 raeburn 13494: }
1.987 raeburn 13495: }
13496: } else {
13497: $modifyform = $pathchgtable;
13498: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13499: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13500: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13501: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13502: }
13503: }
13504: if ($modifyform) {
1.1071 raeburn 13505: if ($actionurl eq '/adm/dependencies') {
13506: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13507: }
1.987 raeburn 13508: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13509: '<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".
13510: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13511: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13512: '</ol></p>'."\n".'<p>'.
13513: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13514: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13515: &start_data_table()."\n".
13516: &start_data_table_header_row().
13517: '<th>'.&mt('Change?').'</th>'.
13518: '<th>'.&mt('Current reference').'</th>'.
13519: '<th>'.&mt('Required reference').'</th>'.
13520: &end_data_table_header_row()."\n".
13521: $modifyform.
13522: &end_data_table().'<br />'."\n".$hiddenstate.
13523: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13524: '</form>'."\n";
13525: }
13526: return;
13527: }
13528:
13529: sub modify_html_refs {
1.1123 raeburn 13530: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13531: my $container;
13532: if ($context eq 'portfolio') {
13533: $container = $env{'form.container'};
13534: } elsif ($context eq 'coursedoc') {
13535: $container = $env{'form.primaryurl'};
1.1071 raeburn 13536: } elsif ($context eq 'manage_dependencies') {
13537: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13538: $container = "/$container";
1.1123 raeburn 13539: } elsif ($context eq 'syllabus') {
13540: $container = $url;
1.987 raeburn 13541: } else {
1.1027 raeburn 13542: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13543: }
13544: my (%allfiles,%codebase,$output,$content);
13545: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13546: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13547: if (wantarray) {
13548: return ('',0,0);
13549: } else {
13550: return;
13551: }
13552: }
13553: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13554: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13555: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13556: if (wantarray) {
13557: return ('',0,0);
13558: } else {
13559: return;
13560: }
13561: }
1.987 raeburn 13562: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13563: if ($content eq '-1') {
13564: if (wantarray) {
13565: return ('',0,0);
13566: } else {
13567: return;
13568: }
13569: }
1.987 raeburn 13570: } else {
1.1071 raeburn 13571: unless ($container =~ /^\Q$dir_root\E/) {
13572: if (wantarray) {
13573: return ('',0,0);
13574: } else {
13575: return;
13576: }
13577: }
1.1317 raeburn 13578: if (open(my $fh,'<',$container)) {
1.987 raeburn 13579: $content = join('', <$fh>);
13580: close($fh);
13581: } else {
1.1071 raeburn 13582: if (wantarray) {
13583: return ('',0,0);
13584: } else {
13585: return;
13586: }
1.987 raeburn 13587: }
13588: }
13589: my ($count,$codebasecount) = (0,0);
13590: my $mm = new File::MMagic;
13591: my $mime_type = $mm->checktype_contents($content);
13592: if ($mime_type eq 'text/html') {
13593: my $parse_result =
13594: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13595: \%codebase,\$content);
13596: if ($parse_result eq 'ok') {
13597: foreach my $i (@changes) {
13598: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13599: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13600: if ($allfiles{$ref}) {
13601: my $newname = $orig;
13602: my ($attrib_regexp,$codebase);
1.1006 raeburn 13603: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13604: if ($attrib_regexp =~ /:/) {
13605: $attrib_regexp =~ s/\:/|/g;
13606: }
13607: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13608: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13609: $count += $numchg;
1.1123 raeburn 13610: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13611: delete($allfiles{$ref});
1.987 raeburn 13612: }
13613: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13614: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13615: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13616: $codebasecount ++;
13617: }
13618: }
13619: }
1.1123 raeburn 13620: my $skiprewrites;
1.987 raeburn 13621: if ($count || $codebasecount) {
13622: my $saveresult;
1.1071 raeburn 13623: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13624: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13625: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13626: if ($url eq $container) {
13627: my ($fname) = ($container =~ m{/([^/]+)$});
13628: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13629: $count,'<span class="LC_filename">'.
1.1071 raeburn 13630: $fname.'</span>').'</p>';
1.987 raeburn 13631: } else {
13632: $output = '<p class="LC_error">'.
13633: &mt('Error: update failed for: [_1].',
13634: '<span class="LC_filename">'.
13635: $container.'</span>').'</p>';
13636: }
1.1123 raeburn 13637: if ($context eq 'syllabus') {
13638: unless ($saveresult eq 'ok') {
13639: $skiprewrites = 1;
13640: }
13641: }
1.987 raeburn 13642: } else {
1.1317 raeburn 13643: if (open(my $fh,'>',$container)) {
1.987 raeburn 13644: print $fh $content;
13645: close($fh);
13646: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13647: $count,'<span class="LC_filename">'.
13648: $container.'</span>').'</p>';
1.661 raeburn 13649: } else {
1.987 raeburn 13650: $output = '<p class="LC_error">'.
13651: &mt('Error: could not update [_1].',
13652: '<span class="LC_filename">'.
13653: $container.'</span>').'</p>';
1.661 raeburn 13654: }
13655: }
13656: }
1.1123 raeburn 13657: if (($context eq 'syllabus') && (!$skiprewrites)) {
13658: my ($actionurl,$state);
13659: $actionurl = "/public/$udom/$uname/syllabus";
13660: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13661: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13662: \%codebase,
13663: {'context' => 'rewrites',
13664: 'ignore_remote_references' => 1,});
13665: if (ref($mapping) eq 'HASH') {
13666: my $rewrites = 0;
13667: foreach my $key (keys(%{$mapping})) {
13668: next if ($key =~ m{^https?://});
13669: my $ref = $mapping->{$key};
13670: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13671: my $attrib;
13672: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13673: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13674: }
13675: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13676: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13677: $rewrites += $numchg;
13678: }
13679: }
13680: if ($rewrites) {
13681: my $saveresult;
13682: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13683: if ($url eq $container) {
13684: my ($fname) = ($container =~ m{/([^/]+)$});
13685: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13686: $count,'<span class="LC_filename">'.
13687: $fname.'</span>').'</p>';
13688: } else {
13689: $output .= '<p class="LC_error">'.
13690: &mt('Error: could not update links in [_1].',
13691: '<span class="LC_filename">'.
13692: $container.'</span>').'</p>';
13693:
13694: }
13695: }
13696: }
13697: }
1.987 raeburn 13698: } else {
13699: &logthis('Failed to parse '.$container.
13700: ' to modify references: '.$parse_result);
1.661 raeburn 13701: }
13702: }
1.1071 raeburn 13703: if (wantarray) {
13704: return ($output,$count,$codebasecount);
13705: } else {
13706: return $output;
13707: }
1.661 raeburn 13708: }
13709:
13710: sub check_for_existing {
13711: my ($path,$fname,$element) = @_;
13712: my ($state,$msg);
13713: if (-d $path.'/'.$fname) {
13714: $state = 'exists';
13715: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13716: } elsif (-e $path.'/'.$fname) {
13717: $state = 'exists';
13718: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13719: }
13720: if ($state eq 'exists') {
13721: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13722: }
13723: return ($state,$msg);
13724: }
13725:
13726: sub check_for_upload {
13727: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13728: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13729: my $filesize = length($env{'form.'.$element});
13730: if (!$filesize) {
13731: my $msg = '<span class="LC_error">'.
13732: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13733: '<span class="LC_filename">'.$fname.'</span>',
13734: $filesize).'<br />'.
1.1007 raeburn 13735: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13736: '</span>';
13737: return ('zero_bytes',$msg);
13738: }
13739: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13740: my $getpropath = 1;
1.1021 raeburn 13741: my ($dirlistref,$listerror) =
13742: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13743: my $found_file = 0;
13744: my $locked_file = 0;
1.991 raeburn 13745: my @lockers;
13746: my $navmap;
13747: if ($env{'request.course.id'}) {
13748: $navmap = Apache::lonnavmaps::navmap->new();
13749: }
1.1021 raeburn 13750: if (ref($dirlistref) eq 'ARRAY') {
13751: foreach my $line (@{$dirlistref}) {
13752: my ($file_name,$rest)=split(/\&/,$line,2);
13753: if ($file_name eq $fname){
13754: $file_name = $path.$file_name;
13755: if ($group ne '') {
13756: $file_name = $group.$file_name;
13757: }
13758: $found_file = 1;
13759: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13760: foreach my $lock (@lockers) {
13761: if (ref($lock) eq 'ARRAY') {
13762: my ($symb,$crsid) = @{$lock};
13763: if ($crsid eq $env{'request.course.id'}) {
13764: if (ref($navmap)) {
13765: my $res = $navmap->getBySymb($symb);
13766: foreach my $part (@{$res->parts()}) {
13767: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13768: unless (($slot_status == $res->RESERVED) ||
13769: ($slot_status == $res->RESERVED_LOCATION)) {
13770: $locked_file = 1;
13771: }
1.991 raeburn 13772: }
1.1021 raeburn 13773: } else {
13774: $locked_file = 1;
1.991 raeburn 13775: }
13776: } else {
13777: $locked_file = 1;
13778: }
13779: }
1.1021 raeburn 13780: }
13781: } else {
13782: my @info = split(/\&/,$rest);
13783: my $currsize = $info[6]/1000;
13784: if ($currsize < $filesize) {
13785: my $extra = $filesize - $currsize;
13786: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13787: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13788: &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 13789: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13790: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13791: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13792: return ('will_exceed_quota',$msg);
13793: }
1.984 raeburn 13794: }
13795: }
1.661 raeburn 13796: }
13797: }
13798: }
13799: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13800: my $msg = '<p class="LC_warning">'.
13801: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13802: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13803: return ('will_exceed_quota',$msg);
13804: } elsif ($found_file) {
13805: if ($locked_file) {
1.1179 bisitz 13806: my $msg = '<p class="LC_warning">';
1.661 raeburn 13807: $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 13808: $msg .= '</p>';
1.661 raeburn 13809: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13810: return ('file_locked',$msg);
13811: } else {
1.1179 bisitz 13812: my $msg = '<p class="LC_error">';
1.984 raeburn 13813: $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 13814: $msg .= '</p>';
1.984 raeburn 13815: return ('existingfile',$msg);
1.661 raeburn 13816: }
13817: }
13818: }
13819:
1.987 raeburn 13820: sub check_for_traversal {
13821: my ($path,$url,$toplevel) = @_;
13822: my @parts=split(/\//,$path);
13823: my $cleanpath;
13824: my $fullpath = $url;
13825: for (my $i=0;$i<@parts;$i++) {
13826: next if ($parts[$i] eq '.');
13827: if ($parts[$i] eq '..') {
13828: $fullpath =~ s{([^/]+/)$}{};
13829: } else {
13830: $fullpath .= $parts[$i].'/';
13831: }
13832: }
13833: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13834: $cleanpath = $1;
13835: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13836: my $curr_toprel = $1;
13837: my @parts = split(/\//,$curr_toprel);
13838: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13839: my @urlparts = split(/\//,$url_toprel);
13840: my $doubledots;
13841: my $startdiff = -1;
13842: for (my $i=0; $i<@urlparts; $i++) {
13843: if ($startdiff == -1) {
13844: unless ($urlparts[$i] eq $parts[$i]) {
13845: $startdiff = $i;
13846: $doubledots .= '../';
13847: }
13848: } else {
13849: $doubledots .= '../';
13850: }
13851: }
13852: if ($startdiff > -1) {
13853: $cleanpath = $doubledots;
13854: for (my $i=$startdiff; $i<@parts; $i++) {
13855: $cleanpath .= $parts[$i].'/';
13856: }
13857: }
13858: }
13859: $cleanpath =~ s{(/)$}{};
13860: return $cleanpath;
13861: }
1.31 albertel 13862:
1.1053 raeburn 13863: sub is_archive_file {
13864: my ($mimetype) = @_;
13865: if (($mimetype eq 'application/octet-stream') ||
13866: ($mimetype eq 'application/x-stuffit') ||
13867: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13868: return 1;
13869: }
13870: return;
13871: }
13872:
13873: sub decompress_form {
1.1065 raeburn 13874: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13875: my %lt = &Apache::lonlocal::texthash (
13876: this => 'This file is an archive file.',
1.1067 raeburn 13877: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13878: itsc => 'Its contents are as follows:',
1.1053 raeburn 13879: youm => 'You may wish to extract its contents.',
13880: extr => 'Extract contents',
1.1067 raeburn 13881: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13882: proa => 'Process automatically?',
1.1053 raeburn 13883: yes => 'Yes',
13884: no => 'No',
1.1067 raeburn 13885: fold => 'Title for folder containing movie',
13886: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13887: );
1.1065 raeburn 13888: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13889: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13890: my $info = &list_archive_contents($fileloc,\@paths);
13891: if (@paths) {
13892: foreach my $path (@paths) {
13893: $path =~ s{^/}{};
1.1067 raeburn 13894: if ($path =~ m{^([^/]+)/$}) {
13895: $topdir = $1;
13896: }
1.1065 raeburn 13897: if ($path =~ m{^([^/]+)/}) {
13898: $toplevel{$1} = $path;
13899: } else {
13900: $toplevel{$path} = $path;
13901: }
13902: }
13903: }
1.1067 raeburn 13904: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13905: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13906: "$topdir/media/",
13907: "$topdir/media/$topdir.mp4",
13908: "$topdir/media/FirstFrame.png",
13909: "$topdir/media/player.swf",
13910: "$topdir/media/swfobject.js",
13911: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13912: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13913: "$topdir/$topdir.mp4",
13914: "$topdir/$topdir\_config.xml",
13915: "$topdir/$topdir\_controller.swf",
13916: "$topdir/$topdir\_embed.css",
13917: "$topdir/$topdir\_First_Frame.png",
13918: "$topdir/$topdir\_player.html",
13919: "$topdir/$topdir\_Thumbnails.png",
13920: "$topdir/playerProductInstall.swf",
13921: "$topdir/scripts/",
13922: "$topdir/scripts/config_xml.js",
13923: "$topdir/scripts/handlebars.js",
13924: "$topdir/scripts/jquery-1.7.1.min.js",
13925: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13926: "$topdir/scripts/modernizr.js",
13927: "$topdir/scripts/player-min.js",
13928: "$topdir/scripts/swfobject.js",
13929: "$topdir/skins/",
13930: "$topdir/skins/configuration_express.xml",
13931: "$topdir/skins/express_show/",
13932: "$topdir/skins/express_show/player-min.css",
13933: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13934: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13935: "$topdir/$topdir.mp4",
13936: "$topdir/$topdir\_config.xml",
13937: "$topdir/$topdir\_controller.swf",
13938: "$topdir/$topdir\_embed.css",
13939: "$topdir/$topdir\_First_Frame.png",
13940: "$topdir/$topdir\_player.html",
13941: "$topdir/$topdir\_Thumbnails.png",
13942: "$topdir/playerProductInstall.swf",
13943: "$topdir/scripts/",
13944: "$topdir/scripts/config_xml.js",
13945: "$topdir/scripts/techsmith-smart-player.min.js",
13946: "$topdir/skins/",
13947: "$topdir/skins/configuration_express.xml",
13948: "$topdir/skins/express_show/",
13949: "$topdir/skins/express_show/spritesheet.min.css",
13950: "$topdir/skins/express_show/spritesheet.png",
13951: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13952: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13953: if (@diffs == 0) {
1.1164 raeburn 13954: $is_camtasia = 6;
13955: } else {
1.1197 raeburn 13956: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13957: if (@diffs == 0) {
13958: $is_camtasia = 8;
1.1197 raeburn 13959: } else {
13960: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13961: if (@diffs == 0) {
13962: $is_camtasia = 8;
13963: }
1.1164 raeburn 13964: }
1.1067 raeburn 13965: }
13966: }
13967: my $output;
13968: if ($is_camtasia) {
13969: $output = <<"ENDCAM";
13970: <script type="text/javascript" language="Javascript">
13971: // <![CDATA[
13972:
13973: function camtasiaToggle() {
13974: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13975: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13976: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 13977: document.getElementById('camtasia_titles').style.display='block';
13978: } else {
13979: document.getElementById('camtasia_titles').style.display='none';
13980: }
13981: }
13982: }
13983: return;
13984: }
13985:
13986: // ]]>
13987: </script>
13988: <p>$lt{'camt'}</p>
13989: ENDCAM
1.1065 raeburn 13990: } else {
1.1067 raeburn 13991: $output = '<p>'.$lt{'this'};
13992: if ($info eq '') {
13993: $output .= ' '.$lt{'youm'}.'</p>'."\n";
13994: } else {
13995: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
13996: '<div><pre>'.$info.'</pre></div>';
13997: }
1.1065 raeburn 13998: }
1.1067 raeburn 13999: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14000: my $duplicates;
14001: my $num = 0;
14002: if (ref($dirlist) eq 'ARRAY') {
14003: foreach my $item (@{$dirlist}) {
14004: if (ref($item) eq 'ARRAY') {
14005: if (exists($toplevel{$item->[0]})) {
14006: $duplicates .=
14007: &start_data_table_row().
14008: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14009: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14010: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14011: 'value="1" />'.&mt('Yes').'</label>'.
14012: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14013: '<td>'.$item->[0].'</td>';
14014: if ($item->[2]) {
14015: $duplicates .= '<td>'.&mt('Directory').'</td>';
14016: } else {
14017: $duplicates .= '<td>'.&mt('File').'</td>';
14018: }
14019: $duplicates .= '<td>'.$item->[3].'</td>'.
14020: '<td>'.
14021: &Apache::lonlocal::locallocaltime($item->[4]).
14022: '</td>'.
14023: &end_data_table_row();
14024: $num ++;
14025: }
14026: }
14027: }
14028: }
14029: my $itemcount;
14030: if (@paths > 0) {
14031: $itemcount = scalar(@paths);
14032: } else {
14033: $itemcount = 1;
14034: }
1.1067 raeburn 14035: if ($is_camtasia) {
14036: $output .= $lt{'auto'}.'<br />'.
14037: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14038: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14039: $lt{'yes'}.'</label> <label>'.
14040: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14041: $lt{'no'}.'</label></span><br />'.
14042: '<div id="camtasia_titles" style="display:block">'.
14043: &Apache::lonhtmlcommon::start_pick_box().
14044: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14045: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14046: &Apache::lonhtmlcommon::row_closure().
14047: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14048: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14049: &Apache::lonhtmlcommon::row_closure(1).
14050: &Apache::lonhtmlcommon::end_pick_box().
14051: '</div>';
14052: }
1.1065 raeburn 14053: $output .=
14054: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14055: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14056: "\n";
1.1065 raeburn 14057: if ($duplicates ne '') {
14058: $output .= '<p><span class="LC_warning">'.
14059: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14060: &start_data_table().
14061: &start_data_table_header_row().
14062: '<th>'.&mt('Overwrite?').'</th>'.
14063: '<th>'.&mt('Name').'</th>'.
14064: '<th>'.&mt('Type').'</th>'.
14065: '<th>'.&mt('Size').'</th>'.
14066: '<th>'.&mt('Last modified').'</th>'.
14067: &end_data_table_header_row().
14068: $duplicates.
14069: &end_data_table().
14070: '</p>';
14071: }
1.1067 raeburn 14072: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14073: if (ref($hiddenelements) eq 'HASH') {
14074: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14075: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14076: }
14077: }
14078: $output .= <<"END";
1.1067 raeburn 14079: <br />
1.1053 raeburn 14080: <input type="submit" name="decompress" value="$lt{'extr'}" />
14081: </form>
14082: $noextract
14083: END
14084: return $output;
14085: }
14086:
1.1065 raeburn 14087: sub decompression_utility {
14088: my ($program) = @_;
14089: my @utilities = ('tar','gunzip','bunzip2','unzip');
14090: my $location;
14091: if (grep(/^\Q$program\E$/,@utilities)) {
14092: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14093: '/usr/sbin/') {
14094: if (-x $dir.$program) {
14095: $location = $dir.$program;
14096: last;
14097: }
14098: }
14099: }
14100: return $location;
14101: }
14102:
14103: sub list_archive_contents {
14104: my ($file,$pathsref) = @_;
14105: my (@cmd,$output);
14106: my $needsregexp;
14107: if ($file =~ /\.zip$/) {
14108: @cmd = (&decompression_utility('unzip'),"-l");
14109: $needsregexp = 1;
14110: } elsif (($file =~ m/\.tar\.gz$/) ||
14111: ($file =~ /\.tgz$/)) {
14112: @cmd = (&decompression_utility('tar'),"-ztf");
14113: } elsif ($file =~ /\.tar\.bz2$/) {
14114: @cmd = (&decompression_utility('tar'),"-jtf");
14115: } elsif ($file =~ m|\.tar$|) {
14116: @cmd = (&decompression_utility('tar'),"-tf");
14117: }
14118: if (@cmd) {
14119: undef($!);
14120: undef($@);
14121: if (open(my $fh,"-|", @cmd, $file)) {
14122: while (my $line = <$fh>) {
14123: $output .= $line;
14124: chomp($line);
14125: my $item;
14126: if ($needsregexp) {
14127: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14128: } else {
14129: $item = $line;
14130: }
14131: if ($item ne '') {
14132: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14133: push(@{$pathsref},$item);
14134: }
14135: }
14136: }
14137: close($fh);
14138: }
14139: }
14140: return $output;
14141: }
14142:
1.1053 raeburn 14143: sub decompress_uploaded_file {
14144: my ($file,$dir) = @_;
14145: &Apache::lonnet::appenv({'cgi.file' => $file});
14146: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14147: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14148: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14149: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14150: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14151: my $decompressed = $env{'cgi.decompressed'};
14152: &Apache::lonnet::delenv('cgi.file');
14153: &Apache::lonnet::delenv('cgi.dir');
14154: &Apache::lonnet::delenv('cgi.decompressed');
14155: return ($decompressed,$result);
14156: }
14157:
1.1055 raeburn 14158: sub process_decompression {
14159: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14160: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14161: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14162: &mt('Unexpected file path.').'</p>'."\n";
14163: }
14164: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14165: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14166: &mt('Unexpected course context.').'</p>'."\n";
14167: }
1.1293 raeburn 14168: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14169: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14170: &mt('Filename contained unexpected characters.').'</p>'."\n";
14171: }
1.1055 raeburn 14172: my ($dir,$error,$warning,$output);
1.1180 raeburn 14173: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14174: $error = &mt('Filename not a supported archive file type.').
14175: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14176: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14177: } else {
14178: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14179: if ($docuhome eq 'no_host') {
14180: $error = &mt('Could not determine home server for course.');
14181: } else {
14182: my @ids=&Apache::lonnet::current_machine_ids();
14183: my $currdir = "$dir_root/$destination";
14184: if (grep(/^\Q$docuhome\E$/,@ids)) {
14185: $dir = &LONCAPA::propath($docudom,$docuname).
14186: "$dir_root/$destination";
14187: } else {
14188: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14189: "$dir_root/$docudom/$docuname/$destination";
14190: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14191: $error = &mt('Archive file not found.');
14192: }
14193: }
1.1065 raeburn 14194: my (@to_overwrite,@to_skip);
14195: if ($env{'form.archive_overwrite_total'} > 0) {
14196: my $total = $env{'form.archive_overwrite_total'};
14197: for (my $i=0; $i<$total; $i++) {
14198: if ($env{'form.archive_overwrite_'.$i} == 1) {
14199: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14200: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14201: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14202: }
14203: }
14204: }
14205: my $numskip = scalar(@to_skip);
1.1292 raeburn 14206: my $numoverwrite = scalar(@to_overwrite);
14207: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14208: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14209: } elsif ($dir eq '') {
1.1055 raeburn 14210: $error = &mt('Directory containing archive file unavailable.');
14211: } elsif (!$error) {
1.1065 raeburn 14212: my ($decompressed,$display);
1.1292 raeburn 14213: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14214: my $tempdir = time.'_'.$$.int(rand(10000));
14215: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14216: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14217: ($decompressed,$display) =
14218: &decompress_uploaded_file($file,"$dir/$tempdir");
14219: foreach my $item (@to_skip) {
14220: if (($item ne '') && ($item !~ /\.\./)) {
14221: if (-f "$dir/$tempdir/$item") {
14222: unlink("$dir/$tempdir/$item");
14223: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14224: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14225: }
14226: }
14227: }
14228: foreach my $item (@to_overwrite) {
14229: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14230: if (($item ne '') && ($item !~ /\.\./)) {
14231: if (-f "$dir/$item") {
14232: unlink("$dir/$item");
14233: } elsif (-d "$dir/$item") {
1.1300 raeburn 14234: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14235: }
14236: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14237: }
1.1065 raeburn 14238: }
14239: }
1.1292 raeburn 14240: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14241: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14242: }
1.1065 raeburn 14243: }
14244: } else {
14245: ($decompressed,$display) =
14246: &decompress_uploaded_file($file,$dir);
14247: }
1.1055 raeburn 14248: if ($decompressed eq 'ok') {
1.1065 raeburn 14249: $output = '<p class="LC_info">'.
14250: &mt('Files extracted successfully from archive.').
14251: '</p>'."\n";
1.1055 raeburn 14252: my ($warning,$result,@contents);
14253: my ($newdirlistref,$newlisterror) =
14254: &Apache::lonnet::dirlist($currdir,$docudom,
14255: $docuname,1);
14256: my (%is_dir,%changes,@newitems);
14257: my $dirptr = 16384;
1.1065 raeburn 14258: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14259: foreach my $dir_line (@{$newdirlistref}) {
14260: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14261: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14262: push(@newitems,$item);
14263: if ($dirptr&$testdir) {
14264: $is_dir{$item} = 1;
14265: }
14266: $changes{$item} = 1;
14267: }
14268: }
14269: }
14270: if (keys(%changes) > 0) {
14271: foreach my $item (sort(@newitems)) {
14272: if ($changes{$item}) {
14273: push(@contents,$item);
14274: }
14275: }
14276: }
14277: if (@contents > 0) {
1.1067 raeburn 14278: my $wantform;
14279: unless ($env{'form.autoextract_camtasia'}) {
14280: $wantform = 1;
14281: }
1.1056 raeburn 14282: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14283: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14284: $currdir,\%is_dir,
14285: \%children,\%parent,
1.1056 raeburn 14286: \@contents,\%dirorder,
14287: \%titles,$wantform);
1.1055 raeburn 14288: if ($datatable ne '') {
14289: $output .= &archive_options_form('decompressed',$datatable,
14290: $count,$hiddenelem);
1.1065 raeburn 14291: my $startcount = 6;
1.1055 raeburn 14292: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14293: \%titles,\%children);
1.1055 raeburn 14294: }
1.1067 raeburn 14295: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14296: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14297: my %displayed;
14298: my $total = 1;
14299: $env{'form.archive_directory'} = [];
14300: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14301: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14302: $path =~ s{/$}{};
14303: my $item;
14304: if ($path ne '') {
14305: $item = "$path/$titles{$i}";
14306: } else {
14307: $item = $titles{$i};
14308: }
14309: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14310: if ($item eq $contents[0]) {
14311: push(@{$env{'form.archive_directory'}},$i);
14312: $env{'form.archive_'.$i} = 'display';
14313: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14314: $displayed{'folder'} = $i;
1.1164 raeburn 14315: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14316: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14317: $env{'form.archive_'.$i} = 'display';
14318: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14319: $displayed{'web'} = $i;
14320: } else {
1.1164 raeburn 14321: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14322: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14323: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14324: push(@{$env{'form.archive_directory'}},$i);
14325: }
14326: $env{'form.archive_'.$i} = 'dependency';
14327: }
14328: $total ++;
14329: }
14330: for (my $i=1; $i<$total; $i++) {
14331: next if ($i == $displayed{'web'});
14332: next if ($i == $displayed{'folder'});
14333: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14334: }
14335: $env{'form.phase'} = 'decompress_cleanup';
14336: $env{'form.archivedelete'} = 1;
14337: $env{'form.archive_count'} = $total-1;
14338: $output .=
14339: &process_extracted_files('coursedocs',$docudom,
14340: $docuname,$destination,
14341: $dir_root,$hiddenelem);
14342: }
1.1055 raeburn 14343: } else {
14344: $warning = &mt('No new items extracted from archive file.');
14345: }
14346: } else {
14347: $output = $display;
14348: $error = &mt('An error occurred during extraction from the archive file.');
14349: }
14350: }
14351: }
14352: }
14353: if ($error) {
14354: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14355: $error.'</p>'."\n";
14356: }
14357: if ($warning) {
14358: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14359: }
14360: return $output;
14361: }
14362:
14363: sub get_extracted {
1.1056 raeburn 14364: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14365: $titles,$wantform) = @_;
1.1055 raeburn 14366: my $count = 0;
14367: my $depth = 0;
14368: my $datatable;
1.1056 raeburn 14369: my @hierarchy;
1.1055 raeburn 14370: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14371: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14372: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14373: foreach my $item (@{$contents}) {
14374: $count ++;
1.1056 raeburn 14375: @{$dirorder->{$count}} = @hierarchy;
14376: $titles->{$count} = $item;
1.1055 raeburn 14377: &archive_hierarchy($depth,$count,$parent,$children);
14378: if ($wantform) {
14379: $datatable .= &archive_row($is_dir->{$item},$item,
14380: $currdir,$depth,$count);
14381: }
14382: if ($is_dir->{$item}) {
14383: $depth ++;
1.1056 raeburn 14384: push(@hierarchy,$count);
14385: $parent->{$depth} = $count;
1.1055 raeburn 14386: $datatable .=
14387: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14388: \$depth,\$count,\@hierarchy,$dirorder,
14389: $children,$parent,$titles,$wantform);
1.1055 raeburn 14390: $depth --;
1.1056 raeburn 14391: pop(@hierarchy);
1.1055 raeburn 14392: }
14393: }
14394: return ($count,$datatable);
14395: }
14396:
14397: sub recurse_extracted_archive {
1.1056 raeburn 14398: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14399: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14400: my $result='';
1.1056 raeburn 14401: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14402: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14403: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14404: return $result;
14405: }
14406: my $dirptr = 16384;
14407: my ($newdirlistref,$newlisterror) =
14408: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14409: if (ref($newdirlistref) eq 'ARRAY') {
14410: foreach my $dir_line (@{$newdirlistref}) {
14411: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14412: unless ($item =~ /^\.+$/) {
14413: $$count ++;
1.1056 raeburn 14414: @{$dirorder->{$$count}} = @{$hierarchy};
14415: $titles->{$$count} = $item;
1.1055 raeburn 14416: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14417:
1.1055 raeburn 14418: my $is_dir;
14419: if ($dirptr&$testdir) {
14420: $is_dir = 1;
14421: }
14422: if ($wantform) {
14423: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14424: }
14425: if ($is_dir) {
14426: $$depth ++;
1.1056 raeburn 14427: push(@{$hierarchy},$$count);
14428: $parent->{$$depth} = $$count;
1.1055 raeburn 14429: $result .=
14430: &recurse_extracted_archive("$currdir/$item",$docudom,
14431: $docuname,$depth,$count,
1.1056 raeburn 14432: $hierarchy,$dirorder,$children,
14433: $parent,$titles,$wantform);
1.1055 raeburn 14434: $$depth --;
1.1056 raeburn 14435: pop(@{$hierarchy});
1.1055 raeburn 14436: }
14437: }
14438: }
14439: }
14440: return $result;
14441: }
14442:
14443: sub archive_hierarchy {
14444: my ($depth,$count,$parent,$children) =@_;
14445: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14446: if (exists($parent->{$depth})) {
14447: $children->{$parent->{$depth}} .= $count.':';
14448: }
14449: }
14450: return;
14451: }
14452:
14453: sub archive_row {
14454: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14455: my ($name) = ($item =~ m{([^/]+)$});
14456: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14457: 'display' => 'Add as file',
1.1055 raeburn 14458: 'dependency' => 'Include as dependency',
14459: 'discard' => 'Discard',
14460: );
14461: if ($is_dir) {
1.1059 raeburn 14462: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14463: }
1.1056 raeburn 14464: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14465: my $offset = 0;
1.1055 raeburn 14466: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14467: $offset ++;
1.1065 raeburn 14468: if ($action ne 'display') {
14469: $offset ++;
14470: }
1.1055 raeburn 14471: $output .= '<td><span class="LC_nobreak">'.
14472: '<label><input type="radio" name="archive_'.$count.
14473: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14474: my $text = $choices{$action};
14475: if ($is_dir) {
14476: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14477: if ($action eq 'display') {
1.1059 raeburn 14478: $text = &mt('Add as folder');
1.1055 raeburn 14479: }
1.1056 raeburn 14480: } else {
14481: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14482:
14483: }
14484: $output .= ' /> '.$choices{$action}.'</label></span>';
14485: if ($action eq 'dependency') {
14486: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14487: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14488: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14489: '<option value=""></option>'."\n".
14490: '</select>'."\n".
14491: '</div>';
1.1059 raeburn 14492: } elsif ($action eq 'display') {
14493: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14494: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14495: '</div>';
1.1055 raeburn 14496: }
1.1056 raeburn 14497: $output .= '</td>';
1.1055 raeburn 14498: }
14499: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14500: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14501: for (my $i=0; $i<$depth; $i++) {
14502: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14503: }
14504: if ($is_dir) {
14505: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14506: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14507: } else {
14508: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14509: }
14510: $output .= ' '.$name.'</td>'."\n".
14511: &end_data_table_row();
14512: return $output;
14513: }
14514:
14515: sub archive_options_form {
1.1065 raeburn 14516: my ($form,$display,$count,$hiddenelem) = @_;
14517: my %lt = &Apache::lonlocal::texthash(
14518: perm => 'Permanently remove archive file?',
14519: hows => 'How should each extracted item be incorporated in the course?',
14520: cont => 'Content actions for all',
14521: addf => 'Add as folder/file',
14522: incd => 'Include as dependency for a displayed file',
14523: disc => 'Discard',
14524: no => 'No',
14525: yes => 'Yes',
14526: save => 'Save',
14527: );
14528: my $output = <<"END";
14529: <form name="$form" method="post" action="">
14530: <p><span class="LC_nobreak">$lt{'perm'}
14531: <label>
14532: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14533: </label>
14534:
14535: <label>
14536: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14537: </span>
14538: </p>
14539: <input type="hidden" name="phase" value="decompress_cleanup" />
14540: <br />$lt{'hows'}
14541: <div class="LC_columnSection">
14542: <fieldset>
14543: <legend>$lt{'cont'}</legend>
14544: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14545: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14546: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14547: </fieldset>
14548: </div>
14549: END
14550: return $output.
1.1055 raeburn 14551: &start_data_table()."\n".
1.1065 raeburn 14552: $display."\n".
1.1055 raeburn 14553: &end_data_table()."\n".
14554: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14555: $hiddenelem.
1.1065 raeburn 14556: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14557: '</form>';
14558: }
14559:
14560: sub archive_javascript {
1.1056 raeburn 14561: my ($startcount,$numitems,$titles,$children) = @_;
14562: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14563: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14564: my $scripttag = <<START;
14565: <script type="text/javascript">
14566: // <![CDATA[
14567:
14568: function checkAll(form,prefix) {
14569: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14570: for (var i=0; i < form.elements.length; i++) {
14571: var id = form.elements[i].id;
14572: if ((id != '') && (id != undefined)) {
14573: if (idstr.test(id)) {
14574: if (form.elements[i].type == 'radio') {
14575: form.elements[i].checked = true;
1.1056 raeburn 14576: var nostart = i-$startcount;
1.1059 raeburn 14577: var offset = nostart%7;
14578: var count = (nostart-offset)/7;
1.1056 raeburn 14579: dependencyCheck(form,count,offset);
1.1055 raeburn 14580: }
14581: }
14582: }
14583: }
14584: }
14585:
14586: function propagateCheck(form,count) {
14587: if (count > 0) {
1.1059 raeburn 14588: var startelement = $startcount + ((count-1) * 7);
14589: for (var j=1; j<6; j++) {
14590: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14591: var item = startelement + j;
14592: if (form.elements[item].type == 'radio') {
14593: if (form.elements[item].checked) {
14594: containerCheck(form,count,j);
14595: break;
14596: }
1.1055 raeburn 14597: }
14598: }
14599: }
14600: }
14601: }
14602:
14603: numitems = $numitems
1.1056 raeburn 14604: var titles = new Array(numitems);
14605: var parents = new Array(numitems);
1.1055 raeburn 14606: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14607: parents[i] = new Array;
1.1055 raeburn 14608: }
1.1059 raeburn 14609: var maintitle = '$maintitle';
1.1055 raeburn 14610:
14611: START
14612:
1.1056 raeburn 14613: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14614: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14615: for (my $i=0; $i<@contents; $i ++) {
14616: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14617: }
14618: }
14619:
1.1056 raeburn 14620: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14621: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14622: }
14623:
1.1055 raeburn 14624: $scripttag .= <<END;
14625:
14626: function containerCheck(form,count,offset) {
14627: if (count > 0) {
1.1056 raeburn 14628: dependencyCheck(form,count,offset);
1.1059 raeburn 14629: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14630: form.elements[item].checked = true;
14631: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14632: if (parents[count].length > 0) {
14633: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14634: containerCheck(form,parents[count][j],offset);
14635: }
14636: }
14637: }
14638: }
14639: }
14640:
14641: function dependencyCheck(form,count,offset) {
14642: if (count > 0) {
1.1059 raeburn 14643: var chosen = (offset+$startcount)+7*(count-1);
14644: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14645: var currtype = form.elements[depitem].type;
14646: if (form.elements[chosen].value == 'dependency') {
14647: document.getElementById('arc_depon_'+count).style.display='block';
14648: form.elements[depitem].options.length = 0;
14649: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14650: for (var i=1; i<=numitems; i++) {
14651: if (i == count) {
14652: continue;
14653: }
1.1059 raeburn 14654: var startelement = $startcount + (i-1) * 7;
14655: for (var j=1; j<6; j++) {
14656: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14657: var item = startelement + j;
14658: if (form.elements[item].type == 'radio') {
14659: if (form.elements[item].checked) {
14660: if (form.elements[item].value == 'display') {
14661: var n = form.elements[depitem].options.length;
14662: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14663: }
14664: }
14665: }
14666: }
14667: }
14668: }
14669: } else {
14670: document.getElementById('arc_depon_'+count).style.display='none';
14671: form.elements[depitem].options.length = 0;
14672: form.elements[depitem].options[0] = new Option('Select','',true,true);
14673: }
1.1059 raeburn 14674: titleCheck(form,count,offset);
1.1056 raeburn 14675: }
14676: }
14677:
14678: function propagateSelect(form,count,offset) {
14679: if (count > 0) {
1.1065 raeburn 14680: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14681: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14682: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14683: if (parents[count].length > 0) {
14684: for (var j=0; j<parents[count].length; j++) {
14685: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14686: }
14687: }
14688: }
14689: }
14690: }
1.1056 raeburn 14691:
14692: function containerSelect(form,count,offset,picked) {
14693: if (count > 0) {
1.1065 raeburn 14694: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14695: if (form.elements[item].type == 'radio') {
14696: if (form.elements[item].value == 'dependency') {
14697: if (form.elements[item+1].type == 'select-one') {
14698: for (var i=0; i<form.elements[item+1].options.length; i++) {
14699: if (form.elements[item+1].options[i].value == picked) {
14700: form.elements[item+1].selectedIndex = i;
14701: break;
14702: }
14703: }
14704: }
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);
14709: }
14710: }
14711: }
14712: }
14713: }
14714: }
14715: }
14716:
1.1059 raeburn 14717: function titleCheck(form,count,offset) {
14718: if (count > 0) {
14719: var chosen = (offset+$startcount)+7*(count-1);
14720: var depitem = $startcount + ((count-1) * 7) + 2;
14721: var currtype = form.elements[depitem].type;
14722: if (form.elements[chosen].value == 'display') {
14723: document.getElementById('arc_title_'+count).style.display='block';
14724: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14725: document.getElementById('archive_title_'+count).value=maintitle;
14726: }
14727: } else {
14728: document.getElementById('arc_title_'+count).style.display='none';
14729: if (currtype == 'text') {
14730: document.getElementById('archive_title_'+count).value='';
14731: }
14732: }
14733: }
14734: return;
14735: }
14736:
1.1055 raeburn 14737: // ]]>
14738: </script>
14739: END
14740: return $scripttag;
14741: }
14742:
14743: sub process_extracted_files {
1.1067 raeburn 14744: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14745: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14746: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14747: my @ids=&Apache::lonnet::current_machine_ids();
14748: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14749: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14750: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14751: if (grep(/^\Q$docuhome\E$/,@ids)) {
14752: $prefix = &LONCAPA::propath($docudom,$docuname);
14753: $pathtocheck = "$dir_root/$destination";
14754: $dir = $dir_root;
14755: $ishome = 1;
14756: } else {
14757: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14758: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14759: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14760: }
14761: my $currdir = "$dir_root/$destination";
14762: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14763: if ($env{'form.folderpath'}) {
14764: my @items = split('&',$env{'form.folderpath'});
14765: $folders{'0'} = $items[-2];
1.1099 raeburn 14766: if ($env{'form.folderpath'} =~ /\:1$/) {
14767: $containers{'0'}='page';
14768: } else {
14769: $containers{'0'}='sequence';
14770: }
1.1055 raeburn 14771: }
14772: my @archdirs = &get_env_multiple('form.archive_directory');
14773: if ($numitems) {
14774: for (my $i=1; $i<=$numitems; $i++) {
14775: my $path = $env{'form.archive_content_'.$i};
14776: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14777: my $item = $1;
14778: $toplevelitems{$item} = $i;
14779: if (grep(/^\Q$i\E$/,@archdirs)) {
14780: $is_dir{$item} = 1;
14781: }
14782: }
14783: }
14784: }
1.1067 raeburn 14785: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14786: if (keys(%toplevelitems) > 0) {
14787: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14788: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14789: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14790: }
1.1066 raeburn 14791: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14792: if ($numitems) {
14793: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14794: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14795: my $path = $env{'form.archive_content_'.$i};
14796: if ($path =~ /^\Q$pathtocheck\E/) {
14797: if ($env{'form.archive_'.$i} eq 'discard') {
14798: if ($prefix ne '' && $path ne '') {
14799: if (-e $prefix.$path) {
1.1066 raeburn 14800: if ((@archdirs > 0) &&
14801: (grep(/^\Q$i\E$/,@archdirs))) {
14802: $todeletedir{$prefix.$path} = 1;
14803: } else {
14804: $todelete{$prefix.$path} = 1;
14805: }
1.1055 raeburn 14806: }
14807: }
14808: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14809: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14810: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14811: $docstitle = $env{'form.archive_title_'.$i};
14812: if ($docstitle eq '') {
14813: $docstitle = $title;
14814: }
1.1055 raeburn 14815: $outer = 0;
1.1056 raeburn 14816: if (ref($dirorder{$i}) eq 'ARRAY') {
14817: if (@{$dirorder{$i}} > 0) {
14818: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14819: if ($env{'form.archive_'.$item} eq 'display') {
14820: $outer = $item;
14821: last;
14822: }
14823: }
14824: }
14825: }
14826: my ($errtext,$fatal) =
14827: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14828: '/'.$folders{$outer}.'.'.
14829: $containers{$outer});
14830: next if ($fatal);
14831: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14832: if ($context eq 'coursedocs') {
1.1056 raeburn 14833: $mapinner{$i} = time;
1.1055 raeburn 14834: $folders{$i} = 'default_'.$mapinner{$i};
14835: $containers{$i} = 'sequence';
14836: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14837: $folders{$i}.'.'.$containers{$i};
14838: my $newidx = &LONCAPA::map::getresidx();
14839: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14840: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14841: push(@LONCAPA::map::order,$newidx);
14842: my ($outtext,$errtext) =
14843: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14844: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14845: '.'.$containers{$outer},1,1);
1.1056 raeburn 14846: $newseqid{$i} = $newidx;
1.1067 raeburn 14847: unless ($errtext) {
1.1294 raeburn 14848: $result .= '<li>'.&mt('Folder: [_1] added to course',
14849: &HTML::Entities::encode($docstitle,'<>&"')).
14850: '</li>'."\n";
1.1067 raeburn 14851: }
1.1055 raeburn 14852: }
14853: } else {
14854: if ($context eq 'coursedocs') {
14855: my $newidx=&LONCAPA::map::getresidx();
14856: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14857: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14858: $title;
1.1392 raeburn 14859: if (($outer !~ /\D/) &&
14860: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14861: ($newidx !~ /\D/)) {
1.1294 raeburn 14862: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14863: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14864: }
14865: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14866: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14867: }
14868: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14869: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14870: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14871: unless ($ishome) {
14872: my $fetch = "$newdest{$i}/$title";
14873: $fetch =~ s/^\Q$prefix$dir\E//;
14874: $prompttofetch{$fetch} = 1;
14875: }
1.1292 raeburn 14876: }
1.1067 raeburn 14877: }
1.1294 raeburn 14878: $LONCAPA::map::resources[$newidx]=
14879: $docstitle.':'.$url.':false:normal:res';
14880: push(@LONCAPA::map::order, $newidx);
14881: my ($outtext,$errtext)=
14882: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14883: $docuname.'/'.$folders{$outer}.
14884: '.'.$containers{$outer},1,1);
14885: unless ($errtext) {
14886: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14887: $result .= '<li>'.&mt('File: [_1] added to course',
14888: &HTML::Entities::encode($docstitle,'<>&"')).
14889: '</li>'."\n";
14890: }
1.1067 raeburn 14891: }
1.1294 raeburn 14892: } else {
14893: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14894: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14895: }
1.1055 raeburn 14896: }
14897: }
1.1086 raeburn 14898: }
14899: } else {
1.1294 raeburn 14900: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14901: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14902: }
14903: }
14904: for (my $i=1; $i<=$numitems; $i++) {
14905: next unless ($env{'form.archive_'.$i} eq 'dependency');
14906: my $path = $env{'form.archive_content_'.$i};
14907: if ($path =~ /^\Q$pathtocheck\E/) {
14908: my ($title) = ($path =~ m{/([^/]+)$});
14909: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14910: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14911: if (ref($dirorder{$i}) eq 'ARRAY') {
14912: my ($itemidx,$fullpath,$relpath);
14913: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14914: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14915: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14916: if ($dirorder{$i}->[$j] eq $container) {
14917: $itemidx = $j;
1.1056 raeburn 14918: }
14919: }
1.1086 raeburn 14920: }
14921: if ($itemidx eq '') {
14922: $itemidx = 0;
14923: }
14924: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14925: if ($mapinner{$referrer{$i}}) {
14926: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14927: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14928: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14929: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14930: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14931: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14932: if (!-e $fullpath) {
14933: mkdir($fullpath,0755);
1.1056 raeburn 14934: }
14935: }
1.1086 raeburn 14936: } else {
14937: last;
1.1056 raeburn 14938: }
1.1086 raeburn 14939: }
14940: }
14941: } elsif ($newdest{$referrer{$i}}) {
14942: $fullpath = $newdest{$referrer{$i}};
14943: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14944: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14945: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14946: last;
14947: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14948: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14949: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14950: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14951: if (!-e $fullpath) {
14952: mkdir($fullpath,0755);
1.1056 raeburn 14953: }
14954: }
1.1086 raeburn 14955: } else {
14956: last;
1.1056 raeburn 14957: }
1.1055 raeburn 14958: }
14959: }
1.1086 raeburn 14960: if ($fullpath ne '') {
14961: if (-e "$prefix$path") {
1.1292 raeburn 14962: unless (rename("$prefix$path","$fullpath/$title")) {
14963: $warning .= &mt('Failed to rename dependency').'<br />';
14964: }
1.1086 raeburn 14965: }
14966: if (-e "$fullpath/$title") {
14967: my $showpath;
14968: if ($relpath ne '') {
14969: $showpath = "$relpath/$title";
14970: } else {
14971: $showpath = "/$title";
14972: }
1.1294 raeburn 14973: $result .= '<li>'.&mt('[_1] included as a dependency',
14974: &HTML::Entities::encode($showpath,'<>&"')).
14975: '</li>'."\n";
1.1292 raeburn 14976: unless ($ishome) {
14977: my $fetch = "$fullpath/$title";
14978: $fetch =~ s/^\Q$prefix$dir\E//;
14979: $prompttofetch{$fetch} = 1;
14980: }
1.1086 raeburn 14981: }
14982: }
1.1055 raeburn 14983: }
1.1086 raeburn 14984: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
14985: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 14986: &HTML::Entities::encode($path,'<>&"'),
14987: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
14988: '<br />';
1.1055 raeburn 14989: }
14990: } else {
1.1294 raeburn 14991: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 14992: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 14993: }
14994: }
14995: if (keys(%todelete)) {
14996: foreach my $key (keys(%todelete)) {
14997: unlink($key);
1.1066 raeburn 14998: }
14999: }
15000: if (keys(%todeletedir)) {
15001: foreach my $key (keys(%todeletedir)) {
15002: rmdir($key);
15003: }
15004: }
15005: foreach my $dir (sort(keys(%is_dir))) {
15006: if (($pathtocheck ne '') && ($dir ne '')) {
15007: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15008: }
15009: }
1.1067 raeburn 15010: if ($result ne '') {
15011: $output .= '<ul>'."\n".
15012: $result."\n".
15013: '</ul>';
15014: }
15015: unless ($ishome) {
15016: my $replicationfail;
15017: foreach my $item (keys(%prompttofetch)) {
15018: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15019: unless ($fetchresult eq 'ok') {
15020: $replicationfail .= '<li>'.$item.'</li>'."\n";
15021: }
15022: }
15023: if ($replicationfail) {
15024: $output .= '<p class="LC_error">'.
15025: &mt('Course home server failed to retrieve:').'<ul>'.
15026: $replicationfail.
15027: '</ul></p>';
15028: }
15029: }
1.1055 raeburn 15030: } else {
15031: $warning = &mt('No items found in archive.');
15032: }
15033: if ($error) {
15034: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15035: $error.'</p>'."\n";
15036: }
15037: if ($warning) {
15038: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15039: }
15040: return $output;
15041: }
15042:
1.1066 raeburn 15043: sub cleanup_empty_dirs {
15044: my ($path) = @_;
15045: if (($path ne '') && (-d $path)) {
15046: if (opendir(my $dirh,$path)) {
15047: my @dircontents = grep(!/^\./,readdir($dirh));
15048: my $numitems = 0;
15049: foreach my $item (@dircontents) {
15050: if (-d "$path/$item") {
1.1111 raeburn 15051: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15052: if (-e "$path/$item") {
15053: $numitems ++;
15054: }
15055: } else {
15056: $numitems ++;
15057: }
15058: }
15059: if ($numitems == 0) {
15060: rmdir($path);
15061: }
15062: closedir($dirh);
15063: }
15064: }
15065: return;
15066: }
15067:
1.41 ng 15068: =pod
1.45 matthew 15069:
1.1162 raeburn 15070: =item * &get_folder_hierarchy()
1.1068 raeburn 15071:
15072: Provides hierarchy of names of folders/sub-folders containing the current
15073: item,
15074:
15075: Inputs: 3
15076: - $navmap - navmaps object
15077:
15078: - $map - url for map (either the trigger itself, or map containing
15079: the resource, which is the trigger).
15080:
15081: - $showitem - 1 => show title for map itself; 0 => do not show.
15082:
15083: Outputs: 1 @pathitems - array of folder/subfolder names.
15084:
15085: =cut
15086:
15087: sub get_folder_hierarchy {
15088: my ($navmap,$map,$showitem) = @_;
15089: my @pathitems;
15090: if (ref($navmap)) {
15091: my $mapres = $navmap->getResourceByUrl($map);
15092: if (ref($mapres)) {
15093: my $pcslist = $mapres->map_hierarchy();
15094: if ($pcslist ne '') {
15095: my @pcs = split(/,/,$pcslist);
15096: foreach my $pc (@pcs) {
15097: if ($pc == 1) {
1.1129 raeburn 15098: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15099: } else {
15100: my $res = $navmap->getByMapPc($pc);
15101: if (ref($res)) {
15102: my $title = $res->compTitle();
15103: $title =~ s/\W+/_/g;
15104: if ($title ne '') {
15105: push(@pathitems,$title);
15106: }
15107: }
15108: }
15109: }
15110: }
1.1071 raeburn 15111: if ($showitem) {
15112: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15113: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15114: } else {
15115: my $maptitle = $mapres->compTitle();
15116: $maptitle =~ s/\W+/_/g;
15117: if ($maptitle ne '') {
15118: push(@pathitems,$maptitle);
15119: }
1.1068 raeburn 15120: }
15121: }
15122: }
15123: }
15124: return @pathitems;
15125: }
15126:
15127: =pod
15128:
1.1015 raeburn 15129: =item * &get_turnedin_filepath()
15130:
15131: Determines path in a user's portfolio file for storage of files uploaded
15132: to a specific essayresponse or dropbox item.
15133:
15134: Inputs: 3 required + 1 optional.
15135: $symb is symb for resource, $uname and $udom are for current user (required).
15136: $caller is optional (can be "submission", if routine is called when storing
15137: an upoaded file when "Submit Answer" button was pressed).
15138:
15139: Returns array containing $path and $multiresp.
15140: $path is path in portfolio. $multiresp is 1 if this resource contains more
15141: than one file upload item. Callers of routine should append partid as a
15142: subdirectory to $path in cases where $multiresp is 1.
15143:
15144: Called by: homework/essayresponse.pm and homework/structuretags.pm
15145:
15146: =cut
15147:
15148: sub get_turnedin_filepath {
15149: my ($symb,$uname,$udom,$caller) = @_;
15150: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15151: my $turnindir;
15152: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15153: $turnindir = $userhash{'turnindir'};
15154: my ($path,$multiresp);
15155: if ($turnindir eq '') {
15156: if ($caller eq 'submission') {
15157: $turnindir = &mt('turned in');
15158: $turnindir =~ s/\W+/_/g;
15159: my %newhash = (
15160: 'turnindir' => $turnindir,
15161: );
15162: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15163: }
15164: }
15165: if ($turnindir ne '') {
15166: $path = '/'.$turnindir.'/';
15167: my ($multipart,$turnin,@pathitems);
15168: my $navmap = Apache::lonnavmaps::navmap->new();
15169: if (defined($navmap)) {
15170: my $mapres = $navmap->getResourceByUrl($map);
15171: if (ref($mapres)) {
15172: my $pcslist = $mapres->map_hierarchy();
15173: if ($pcslist ne '') {
15174: foreach my $pc (split(/,/,$pcslist)) {
15175: my $res = $navmap->getByMapPc($pc);
15176: if (ref($res)) {
15177: my $title = $res->compTitle();
15178: $title =~ s/\W+/_/g;
15179: if ($title ne '') {
1.1149 raeburn 15180: if (($pc > 1) && (length($title) > 12)) {
15181: $title = substr($title,0,12);
15182: }
1.1015 raeburn 15183: push(@pathitems,$title);
15184: }
15185: }
15186: }
15187: }
15188: my $maptitle = $mapres->compTitle();
15189: $maptitle =~ s/\W+/_/g;
15190: if ($maptitle ne '') {
1.1149 raeburn 15191: if (length($maptitle) > 12) {
15192: $maptitle = substr($maptitle,0,12);
15193: }
1.1015 raeburn 15194: push(@pathitems,$maptitle);
15195: }
15196: unless ($env{'request.state'} eq 'construct') {
15197: my $res = $navmap->getBySymb($symb);
15198: if (ref($res)) {
15199: my $partlist = $res->parts();
15200: my $totaluploads = 0;
15201: if (ref($partlist) eq 'ARRAY') {
15202: foreach my $part (@{$partlist}) {
15203: my @types = $res->responseType($part);
15204: my @ids = $res->responseIds($part);
15205: for (my $i=0; $i < scalar(@ids); $i++) {
15206: if ($types[$i] eq 'essay') {
15207: my $partid = $part.'_'.$ids[$i];
15208: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15209: $totaluploads ++;
15210: }
15211: }
15212: }
15213: }
15214: if ($totaluploads > 1) {
15215: $multiresp = 1;
15216: }
15217: }
15218: }
15219: }
15220: } else {
15221: return;
15222: }
15223: } else {
15224: return;
15225: }
15226: my $restitle=&Apache::lonnet::gettitle($symb);
15227: $restitle =~ s/\W+/_/g;
15228: if ($restitle eq '') {
15229: $restitle = ($resurl =~ m{/[^/]+$});
15230: if ($restitle eq '') {
15231: $restitle = time;
15232: }
15233: }
1.1149 raeburn 15234: if (length($restitle) > 12) {
15235: $restitle = substr($restitle,0,12);
15236: }
1.1015 raeburn 15237: push(@pathitems,$restitle);
15238: $path .= join('/',@pathitems);
15239: }
15240: return ($path,$multiresp);
15241: }
15242:
15243: =pod
15244:
1.464 albertel 15245: =back
1.41 ng 15246:
1.112 bowersj2 15247: =head1 CSV Upload/Handling functions
1.38 albertel 15248:
1.41 ng 15249: =over 4
15250:
1.648 raeburn 15251: =item * &upfile_store($r)
1.41 ng 15252:
15253: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15254: needs $env{'form.upfile'}
1.41 ng 15255: returns $datatoken to be put into hidden field
15256:
15257: =cut
1.31 albertel 15258:
15259: sub upfile_store {
15260: my $r=shift;
1.258 albertel 15261: $env{'form.upfile'}=~s/\r/\n/gs;
15262: $env{'form.upfile'}=~s/\f/\n/gs;
15263: $env{'form.upfile'}=~s/\n+/\n/gs;
15264: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15265:
1.1299 raeburn 15266: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15267: '_enroll_'.$env{'request.course.id'}.'_'.
15268: time.'_'.$$);
15269: return if ($datatoken eq '');
15270:
1.31 albertel 15271: {
1.158 raeburn 15272: my $datafile = $r->dir_config('lonDaemons').
15273: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15274: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15275: print $fh $env{'form.upfile'};
1.158 raeburn 15276: close($fh);
15277: }
1.31 albertel 15278: }
15279: return $datatoken;
15280: }
15281:
1.56 matthew 15282: =pod
15283:
1.1290 raeburn 15284: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15285:
15286: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15287: $datatoken is the name to assign to the temporary file.
1.258 albertel 15288: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15289:
15290: =cut
1.31 albertel 15291:
15292: sub load_tmp_file {
1.1290 raeburn 15293: my ($r,$datatoken) = @_;
15294: return if ($datatoken eq '');
1.31 albertel 15295: my @studentdata=();
15296: {
1.158 raeburn 15297: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15298: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15299: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15300: @studentdata=<$fh>;
15301: close($fh);
15302: }
1.31 albertel 15303: }
1.258 albertel 15304: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15305: }
15306:
1.1290 raeburn 15307: sub valid_datatoken {
15308: my ($datatoken) = @_;
1.1325 raeburn 15309: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15310: return $datatoken;
15311: }
15312: return;
15313: }
15314:
1.56 matthew 15315: =pod
15316:
1.648 raeburn 15317: =item * &upfile_record_sep()
1.41 ng 15318:
15319: Separate uploaded file into records
15320: returns array of records,
1.258 albertel 15321: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15322:
15323: =cut
1.31 albertel 15324:
15325: sub upfile_record_sep {
1.258 albertel 15326: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15327: } else {
1.248 albertel 15328: my @records;
1.258 albertel 15329: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15330: if ($line=~/^\s*$/) { next; }
15331: push(@records,$line);
15332: }
15333: return @records;
1.31 albertel 15334: }
15335: }
15336:
1.56 matthew 15337: =pod
15338:
1.648 raeburn 15339: =item * &record_sep($record)
1.41 ng 15340:
1.258 albertel 15341: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15342:
15343: =cut
15344:
1.263 www 15345: sub takeleft {
15346: my $index=shift;
15347: return substr('0000'.$index,-4,4);
15348: }
15349:
1.31 albertel 15350: sub record_sep {
15351: my $record=shift;
15352: my %components=();
1.258 albertel 15353: if ($env{'form.upfiletype'} eq 'xml') {
15354: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15355: my $i=0;
1.356 albertel 15356: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15357: $field=~s/^(\"|\')//;
15358: $field=~s/(\"|\')$//;
1.263 www 15359: $components{&takeleft($i)}=$field;
1.31 albertel 15360: $i++;
15361: }
1.258 albertel 15362: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15363: my $i=0;
1.356 albertel 15364: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15365: $field=~s/^(\"|\')//;
15366: $field=~s/(\"|\')$//;
1.263 www 15367: $components{&takeleft($i)}=$field;
1.31 albertel 15368: $i++;
15369: }
15370: } else {
1.561 www 15371: my $separator=',';
1.480 banghart 15372: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15373: $separator=';';
1.480 banghart 15374: }
1.31 albertel 15375: my $i=0;
1.561 www 15376: # the character we are looking for to indicate the end of a quote or a record
15377: my $looking_for=$separator;
15378: # do not add the characters to the fields
15379: my $ignore=0;
15380: # we just encountered a separator (or the beginning of the record)
15381: my $just_found_separator=1;
15382: # store the field we are working on here
15383: my $field='';
15384: # work our way through all characters in record
15385: foreach my $character ($record=~/(.)/g) {
15386: if ($character eq $looking_for) {
15387: if ($character ne $separator) {
15388: # Found the end of a quote, again looking for separator
15389: $looking_for=$separator;
15390: $ignore=1;
15391: } else {
15392: # Found a separator, store away what we got
15393: $components{&takeleft($i)}=$field;
15394: $i++;
15395: $just_found_separator=1;
15396: $ignore=0;
15397: $field='';
15398: }
15399: next;
15400: }
15401: # single or double quotation marks after a separator indicate beginning of a quote
15402: # we are now looking for the end of the quote and need to ignore separators
15403: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15404: $looking_for=$character;
15405: next;
15406: }
15407: # ignore would be true after we reached the end of a quote
15408: if ($ignore) { next; }
15409: if (($just_found_separator) && ($character=~/\s/)) { next; }
15410: $field.=$character;
15411: $just_found_separator=0;
1.31 albertel 15412: }
1.561 www 15413: # catch the very last entry, since we never encountered the separator
15414: $components{&takeleft($i)}=$field;
1.31 albertel 15415: }
15416: return %components;
15417: }
15418:
1.144 matthew 15419: ######################################################
15420: ######################################################
15421:
1.56 matthew 15422: =pod
15423:
1.648 raeburn 15424: =item * &upfile_select_html()
1.41 ng 15425:
1.144 matthew 15426: Return HTML code to select a file from the users machine and specify
15427: the file type.
1.41 ng 15428:
15429: =cut
15430:
1.144 matthew 15431: ######################################################
15432: ######################################################
1.31 albertel 15433: sub upfile_select_html {
1.144 matthew 15434: my %Types = (
15435: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15436: semisv => &mt('Semicolon separated values'),
1.144 matthew 15437: space => &mt('Space separated'),
15438: tab => &mt('Tabulator separated'),
15439: # xml => &mt('HTML/XML'),
15440: );
15441: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15442: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15443: foreach my $type (sort(keys(%Types))) {
15444: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15445: }
15446: $Str .= "</select>\n";
15447: return $Str;
1.31 albertel 15448: }
15449:
1.301 albertel 15450: sub get_samples {
15451: my ($records,$toget) = @_;
15452: my @samples=({});
15453: my $got=0;
15454: foreach my $rec (@$records) {
15455: my %temp = &record_sep($rec);
15456: if (! grep(/\S/, values(%temp))) { next; }
15457: if (%temp) {
15458: $samples[$got]=\%temp;
15459: $got++;
15460: if ($got == $toget) { last; }
15461: }
15462: }
15463: return \@samples;
15464: }
15465:
1.144 matthew 15466: ######################################################
15467: ######################################################
15468:
1.56 matthew 15469: =pod
15470:
1.648 raeburn 15471: =item * &csv_print_samples($r,$records)
1.41 ng 15472:
15473: Prints a table of sample values from each column uploaded $r is an
15474: Apache Request ref, $records is an arrayref from
15475: &Apache::loncommon::upfile_record_sep
15476:
15477: =cut
15478:
1.144 matthew 15479: ######################################################
15480: ######################################################
1.31 albertel 15481: sub csv_print_samples {
15482: my ($r,$records) = @_;
1.662 bisitz 15483: my $samples = &get_samples($records,5);
1.301 albertel 15484:
1.594 raeburn 15485: $r->print(&mt('Samples').'<br />'.&start_data_table().
15486: &start_data_table_header_row());
1.356 albertel 15487: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15488: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15489: $r->print(&end_data_table_header_row());
1.301 albertel 15490: foreach my $hash (@$samples) {
1.594 raeburn 15491: $r->print(&start_data_table_row());
1.356 albertel 15492: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15493: $r->print('<td>');
1.356 albertel 15494: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15495: $r->print('</td>');
15496: }
1.594 raeburn 15497: $r->print(&end_data_table_row());
1.31 albertel 15498: }
1.594 raeburn 15499: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15500: }
15501:
1.144 matthew 15502: ######################################################
15503: ######################################################
15504:
1.56 matthew 15505: =pod
15506:
1.648 raeburn 15507: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15508:
15509: Prints a table to create associations between values and table columns.
1.144 matthew 15510:
1.41 ng 15511: $r is an Apache Request ref,
15512: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15513: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15514:
15515: =cut
15516:
1.144 matthew 15517: ######################################################
15518: ######################################################
1.31 albertel 15519: sub csv_print_select_table {
15520: my ($r,$records,$d) = @_;
1.301 albertel 15521: my $i=0;
15522: my $samples = &get_samples($records,1);
1.144 matthew 15523: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15524: &start_data_table().&start_data_table_header_row().
1.144 matthew 15525: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15526: '<th>'.&mt('Column').'</th>'.
15527: &end_data_table_header_row()."\n");
1.356 albertel 15528: foreach my $array_ref (@$d) {
15529: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15530: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15531:
1.875 bisitz 15532: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15533: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15534: $r->print('<option value="none"></option>');
1.356 albertel 15535: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15536: $r->print('<option value="'.$sample.'"'.
15537: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15538: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15539: }
1.594 raeburn 15540: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15541: $i++;
15542: }
1.594 raeburn 15543: $r->print(&end_data_table());
1.31 albertel 15544: $i--;
15545: return $i;
15546: }
1.56 matthew 15547:
1.144 matthew 15548: ######################################################
15549: ######################################################
15550:
1.56 matthew 15551: =pod
1.31 albertel 15552:
1.648 raeburn 15553: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15554:
15555: Prints a table of sample values from the upload and can make associate samples to internal names.
15556:
15557: $r is an Apache Request ref,
15558: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15559: $d is an array of 2 element arrays (internal name, displayed name)
15560:
15561: =cut
15562:
1.144 matthew 15563: ######################################################
15564: ######################################################
1.31 albertel 15565: sub csv_samples_select_table {
15566: my ($r,$records,$d) = @_;
15567: my $i=0;
1.144 matthew 15568: #
1.662 bisitz 15569: my $max_samples = 5;
15570: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15571: $r->print(&start_data_table().
15572: &start_data_table_header_row().'<th>'.
15573: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15574: &end_data_table_header_row());
1.301 albertel 15575:
15576: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15577: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15578: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15579: foreach my $option (@$d) {
15580: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15581: $r->print('<option value="'.$value.'"'.
1.253 albertel 15582: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15583: $display.'</option>');
1.31 albertel 15584: }
15585: $r->print('</select></td><td>');
1.662 bisitz 15586: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15587: if (defined($samples->[$line]{$key})) {
15588: $r->print($samples->[$line]{$key}."<br />\n");
15589: }
15590: }
1.594 raeburn 15591: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15592: $i++;
15593: }
1.594 raeburn 15594: $r->print(&end_data_table());
1.31 albertel 15595: $i--;
15596: return($i);
1.115 matthew 15597: }
15598:
1.144 matthew 15599: ######################################################
15600: ######################################################
15601:
1.115 matthew 15602: =pod
15603:
1.648 raeburn 15604: =item * &clean_excel_name($name)
1.115 matthew 15605:
15606: Returns a replacement for $name which does not contain any illegal characters.
15607:
15608: =cut
15609:
1.144 matthew 15610: ######################################################
15611: ######################################################
1.115 matthew 15612: sub clean_excel_name {
15613: my ($name) = @_;
15614: $name =~ s/[:\*\?\/\\]//g;
15615: if (length($name) > 31) {
15616: $name = substr($name,0,31);
15617: }
15618: return $name;
1.25 albertel 15619: }
1.84 albertel 15620:
1.85 albertel 15621: =pod
15622:
1.648 raeburn 15623: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15624:
15625: Returns either 1 or undef
15626:
15627: 1 if the part is to be hidden, undef if it is to be shown
15628:
15629: Arguments are:
15630:
15631: $id the id of the part to be checked
15632: $symb, optional the symb of the resource to check
15633: $udom, optional the domain of the user to check for
15634: $uname, optional the username of the user to check for
15635:
15636: =cut
1.84 albertel 15637:
15638: sub check_if_partid_hidden {
15639: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15640: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15641: $symb,$udom,$uname);
1.141 albertel 15642: my $truth=1;
15643: #if the string starts with !, then the list is the list to show not hide
15644: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15645: my @hiddenlist=split(/,/,$hiddenparts);
15646: foreach my $checkid (@hiddenlist) {
1.141 albertel 15647: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15648: }
1.141 albertel 15649: return !$truth;
1.84 albertel 15650: }
1.127 matthew 15651:
1.138 matthew 15652:
15653: ############################################################
15654: ############################################################
15655:
15656: =pod
15657:
1.157 matthew 15658: =back
15659:
1.138 matthew 15660: =head1 cgi-bin script and graphing routines
15661:
1.157 matthew 15662: =over 4
15663:
1.648 raeburn 15664: =item * &get_cgi_id()
1.138 matthew 15665:
15666: Inputs: none
15667:
15668: Returns an id which can be used to pass environment variables
15669: to various cgi-bin scripts. These environment variables will
15670: be removed from the users environment after a given time by
15671: the routine &Apache::lonnet::transfer_profile_to_env.
15672:
15673: =cut
15674:
15675: ############################################################
15676: ############################################################
1.152 albertel 15677: my $uniq=0;
1.136 matthew 15678: sub get_cgi_id {
1.154 albertel 15679: $uniq=($uniq+1)%100000;
1.280 albertel 15680: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15681: }
15682:
1.127 matthew 15683: ############################################################
15684: ############################################################
15685:
15686: =pod
15687:
1.648 raeburn 15688: =item * &DrawBarGraph()
1.127 matthew 15689:
1.138 matthew 15690: Facilitates the plotting of data in a (stacked) bar graph.
15691: Puts plot definition data into the users environment in order for
15692: graph.png to plot it. Returns an <img> tag for the plot.
15693: The bars on the plot are labeled '1','2',...,'n'.
15694:
15695: Inputs:
15696:
15697: =over 4
15698:
15699: =item $Title: string, the title of the plot
15700:
15701: =item $xlabel: string, text describing the X-axis of the plot
15702:
15703: =item $ylabel: string, text describing the Y-axis of the plot
15704:
15705: =item $Max: scalar, the maximum Y value to use in the plot
15706: If $Max is < any data point, the graph will not be rendered.
15707:
1.140 matthew 15708: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15709: they are plotted. If undefined, default values will be used.
15710:
1.178 matthew 15711: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15712:
1.138 matthew 15713: =item @Values: An array of array references. Each array reference holds data
15714: to be plotted in a stacked bar chart.
15715:
1.239 matthew 15716: =item If the final element of @Values is a hash reference the key/value
15717: pairs will be added to the graph definition.
15718:
1.138 matthew 15719: =back
15720:
15721: Returns:
15722:
15723: An <img> tag which references graph.png and the appropriate identifying
15724: information for the plot.
15725:
1.127 matthew 15726: =cut
15727:
15728: ############################################################
15729: ############################################################
1.134 matthew 15730: sub DrawBarGraph {
1.178 matthew 15731: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15732: #
15733: if (! defined($colors)) {
15734: $colors = ['#33ff00',
15735: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15736: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15737: ];
15738: }
1.228 matthew 15739: my $extra_settings = {};
15740: if (ref($Values[-1]) eq 'HASH') {
15741: $extra_settings = pop(@Values);
15742: }
1.127 matthew 15743: #
1.136 matthew 15744: my $identifier = &get_cgi_id();
15745: my $id = 'cgi.'.$identifier;
1.129 matthew 15746: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15747: return '';
15748: }
1.225 matthew 15749: #
15750: my @Labels;
15751: if (defined($labels)) {
15752: @Labels = @$labels;
15753: } else {
15754: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15755: push(@Labels,$i+1);
1.225 matthew 15756: }
15757: }
15758: #
1.129 matthew 15759: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15760: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15761: my %ValuesHash;
15762: my $NumSets=1;
15763: foreach my $array (@Values) {
15764: next if (! ref($array));
1.136 matthew 15765: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15766: join(',',@$array);
1.129 matthew 15767: }
1.127 matthew 15768: #
1.136 matthew 15769: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15770: if ($NumBars < 3) {
15771: $width = 120+$NumBars*32;
1.220 matthew 15772: $xskip = 1;
1.225 matthew 15773: $bar_width = 30;
15774: } elsif ($NumBars < 5) {
15775: $width = 120+$NumBars*20;
15776: $xskip = 1;
15777: $bar_width = 20;
1.220 matthew 15778: } elsif ($NumBars < 10) {
1.136 matthew 15779: $width = 120+$NumBars*15;
15780: $xskip = 1;
15781: $bar_width = 15;
15782: } elsif ($NumBars <= 25) {
15783: $width = 120+$NumBars*11;
15784: $xskip = 5;
15785: $bar_width = 8;
15786: } elsif ($NumBars <= 50) {
15787: $width = 120+$NumBars*8;
15788: $xskip = 5;
15789: $bar_width = 4;
15790: } else {
15791: $width = 120+$NumBars*8;
15792: $xskip = 5;
15793: $bar_width = 4;
15794: }
15795: #
1.137 matthew 15796: $Max = 1 if ($Max < 1);
15797: if ( int($Max) < $Max ) {
15798: $Max++;
15799: $Max = int($Max);
15800: }
1.127 matthew 15801: $Title = '' if (! defined($Title));
15802: $xlabel = '' if (! defined($xlabel));
15803: $ylabel = '' if (! defined($ylabel));
1.369 www 15804: $ValuesHash{$id.'.title'} = &escape($Title);
15805: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15806: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15807: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15808: $ValuesHash{$id.'.NumBars'} = $NumBars;
15809: $ValuesHash{$id.'.NumSets'} = $NumSets;
15810: $ValuesHash{$id.'.PlotType'} = 'bar';
15811: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15812: $ValuesHash{$id.'.height'} = $height;
15813: $ValuesHash{$id.'.width'} = $width;
15814: $ValuesHash{$id.'.xskip'} = $xskip;
15815: $ValuesHash{$id.'.bar_width'} = $bar_width;
15816: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15817: #
1.228 matthew 15818: # Deal with other parameters
15819: while (my ($key,$value) = each(%$extra_settings)) {
15820: $ValuesHash{$id.'.'.$key} = $value;
15821: }
15822: #
1.646 raeburn 15823: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15824: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15825: }
15826:
15827: ############################################################
15828: ############################################################
15829:
15830: =pod
15831:
1.648 raeburn 15832: =item * &DrawXYGraph()
1.137 matthew 15833:
1.138 matthew 15834: Facilitates the plotting of data in an XY graph.
15835: Puts plot definition data into the users environment in order for
15836: graph.png to plot it. Returns an <img> tag for the plot.
15837:
15838: Inputs:
15839:
15840: =over 4
15841:
15842: =item $Title: string, the title of the plot
15843:
15844: =item $xlabel: string, text describing the X-axis of the plot
15845:
15846: =item $ylabel: string, text describing the Y-axis of the plot
15847:
15848: =item $Max: scalar, the maximum Y value to use in the plot
15849: If $Max is < any data point, the graph will not be rendered.
15850:
15851: =item $colors: Array ref containing the hex color codes for the data to be
15852: plotted in. If undefined, default values will be used.
15853:
15854: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15855:
15856: =item $Ydata: Array ref containing Array refs.
1.185 www 15857: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15858:
15859: =item %Values: hash indicating or overriding any default values which are
15860: passed to graph.png.
15861: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15862:
15863: =back
15864:
15865: Returns:
15866:
15867: An <img> tag which references graph.png and the appropriate identifying
15868: information for the plot.
15869:
1.137 matthew 15870: =cut
15871:
15872: ############################################################
15873: ############################################################
15874: sub DrawXYGraph {
15875: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15876: #
15877: # Create the identifier for the graph
15878: my $identifier = &get_cgi_id();
15879: my $id = 'cgi.'.$identifier;
15880: #
15881: $Title = '' if (! defined($Title));
15882: $xlabel = '' if (! defined($xlabel));
15883: $ylabel = '' if (! defined($ylabel));
15884: my %ValuesHash =
15885: (
1.369 www 15886: $id.'.title' => &escape($Title),
15887: $id.'.xlabel' => &escape($xlabel),
15888: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15889: $id.'.y_max_value'=> $Max,
15890: $id.'.labels' => join(',',@$Xlabels),
15891: $id.'.PlotType' => 'XY',
15892: );
15893: #
15894: if (defined($colors) && ref($colors) eq 'ARRAY') {
15895: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15896: }
15897: #
15898: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15899: return '';
15900: }
15901: my $NumSets=1;
1.138 matthew 15902: foreach my $array (@{$Ydata}){
1.137 matthew 15903: next if (! ref($array));
15904: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15905: }
1.138 matthew 15906: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15907: #
15908: # Deal with other parameters
15909: while (my ($key,$value) = each(%Values)) {
15910: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15911: }
15912: #
1.646 raeburn 15913: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15914: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15915: }
15916:
15917: ############################################################
15918: ############################################################
15919:
15920: =pod
15921:
1.648 raeburn 15922: =item * &DrawXYYGraph()
1.138 matthew 15923:
15924: Facilitates the plotting of data in an XY graph with two Y axes.
15925: Puts plot definition data into the users environment in order for
15926: graph.png to plot it. Returns an <img> tag for the plot.
15927:
15928: Inputs:
15929:
15930: =over 4
15931:
15932: =item $Title: string, the title of the plot
15933:
15934: =item $xlabel: string, text describing the X-axis of the plot
15935:
15936: =item $ylabel: string, text describing the Y-axis of the plot
15937:
15938: =item $colors: Array ref containing the hex color codes for the data to be
15939: plotted in. If undefined, default values will be used.
15940:
15941: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15942:
15943: =item $Ydata1: The first data set
15944:
15945: =item $Min1: The minimum value of the left Y-axis
15946:
15947: =item $Max1: The maximum value of the left Y-axis
15948:
15949: =item $Ydata2: The second data set
15950:
15951: =item $Min2: The minimum value of the right Y-axis
15952:
15953: =item $Max2: The maximum value of the left Y-axis
15954:
15955: =item %Values: hash indicating or overriding any default values which are
15956: passed to graph.png.
15957: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15958:
15959: =back
15960:
15961: Returns:
15962:
15963: An <img> tag which references graph.png and the appropriate identifying
15964: information for the plot.
1.136 matthew 15965:
15966: =cut
15967:
15968: ############################################################
15969: ############################################################
1.137 matthew 15970: sub DrawXYYGraph {
15971: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15972: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15973: #
15974: # Create the identifier for the graph
15975: my $identifier = &get_cgi_id();
15976: my $id = 'cgi.'.$identifier;
15977: #
15978: $Title = '' if (! defined($Title));
15979: $xlabel = '' if (! defined($xlabel));
15980: $ylabel = '' if (! defined($ylabel));
15981: my %ValuesHash =
15982: (
1.369 www 15983: $id.'.title' => &escape($Title),
15984: $id.'.xlabel' => &escape($xlabel),
15985: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 15986: $id.'.labels' => join(',',@$Xlabels),
15987: $id.'.PlotType' => 'XY',
15988: $id.'.NumSets' => 2,
1.137 matthew 15989: $id.'.two_axes' => 1,
15990: $id.'.y1_max_value' => $Max1,
15991: $id.'.y1_min_value' => $Min1,
15992: $id.'.y2_max_value' => $Max2,
15993: $id.'.y2_min_value' => $Min2,
1.136 matthew 15994: );
15995: #
1.137 matthew 15996: if (defined($colors) && ref($colors) eq 'ARRAY') {
15997: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15998: }
15999: #
16000: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16001: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16002: return '';
16003: }
16004: my $NumSets=1;
1.137 matthew 16005: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16006: next if (! ref($array));
16007: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16008: }
16009: #
16010: # Deal with other parameters
16011: while (my ($key,$value) = each(%Values)) {
16012: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16013: }
16014: #
1.646 raeburn 16015: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16016: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16017: }
16018:
16019: ############################################################
16020: ############################################################
16021:
16022: =pod
16023:
1.157 matthew 16024: =back
16025:
1.139 matthew 16026: =head1 Statistics helper routines?
16027:
16028: Bad place for them but what the hell.
16029:
1.157 matthew 16030: =over 4
16031:
1.648 raeburn 16032: =item * &chartlink()
1.139 matthew 16033:
16034: Returns a link to the chart for a specific student.
16035:
16036: Inputs:
16037:
16038: =over 4
16039:
16040: =item $linktext: The text of the link
16041:
16042: =item $sname: The students username
16043:
16044: =item $sdomain: The students domain
16045:
16046: =back
16047:
1.157 matthew 16048: =back
16049:
1.139 matthew 16050: =cut
16051:
16052: ############################################################
16053: ############################################################
16054: sub chartlink {
16055: my ($linktext, $sname, $sdomain) = @_;
16056: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16057: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16058: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16059: '">'.$linktext.'</a>';
1.153 matthew 16060: }
16061:
16062: #######################################################
16063: #######################################################
16064:
16065: =pod
16066:
16067: =head1 Course Environment Routines
1.157 matthew 16068:
16069: =over 4
1.153 matthew 16070:
1.648 raeburn 16071: =item * &restore_course_settings()
1.153 matthew 16072:
1.648 raeburn 16073: =item * &store_course_settings()
1.153 matthew 16074:
16075: Restores/Store indicated form parameters from the course environment.
16076: Will not overwrite existing values of the form parameters.
16077:
16078: Inputs:
16079: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16080:
16081: a hash ref describing the data to be stored. For example:
16082:
16083: %Save_Parameters = ('Status' => 'scalar',
16084: 'chartoutputmode' => 'scalar',
16085: 'chartoutputdata' => 'scalar',
16086: 'Section' => 'array',
1.373 raeburn 16087: 'Group' => 'array',
1.153 matthew 16088: 'StudentData' => 'array',
16089: 'Maps' => 'array');
16090:
16091: Returns: both routines return nothing
16092:
1.631 raeburn 16093: =back
16094:
1.153 matthew 16095: =cut
16096:
16097: #######################################################
16098: #######################################################
16099: sub store_course_settings {
1.496 albertel 16100: return &store_settings($env{'request.course.id'},@_);
16101: }
16102:
16103: sub store_settings {
1.153 matthew 16104: # save to the environment
16105: # appenv the same items, just to be safe
1.300 albertel 16106: my $udom = $env{'user.domain'};
16107: my $uname = $env{'user.name'};
1.496 albertel 16108: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16109: my %SaveHash;
16110: my %AppHash;
16111: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16112: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16113: my $envname = 'environment.'.$basename;
1.258 albertel 16114: if (exists($env{'form.'.$setting})) {
1.153 matthew 16115: # Save this value away
16116: if ($type eq 'scalar' &&
1.258 albertel 16117: (! exists($env{$envname}) ||
16118: $env{$envname} ne $env{'form.'.$setting})) {
16119: $SaveHash{$basename} = $env{'form.'.$setting};
16120: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16121: } elsif ($type eq 'array') {
16122: my $stored_form;
1.258 albertel 16123: if (ref($env{'form.'.$setting})) {
1.153 matthew 16124: $stored_form = join(',',
16125: map {
1.369 www 16126: &escape($_);
1.258 albertel 16127: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16128: } else {
16129: $stored_form =
1.369 www 16130: &escape($env{'form.'.$setting});
1.153 matthew 16131: }
16132: # Determine if the array contents are the same.
1.258 albertel 16133: if ($stored_form ne $env{$envname}) {
1.153 matthew 16134: $SaveHash{$basename} = $stored_form;
16135: $AppHash{$envname} = $stored_form;
16136: }
16137: }
16138: }
16139: }
16140: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16141: $udom,$uname);
1.153 matthew 16142: if ($put_result !~ /^(ok|delayed)/) {
16143: &Apache::lonnet::logthis('unable to save form parameters, '.
16144: 'got error:'.$put_result);
16145: }
16146: # Make sure these settings stick around in this session, too
1.646 raeburn 16147: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16148: return;
16149: }
16150:
16151: sub restore_course_settings {
1.499 albertel 16152: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16153: }
16154:
16155: sub restore_settings {
16156: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16157: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16158: next if (exists($env{'form.'.$setting}));
1.496 albertel 16159: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16160: '.'.$setting;
1.258 albertel 16161: if (exists($env{$envname})) {
1.153 matthew 16162: if ($type eq 'scalar') {
1.258 albertel 16163: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16164: } elsif ($type eq 'array') {
1.258 albertel 16165: $env{'form.'.$setting} = [
1.153 matthew 16166: map {
1.369 www 16167: &unescape($_);
1.258 albertel 16168: } split(',',$env{$envname})
1.153 matthew 16169: ];
16170: }
16171: }
16172: }
1.127 matthew 16173: }
16174:
1.618 raeburn 16175: #######################################################
16176: #######################################################
16177:
16178: =pod
16179:
16180: =head1 Domain E-mail Routines
16181:
16182: =over 4
16183:
1.648 raeburn 16184: =item * &build_recipient_list()
1.618 raeburn 16185:
1.1144 raeburn 16186: Build recipient lists for following types of e-mail:
1.766 raeburn 16187: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16188: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16189: module change checking, student/employee ID conflict checks, as
16190: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16191: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16192:
16193: Inputs:
1.619 raeburn 16194: defmail (scalar - email address of default recipient),
1.1144 raeburn 16195: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16196: requestsmail, updatesmail, or idconflictsmail).
16197:
1.619 raeburn 16198: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16199:
1.619 raeburn 16200: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16201: i.e., predates configuration by DC via domainprefs.pm
16202:
16203: $requname username of requester (if mailing type is helpdeskmail)
16204:
16205: $requdom domain of requester (if mailing type is helpdeskmail)
16206:
16207: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16208:
1.618 raeburn 16209:
1.655 raeburn 16210: Returns: comma separated list of addresses to which to send e-mail.
16211:
16212: =back
1.618 raeburn 16213:
16214: =cut
16215:
16216: ############################################################
16217: ############################################################
16218: sub build_recipient_list {
1.1297 raeburn 16219: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16220: my @recipients;
1.1270 raeburn 16221: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16222: my %domconfig =
1.1270 raeburn 16223: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16224: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16225: if (exists($domconfig{'contacts'}{$mailing})) {
16226: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16227: my @contacts = ('adminemail','supportemail');
16228: foreach my $item (@contacts) {
16229: if ($domconfig{'contacts'}{$mailing}{$item}) {
16230: my $addr = $domconfig{'contacts'}{$item};
16231: if (!grep(/^\Q$addr\E$/,@recipients)) {
16232: push(@recipients,$addr);
16233: }
1.619 raeburn 16234: }
1.1270 raeburn 16235: }
16236: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16237: if ($mailing eq 'helpdeskmail') {
16238: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16239: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16240: my @ok_bccs;
16241: foreach my $bcc (@bccs) {
16242: $bcc =~ s/^\s+//g;
16243: $bcc =~ s/\s+$//g;
16244: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16245: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16246: push(@ok_bccs,$bcc);
16247: }
16248: }
16249: }
16250: if (@ok_bccs > 0) {
16251: $allbcc = join(', ',@ok_bccs);
16252: }
16253: }
16254: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16255: }
16256: }
1.766 raeburn 16257: } elsif ($origmail ne '') {
1.1270 raeburn 16258: $lastresort = $origmail;
1.618 raeburn 16259: }
1.1297 raeburn 16260: if ($mailing eq 'helpdeskmail') {
16261: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16262: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16263: my ($inststatus,$inststatus_checked);
16264: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16265: ($env{'user.domain'} ne 'public')) {
16266: $inststatus_checked = 1;
16267: $inststatus = $env{'environment.inststatus'};
16268: }
16269: unless ($inststatus_checked) {
16270: if (($requname ne '') && ($requdom ne '')) {
16271: if (($requname =~ /^$match_username$/) &&
16272: ($requdom =~ /^$match_domain$/) &&
16273: (&Apache::lonnet::domain($requdom))) {
16274: my $requhome = &Apache::lonnet::homeserver($requname,
16275: $requdom);
16276: unless ($requhome eq 'no_host') {
16277: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16278: $inststatus = $userenv{'inststatus'};
16279: $inststatus_checked = 1;
16280: }
16281: }
16282: }
16283: }
16284: unless ($inststatus_checked) {
16285: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16286: my %srch = (srchby => 'email',
16287: srchdomain => $defdom,
16288: srchterm => $reqemail,
16289: srchtype => 'exact');
16290: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16291: foreach my $uname (keys(%srch_results)) {
16292: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16293: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16294: $inststatus_checked = 1;
16295: last;
16296: }
16297: }
16298: unless ($inststatus_checked) {
16299: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16300: if ($dirsrchres eq 'ok') {
16301: foreach my $uname (keys(%srch_results)) {
16302: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16303: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16304: $inststatus_checked = 1;
16305: last;
16306: }
16307: }
16308: }
16309: }
16310: }
16311: }
16312: if ($inststatus ne '') {
16313: foreach my $status (split(/\:/,$inststatus)) {
16314: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16315: my @contacts = ('adminemail','supportemail');
16316: foreach my $item (@contacts) {
16317: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16318: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16319: if (!grep(/^\Q$addr\E$/,@recipients)) {
16320: push(@recipients,$addr);
16321: }
16322: }
16323: }
16324: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16325: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16326: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16327: my @ok_bccs;
16328: foreach my $bcc (@bccs) {
16329: $bcc =~ s/^\s+//g;
16330: $bcc =~ s/\s+$//g;
16331: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16332: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16333: push(@ok_bccs,$bcc);
16334: }
16335: }
16336: }
16337: if (@ok_bccs > 0) {
16338: $allbcc = join(', ',@ok_bccs);
16339: }
16340: }
16341: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16342: last;
16343: }
16344: }
16345: }
16346: }
16347: }
1.619 raeburn 16348: } elsif ($origmail ne '') {
1.1270 raeburn 16349: $lastresort = $origmail;
16350: }
1.1297 raeburn 16351: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16352: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16353: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16354: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16355: my %what = (
16356: perlvar => 1,
16357: );
16358: my $primary = &Apache::lonnet::domain($defdom,'primary');
16359: if ($primary) {
16360: my $gotaddr;
16361: my ($result,$returnhash) =
16362: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16363: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16364: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16365: $lastresort = $returnhash->{'lonSupportEMail'};
16366: $gotaddr = 1;
16367: }
16368: }
16369: unless ($gotaddr) {
16370: my $uintdom = &Apache::lonnet::internet_dom($primary);
16371: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16372: unless ($uintdom eq $intdom) {
16373: my %domconfig =
16374: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16375: if (ref($domconfig{'contacts'}) eq 'HASH') {
16376: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16377: my @contacts = ('adminemail','supportemail');
16378: foreach my $item (@contacts) {
16379: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16380: my $addr = $domconfig{'contacts'}{$item};
16381: if (!grep(/^\Q$addr\E$/,@recipients)) {
16382: push(@recipients,$addr);
16383: }
16384: }
16385: }
16386: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16387: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16388: }
16389: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16390: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16391: my @ok_bccs;
16392: foreach my $bcc (@bccs) {
16393: $bcc =~ s/^\s+//g;
16394: $bcc =~ s/\s+$//g;
16395: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16396: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16397: push(@ok_bccs,$bcc);
16398: }
16399: }
16400: }
16401: if (@ok_bccs > 0) {
16402: $allbcc = join(', ',@ok_bccs);
16403: }
16404: }
16405: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16406: }
16407: }
16408: }
16409: }
16410: }
16411: }
1.618 raeburn 16412: }
1.688 raeburn 16413: if (defined($defmail)) {
16414: if ($defmail ne '') {
16415: push(@recipients,$defmail);
16416: }
1.618 raeburn 16417: }
16418: if ($otheremails) {
1.619 raeburn 16419: my @others;
16420: if ($otheremails =~ /,/) {
16421: @others = split(/,/,$otheremails);
1.618 raeburn 16422: } else {
1.619 raeburn 16423: push(@others,$otheremails);
16424: }
16425: foreach my $addr (@others) {
16426: if (!grep(/^\Q$addr\E$/,@recipients)) {
16427: push(@recipients,$addr);
16428: }
1.618 raeburn 16429: }
16430: }
1.1298 raeburn 16431: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16432: if ((!@recipients) && ($lastresort ne '')) {
16433: push(@recipients,$lastresort);
16434: }
16435: } elsif ($lastresort ne '') {
16436: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16437: push(@recipients,$lastresort);
16438: }
16439: }
1.1271 raeburn 16440: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16441: if (wantarray) {
16442: return ($recipientlist,$allbcc,$addtext);
16443: } else {
16444: return $recipientlist;
16445: }
1.618 raeburn 16446: }
16447:
1.127 matthew 16448: ############################################################
16449: ############################################################
1.154 albertel 16450:
1.655 raeburn 16451: =pod
16452:
1.1224 musolffc 16453: =over 4
16454:
1.1223 musolffc 16455: =item * &mime_email()
16456:
16457: Sends an email with a possible attachment
16458:
16459: Inputs:
16460:
16461: =over 4
16462:
16463: from - Sender's email address
16464:
1.1343 raeburn 16465: replyto - Reply-To email address
16466:
1.1223 musolffc 16467: to - Email address of recipient
16468:
16469: subject - Subject of email
16470:
16471: body - Body of email
16472:
16473: cc_string - Carbon copy email address
16474:
16475: bcc - Blind carbon copy email address
16476:
16477: attachment_path - Path of file to be attached
16478:
16479: file_name - Name of file to be attached
16480:
16481: attachment_text - The body of an attachment of type "TEXT"
16482:
16483: =back
16484:
16485: =back
16486:
16487: =cut
16488:
16489: ############################################################
16490: ############################################################
16491:
16492: sub mime_email {
1.1343 raeburn 16493: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16494: $file_name,$attachment_text) = @_;
16495:
1.1223 musolffc 16496: my $msg = MIME::Lite->new(
16497: From => $from,
16498: To => $to,
16499: Subject => $subject,
16500: Type =>'TEXT',
16501: Data => $body,
16502: );
1.1343 raeburn 16503: if ($replyto ne '') {
16504: $msg->add("Reply-To" => $replyto);
16505: }
1.1223 musolffc 16506: if ($cc_string ne '') {
16507: $msg->add("Cc" => $cc_string);
16508: }
16509: if ($bcc ne '') {
16510: $msg->add("Bcc" => $bcc);
16511: }
16512: $msg->attr("content-type" => "text/plain");
16513: $msg->attr("content-type.charset" => "UTF-8");
16514: # Attach file if given
16515: if ($attachment_path) {
16516: unless ($file_name) {
16517: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16518: }
16519: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16520: $msg->attach(Type => $type,
16521: Path => $attachment_path,
16522: Filename => $file_name
16523: );
16524: # Otherwise attach text if given
16525: } elsif ($attachment_text) {
16526: $msg->attach(Type => 'TEXT',
16527: Data => $attachment_text);
16528: }
16529: # Send it
16530: $msg->send('sendmail');
16531: }
16532:
16533: ############################################################
16534: ############################################################
16535:
16536: =pod
16537:
1.655 raeburn 16538: =head1 Course Catalog Routines
16539:
16540: =over 4
16541:
16542: =item * &gather_categories()
16543:
16544: Converts category definitions - keys of categories hash stored in
16545: coursecategories in configuration.db on the primary library server in a
16546: domain - to an array. Also generates javascript and idx hash used to
16547: generate Domain Coordinator interface for editing Course Categories.
16548:
16549: Inputs:
1.663 raeburn 16550:
1.655 raeburn 16551: categories (reference to hash of category definitions).
1.663 raeburn 16552:
1.655 raeburn 16553: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16554: categories and subcategories).
1.663 raeburn 16555:
1.655 raeburn 16556: idx (reference to hash of counters used in Domain Coordinator interface for
16557: editing Course Categories).
1.663 raeburn 16558:
1.655 raeburn 16559: jsarray (reference to array of categories used to create Javascript arrays for
16560: Domain Coordinator interface for editing Course Categories).
16561:
16562: Returns: nothing
16563:
16564: Side effects: populates cats, idx and jsarray.
16565:
16566: =cut
16567:
16568: sub gather_categories {
16569: my ($categories,$cats,$idx,$jsarray) = @_;
16570: my %counters;
16571: my $num = 0;
16572: foreach my $item (keys(%{$categories})) {
16573: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16574: if ($container eq '' && $depth == 0) {
16575: $cats->[$depth][$categories->{$item}] = $cat;
16576: } else {
16577: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16578: }
16579: my ($escitem,$tail) = split(/:/,$item,2);
16580: if ($counters{$tail} eq '') {
16581: $counters{$tail} = $num;
16582: $num ++;
16583: }
16584: if (ref($idx) eq 'HASH') {
16585: $idx->{$item} = $counters{$tail};
16586: }
16587: if (ref($jsarray) eq 'ARRAY') {
16588: push(@{$jsarray->[$counters{$tail}]},$item);
16589: }
16590: }
16591: return;
16592: }
16593:
16594: =pod
16595:
16596: =item * &extract_categories()
16597:
16598: Used to generate breadcrumb trails for course categories.
16599:
16600: Inputs:
1.663 raeburn 16601:
1.655 raeburn 16602: categories (reference to hash of category definitions).
1.663 raeburn 16603:
1.655 raeburn 16604: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16605: categories and subcategories).
1.663 raeburn 16606:
1.655 raeburn 16607: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16608:
1.655 raeburn 16609: allitems (reference to hash - key is category key
16610: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16611:
1.655 raeburn 16612: idx (reference to hash of counters used in Domain Coordinator interface for
16613: editing Course Categories).
1.663 raeburn 16614:
1.655 raeburn 16615: jsarray (reference to array of categories used to create Javascript arrays for
16616: Domain Coordinator interface for editing Course Categories).
16617:
1.665 raeburn 16618: subcats (reference to hash of arrays containing all subcategories within each
16619: category, -recursive)
16620:
1.1321 raeburn 16621: maxd (reference to hash used to hold max depth for all top-level categories).
16622:
1.655 raeburn 16623: Returns: nothing
16624:
16625: Side effects: populates trails and allitems hash references.
16626:
16627: =cut
16628:
16629: sub extract_categories {
1.1321 raeburn 16630: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16631: if (ref($categories) eq 'HASH') {
16632: &gather_categories($categories,$cats,$idx,$jsarray);
16633: if (ref($cats->[0]) eq 'ARRAY') {
16634: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16635: my $name = $cats->[0][$i];
16636: my $item = &escape($name).'::0';
16637: my $trailstr;
16638: if ($name eq 'instcode') {
16639: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16640: } elsif ($name eq 'communities') {
16641: $trailstr = &mt('Communities');
1.1239 raeburn 16642: } elsif ($name eq 'placement') {
16643: $trailstr = &mt('Placement Tests');
1.655 raeburn 16644: } else {
16645: $trailstr = $name;
16646: }
16647: if ($allitems->{$item} eq '') {
16648: push(@{$trails},$trailstr);
16649: $allitems->{$item} = scalar(@{$trails})-1;
16650: }
16651: my @parents = ($name);
16652: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16653: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16654: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16655: if (ref($subcats) eq 'HASH') {
16656: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16657: }
1.1321 raeburn 16658: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16659: }
16660: } else {
16661: if (ref($subcats) eq 'HASH') {
16662: $subcats->{$item} = [];
1.655 raeburn 16663: }
1.1321 raeburn 16664: if (ref($maxd) eq 'HASH') {
16665: $maxd->{$name} = 1;
16666: }
1.655 raeburn 16667: }
16668: }
16669: }
16670: }
16671: return;
16672: }
16673:
16674: =pod
16675:
1.1162 raeburn 16676: =item * &recurse_categories()
1.655 raeburn 16677:
16678: Recursively used to generate breadcrumb trails for course categories.
16679:
16680: Inputs:
1.663 raeburn 16681:
1.655 raeburn 16682: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16683: categories and subcategories).
1.663 raeburn 16684:
1.655 raeburn 16685: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16686:
16687: category (current course category, for which breadcrumb trail is being generated).
16688:
16689: trails (reference to array of breadcrumb trails for each category).
16690:
1.655 raeburn 16691: allitems (reference to hash - key is category key
16692: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16693:
1.655 raeburn 16694: parents (array containing containers directories for current category,
16695: back to top level).
16696:
16697: Returns: nothing
16698:
16699: Side effects: populates trails and allitems hash references
16700:
16701: =cut
16702:
16703: sub recurse_categories {
1.1321 raeburn 16704: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16705: my $shallower = $depth - 1;
16706: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16707: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16708: my $name = $cats->[$depth]{$category}[$k];
16709: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16710: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16711: if ($allitems->{$item} eq '') {
16712: push(@{$trails},$trailstr);
16713: $allitems->{$item} = scalar(@{$trails})-1;
16714: }
16715: my $deeper = $depth+1;
16716: push(@{$parents},$category);
1.665 raeburn 16717: if (ref($subcats) eq 'HASH') {
16718: my $subcat = &escape($name).':'.$category.':'.$depth;
16719: for (my $j=@{$parents}; $j>=0; $j--) {
16720: my $higher;
16721: if ($j > 0) {
16722: $higher = &escape($parents->[$j]).':'.
16723: &escape($parents->[$j-1]).':'.$j;
16724: } else {
16725: $higher = &escape($parents->[$j]).'::'.$j;
16726: }
16727: push(@{$subcats->{$higher}},$subcat);
16728: }
16729: }
16730: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16731: $subcats,$maxd);
1.655 raeburn 16732: pop(@{$parents});
16733: }
16734: } else {
16735: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16736: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16737: if ($allitems->{$item} eq '') {
16738: push(@{$trails},$trailstr);
16739: $allitems->{$item} = scalar(@{$trails})-1;
16740: }
1.1321 raeburn 16741: if (ref($maxd) eq 'HASH') {
16742: if ($depth > $maxd->{$parents->[0]}) {
16743: $maxd->{$parents->[0]} = $depth;
16744: }
16745: }
1.655 raeburn 16746: }
16747: return;
16748: }
16749:
1.663 raeburn 16750: =pod
16751:
1.1162 raeburn 16752: =item * &assign_categories_table()
1.663 raeburn 16753:
16754: Create a datatable for display of hierarchical categories in a domain,
16755: with checkboxes to allow a course to be categorized.
16756:
16757: Inputs:
16758:
16759: cathash - reference to hash of categories defined for the domain (from
16760: configuration.db)
16761:
16762: currcat - scalar with an & separated list of categories assigned to a course.
16763:
1.919 raeburn 16764: type - scalar contains course type (Course or Community).
16765:
1.1260 raeburn 16766: disabled - scalar (optional) contains disabled="disabled" if input elements are
16767: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16768:
1.663 raeburn 16769: Returns: $output (markup to be displayed)
16770:
16771: =cut
16772:
16773: sub assign_categories_table {
1.1259 raeburn 16774: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16775: my $output;
16776: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16777: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16778: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16779: $maxdepth = scalar(@cats);
16780: if (@cats > 0) {
16781: my $itemcount = 0;
16782: if (ref($cats[0]) eq 'ARRAY') {
16783: my @currcategories;
16784: if ($currcat ne '') {
16785: @currcategories = split('&',$currcat);
16786: }
1.919 raeburn 16787: my $table;
1.663 raeburn 16788: for (my $i=0; $i<@{$cats[0]}; $i++) {
16789: my $parent = $cats[0][$i];
1.919 raeburn 16790: next if ($parent eq 'instcode');
16791: if ($type eq 'Community') {
16792: next unless ($parent eq 'communities');
1.1239 raeburn 16793: } elsif ($type eq 'Placement') {
16794: next unless ($parent eq 'placement');
1.919 raeburn 16795: } else {
1.1239 raeburn 16796: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16797: }
1.663 raeburn 16798: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16799: my $item = &escape($parent).'::0';
16800: my $checked = '';
16801: if (@currcategories > 0) {
16802: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16803: $checked = ' checked="checked"';
1.663 raeburn 16804: }
16805: }
1.919 raeburn 16806: my $parent_title = $parent;
16807: if ($parent eq 'communities') {
16808: $parent_title = &mt('Communities');
1.1239 raeburn 16809: } elsif ($parent eq 'placement') {
16810: $parent_title = &mt('Placement Tests');
1.919 raeburn 16811: }
16812: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16813: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16814: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16815: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16816: my $depth = 1;
16817: push(@path,$parent);
1.1259 raeburn 16818: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16819: pop(@path);
1.919 raeburn 16820: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16821: $itemcount ++;
16822: }
1.919 raeburn 16823: if ($itemcount) {
16824: $output = &Apache::loncommon::start_data_table().
16825: $table.
16826: &Apache::loncommon::end_data_table();
16827: }
1.663 raeburn 16828: }
16829: }
16830: }
16831: return $output;
16832: }
16833:
16834: =pod
16835:
1.1162 raeburn 16836: =item * &assign_category_rows()
1.663 raeburn 16837:
16838: Create a datatable row for display of nested categories in a domain,
16839: with checkboxes to allow a course to be categorized,called recursively.
16840:
16841: Inputs:
16842:
16843: itemcount - track row number for alternating colors
16844:
16845: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16846: categories and subcategories.
16847:
16848: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16849:
16850: parent - parent of current category item
16851:
16852: path - Array containing all categories back up through the hierarchy from the
16853: current category to the top level.
16854:
16855: currcategories - reference to array of current categories assigned to the course
16856:
1.1260 raeburn 16857: disabled - scalar (optional) contains disabled="disabled" if input elements are
16858: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16859:
1.663 raeburn 16860: Returns: $output (markup to be displayed).
16861:
16862: =cut
16863:
16864: sub assign_category_rows {
1.1259 raeburn 16865: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16866: my ($text,$name,$item,$chgstr);
16867: if (ref($cats) eq 'ARRAY') {
16868: my $maxdepth = scalar(@{$cats});
16869: if (ref($cats->[$depth]) eq 'HASH') {
16870: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16871: my $numchildren = @{$cats->[$depth]{$parent}};
16872: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16873: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16874: for (my $j=0; $j<$numchildren; $j++) {
16875: $name = $cats->[$depth]{$parent}[$j];
16876: $item = &escape($name).':'.&escape($parent).':'.$depth;
16877: my $deeper = $depth+1;
16878: my $checked = '';
16879: if (ref($currcategories) eq 'ARRAY') {
16880: if (@{$currcategories} > 0) {
16881: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16882: $checked = ' checked="checked"';
1.663 raeburn 16883: }
16884: }
16885: }
1.664 raeburn 16886: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16887: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16888: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16889: '<input type="hidden" name="catname" value="'.$name.'" />'.
16890: '</td><td>';
1.663 raeburn 16891: if (ref($path) eq 'ARRAY') {
16892: push(@{$path},$name);
1.1259 raeburn 16893: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16894: pop(@{$path});
16895: }
16896: $text .= '</td></tr>';
16897: }
16898: $text .= '</table></td>';
16899: }
16900: }
16901: }
16902: return $text;
16903: }
16904:
1.1181 raeburn 16905: =pod
16906:
16907: =back
16908:
16909: =cut
16910:
1.655 raeburn 16911: ############################################################
16912: ############################################################
16913:
16914:
1.443 albertel 16915: sub commit_customrole {
1.1408 raeburn 16916: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16917: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16918: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16919: $context,$othdomby,$requester);
1.630 raeburn 16920: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16921: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16922: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16923: if (wantarray) {
16924: return ($output,$result);
16925: } else {
16926: return $output;
16927: }
1.443 albertel 16928: }
16929:
16930: sub commit_standardrole {
1.1408 raeburn 16931: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16932: $othdomby,$requester) = @_;
1.1399 raeburn 16933: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16934: if ($context eq 'auto') {
16935: $linefeed = "\n";
16936: } else {
16937: $linefeed = "<br />\n";
16938: }
1.443 albertel 16939: if ($three eq 'st') {
1.1399 raeburn 16940: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16941: $one,$two,$sec,$context,$credits,$othdomby,
16942: $requester);
1.541 raeburn 16943: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16944: ($result eq 'unknown_course') || ($result eq 'refused')) {
16945: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16946: } else {
1.541 raeburn 16947: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16948: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16949: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16950: if ($context eq 'auto') {
16951: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16952: } else {
16953: $output .= '<b>'.$result.'</b>'.$linefeed.
16954: &mt('Add to classlist').': <b>ok</b>';
16955: }
16956: $output .= $linefeed;
1.443 albertel 16957: }
16958: } else {
16959: $output = &mt('Assigning').' '.$three.' in '.$url.
16960: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16961: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 16962: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
16963: '','',$context,$othdomby,$requester);
1.541 raeburn 16964: if ($context eq 'auto') {
16965: $output .= $result.$linefeed;
16966: } else {
16967: $output .= '<b>'.$result.'</b>'.$linefeed;
16968: }
1.443 albertel 16969: }
1.1399 raeburn 16970: if (wantarray) {
16971: return ($output,$result);
16972: } else {
16973: return $output;
16974: }
1.443 albertel 16975: }
16976:
16977: sub commit_studentrole {
1.1116 raeburn 16978: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 16979: $credits,$othdomby,$requester) = @_;
1.626 raeburn 16980: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 16981: if ($context eq 'auto') {
16982: $linefeed = "\n";
16983: } else {
16984: $linefeed = '<br />'."\n";
16985: }
1.443 albertel 16986: if (defined($one) && defined($two)) {
16987: my $cid=$one.'_'.$two;
16988: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
16989: my $secchange = 0;
16990: my $expire_role_result;
16991: my $modify_section_result;
1.628 raeburn 16992: if ($oldsec ne '-1') {
16993: if ($oldsec ne $sec) {
1.443 albertel 16994: $secchange = 1;
1.628 raeburn 16995: my $now = time;
1.443 albertel 16996: my $uurl='/'.$cid;
16997: $uurl=~s/\_/\//g;
16998: if ($oldsec) {
16999: $uurl.='/'.$oldsec;
17000: }
1.626 raeburn 17001: $oldsecurl = $uurl;
1.628 raeburn 17002: $expire_role_result =
1.1408 raeburn 17003: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17004: '','','',$context,$othdomby,$requester);
17005: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17006: if ($expire_role_result eq 'refused') {
17007: my @roles = ('st');
17008: my @statuses = ('previous');
17009: my @roledoms = ($one);
17010: my $withsec = 1;
17011: my %roleshash =
17012: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17013: \@statuses,\@roles,\@roledoms,$withsec);
17014: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17015: my ($oldstart,$oldend) =
17016: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17017: if ($oldend > 0 && $oldend <= $now) {
17018: $expire_role_result = 'ok';
17019: }
17020: }
17021: }
17022: }
1.443 albertel 17023: $result = $expire_role_result;
17024: }
17025: }
17026: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17027: $modify_section_result =
17028: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17029: undef,undef,undef,$sec,
17030: $end,$start,'','',$cid,
1.1408 raeburn 17031: '',$context,$credits,'',
17032: $othdomby,$requester);
1.443 albertel 17033: if ($modify_section_result =~ /^ok/) {
17034: if ($secchange == 1) {
1.628 raeburn 17035: if ($sec eq '') {
17036: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17037: } else {
17038: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17039: }
1.443 albertel 17040: } elsif ($oldsec eq '-1') {
1.628 raeburn 17041: if ($sec eq '') {
17042: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17043: } else {
17044: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17045: }
1.443 albertel 17046: } else {
1.628 raeburn 17047: if ($sec eq '') {
17048: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17049: } else {
17050: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17051: }
1.443 albertel 17052: }
17053: } else {
1.1115 raeburn 17054: if ($secchange) {
1.628 raeburn 17055: $$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;
17056: } else {
17057: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17058: }
1.443 albertel 17059: }
17060: $result = $modify_section_result;
17061: } elsif ($secchange == 1) {
1.628 raeburn 17062: if ($oldsec eq '') {
1.1103 raeburn 17063: $$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 17064: } else {
17065: $$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;
17066: }
1.626 raeburn 17067: if ($expire_role_result eq 'refused') {
17068: my $newsecurl = '/'.$cid;
17069: $newsecurl =~ s/\_/\//g;
17070: if ($sec ne '') {
17071: $newsecurl.='/'.$sec;
17072: }
17073: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17074: if ($sec eq '') {
17075: $$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;
17076: } else {
17077: $$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;
17078: }
17079: }
17080: }
1.443 albertel 17081: }
17082: } else {
1.626 raeburn 17083: $$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 17084: $result = "error: incomplete course id\n";
17085: }
17086: return $result;
17087: }
17088:
1.1108 raeburn 17089: sub show_role_extent {
17090: my ($scope,$context,$role) = @_;
17091: $scope =~ s{^/}{};
17092: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17093: push(@courseroles,'co');
17094: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17095: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17096: $scope =~ s{/}{_};
17097: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17098: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17099: my ($audom,$auname) = split(/\//,$scope);
17100: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17101: &Apache::loncommon::plainname($auname,$audom).'</span>');
17102: } else {
17103: $scope =~ s{/$}{};
17104: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17105: &Apache::lonnet::domain($scope,'description').'</span>');
17106: }
17107: }
17108:
1.443 albertel 17109: ############################################################
17110: ############################################################
17111:
1.566 albertel 17112: sub check_clone {
1.578 raeburn 17113: my ($args,$linefeed) = @_;
1.566 albertel 17114: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17115: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17116: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17117: my $clonetitle;
17118: my @clonemsg;
1.566 albertel 17119: my $can_clone = 0;
1.944 raeburn 17120: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17121: if ($lctype ne 'community') {
17122: $lctype = 'course';
17123: }
1.566 albertel 17124: if ($clonehome eq 'no_host') {
1.944 raeburn 17125: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17126: push(@clonemsg,({
17127: mt => 'No new community created.',
17128: args => [],
17129: },
17130: {
17131: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17132: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17133: }));
1.908 raeburn 17134: } else {
1.1344 raeburn 17135: push(@clonemsg,({
17136: mt => 'No new course created.',
17137: args => [],
17138: },
17139: {
17140: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17141: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17142: }));
17143: }
1.566 albertel 17144: } else {
17145: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17146: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17147: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17148: if ($clonedesc{'type'} ne '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 course not a community.',
17155: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17156: }));
17157: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17158: }
17159: }
1.1262 raeburn 17160: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17161: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17162: $can_clone = 1;
17163: } else {
1.1221 raeburn 17164: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17165: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17166: if ($clonehash{'cloners'} eq '') {
17167: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17168: if ($domdefs{'canclone'}) {
17169: unless ($domdefs{'canclone'} eq 'none') {
17170: if ($domdefs{'canclone'} eq 'domain') {
17171: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17172: $can_clone = 1;
17173: }
17174: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17175: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17176: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17177: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17178: $can_clone = 1;
17179: }
17180: }
17181: }
17182: }
1.578 raeburn 17183: } else {
1.1221 raeburn 17184: my @cloners = split(/,/,$clonehash{'cloners'});
17185: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17186: $can_clone = 1;
1.1221 raeburn 17187: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17188: $can_clone = 1;
1.1225 raeburn 17189: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17190: $can_clone = 1;
1.1221 raeburn 17191: }
17192: unless ($can_clone) {
1.1225 raeburn 17193: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17194: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17195: my (%gotdomdefaults,%gotcodedefaults);
17196: foreach my $cloner (@cloners) {
17197: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17198: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17199: my (%codedefaults,@code_order);
17200: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17201: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17202: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17203: }
17204: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17205: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17206: }
17207: } else {
17208: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17209: \%codedefaults,
17210: \@code_order);
17211: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17212: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17213: }
17214: if (@code_order > 0) {
17215: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17216: $cloner,$clonehash{'internal.coursecode'},
17217: $args->{'crscode'})) {
17218: $can_clone = 1;
17219: last;
17220: }
17221: }
17222: }
17223: }
17224: }
1.1225 raeburn 17225: }
17226: }
17227: unless ($can_clone) {
17228: my $ccrole = 'cc';
17229: if ($args->{'crstype'} eq 'Community') {
17230: $ccrole = 'co';
17231: }
17232: my %roleshash =
17233: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17234: $args->{'ccdomain'},
17235: 'userroles',['active'],[$ccrole],
17236: [$args->{'clonedomain'}]);
17237: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17238: $can_clone = 1;
17239: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17240: $args->{'ccuname'},$args->{'ccdomain'})) {
17241: $can_clone = 1;
1.1221 raeburn 17242: }
17243: }
17244: unless ($can_clone) {
17245: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17246: push(@clonemsg,({
17247: mt => 'No new community created.',
17248: args => [],
17249: },
17250: {
17251: 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]).',
17252: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17253: }));
1.942 raeburn 17254: } else {
1.1344 raeburn 17255: push(@clonemsg,({
17256: mt => 'No new course created.',
17257: args => [],
17258: },
17259: {
17260: 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]).',
17261: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17262: }));
1.1221 raeburn 17263: }
1.566 albertel 17264: }
1.578 raeburn 17265: }
1.566 albertel 17266: }
1.1344 raeburn 17267: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17268: }
17269:
1.444 albertel 17270: sub construct_course {
1.1262 raeburn 17271: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17272: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17273: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17274: my $linefeed = '<br />'."\n";
17275: if ($context eq 'auto') {
17276: $linefeed = "\n";
17277: }
1.566 albertel 17278:
17279: #
17280: # Are we cloning?
17281: #
1.1344 raeburn 17282: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17283: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17284: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17285: if (!$can_clone) {
1.1344 raeburn 17286: return (0,$outcome,$clonemsgref);
1.566 albertel 17287: }
17288: }
17289:
1.444 albertel 17290: #
17291: # Open course
17292: #
1.1239 raeburn 17293: my $showncrstype;
17294: if ($args->{'crstype'} eq 'Placement') {
17295: $showncrstype = 'placement test';
17296: } else {
17297: $showncrstype = lc($args->{'crstype'});
17298: }
1.444 albertel 17299: my %cenv=();
17300: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17301: $args->{'cdescr'},
17302: $args->{'curl'},
17303: $args->{'course_home'},
17304: $args->{'nonstandard'},
17305: $args->{'crscode'},
17306: $args->{'ccuname'}.':'.
17307: $args->{'ccdomain'},
1.882 raeburn 17308: $args->{'crstype'},
1.1344 raeburn 17309: $cnum,$context,$category,
17310: $callercontext);
1.444 albertel 17311:
17312: # Note: The testing routines depend on this being output; see
17313: # Utils::Course. This needs to at least be output as a comment
17314: # if anyone ever decides to not show this, and Utils::Course::new
17315: # will need to be suitably modified.
1.1344 raeburn 17316: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17317: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17318: } else {
17319: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17320: }
1.943 raeburn 17321: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17322: return (0,$outcome,$clonemsgref);
1.943 raeburn 17323: }
17324:
1.444 albertel 17325: #
17326: # Check if created correctly
17327: #
1.479 albertel 17328: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17329: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17330: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17331: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17332: $outcome .= &mt_user($user_lh,
17333: 'Course creation failed, unrecognized course home server.');
17334: } else {
17335: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17336: }
17337: $outcome .= $linefeed;
17338: return (0,$outcome,$clonemsgref);
1.943 raeburn 17339: }
1.541 raeburn 17340: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17341:
1.444 albertel 17342: #
1.566 albertel 17343: # Do the cloning
17344: #
1.1344 raeburn 17345: my @clonemsg;
1.566 albertel 17346: if ($can_clone && $cloneid) {
1.1344 raeburn 17347: push(@clonemsg,
17348: {
17349: mt => 'Created [_1] by cloning from [_2]',
17350: args => [$showncrstype,$clonetitle],
17351: });
1.566 albertel 17352: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17353: # Copy all files
1.1344 raeburn 17354: my @info =
17355: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17356: $args->{'dateshift'},$args->{'crscode'},
17357: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17358: $args->{'tinyurls'});
17359: if (@info) {
17360: push(@clonemsg,@info);
17361: }
1.444 albertel 17362: # Restore URL
1.566 albertel 17363: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17364: # Restore title
1.566 albertel 17365: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17366: # Restore creation date, creator and creation context.
17367: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17368: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17369: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17370: # Mark as cloned
1.566 albertel 17371: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17372: # Need to clone grading mode
17373: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17374: $cenv{'grading'}=$newenv{'grading'};
17375: # Do not clone these environment entries
17376: &Apache::lonnet::del('environment',
17377: ['default_enrollment_start_date',
17378: 'default_enrollment_end_date',
17379: 'question.email',
17380: 'policy.email',
17381: 'comment.email',
17382: 'pch.users.denied',
1.725 raeburn 17383: 'plc.users.denied',
17384: 'hidefromcat',
1.1121 raeburn 17385: 'checkforpriv',
1.1355 raeburn 17386: 'categories'],
1.638 www 17387: $$crsudom,$$crsunum);
1.1170 raeburn 17388: if ($args->{'textbook'}) {
17389: $cenv{'internal.textbook'} = $args->{'textbook'};
17390: }
1.444 albertel 17391: }
1.566 albertel 17392:
1.444 albertel 17393: #
17394: # Set environment (will override cloned, if existing)
17395: #
17396: my @sections = ();
17397: my @xlists = ();
17398: if ($args->{'crstype'}) {
17399: $cenv{'type'}=$args->{'crstype'};
17400: }
1.1371 raeburn 17401: if ($args->{'lti'}) {
17402: $cenv{'internal.lti'}=$args->{'lti'};
17403: }
1.444 albertel 17404: if ($args->{'crsid'}) {
17405: $cenv{'courseid'}=$args->{'crsid'};
17406: }
17407: if ($args->{'crscode'}) {
17408: $cenv{'internal.coursecode'}=$args->{'crscode'};
17409: }
17410: if ($args->{'crsquota'} ne '') {
17411: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17412: } else {
17413: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17414: }
17415: if ($args->{'ccuname'}) {
17416: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17417: ':'.$args->{'ccdomain'};
17418: } else {
17419: $cenv{'internal.courseowner'} = $args->{'curruser'};
17420: }
1.1116 raeburn 17421: if ($args->{'defaultcredits'}) {
17422: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17423: }
1.444 albertel 17424: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17425: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17426: if ($args->{'crssections'}) {
17427: $cenv{'internal.sectionnums'} = '';
17428: if ($args->{'crssections'} =~ m/,/) {
17429: @sections = split/,/,$args->{'crssections'};
17430: } else {
17431: $sections[0] = $args->{'crssections'};
17432: }
17433: if (@sections > 0) {
17434: foreach my $item (@sections) {
17435: my ($sec,$gp) = split/:/,$item;
17436: my $class = $args->{'crscode'}.$sec;
17437: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17438: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17439: if ($addcheck eq 'ok') {
17440: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17441: push(@oklcsecs,$gp);
17442: }
17443: } else {
1.1263 raeburn 17444: push(@badclasses,$class);
1.444 albertel 17445: }
17446: }
17447: $cenv{'internal.sectionnums'} =~ s/,$//;
17448: }
17449: }
17450: # do not hide course coordinator from staff listing,
17451: # even if privileged
17452: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17453: # add course coordinator's domain to domains to check for privileged users
17454: # if different to course domain
17455: if ($$crsudom ne $args->{'ccdomain'}) {
17456: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17457: }
1.444 albertel 17458: # add crosslistings
17459: if ($args->{'crsxlist'}) {
17460: $cenv{'internal.crosslistings'}='';
17461: if ($args->{'crsxlist'} =~ m/,/) {
17462: @xlists = split/,/,$args->{'crsxlist'};
17463: } else {
17464: $xlists[0] = $args->{'crsxlist'};
17465: }
17466: if (@xlists > 0) {
17467: foreach my $item (@xlists) {
17468: my ($xl,$gp) = split/:/,$item;
17469: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17470: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17471: if ($addcheck eq 'ok') {
17472: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17473: push(@oklcsecs,$gp);
17474: }
17475: } else {
1.1263 raeburn 17476: push(@badclasses,$xl);
1.444 albertel 17477: }
17478: }
17479: $cenv{'internal.crosslistings'} =~ s/,$//;
17480: }
17481: }
17482: if ($args->{'autoadds'}) {
17483: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17484: }
17485: if ($args->{'autodrops'}) {
17486: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17487: }
17488: # check for notification of enrollment changes
17489: my @notified = ();
17490: if ($args->{'notify_owner'}) {
17491: if ($args->{'ccuname'} ne '') {
17492: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17493: }
17494: }
17495: if ($args->{'notify_dc'}) {
17496: if ($uname ne '') {
1.630 raeburn 17497: push(@notified,$uname.':'.$udom);
1.444 albertel 17498: }
17499: }
17500: if (@notified > 0) {
17501: my $notifylist;
17502: if (@notified > 1) {
17503: $notifylist = join(',',@notified);
17504: } else {
17505: $notifylist = $notified[0];
17506: }
17507: $cenv{'internal.notifylist'} = $notifylist;
17508: }
17509: if (@badclasses > 0) {
17510: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17511: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17512: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17513: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17514: );
1.1264 raeburn 17515: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17516: &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 17517: if ($context eq 'auto') {
17518: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17519: } else {
1.566 albertel 17520: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17521: }
17522: foreach my $item (@badclasses) {
1.541 raeburn 17523: if ($context eq 'auto') {
1.1261 raeburn 17524: $outcome .= " - $item\n";
1.541 raeburn 17525: } else {
1.1261 raeburn 17526: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17527: }
1.1261 raeburn 17528: }
17529: if ($context eq 'auto') {
17530: $outcome .= $linefeed;
17531: } else {
17532: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17533: }
1.444 albertel 17534: }
17535: if ($args->{'no_end_date'}) {
17536: $args->{'endaccess'} = 0;
17537: }
1.1412 raeburn 17538: # If an official course with institutional sections is created by cloning
17539: # an existing course, section-specific hiding of course totals in student's
17540: # view of grades as copied from cloned course, will be checked for valid
17541: # sections.
17542: if (($can_clone && $cloneid) &&
17543: ($cenv{'internal.coursecode'} ne '') &&
17544: ($cenv{'grading'} eq 'standard') &&
17545: ($cenv{'hidetotals'} ne '') &&
17546: ($cenv{'hidetotals'} ne 'all')) {
17547: my @hidesecs;
17548: my $deletehidetotals;
17549: if (@oklcsecs) {
17550: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17551: if (grep(/^\Q$sec$/,@oklcsecs)) {
17552: push(@hidesecs,$sec);
17553: }
17554: }
17555: if (@hidesecs) {
17556: $cenv{'hidetotals'} = join(',',@hidesecs);
17557: } else {
17558: $deletehidetotals = 1;
17559: }
17560: } else {
17561: $deletehidetotals = 1;
17562: }
17563: if ($deletehidetotals) {
17564: delete($cenv{'hidetotals'});
17565: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17566: }
17567: }
1.444 albertel 17568: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17569: $cenv{'internal.autoend'}=$args->{'enrollend'};
17570: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17571: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17572: if ($args->{'showphotos'}) {
17573: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17574: }
17575: $cenv{'internal.authtype'} = $args->{'authtype'};
17576: $cenv{'internal.autharg'} = $args->{'autharg'};
17577: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17578: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17579: 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');
17580: if ($context eq 'auto') {
17581: $outcome .= $krb_msg;
17582: } else {
1.566 albertel 17583: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17584: }
17585: $outcome .= $linefeed;
1.444 albertel 17586: }
17587: }
17588: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17589: if ($args->{'setpolicy'}) {
17590: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17591: }
17592: if ($args->{'setcontent'}) {
17593: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17594: }
1.1251 raeburn 17595: if ($args->{'setcomment'}) {
17596: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17597: }
1.444 albertel 17598: }
17599: if ($args->{'reshome'}) {
17600: $cenv{'reshome'}=$args->{'reshome'}.'/';
17601: $cenv{'reshome'}=~s/\/+$/\//;
17602: }
17603: #
17604: # course has keyed access
17605: #
17606: if ($args->{'setkeys'}) {
17607: $cenv{'keyaccess'}='yes';
17608: }
17609: # if specified, key authority is not course, but user
17610: # only active if keyaccess is yes
17611: if ($args->{'keyauth'}) {
1.487 albertel 17612: my ($user,$domain) = split(':',$args->{'keyauth'});
17613: $user = &LONCAPA::clean_username($user);
17614: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17615: if ($user ne '' && $domain ne '') {
1.487 albertel 17616: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17617: }
17618: }
17619:
1.1166 raeburn 17620: #
1.1167 raeburn 17621: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17622: #
17623: if ($args->{'uniquecode'}) {
17624: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17625: if ($code) {
17626: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17627: my %crsinfo =
17628: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17629: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17630: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17631: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17632: }
1.1166 raeburn 17633: if (ref($coderef)) {
17634: $$coderef = $code;
17635: }
17636: }
17637: }
17638:
1.444 albertel 17639: if ($args->{'disresdis'}) {
17640: $cenv{'pch.roles.denied'}='st';
17641: }
17642: if ($args->{'disablechat'}) {
17643: $cenv{'plc.roles.denied'}='st';
17644: }
17645:
17646: # Record we've not yet viewed the Course Initialization Helper for this
17647: # course
17648: $cenv{'course.helper.not.run'} = 1;
17649: #
17650: # Use new Randomseed
17651: #
17652: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17653: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17654: #
17655: # The encryption code and receipt prefix for this course
17656: #
17657: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17658: $cenv{'internal.encpref'}=100+int(9*rand(99));
17659: #
17660: # By default, use standard grading
17661: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17662:
1.541 raeburn 17663: $outcome .= $linefeed.&mt('Setting environment').': '.
17664: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17665: #
17666: # Open all assignments
17667: #
17668: if ($args->{'openall'}) {
1.1341 raeburn 17669: my $opendate = time;
17670: if ($args->{'openallfrom'} =~ /^\d+$/) {
17671: $opendate = $args->{'openallfrom'};
17672: }
1.444 albertel 17673: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17674: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17675: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17676: $outcome .= &mt('All assignments open starting [_1]',
17677: &Apache::lonlocal::locallocaltime($opendate)).': '.
17678: &Apache::lonnet::cput
17679: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17680: }
17681: #
17682: # Set first page
17683: #
17684: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17685: || ($cloneid)) {
17686: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17687:
17688: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17689: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17690:
1.444 albertel 17691: $outcome .= ($fatal?$errtext:'read ok').' - ';
17692: my $title; my $url;
17693: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17694: $title=&mt('Syllabus');
1.444 albertel 17695: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17696: } else {
1.963 raeburn 17697: $title=&mt('Table of Contents');
1.444 albertel 17698: $url='/adm/navmaps';
17699: }
1.445 albertel 17700:
17701: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17702: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17703:
17704: if ($errtext) { $fatal=2; }
1.541 raeburn 17705: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17706: }
1.566 albertel 17707:
1.1237 raeburn 17708: #
17709: # Set params for Placement Tests
17710: #
1.1239 raeburn 17711: if ($args->{'crstype'} eq 'Placement') {
17712: my %storecontent;
17713: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17714: my %defaults = (
17715: buttonshide => { value => 'yes',
17716: type => 'string_yesno',},
17717: type => { value => 'randomizetry',
17718: type => 'string_questiontype',},
17719: maxtries => { value => 1,
17720: type => 'int_pos',},
17721: problemstatus => { value => 'no',
17722: type => 'string_problemstatus',},
17723: );
17724: foreach my $key (keys(%defaults)) {
17725: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17726: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17727: }
1.1237 raeburn 17728: &Apache::lonnet::cput
17729: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17730: }
17731:
1.1344 raeburn 17732: return (1,$outcome,\@clonemsg);
1.444 albertel 17733: }
17734:
1.1166 raeburn 17735: sub make_unique_code {
17736: my ($cdom,$cnum) = @_;
17737: # get lock on uniquecodes db
17738: my $lockhash = {
17739: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17740: ':'.$env{'user.domain'},
17741: };
17742: my $tries = 0;
17743: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17744: my ($code,$error);
17745:
17746: while (($gotlock ne 'ok') && ($tries<3)) {
17747: $tries ++;
17748: sleep 1;
17749: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17750: }
17751: if ($gotlock eq 'ok') {
17752: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17753: my $gotcode;
17754: my $attempts = 0;
17755: while ((!$gotcode) && ($attempts < 100)) {
17756: $code = &generate_code();
17757: if (!exists($currcodes{$code})) {
17758: $gotcode = 1;
17759: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17760: $error = 'nostore';
17761: }
17762: }
17763: $attempts ++;
17764: }
17765: my @del_lock = ($cnum."\0".'uniquecodes');
17766: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17767: } else {
17768: $error = 'nolock';
17769: }
17770: return ($code,$error);
17771: }
17772:
17773: sub generate_code {
17774: my $code;
17775: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17776: for (my $i=0; $i<6; $i++) {
17777: my $lettnum = int (rand 2);
17778: my $item = '';
17779: if ($lettnum) {
17780: $item = $letts[int( rand(18) )];
17781: } else {
17782: $item = 1+int( rand(8) );
17783: }
17784: $code .= $item;
17785: }
17786: return $code;
17787: }
17788:
1.444 albertel 17789: ############################################################
17790: ############################################################
17791:
1.1237 raeburn 17792: # Community, Course and Placement Test
1.378 raeburn 17793: sub course_type {
17794: my ($cid) = @_;
17795: if (!defined($cid)) {
17796: $cid = $env{'request.course.id'};
17797: }
1.404 albertel 17798: if (defined($env{'course.'.$cid.'.type'})) {
17799: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17800: } else {
17801: return 'Course';
1.377 raeburn 17802: }
17803: }
1.156 albertel 17804:
1.406 raeburn 17805: sub group_term {
17806: my $crstype = &course_type();
17807: my %names = (
17808: 'Course' => 'group',
1.865 raeburn 17809: 'Community' => 'group',
1.1237 raeburn 17810: 'Placement' => 'group',
1.406 raeburn 17811: );
17812: return $names{$crstype};
17813: }
17814:
1.902 raeburn 17815: sub course_types {
1.1310 raeburn 17816: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17817: my %typename = (
17818: official => 'Official course',
17819: unofficial => 'Unofficial course',
17820: community => 'Community',
1.1165 raeburn 17821: textbook => 'Textbook course',
1.1237 raeburn 17822: placement => 'Placement test',
1.1310 raeburn 17823: lti => 'LTI provider',
1.902 raeburn 17824: );
17825: return (\@types,\%typename);
17826: }
17827:
1.156 albertel 17828: sub icon {
17829: my ($file)=@_;
1.505 albertel 17830: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17831: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17832: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17833: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17834: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17835: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17836: $curfext.".gif") {
17837: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17838: $curfext.".gif";
17839: }
17840: }
1.249 albertel 17841: return &lonhttpdurl($iconname);
1.154 albertel 17842: }
1.84 albertel 17843:
1.575 albertel 17844: sub lonhttpdurl {
1.692 www 17845: #
17846: # Had been used for "small fry" static images on separate port 8080.
17847: # Modify here if lightweight http functionality desired again.
17848: # Currently eliminated due to increasing firewall issues.
17849: #
1.575 albertel 17850: my ($url)=@_;
1.692 www 17851: return $url;
1.215 albertel 17852: }
17853:
1.213 albertel 17854: sub connection_aborted {
17855: my ($r)=@_;
17856: $r->print(" ");$r->rflush();
17857: my $c = $r->connection;
17858: return $c->aborted();
17859: }
17860:
1.221 foxr 17861: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17862: # strings as 'strings'.
17863: sub escape_single {
1.221 foxr 17864: my ($input) = @_;
1.223 albertel 17865: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17866: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17867: return $input;
17868: }
1.223 albertel 17869:
1.222 foxr 17870: # Same as escape_single, but escape's "'s This
17871: # can be used for "strings"
17872: sub escape_double {
17873: my ($input) = @_;
17874: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17875: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17876: return $input;
17877: }
1.223 albertel 17878:
1.222 foxr 17879: # Escapes the last element of a full URL.
17880: sub escape_url {
17881: my ($url) = @_;
1.238 raeburn 17882: my @urlslices = split(/\//, $url,-1);
1.369 www 17883: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17884: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17885: }
1.462 albertel 17886:
1.820 raeburn 17887: sub compare_arrays {
17888: my ($arrayref1,$arrayref2) = @_;
17889: my (@difference,%count);
17890: @difference = ();
17891: %count = ();
17892: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17893: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17894: foreach my $element (keys(%count)) {
17895: if ($count{$element} == 1) {
17896: push(@difference,$element);
17897: }
17898: }
17899: }
17900: return @difference;
17901: }
17902:
1.1322 raeburn 17903: sub lon_status_items {
17904: my %defaults = (
17905: E => 100,
17906: W => 4,
17907: N => 1,
1.1324 raeburn 17908: U => 5,
1.1322 raeburn 17909: threshold => 200,
17910: sysmail => 2500,
17911: );
17912: my %names = (
17913: E => 'Errors',
17914: W => 'Warnings',
17915: N => 'Notices',
1.1324 raeburn 17916: U => 'Unsent',
1.1322 raeburn 17917: );
17918: return (\%defaults,\%names);
17919: }
17920:
1.817 bisitz 17921: # -------------------------------------------------------- Initialize user login
1.462 albertel 17922: sub init_user_environment {
1.463 albertel 17923: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17924: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17925:
17926: my $public=($username eq 'public' && $domain eq 'public');
17927:
1.1415 raeburn 17928: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17929: $coauthorenv);
1.462 albertel 17930: my $now=time;
17931:
17932: if ($public) {
17933: my $max_public=100;
17934: my $oldest;
17935: my $oldest_time=0;
17936: for(my $next=1;$next<=$max_public;$next++) {
17937: if (-e $lonids."/publicuser_$next.id") {
17938: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17939: if ($mtime<$oldest_time || !$oldest_time) {
17940: $oldest_time=$mtime;
17941: $oldest=$next;
17942: }
17943: } else {
17944: $cookie="publicuser_$next";
17945: last;
17946: }
17947: }
17948: if (!$cookie) { $cookie="publicuser_$oldest"; }
17949: } else {
1.1275 raeburn 17950: # See if old ID present, if so, remove if this isn't a robot,
17951: # killing any existing non-robot sessions
1.463 albertel 17952: if (!$args->{'robot'}) {
17953: opendir(DIR,$lonids);
17954: while ($filename=readdir(DIR)) {
17955: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17956: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17957: &GDBM_READER(),0640)) {
1.1295 raeburn 17958: my $linkedfile;
1.1320 raeburn 17959: if (exists($oldenv{'user.linkedenv'})) {
17960: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17961: }
1.1320 raeburn 17962: untie(%oldenv);
17963: if (unlink("$lonids/$filename")) {
17964: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17965: if (-l "$lonids/$linkedfile.id") {
17966: unlink("$lonids/$linkedfile.id");
17967: }
1.1295 raeburn 17968: }
17969: }
17970: } else {
17971: unlink($lonids.'/'.$filename);
17972: }
1.463 albertel 17973: }
1.462 albertel 17974: }
1.463 albertel 17975: closedir(DIR);
1.1204 raeburn 17976: # If there is a undeleted lockfile for the user's paste buffer remove it.
17977: my $namespace = 'nohist_courseeditor';
17978: my $lockingkey = 'paste'."\0".'locked_num';
17979: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
17980: $domain,$username);
17981: if (exists($lockhash{$lockingkey})) {
17982: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
17983: unless ($delresult eq 'ok') {
17984: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
17985: }
17986: }
1.462 albertel 17987: }
17988: # Give them a new cookie
1.463 albertel 17989: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 17990: : $now.$$.int(rand(10000)));
1.463 albertel 17991: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 17992:
17993: # Initialize roles
17994:
1.1414 raeburn 17995: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 17996: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 17997: }
17998: # ------------------------------------ Check browser type and MathML capability
17999:
1.1194 raeburn 18000: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18001: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18002:
18003: # ------------------------------------------------------------- Get environment
18004:
18005: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18006: my ($tmp) = keys(%userenv);
1.1275 raeburn 18007: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18008: undef(%userenv);
18009: }
18010: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18011: $form->{'interface'}=$userenv{'interface'};
18012: }
18013: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18014:
18015: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18016: foreach my $option ('interface','localpath','localres') {
18017: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18018: }
18019: # --------------------------------------------------------- Write first profile
18020:
18021: {
1.1350 raeburn 18022: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18023: my %initial_env =
18024: ("user.name" => $username,
18025: "user.domain" => $domain,
18026: "user.home" => $authhost,
18027: "browser.type" => $clientbrowser,
18028: "browser.version" => $clientversion,
18029: "browser.mathml" => $clientmathml,
18030: "browser.unicode" => $clientunicode,
18031: "browser.os" => $clientos,
1.1137 raeburn 18032: "browser.mobile" => $clientmobile,
1.1141 raeburn 18033: "browser.info" => $clientinfo,
1.1194 raeburn 18034: "browser.osversion" => $clientosversion,
1.462 albertel 18035: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18036: "request.course.fn" => '',
18037: "request.course.uri" => '',
18038: "request.course.sec" => '',
18039: "request.role" => 'cm',
18040: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18041: "request.host" => $ip,);
1.462 albertel 18042:
18043: if ($form->{'localpath'}) {
18044: $initial_env{"browser.localpath"} = $form->{'localpath'};
18045: $initial_env{"browser.localres"} = $form->{'localres'};
18046: }
18047:
18048: if ($form->{'interface'}) {
18049: $form->{'interface'}=~s/\W//gs;
18050: $initial_env{"browser.interface"} = $form->{'interface'};
18051: $env{'browser.interface'}=$form->{'interface'};
18052: }
18053:
1.1157 raeburn 18054: if ($form->{'iptoken'}) {
18055: my $lonhost = $r->dir_config('lonHostID');
18056: $initial_env{"user.noloadbalance"} = $lonhost;
18057: $env{'user.noloadbalance'} = $lonhost;
18058: }
18059:
1.1268 raeburn 18060: if ($form->{'noloadbalance'}) {
18061: my @hosts = &Apache::lonnet::current_machine_ids();
18062: my $hosthere = $form->{'noloadbalance'};
18063: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18064: $initial_env{"user.noloadbalance"} = $hosthere;
18065: $env{'user.noloadbalance'} = $hosthere;
18066: }
18067: }
18068:
1.1016 raeburn 18069: unless ($domain eq 'public') {
1.1273 raeburn 18070: my %is_adv = ( is_adv => $env{'user.adv'} );
18071: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18072:
1.1414 raeburn 18073: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18074: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18075: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18076: undef,\%userenv,\%domdef,\%is_adv);
18077: }
1.980 raeburn 18078:
1.1311 raeburn 18079: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18080: $userenv{'canrequest.'.$crstype} =
18081: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18082: 'reload','requestcourses',
18083: \%userenv,\%domdef,\%is_adv);
18084: }
1.724 raeburn 18085:
1.1418 raeburn 18086: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18087: (exists($userroles->{"user.role.au./$domain/"}))) {
18088: if ($userenv{'authoreditors'}) {
18089: $userenv{'editors'} = $userenv{'authoreditors'};
18090: } elsif ($domdef{'editors'} ne '') {
18091: $userenv{'editors'} = $domdef{'editors'};
18092: } else {
18093: $userenv{'editors'} = 'edit,xml';
18094: }
1.1431 raeburn 18095: if ($userenv{'authorarchive'}) {
18096: $userenv{'canarchive'} = 1;
18097: } elsif (($userenv{'authorarchive'} eq '') &&
18098: ($domdef{'archive'})) {
18099: $userenv{'canarchive'} = 1;
18100: }
1.1418 raeburn 18101: }
18102:
1.1273 raeburn 18103: $userenv{'canrequest.author'} =
18104: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18105: 'reload','requestauthor',
1.980 raeburn 18106: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18107: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18108: $domain,$username);
18109: my $reqstatus = $reqauthor{'author_status'};
18110: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18111: if (ref($reqauthor{'author'}) eq 'HASH') {
18112: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18113: $reqauthor{'author'}{'timestamp'};
18114: }
1.1092 raeburn 18115: }
1.1287 raeburn 18116: my ($types,$typename) = &course_types();
18117: if (ref($types) eq 'ARRAY') {
18118: my @options = ('approval','validate','autolimit');
18119: my $optregex = join('|',@options);
18120: my (%willtrust,%trustchecked);
18121: foreach my $type (@{$types}) {
18122: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18123: if ($dom_str ne '') {
18124: my $updatedstr = '';
18125: my @possdomains = split(',',$dom_str);
18126: foreach my $entry (@possdomains) {
18127: my ($extdom,$extopt) = split(':',$entry);
18128: unless ($trustchecked{$extdom}) {
18129: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18130: $trustchecked{$extdom} = 1;
18131: }
18132: if ($willtrust{$extdom}) {
18133: $updatedstr .= $entry.',';
18134: }
18135: }
18136: $updatedstr =~ s/,$//;
18137: if ($updatedstr) {
18138: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18139: } else {
18140: delete($userenv{'reqcrsotherdom.'.$type});
18141: }
18142: }
18143: }
18144: }
1.1092 raeburn 18145: }
1.462 albertel 18146: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18147:
1.462 albertel 18148: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18149: &GDBM_WRCREAT(),0640)) {
18150: &_add_to_env(\%disk_env,\%initial_env);
18151: &_add_to_env(\%disk_env,\%userenv,'environment.');
18152: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18153: if (ref($firstaccenv) eq 'HASH') {
18154: &_add_to_env(\%disk_env,$firstaccenv);
18155: }
18156: if (ref($timerintenv) eq 'HASH') {
18157: &_add_to_env(\%disk_env,$timerintenv);
18158: }
1.1414 raeburn 18159: if (ref($coauthorenv) eq 'HASH') {
18160: if (keys(%{$coauthorenv})) {
18161: &_add_to_env(\%disk_env,$coauthorenv);
18162: }
18163: }
1.463 albertel 18164: if (ref($args->{'extra_env'})) {
18165: &_add_to_env(\%disk_env,$args->{'extra_env'});
18166: }
1.462 albertel 18167: untie(%disk_env);
18168: } else {
1.705 tempelho 18169: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18170: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18171: return 'error: '.$!;
18172: }
18173: }
18174: $env{'request.role'}='cm';
18175: $env{'request.role.adv'}=$env{'user.adv'};
18176: $env{'browser.type'}=$clientbrowser;
18177:
18178: return $cookie;
18179:
18180: }
18181:
18182: sub _add_to_env {
18183: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18184: if (ref($env_data) eq 'HASH') {
18185: while (my ($key,$value) = each(%$env_data)) {
18186: $idf->{$prefix.$key} = $value;
18187: $env{$prefix.$key} = $value;
18188: }
1.462 albertel 18189: }
18190: }
18191:
1.685 tempelho 18192: # --- Get the symbolic name of a problem and the url
18193: sub get_symb {
18194: my ($request,$silent) = @_;
1.726 raeburn 18195: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18196: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18197: if ($symb eq '') {
18198: if (!$silent) {
1.1071 raeburn 18199: if (ref($request)) {
18200: $request->print("Unable to handle ambiguous references:$url:.");
18201: }
1.685 tempelho 18202: return ();
18203: }
18204: }
18205: &Apache::lonenc::check_decrypt(\$symb);
18206: return ($symb);
18207: }
18208:
18209: # --------------------------------------------------------------Get annotation
18210:
18211: sub get_annotation {
18212: my ($symb,$enc) = @_;
18213:
18214: my $key = $symb;
18215: if (!$enc) {
18216: $key =
18217: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18218: }
18219: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18220: return $annotation{$key};
18221: }
18222:
18223: sub clean_symb {
1.731 raeburn 18224: my ($symb,$delete_enc) = @_;
1.685 tempelho 18225:
18226: &Apache::lonenc::check_decrypt(\$symb);
18227: my $enc = $env{'request.enc'};
1.731 raeburn 18228: if ($delete_enc) {
1.730 raeburn 18229: delete($env{'request.enc'});
18230: }
1.685 tempelho 18231:
18232: return ($symb,$enc);
18233: }
1.462 albertel 18234:
1.1181 raeburn 18235: ############################################################
18236: ############################################################
18237:
18238: =pod
18239:
18240: =head1 Routines for building display used to search for courses
18241:
18242:
18243: =over 4
18244:
18245: =item * &build_filters()
18246:
18247: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18248: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18249: and quotacheck.pl
18250:
1.1181 raeburn 18251:
18252: Inputs:
18253:
18254: filterlist - anonymous array of fields to include as potential filters
18255:
18256: crstype - course type
18257:
18258: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18259: to pop-open a course selector (will contain "extra element").
18260:
18261: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18262:
18263: filter - anonymous hash of criteria and their values
18264:
18265: action - form action
18266:
18267: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18268:
1.1182 raeburn 18269: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18270:
18271: cloneruname - username of owner of new course who wants to clone
18272:
18273: clonerudom - domain of owner of new course who wants to clone
18274:
18275: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18276:
18277: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18278:
18279: codedom - domain
18280:
18281: formname - value of form element named "form".
18282:
18283: fixeddom - domain, if fixed.
18284:
18285: prevphase - value to assign to form element named "phase" when going back to the previous screen
18286:
18287: cnameelement - name of form element in form on opener page which will receive title of selected course
18288:
18289: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18290:
18291: cdomelement - name of form element in form on opener page which will receive domain of selected course
18292:
18293: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18294:
18295: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18296:
18297: clonewarning - warning message about missing information for intended course owner when DC creates a course
18298:
1.1182 raeburn 18299:
1.1181 raeburn 18300: Returns: $output - HTML for display of search criteria, and hidden form elements.
18301:
1.1182 raeburn 18302:
1.1181 raeburn 18303: Side Effects: None
18304:
18305: =cut
18306:
18307: # ---------------------------------------------- search for courses based on last activity etc.
18308:
18309: sub build_filters {
18310: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18311: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18312: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18313: $cnameelement,$cnumelement,$cdomelement,$setroles,
18314: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18315: my ($list,$jscript);
1.1181 raeburn 18316: my $onchange = 'javascript:updateFilters(this)';
18317: my ($domainselectform,$sincefilterform,$createdfilterform,
18318: $ownerdomselectform,$persondomselectform,$instcodeform,
18319: $typeselectform,$instcodetitle);
18320: if ($formname eq '') {
18321: $formname = $caller;
18322: }
18323: foreach my $item (@{$filterlist}) {
18324: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18325: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18326: if ($item eq 'domainfilter') {
18327: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18328: } elsif ($item eq 'coursefilter') {
18329: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18330: } elsif ($item eq 'ownerfilter') {
18331: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18332: } elsif ($item eq 'ownerdomfilter') {
18333: $filter->{'ownerdomfilter'} =
18334: &LONCAPA::clean_domain($filter->{$item});
18335: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18336: 'ownerdomfilter',1);
18337: } elsif ($item eq 'personfilter') {
18338: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18339: } elsif ($item eq 'persondomfilter') {
18340: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18341: 'persondomfilter',1);
18342: } else {
18343: $filter->{$item} =~ s/\W//g;
18344: }
18345: if (!$filter->{$item}) {
18346: $filter->{$item} = '';
18347: }
18348: }
18349: if ($item eq 'domainfilter') {
18350: my $allow_blank = 1;
18351: if ($formname eq 'portform') {
18352: $allow_blank=0;
18353: } elsif ($formname eq 'studentform') {
18354: $allow_blank=0;
18355: }
18356: if ($fixeddom) {
18357: $domainselectform = '<input type="hidden" name="domainfilter"'.
18358: ' value="'.$codedom.'" />'.
18359: &Apache::lonnet::domain($codedom,'description');
18360: } else {
18361: $domainselectform = &select_dom_form($filter->{$item},
18362: 'domainfilter',
18363: $allow_blank,'',$onchange);
18364: }
18365: } else {
18366: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18367: }
18368: }
18369:
18370: # last course activity filter and selection
18371: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18372:
18373: # course created filter and selection
18374: if (exists($filter->{'createdfilter'})) {
18375: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18376: }
18377:
1.1239 raeburn 18378: my $prefix = $crstype;
18379: if ($crstype eq 'Placement') {
18380: $prefix = 'Placement Test'
18381: }
1.1181 raeburn 18382: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18383: 'cac' => "$prefix Activity",
18384: 'ccr' => "$prefix Created",
18385: 'cde' => "$prefix Title",
18386: 'cdo' => "$prefix Domain",
1.1181 raeburn 18387: 'ins' => 'Institutional Code',
18388: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18389: 'cow' => "$prefix Owner/Co-owner",
18390: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18391: 'cog' => 'Type',
18392: );
18393:
18394: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18395: my $typeval = 'Course';
18396: if ($crstype eq 'Community') {
18397: $typeval = 'Community';
1.1239 raeburn 18398: } elsif ($crstype eq 'Placement') {
18399: $typeval = 'Placement';
1.1181 raeburn 18400: }
18401: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18402: } else {
18403: $typeselectform = '<select name="type" size="1"';
18404: if ($onchange) {
18405: $typeselectform .= ' onchange="'.$onchange.'"';
18406: }
18407: $typeselectform .= '>'."\n";
1.1237 raeburn 18408: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18409: my $shown;
18410: if ($posstype eq 'Placement') {
18411: $shown = &mt('Placement Test');
18412: } else {
18413: $shown = &mt($posstype);
18414: }
1.1181 raeburn 18415: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18416: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18417: }
18418: $typeselectform.="</select>";
18419: }
18420:
18421: my ($cloneableonlyform,$cloneabletitle);
18422: if (exists($filter->{'cloneableonly'})) {
18423: my $cloneableon = '';
18424: my $cloneableoff = ' checked="checked"';
18425: if ($filter->{'cloneableonly'}) {
18426: $cloneableon = $cloneableoff;
18427: $cloneableoff = '';
18428: }
18429: $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>';
18430: if ($formname eq 'ccrs') {
1.1187 bisitz 18431: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18432: } else {
18433: $cloneabletitle = &mt('Cloneable by you');
18434: }
18435: }
18436: my $officialjs;
18437: if ($crstype eq 'Course') {
18438: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18439: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18440: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18441: if ($codedom) {
1.1181 raeburn 18442: $officialjs = 1;
18443: ($instcodeform,$jscript,$$numtitlesref) =
18444: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18445: $officialjs,$codetitlesref);
18446: if ($jscript) {
1.1182 raeburn 18447: $jscript = '<script type="text/javascript">'."\n".
18448: '// <![CDATA['."\n".
18449: $jscript."\n".
18450: '// ]]>'."\n".
18451: '</script>'."\n";
1.1181 raeburn 18452: }
18453: }
18454: if ($instcodeform eq '') {
18455: $instcodeform =
18456: '<input type="text" name="instcodefilter" size="10" value="'.
18457: $list->{'instcodefilter'}.'" />';
18458: $instcodetitle = $lt{'ins'};
18459: } else {
18460: $instcodetitle = $lt{'inc'};
18461: }
18462: if ($fixeddom) {
18463: $instcodetitle .= '<br />('.$codedom.')';
18464: }
18465: }
18466: }
18467: my $output = qq|
18468: <form method="post" name="filterpicker" action="$action">
18469: <input type="hidden" name="form" value="$formname" />
18470: |;
18471: if ($formname eq 'modifycourse') {
18472: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18473: '<input type="hidden" name="prevphase" value="'.
18474: $prevphase.'" />'."\n";
1.1198 musolffc 18475: } elsif ($formname eq 'quotacheck') {
18476: $output .= qq|
18477: <input type="hidden" name="sortby" value="" />
18478: <input type="hidden" name="sortorder" value="" />
18479: |;
18480: } else {
1.1181 raeburn 18481: my $name_input;
18482: if ($cnameelement ne '') {
18483: $name_input = '<input type="hidden" name="cnameelement" value="'.
18484: $cnameelement.'" />';
18485: }
18486: $output .= qq|
1.1182 raeburn 18487: <input type="hidden" name="cnumelement" value="$cnumelement" />
18488: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18489: $name_input
18490: $roleelement
18491: $multelement
18492: $typeelement
18493: |;
18494: if ($formname eq 'portform') {
18495: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18496: }
18497: }
18498: if ($fixeddom) {
18499: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18500: }
18501: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18502: if ($sincefilterform) {
18503: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18504: .$sincefilterform
18505: .&Apache::lonhtmlcommon::row_closure();
18506: }
18507: if ($createdfilterform) {
18508: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18509: .$createdfilterform
18510: .&Apache::lonhtmlcommon::row_closure();
18511: }
18512: if ($domainselectform) {
18513: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18514: .$domainselectform
18515: .&Apache::lonhtmlcommon::row_closure();
18516: }
18517: if ($typeselectform) {
18518: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18519: $output .= $typeselectform;
18520: } else {
18521: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18522: .$typeselectform
18523: .&Apache::lonhtmlcommon::row_closure();
18524: }
18525: }
18526: if ($instcodeform) {
18527: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18528: .$instcodeform
18529: .&Apache::lonhtmlcommon::row_closure();
18530: }
18531: if (exists($filter->{'ownerfilter'})) {
18532: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18533: '<table><tr><td>'.&mt('Username').'<br />'.
18534: '<input type="text" name="ownerfilter" size="20" value="'.
18535: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18536: $ownerdomselectform.'</td></tr></table>'.
18537: &Apache::lonhtmlcommon::row_closure();
18538: }
18539: if (exists($filter->{'personfilter'})) {
18540: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18541: '<table><tr><td>'.&mt('Username').'<br />'.
18542: '<input type="text" name="personfilter" size="20" value="'.
18543: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18544: $persondomselectform.'</td></tr></table>'.
18545: &Apache::lonhtmlcommon::row_closure();
18546: }
18547: if (exists($filter->{'coursefilter'})) {
18548: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18549: .'<input type="text" name="coursefilter" size="25" value="'
18550: .$list->{'coursefilter'}.'" />'
18551: .&Apache::lonhtmlcommon::row_closure();
18552: }
18553: if ($cloneableonlyform) {
18554: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18555: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18556: }
18557: if (exists($filter->{'descriptfilter'})) {
18558: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18559: .'<input type="text" name="descriptfilter" size="40" value="'
18560: .$list->{'descriptfilter'}.'" />'
18561: .&Apache::lonhtmlcommon::row_closure(1);
18562: }
18563: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18564: '<input type="hidden" name="updater" value="" />'."\n".
18565: '<input type="submit" name="gosearch" value="'.
18566: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18567: return $jscript.$clonewarning.$output;
18568: }
18569:
18570: =pod
18571:
18572: =item * &timebased_select_form()
18573:
1.1182 raeburn 18574: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18575: filter e.g., Course Activity, Course Created, when searching for courses
18576: or communities
18577:
18578: Inputs:
18579:
18580: item - name of form element (sincefilter or createdfilter)
18581:
18582: filter - anonymous hash of criteria and their values
18583:
18584: Returns: HTML for a select box contained a blank, then six time selections,
18585: with value set in incoming form variables currently selected.
18586:
18587: Side Effects: None
18588:
18589: =cut
18590:
18591: sub timebased_select_form {
18592: my ($item,$filter) = @_;
18593: if (ref($filter) eq 'HASH') {
18594: $filter->{$item} =~ s/[^\d-]//g;
18595: if (!$filter->{$item}) { $filter->{$item}=-1; }
18596: return &select_form(
18597: $filter->{$item},
18598: $item,
18599: { '-1' => '',
18600: '86400' => &mt('today'),
18601: '604800' => &mt('last week'),
18602: '2592000' => &mt('last month'),
18603: '7776000' => &mt('last three months'),
18604: '15552000' => &mt('last six months'),
18605: '31104000' => &mt('last year'),
18606: 'select_form_order' =>
18607: ['-1','86400','604800','2592000','7776000',
18608: '15552000','31104000']});
18609: }
18610: }
18611:
18612: =pod
18613:
18614: =item * &js_changer()
18615:
18616: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18617: when course type or domain is changed, and also to hide 'Searching ...' on
18618: page load completion for page showing search result.
1.1181 raeburn 18619:
18620: Inputs: None
18621:
1.1183 raeburn 18622: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18623:
18624: Side Effects: None
18625:
18626: =cut
18627:
18628: sub js_changer {
18629: return <<ENDJS;
18630: <script type="text/javascript">
18631: // <![CDATA[
18632: function updateFilters(caller) {
18633: if (typeof(caller) != "undefined") {
18634: document.filterpicker.updater.value = caller.name;
18635: }
18636: document.filterpicker.submit();
18637: }
1.1183 raeburn 18638:
18639: function hideSearching() {
18640: if (document.getElementById('searching')) {
18641: document.getElementById('searching').style.display = 'none';
18642: }
18643: return;
18644: }
18645:
1.1181 raeburn 18646: // ]]>
18647: </script>
18648:
18649: ENDJS
18650: }
18651:
18652: =pod
18653:
1.1182 raeburn 18654: =item * &search_courses()
18655:
18656: Process selected filters form course search form and pass to lonnet::courseiddump
18657: to retrieve a hash for which keys are courseIDs which match the selected filters.
18658:
18659: Inputs:
18660:
18661: dom - domain being searched
18662:
18663: type - course type ('Course' or 'Community' or '.' if any).
18664:
18665: filter - anonymous hash of criteria and their values
18666:
18667: numtitles - for institutional codes - number of categories
18668:
18669: cloneruname - optional username of new course owner
18670:
18671: clonerudom - optional domain of new course owner
18672:
1.1221 raeburn 18673: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18674: (used when DC is using course creation form)
18675:
18676: codetitles - reference to array of titles of components in institutional codes (official courses).
18677:
1.1221 raeburn 18678: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18679: (and so can clone automatically)
18680:
18681: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18682:
18683: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18684: courses to clone
1.1182 raeburn 18685:
18686: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18687:
18688:
18689: Side Effects: None
18690:
18691: =cut
18692:
18693:
18694: sub search_courses {
1.1221 raeburn 18695: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18696: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18697: my (%courses,%showcourses,$cloner);
18698: if (($filter->{'ownerfilter'} ne '') ||
18699: ($filter->{'ownerdomfilter'} ne '')) {
18700: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18701: $filter->{'ownerdomfilter'};
18702: }
18703: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18704: if (!$filter->{$item}) {
18705: $filter->{$item}='.';
18706: }
18707: }
18708: my $now = time;
18709: my $timefilter =
18710: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18711: my ($createdbefore,$createdafter);
18712: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18713: $createdbefore = $now;
18714: $createdafter = $now-$filter->{'createdfilter'};
18715: }
18716: my ($instcodefilter,$regexpok);
18717: if ($numtitles) {
18718: if ($env{'form.official'} eq 'on') {
18719: $instcodefilter =
18720: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18721: $regexpok = 1;
18722: } elsif ($env{'form.official'} eq 'off') {
18723: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18724: unless ($instcodefilter eq '') {
18725: $regexpok = -1;
18726: }
18727: }
18728: } else {
18729: $instcodefilter = $filter->{'instcodefilter'};
18730: }
18731: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18732: if ($type eq '') { $type = '.'; }
18733:
18734: if (($clonerudom ne '') && ($cloneruname ne '')) {
18735: $cloner = $cloneruname.':'.$clonerudom;
18736: }
18737: %courses = &Apache::lonnet::courseiddump($dom,
18738: $filter->{'descriptfilter'},
18739: $timefilter,
18740: $instcodefilter,
18741: $filter->{'combownerfilter'},
18742: $filter->{'coursefilter'},
18743: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18744: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18745: $filter->{'cloneableonly'},
18746: $createdbefore,$createdafter,undef,
1.1221 raeburn 18747: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18748: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18749: my $ccrole;
18750: if ($type eq 'Community') {
18751: $ccrole = 'co';
18752: } else {
18753: $ccrole = 'cc';
18754: }
18755: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18756: $filter->{'persondomfilter'},
18757: 'userroles',undef,
18758: [$ccrole,'in','ad','ep','ta','cr'],
18759: $dom);
18760: foreach my $role (keys(%rolehash)) {
18761: my ($cnum,$cdom,$courserole) = split(':',$role);
18762: my $cid = $cdom.'_'.$cnum;
18763: if (exists($courses{$cid})) {
18764: if (ref($courses{$cid}) eq 'HASH') {
18765: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18766: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18767: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18768: }
18769: } else {
18770: $courses{$cid}{roles} = [$courserole];
18771: }
18772: $showcourses{$cid} = $courses{$cid};
18773: }
18774: }
18775: }
18776: %courses = %showcourses;
18777: }
18778: return %courses;
18779: }
18780:
18781: =pod
18782:
1.1181 raeburn 18783: =back
18784:
1.1207 raeburn 18785: =head1 Routines for version requirements for current course.
18786:
18787: =over 4
18788:
18789: =item * &check_release_required()
18790:
18791: Compares required LON-CAPA version with version on server, and
18792: if required version is newer looks for a server with the required version.
18793:
18794: Looks first at servers in user's owen domain; if none suitable, looks at
18795: servers in course's domain are permitted to host sessions for user's domain.
18796:
18797: Inputs:
18798:
18799: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18800:
18801: $courseid - Course ID of current course
18802:
18803: $rolecode - User's current role in course (for switchserver query string).
18804:
18805: $required - LON-CAPA version needed by course (format: Major.Minor).
18806:
18807:
18808: Returns:
18809:
18810: $switchserver - query string tp append to /adm/switchserver call (if
18811: current server's LON-CAPA version is too old.
18812:
18813: $warning - Message is displayed if no suitable server could be found.
18814:
18815: =cut
18816:
18817: sub check_release_required {
18818: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18819: my ($switchserver,$warning);
18820: if ($required ne '') {
18821: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18822: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18823: if ($reqdmajor ne '' && $reqdminor ne '') {
18824: my $otherserver;
18825: if (($major eq '' && $minor eq '') ||
18826: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18827: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18828: my $switchlcrev =
18829: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18830: $userdomserver);
18831: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18832: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18833: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18834: my $cdom = $env{'course.'.$courseid.'.domain'};
18835: if ($cdom ne $env{'user.domain'}) {
18836: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18837: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18838: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18839: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18840: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18841: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18842: my $canhost =
18843: &Apache::lonnet::can_host_session($env{'user.domain'},
18844: $coursedomserver,
18845: $remoterev,
18846: $udomdefaults{'remotesessions'},
18847: $defdomdefaults{'hostedsessions'});
18848:
18849: if ($canhost) {
18850: $otherserver = $coursedomserver;
18851: } else {
18852: $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.");
18853: }
18854: } else {
18855: $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).");
18856: }
18857: } else {
18858: $otherserver = $userdomserver;
18859: }
18860: }
18861: if ($otherserver ne '') {
18862: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18863: }
18864: }
18865: }
18866: return ($switchserver,$warning);
18867: }
18868:
18869: =pod
18870:
18871: =item * &check_release_result()
18872:
18873: Inputs:
18874:
18875: $switchwarning - Warning message if no suitable server found to host session.
18876:
18877: $switchserver - query string to append to /adm/switchserver containing lonHostID
18878: and current role.
18879:
18880: Returns: HTML to display with information about requirement to switch server.
18881: Either displaying warning with link to Roles/Courses screen or
18882: display link to switchserver.
18883:
1.1181 raeburn 18884: =cut
18885:
1.1207 raeburn 18886: sub check_release_result {
18887: my ($switchwarning,$switchserver) = @_;
18888: my $output = &start_page('Selected course unavailable on this server').
18889: '<p class="LC_warning">';
18890: if ($switchwarning) {
18891: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18892: if (&show_course()) {
18893: $output .= &mt('Display courses');
18894: } else {
18895: $output .= &mt('Display roles');
18896: }
18897: $output .= '</a>';
18898: } elsif ($switchserver) {
18899: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18900: '<br />'.
18901: '<a href="/adm/switchserver?'.$switchserver.'">'.
18902: &mt('Switch Server').
18903: '</a>';
18904: }
18905: $output .= '</p>'.&end_page();
18906: return $output;
18907: }
18908:
18909: =pod
18910:
18911: =item * &needs_coursereinit()
18912:
18913: Determine if course contents stored for user's session needs to be
18914: refreshed, because content has changed since "Big Hash" last tied.
18915:
18916: Check for change is made if time last checked is more than 10 minutes ago
18917: (by default).
18918:
18919: Inputs:
18920:
18921: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18922:
18923: $interval (optional) - Time which may elapse (in s) between last check for content
18924: change in current course. (default: 600 s).
18925:
18926: Returns: an array; first element is:
18927:
18928: =over 4
18929:
18930: 'switch' - if content updates mean user's session
18931: needs to be switched to a server running a newer LON-CAPA version
18932:
18933: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18934: on current server hosting user's session
18935:
18936: '' - if no action required.
18937:
18938: =back
18939:
18940: If first item element is 'switch':
18941:
18942: second item is $switchwarning - Warning message if no suitable server found to host session.
18943:
18944: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18945: and current role.
18946:
18947: otherwise: no other elements returned.
18948:
18949: =back
18950:
18951: =cut
18952:
18953: sub needs_coursereinit {
18954: my ($loncaparev,$interval) = @_;
18955: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18956: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18957: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18958: my $now = time;
18959: if ($interval eq '') {
18960: $interval = 600;
18961: }
18962: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18963: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18964: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18965: if ($blocked) {
18966: return ();
18967: }
1.1391 raeburn 18968: my $update;
18969: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18970: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
18971: if ($lastmainchange > $env{'request.course.tied'}) {
18972: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18973: if ($needswitch) {
18974: return ('switch',$switchwarning,$switchserver);
18975: }
18976: $update = 'main';
18977: }
18978: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
18979: if ($update) {
18980: $update = 'both';
18981: } else {
18982: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18983: if ($needswitch) {
18984: return ('switch',$switchwarning,$switchserver);
18985: } else {
18986: $update = 'supp';
1.1207 raeburn 18987: }
18988: }
1.1391 raeburn 18989: return ($update);
18990: }
18991: }
18992: return ();
18993: }
18994:
18995: sub switch_for_update {
18996: my ($loncaparev,$cdom,$cnum) = @_;
18997: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18998: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
18999: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19000: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19001: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19002: $curr_reqd_hash{'internal.releaserequired'}});
19003: my ($switchserver,$switchwarning) =
19004: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19005: $curr_reqd_hash{'internal.releaserequired'});
19006: if ($switchwarning ne '' || $switchserver ne '') {
19007: return ('switch',$switchwarning,$switchserver);
19008: }
1.1207 raeburn 19009: }
19010: }
19011: return ();
19012: }
1.1181 raeburn 19013:
1.1083 raeburn 19014: sub update_content_constraints {
1.1395 raeburn 19015: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19016: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19017: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19018: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19019: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19020: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19021: if ($item eq 'resourcetag') {
19022: if ($name eq 'responsetype') {
19023: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19024: }
1.1307 raeburn 19025: } elsif ($item eq 'course') {
19026: if ($name eq 'courserestype') {
19027: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19028: }
1.1083 raeburn 19029: }
19030: }
19031: my $navmap = Apache::lonnavmaps::navmap->new();
19032: if (defined($navmap)) {
1.1307 raeburn 19033: my (%allresponses,%allcrsrestypes);
19034: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19035: if ($res->is_tool()) {
19036: if ($allcrsrestypes{'exttool'}) {
19037: $allcrsrestypes{'exttool'} ++;
19038: } else {
19039: $allcrsrestypes{'exttool'} = 1;
19040: }
19041: next;
19042: }
1.1083 raeburn 19043: my %responses = $res->responseTypes();
19044: foreach my $key (keys(%responses)) {
19045: next unless(exists($checkresponsetypes{$key}));
19046: $allresponses{$key} += $responses{$key};
19047: }
19048: }
19049: foreach my $key (keys(%allresponses)) {
19050: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19051: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19052: ($reqdmajor,$reqdminor) = ($major,$minor);
19053: }
19054: }
1.1307 raeburn 19055: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19056: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19057: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19058: ($reqdmajor,$reqdminor) = ($major,$minor);
19059: }
19060: }
1.1083 raeburn 19061: undef($navmap);
19062: }
1.1391 raeburn 19063: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19064: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19065: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19066: ($reqdmajor,$reqdminor) = ($major,$minor);
19067: }
19068: }
1.1083 raeburn 19069: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19070: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19071: }
19072: return;
19073: }
19074:
1.1110 raeburn 19075: sub allmaps_incourse {
19076: my ($cdom,$cnum,$chome,$cid) = @_;
19077: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19078: $cid = $env{'request.course.id'};
19079: $cdom = $env{'course.'.$cid.'.domain'};
19080: $cnum = $env{'course.'.$cid.'.num'};
19081: $chome = $env{'course.'.$cid.'.home'};
19082: }
19083: my %allmaps = ();
19084: my $lastchange =
19085: &Apache::lonnet::get_coursechange($cdom,$cnum);
19086: if ($lastchange > $env{'request.course.tied'}) {
19087: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19088: unless ($ferr) {
1.1395 raeburn 19089: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19090: }
19091: }
19092: my $navmap = Apache::lonnavmaps::navmap->new();
19093: if (defined($navmap)) {
19094: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19095: $allmaps{$res->src()} = 1;
19096: }
19097: }
19098: return \%allmaps;
19099: }
19100:
1.1083 raeburn 19101: sub parse_supplemental_title {
19102: my ($title) = @_;
19103:
19104: my ($foldertitle,$renametitle);
19105: if ($title =~ /&&&/) {
19106: $title = &HTML::Entites::decode($title);
19107: }
19108: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19109: $renametitle=$4;
19110: my ($time,$uname,$udom) = ($1,$2,$3);
19111: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19112: my $name = &plainname($uname,$udom);
19113: $name = &HTML::Entities::encode($name,'"<>&\'');
19114: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19115: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19116: if ($foldertitle ne '') {
1.1401 raeburn 19117: $title .= ': <br />'.$foldertitle;
19118: }
1.1083 raeburn 19119: }
19120: if (wantarray) {
19121: return ($title,$foldertitle,$renametitle);
19122: }
19123: return $title;
19124: }
19125:
1.1395 raeburn 19126: sub get_supplemental {
19127: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19128: my $hashid=$cnum.':'.$cdom;
19129: my ($supplemental,$cached,$set_httprefs);
19130: unless ($ignorecache) {
19131: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19132: }
19133: unless (defined($cached)) {
19134: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19135: unless ($chome eq 'no_host') {
19136: my @order = @LONCAPA::map::order;
19137: my @resources = @LONCAPA::map::resources;
19138: my @resparms = @LONCAPA::map::resparms;
19139: my @zombies = @LONCAPA::map::zombies;
19140: my ($errors,%ids,%hidden);
19141: $errors =
19142: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19143: $errors,$possdel,\%ids,\%hidden);
19144: @LONCAPA::map::order = @order;
19145: @LONCAPA::map::resources = @resources;
19146: @LONCAPA::map::resparms = @resparms;
19147: @LONCAPA::map::zombies = @zombies;
19148: $set_httprefs = 1;
19149: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19150: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19151: }
19152: $supplemental = {
19153: ids => \%ids,
19154: hidden => \%hidden,
19155: };
19156: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19157: }
19158: }
19159: return ($supplemental,$set_httprefs);
19160: }
19161:
1.1143 raeburn 19162: sub recurse_supplemental {
1.1391 raeburn 19163: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19164: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19165: my $mapnum;
19166: if ($suppmap eq 'supplemental.sequence') {
19167: $mapnum = 0;
19168: } else {
19169: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19170: }
1.1143 raeburn 19171: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19172: if ($fatal) {
19173: $errors ++;
19174: } else {
1.1389 raeburn 19175: my @order = @LONCAPA::map::order;
19176: if (@order > 0) {
19177: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19178: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19179: foreach my $idx (@order) {
19180: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19181: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19182: my $id = $mapnum.':'.$idx;
19183: push(@{$suppids->{$src}},$id);
19184: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19185: $hiddensupp->{$id} = 1;
19186: }
1.1146 raeburn 19187: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19188: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19189: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19190: } else {
1.1391 raeburn 19191: my $allowed;
19192: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19193: $allowed = 1;
19194: } elsif ($possdel) {
19195: foreach my $item (@{$suppids->{$src}}) {
19196: next if ($item eq $id);
19197: unless ($hiddensupp->{$item}) {
19198: $allowed = 1;
19199: last;
19200: }
19201: }
19202: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19203: &Apache::lonnet::delenv('httpref.'.$src);
19204: }
19205: }
19206: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19207: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19208: }
1.1143 raeburn 19209: }
19210: }
19211: }
19212: }
19213: }
19214: }
1.1391 raeburn 19215: return $errors;
19216: }
19217:
19218: sub set_supp_httprefs {
19219: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19220: if (ref($supplemental) eq 'HASH') {
19221: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19222: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19223: next if ($src =~ /\.sequence$/);
19224: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19225: my $allowed;
19226: if ($env{'request.role.adv'}) {
19227: $allowed = 1;
19228: } else {
19229: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19230: unless ($supplemental->{'hidden'}->{$id}) {
19231: $allowed = 1;
19232: last;
19233: }
19234: }
19235: }
19236: if (exists($env{'httpref.'.$src})) {
19237: if ($possdel) {
19238: unless ($allowed) {
19239: &Apache::lonnet::delenv('httpref.'.$src);
19240: }
19241: }
19242: } elsif ($allowed) {
19243: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19244: }
19245: }
19246: }
19247: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19248: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19249: }
19250: }
19251: }
19252: }
19253:
19254: sub get_supp_parameter {
19255: my ($resparm,$name)=@_;
19256: return if ($resparm eq '');
19257: my $value=undef;
19258: my $ptype=undef;
19259: foreach (split('&&&',$resparm)) {
19260: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19261: if ($thisname eq $name) {
19262: $value=$thisvalue;
19263: $ptype=$thistype;
19264: }
19265: }
19266: return $value;
1.1143 raeburn 19267: }
19268:
1.1101 raeburn 19269: sub symb_to_docspath {
1.1267 raeburn 19270: my ($symb,$navmapref) = @_;
19271: return unless ($symb && ref($navmapref));
1.1101 raeburn 19272: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19273: if ($resurl=~/\.(sequence|page)$/) {
19274: $mapurl=$resurl;
19275: } elsif ($resurl eq 'adm/navmaps') {
19276: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19277: }
19278: my $mapresobj;
1.1267 raeburn 19279: unless (ref($$navmapref)) {
19280: $$navmapref = Apache::lonnavmaps::navmap->new();
19281: }
19282: if (ref($$navmapref)) {
19283: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19284: }
19285: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19286: my $type=$2;
19287: my $path;
19288: if (ref($mapresobj)) {
19289: my $pcslist = $mapresobj->map_hierarchy();
19290: if ($pcslist ne '') {
19291: foreach my $pc (split(/,/,$pcslist)) {
19292: next if ($pc <= 1);
1.1267 raeburn 19293: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19294: if (ref($res)) {
19295: my $thisurl = $res->src();
19296: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19297: my $thistitle = $res->title();
19298: $path .= '&'.
19299: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19300: &escape($thistitle).
1.1101 raeburn 19301: ':'.$res->randompick().
19302: ':'.$res->randomout().
19303: ':'.$res->encrypted().
19304: ':'.$res->randomorder().
19305: ':'.$res->is_page();
19306: }
19307: }
19308: }
19309: $path =~ s/^\&//;
19310: my $maptitle = $mapresobj->title();
19311: if ($mapurl eq 'default') {
1.1129 raeburn 19312: $maptitle = 'Main Content';
1.1101 raeburn 19313: }
19314: $path .= (($path ne '')? '&' : '').
19315: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19316: &escape($maptitle).
1.1101 raeburn 19317: ':'.$mapresobj->randompick().
19318: ':'.$mapresobj->randomout().
19319: ':'.$mapresobj->encrypted().
19320: ':'.$mapresobj->randomorder().
19321: ':'.$mapresobj->is_page();
19322: } else {
19323: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19324: my $ispage = (($type eq 'page')? 1 : '');
19325: if ($mapurl eq 'default') {
1.1129 raeburn 19326: $maptitle = 'Main Content';
1.1101 raeburn 19327: }
19328: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19329: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19330: }
19331: unless ($mapurl eq 'default') {
19332: $path = 'default&'.
1.1146 raeburn 19333: &escape('Main Content').
1.1101 raeburn 19334: ':::::&'.$path;
19335: }
19336: return $path;
19337: }
19338:
1.1393 raeburn 19339: sub validate_folderpath {
19340: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19341: if ($env{'form.folderpath'} ne '') {
19342: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19343: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19344: for (my $i=0; $i<@items; $i++) {
19345: my $odd = $i%2;
19346: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19347: $badpath = 1;
1.1394 raeburn 19348: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19349: my $idx = $i-1;
1.1394 raeburn 19350: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19351: my $esc_name = $1;
19352: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19353: $supppath .= '&'.$esc_name;
19354: $changed = 1;
19355: } else {
19356: $supppath .= '&'.$items[$i];
19357: }
19358: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19359: $changed = 1;
1.1393 raeburn 19360: my $is_hidden;
19361: unless ($got_supp) {
1.1395 raeburn 19362: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19363: if (ref($supplemental) eq 'HASH') {
19364: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19365: %supphidden = %{$supplemental->{'hidden'}};
19366: }
19367: if (ref($supplemental->{'ids'}) eq 'HASH') {
19368: %suppids = %{$supplemental->{'ids'}};
19369: }
19370: }
19371: $got_supp = 1;
19372: }
19373: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19374: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19375: if ($supphidden{$mapid}) {
19376: $is_hidden = 1;
19377: }
19378: }
1.1394 raeburn 19379: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19380: } else {
19381: $supppath .= '&'.$items[$i];
1.1393 raeburn 19382: }
19383: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19384: $badpath = 1;
1.1394 raeburn 19385: } elsif ($supplementalflag) {
1.1393 raeburn 19386: $supppath .= '&'.$items[$i];
19387: }
19388: last if ($badpath);
19389: }
19390: if ($badpath) {
19391: delete($env{'form.folderpath'});
1.1394 raeburn 19392: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19393: $supppath =~ s/^\&//;
19394: $env{'form.folderpath'} = $supppath;
19395: }
19396: }
19397: return;
19398: }
19399:
1.1094 raeburn 19400: sub captcha_display {
1.1327 raeburn 19401: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19402: my ($output,$error);
1.1234 raeburn 19403: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19404: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19405: if ($captcha eq 'original') {
1.1094 raeburn 19406: $output = &create_captcha();
19407: unless ($output) {
1.1172 raeburn 19408: $error = 'captcha';
1.1094 raeburn 19409: }
19410: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19411: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19412: unless ($output) {
1.1172 raeburn 19413: $error = 'recaptcha';
1.1094 raeburn 19414: }
19415: }
1.1234 raeburn 19416: return ($output,$error,$captcha,$version);
1.1094 raeburn 19417: }
19418:
19419: sub captcha_response {
1.1327 raeburn 19420: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19421: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19422: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19423: if ($captcha eq 'original') {
1.1094 raeburn 19424: ($captcha_chk,$captcha_error) = &check_captcha();
19425: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19426: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19427: } else {
19428: $captcha_chk = 1;
19429: }
19430: return ($captcha_chk,$captcha_error);
19431: }
19432:
19433: sub get_captcha_config {
1.1327 raeburn 19434: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19435: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19436: my $hostname = &Apache::lonnet::hostname($lonhost);
19437: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19438: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19439: if ($context eq 'usercreation') {
19440: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19441: if (ref($domconfig{$context}) eq 'HASH') {
19442: $hashtocheck = $domconfig{$context}{'cancreate'};
19443: if (ref($hashtocheck) eq 'HASH') {
19444: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19445: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19446: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19447: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19448: }
19449: if ($privkey && $pubkey) {
19450: $captcha = 'recaptcha';
1.1234 raeburn 19451: $version = $hashtocheck->{'recaptchaversion'};
19452: if ($version ne '2') {
19453: $version = 1;
19454: }
1.1095 raeburn 19455: } else {
19456: $captcha = 'original';
19457: }
19458: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19459: $captcha = 'original';
19460: }
1.1094 raeburn 19461: }
1.1095 raeburn 19462: } else {
19463: $captcha = 'captcha';
19464: }
19465: } elsif ($context eq 'login') {
19466: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19467: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19468: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19469: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19470: if ($privkey && $pubkey) {
19471: $captcha = 'recaptcha';
1.1234 raeburn 19472: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19473: if ($version ne '2') {
19474: $version = 1;
19475: }
1.1095 raeburn 19476: } else {
19477: $captcha = 'original';
1.1094 raeburn 19478: }
1.1095 raeburn 19479: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19480: $captcha = 'original';
1.1094 raeburn 19481: }
1.1327 raeburn 19482: } elsif ($context eq 'passwords') {
19483: if ($dom_in_effect) {
19484: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19485: if ($passwdconf{'captcha'} eq 'recaptcha') {
19486: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19487: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19488: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19489: }
19490: if ($privkey && $pubkey) {
19491: $captcha = 'recaptcha';
19492: $version = $passwdconf{'recaptchaversion'};
19493: if ($version ne '2') {
19494: $version = 1;
19495: }
19496: } else {
19497: $captcha = 'original';
19498: }
19499: } elsif ($passwdconf{'captcha'} ne 'notused') {
19500: $captcha = 'original';
19501: }
19502: }
19503: }
1.1234 raeburn 19504: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19505: }
19506:
19507: sub create_captcha {
19508: my %captcha_params = &captcha_settings();
19509: my ($output,$maxtries,$tries) = ('',10,0);
19510: while ($tries < $maxtries) {
19511: $tries ++;
19512: my $captcha = Authen::Captcha->new (
19513: output_folder => $captcha_params{'output_dir'},
19514: data_folder => $captcha_params{'db_dir'},
19515: );
19516: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19517:
19518: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19519: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19520: '<span class="LC_nobreak">'.
1.1094 raeburn 19521: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19522: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19523: '</span><br />'.
1.1176 raeburn 19524: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19525: last;
19526: }
19527: }
1.1323 raeburn 19528: if ($output eq '') {
19529: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19530: }
1.1094 raeburn 19531: return $output;
19532: }
19533:
19534: sub captcha_settings {
19535: my %captcha_params = (
19536: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19537: www_output_dir => "/captchaspool",
19538: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19539: numchars => '5',
19540: );
19541: return %captcha_params;
19542: }
19543:
19544: sub check_captcha {
19545: my ($captcha_chk,$captcha_error);
19546: my $code = $env{'form.code'};
19547: my $md5sum = $env{'form.crypt'};
19548: my %captcha_params = &captcha_settings();
19549: my $captcha = Authen::Captcha->new(
19550: output_folder => $captcha_params{'output_dir'},
19551: data_folder => $captcha_params{'db_dir'},
19552: );
1.1109 raeburn 19553: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19554: my %captcha_hash = (
19555: 0 => 'Code not checked (file error)',
19556: -1 => 'Failed: code expired',
19557: -2 => 'Failed: invalid code (not in database)',
19558: -3 => 'Failed: invalid code (code does not match crypt)',
19559: );
19560: if ($captcha_chk != 1) {
19561: $captcha_error = $captcha_hash{$captcha_chk}
19562: }
19563: return ($captcha_chk,$captcha_error);
19564: }
19565:
19566: sub create_recaptcha {
1.1234 raeburn 19567: my ($pubkey,$version) = @_;
19568: if ($version >= 2) {
1.1367 raeburn 19569: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19570: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19571: } else {
19572: my $use_ssl;
19573: if ($ENV{'SERVER_PORT'} == 443) {
19574: $use_ssl = 1;
19575: }
19576: my $captcha = Captcha::reCAPTCHA->new;
19577: return $captcha->get_options_setter({theme => 'white'})."\n".
19578: $captcha->get_html($pubkey,undef,$use_ssl).
19579: &mt('If the text is hard to read, [_1] will replace them.',
19580: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19581: '<br /><br />';
19582: }
1.1094 raeburn 19583: }
19584:
19585: sub check_recaptcha {
1.1234 raeburn 19586: my ($privkey,$version) = @_;
1.1094 raeburn 19587: my $captcha_chk;
1.1350 raeburn 19588: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19589: if ($version >= 2) {
19590: my %info = (
19591: secret => $privkey,
19592: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19593: remoteip => $ip,
1.1234 raeburn 19594: );
1.1280 raeburn 19595: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19596: $request->content(join('&',map {
19597: my $name = escape($_);
19598: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19599: ? join("&$name=", map {escape($_) } @{$info{$_}})
19600: : &escape($info{$_}) );
19601: } keys(%info)));
19602: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19603: if ($response->is_success) {
19604: my $data = JSON::DWIW->from_json($response->decoded_content);
19605: if (ref($data) eq 'HASH') {
19606: if ($data->{'success'}) {
19607: $captcha_chk = 1;
19608: }
19609: }
19610: }
19611: } else {
19612: my $captcha = Captcha::reCAPTCHA->new;
19613: my $captcha_result =
19614: $captcha->check_answer(
19615: $privkey,
1.1350 raeburn 19616: $ip,
1.1234 raeburn 19617: $env{'form.recaptcha_challenge_field'},
19618: $env{'form.recaptcha_response_field'},
19619: );
19620: if ($captcha_result->{is_valid}) {
19621: $captcha_chk = 1;
19622: }
1.1094 raeburn 19623: }
19624: return $captcha_chk;
19625: }
19626:
1.1174 raeburn 19627: sub emailusername_info {
1.1244 raeburn 19628: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19629: my %titles = &Apache::lonlocal::texthash (
19630: lastname => 'Last Name',
19631: firstname => 'First Name',
19632: institution => 'School/college/university',
19633: location => "School's city, state/province, country",
19634: web => "School's web address",
19635: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19636: id => 'Student/Employee ID',
1.1174 raeburn 19637: );
19638: return (\@fields,\%titles);
19639: }
19640:
1.1161 raeburn 19641: sub cleanup_html {
19642: my ($incoming) = @_;
19643: my $outgoing;
19644: if ($incoming ne '') {
19645: $outgoing = $incoming;
19646: $outgoing =~ s/;/;/g;
19647: $outgoing =~ s/\#/#/g;
19648: $outgoing =~ s/\&/&/g;
19649: $outgoing =~ s/</</g;
19650: $outgoing =~ s/>/>/g;
19651: $outgoing =~ s/\(/(/g;
19652: $outgoing =~ s/\)/)/g;
19653: $outgoing =~ s/"/"/g;
19654: $outgoing =~ s/'/'/g;
19655: $outgoing =~ s/\$/$/g;
19656: $outgoing =~ s{/}{/}g;
19657: $outgoing =~ s/=/=/g;
19658: $outgoing =~ s/\\/\/g
19659: }
19660: return $outgoing;
19661: }
19662:
1.1190 musolffc 19663: # Checks for critical messages and returns a redirect url if one exists.
19664: # $interval indicates how often to check for messages.
1.1282 raeburn 19665: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19666: sub critical_redirect {
1.1282 raeburn 19667: my ($interval,$context) = @_;
1.1356 raeburn 19668: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19669: return ();
19670: }
1.1190 musolffc 19671: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19672: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19673: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19674: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19675: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19676: if ($blocked) {
19677: my $checkrole = "cm./$cdom/$cnum";
19678: if ($env{'request.course.sec'} ne '') {
19679: $checkrole .= "/$env{'request.course.sec'}";
19680: }
19681: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19682: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19683: return;
19684: }
19685: }
19686: }
1.1190 musolffc 19687: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19688: $env{'user.name'});
19689: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19690: my $redirecturl;
1.1190 musolffc 19691: if ($what[0]) {
1.1356 raeburn 19692: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19693: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19694: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19695: return (1, $url);
1.1190 musolffc 19696: }
1.1191 raeburn 19697: }
19698: }
19699: return ();
1.1190 musolffc 19700: }
19701:
1.1174 raeburn 19702: # Use:
19703: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19704: #
19705: ##################################################
19706: # password associated functions #
19707: ##################################################
19708: sub des_keys {
19709: # Make a new key for DES encryption.
19710: # Each key has two parts which are returned separately.
19711: # Please note: Each key must be passed through the &hex function
19712: # before it is output to the web browser. The hex versions cannot
19713: # be used to decrypt.
19714: my @hexstr=('0','1','2','3','4','5','6','7',
19715: '8','9','a','b','c','d','e','f');
19716: my $lkey='';
19717: for (0..7) {
19718: $lkey.=$hexstr[rand(15)];
19719: }
19720: my $ukey='';
19721: for (0..7) {
19722: $ukey.=$hexstr[rand(15)];
19723: }
19724: return ($lkey,$ukey);
19725: }
19726:
19727: sub des_decrypt {
19728: my ($key,$cyphertext) = @_;
19729: my $keybin=pack("H16",$key);
19730: my $cypher;
19731: if ($Crypt::DES::VERSION>=2.03) {
19732: $cypher=new Crypt::DES $keybin;
19733: } else {
19734: $cypher=new DES $keybin;
19735: }
1.1233 raeburn 19736: my $plaintext='';
19737: my $cypherlength = length($cyphertext);
19738: my $numchunks = int($cypherlength/32);
19739: for (my $j=0; $j<$numchunks; $j++) {
19740: my $start = $j*32;
19741: my $cypherblock = substr($cyphertext,$start,32);
19742: my $chunk =
19743: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19744: $chunk .=
19745: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19746: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19747: $plaintext .= $chunk;
19748: }
1.1174 raeburn 19749: return $plaintext;
19750: }
19751:
1.1344 raeburn 19752: sub get_requested_shorturls {
1.1309 raeburn 19753: my ($cdom,$cnum,$navmap) = @_;
19754: return unless (ref($navmap));
1.1344 raeburn 19755: my ($numnew,$errors);
1.1309 raeburn 19756: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19757: if (@toshorten) {
19758: my (%maps,%resources,%titles);
19759: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19760: 'shorturls',$cdom,$cnum);
19761: if (keys(%resources)) {
1.1344 raeburn 19762: my %tocreate;
1.1309 raeburn 19763: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19764: my $symb = $resources{$item};
19765: if ($symb) {
19766: $tocreate{$cnum.'&'.$symb} = 1;
19767: }
19768: }
1.1344 raeburn 19769: if (keys(%tocreate)) {
19770: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19771: \%tocreate);
19772: }
1.1309 raeburn 19773: }
1.1344 raeburn 19774: }
19775: return ($numnew,$errors);
19776: }
19777:
19778: sub make_short_symbs {
19779: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19780: my ($numnew,@errors);
19781: if (ref($tocreateref) eq 'HASH') {
19782: my %tocreate = %{$tocreateref};
1.1309 raeburn 19783: if (keys(%tocreate)) {
19784: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19785: my $su = Short::URL->new(no_vowels => 1);
19786: my $init = '';
19787: my (%newunique,%addcourse,%courseonly,%failed);
19788: # get lock on tiny db
19789: my $now = time;
1.1344 raeburn 19790: if ($lockuser eq '') {
19791: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19792: }
1.1309 raeburn 19793: my $lockhash = {
1.1344 raeburn 19794: "lock\0$now" => $lockuser,
1.1309 raeburn 19795: };
19796: my $tries = 0;
19797: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19798: my ($code,$error);
19799: while (($gotlock ne 'ok') && ($tries<3)) {
19800: $tries ++;
19801: sleep 1;
1.1319 raeburn 19802: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19803: }
19804: if ($gotlock eq 'ok') {
19805: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19806: \%addcourse,\%courseonly,\%failed);
19807: if (keys(%failed)) {
19808: my $numfailed = scalar(keys(%failed));
19809: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19810: }
19811: if (keys(%newunique)) {
19812: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19813: if ($putres eq 'ok') {
19814: $numnew = scalar(keys(%newunique));
19815: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19816: unless ($newputres eq 'ok') {
19817: push(@errors,&mt('error: could not store course look-up of short URLs'));
19818: }
19819: } else {
19820: push(@errors,&mt('error: could not store unique six character URLs'));
19821: }
19822: }
19823: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19824: unless ($dellockres eq 'ok') {
19825: push(@errors,&mt('error: could not release lockfile'));
19826: }
19827: } else {
19828: push(@errors,&mt('error: could not obtain lockfile'));
19829: }
19830: if (keys(%courseonly)) {
19831: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19832: if ($result ne 'ok') {
19833: push(@errors,&mt('error: could not update course look-up of short URLs'));
19834: }
19835: }
19836: }
19837: }
19838: return ($numnew,\@errors);
19839: }
19840:
19841: sub shorten_symbs {
19842: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19843: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19844: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19845: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19846: my (%possibles,%collisions);
19847: foreach my $key (keys(%{$tocreate})) {
19848: my $num = String::CRC32::crc32($key);
19849: my $tiny = $su->encode($num,$init);
19850: if ($tiny) {
19851: $possibles{$tiny} = $key;
19852: }
19853: }
19854: if (!$init) {
19855: $init = 1;
19856: } else {
19857: $init ++;
19858: }
19859: if (keys(%possibles)) {
19860: my @posstiny = keys(%possibles);
19861: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19862: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19863: if (keys(%currtiny)) {
19864: foreach my $key (keys(%currtiny)) {
19865: next if ($currtiny{$key} eq '');
19866: if ($currtiny{$key} eq $possibles{$key}) {
19867: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19868: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19869: $courseonly->{$tsymb} = $key;
19870: }
19871: } else {
19872: $collisions{$possibles{$key}} = 1;
19873: }
19874: delete($possibles{$key});
19875: }
19876: }
19877: foreach my $key (keys(%possibles)) {
19878: $newunique->{$key} = $possibles{$key};
19879: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19880: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19881: $addcourse->{$tsymb} = $key;
19882: }
19883: }
19884: }
19885: if (keys(%collisions)) {
19886: if ($init <5) {
19887: if (!$init) {
19888: $init = 1;
19889: } else {
19890: $init ++;
19891: }
19892: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19893: $newunique,$addcourse,$courseonly,$failed);
19894: } else {
19895: foreach my $key (keys(%collisions)) {
19896: $failed->{$key} = 1;
19897: }
19898: }
19899: }
19900: return $init;
19901: }
19902:
1.1328 raeburn 19903: sub is_nonframeable {
1.1329 raeburn 19904: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19905: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19906: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19907:
19908: $remprotocol = lc($remprotocol);
19909: $remhost = lc($remhost);
19910: my $remport = 80;
19911: if ($remprotocol eq 'https') {
19912: $remport = 443;
19913: }
1.1330 raeburn 19914: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19915: if ($cached) {
19916: unless ($nocache) {
19917: if ($result) {
19918: return 1;
19919: } else {
19920: return 0;
19921: }
19922: }
19923: }
1.1328 raeburn 19924: my $uselink;
19925: my $request = new HTTP::Request('HEAD',$url);
19926: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19927: if ($response->is_success()) {
19928: my $secpolicy = lc($response->header('content-security-policy'));
19929: my $xframeop = lc($response->header('x-frame-options'));
19930: $secpolicy =~ s/^\s+|\s+$//g;
19931: $xframeop =~ s/^\s+|\s+$//g;
19932: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19933: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19934: my ($origin,$protocol,$port);
19935: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19936: $port = $ENV{'SERVER_PORT'};
19937: } else {
19938: $port = 80;
19939: }
19940: if ($absolute eq '') {
19941: $protocol = 'http:';
19942: if ($port == 443) {
19943: $protocol = 'https:';
19944: }
19945: $origin = $protocol.'//'.lc($hostname);
19946: } else {
19947: $origin = lc($absolute);
19948: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19949: }
19950: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19951: my $framepolicy = $1;
19952: $framepolicy =~ s/^\s+|\s+$//g;
19953: my @policies = split(/\s+/,$framepolicy);
19954: if (@policies) {
19955: if (grep(/^\Q'none'\E$/,@policies)) {
19956: $uselink = 1;
19957: } else {
19958: $uselink = 1;
19959: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19960: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19961: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19962: undef($uselink);
19963: }
19964: if ($uselink) {
19965: if (grep(/^\Q'self'\E$/,@policies)) {
19966: if (($origin ne '') && ($remotehost eq $origin)) {
19967: undef($uselink);
19968: }
19969: }
19970: }
19971: if ($uselink) {
19972: my @possok;
19973: if ($ip ne '') {
19974: push(@possok,$ip);
19975: }
19976: my $hoststr = '';
19977: foreach my $part (reverse(split(/\./,$hostname))) {
19978: if ($hoststr eq '') {
19979: $hoststr = $part;
19980: } else {
19981: $hoststr = "$part.$hoststr";
19982: }
19983: if ($hoststr eq $hostname) {
19984: push(@possok,$hostname);
19985: } else {
19986: push(@possok,"*.$hoststr");
19987: }
19988: }
19989: if (@possok) {
19990: foreach my $poss (@possok) {
19991: last if (!$uselink);
19992: foreach my $policy (@policies) {
19993: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
19994: undef($uselink);
19995: last;
19996: }
19997: }
19998: }
19999: }
20000: }
20001: }
20002: }
20003: } elsif ($xframeop ne '') {
20004: $uselink = 1;
20005: my @policies = split(/\s*,\s*/,$xframeop);
20006: if (@policies) {
20007: unless (grep(/^deny$/,@policies)) {
20008: if ($origin ne '') {
20009: if (grep(/^sameorigin$/,@policies)) {
20010: if ($remotehost eq $origin) {
20011: undef($uselink);
20012: }
20013: }
20014: if ($uselink) {
20015: foreach my $policy (@policies) {
20016: if ($policy =~ /^allow-from\s*(.+)$/) {
20017: my $allowfrom = $1;
20018: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20019: undef($uselink);
20020: last;
20021: }
20022: }
20023: }
20024: }
20025: }
20026: }
20027: }
20028: }
20029: }
20030: }
1.1329 raeburn 20031: if ($nocache) {
20032: if ($cached) {
20033: my $devalidate;
20034: if ($uselink && !$result) {
20035: $devalidate = 1;
20036: } elsif (!$uselink && $result) {
20037: $devalidate = 1;
20038: }
20039: if ($devalidate) {
20040: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20041: }
20042: }
20043: } else {
20044: if ($uselink) {
20045: $result = 1;
20046: } else {
20047: $result = 0;
20048: }
20049: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20050: }
1.1328 raeburn 20051: return $uselink;
20052: }
20053:
1.1359 raeburn 20054: sub page_menu {
20055: my ($menucolls,$menunum) = @_;
20056: my %menu;
20057: foreach my $item (split(/;/,$menucolls)) {
20058: my ($num,$value) = split(/\%/,$item);
20059: if ($num eq $menunum) {
20060: my @entries = split(/\&/,$value);
20061: foreach my $entry (@entries) {
20062: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20063: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20064: $menu{$name} = $fields;
20065: } else {
20066: my @shown;
20067: if ($fields =~ /,/) {
20068: @shown = split(/,/,$fields);
20069: } else {
20070: @shown = ($fields);
20071: }
20072: if (@shown) {
20073: foreach my $field (@shown) {
20074: next if ($field eq '');
20075: $menu{$field} = 1;
20076: }
20077: }
20078: }
20079: }
20080: }
20081: }
20082: return %menu;
20083: }
20084:
1.112 bowersj2 20085: 1;
20086: __END__;
1.41 ng 20087:
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