Annotation of loncom/interface/loncommon.pm, revision 1.739
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.739 ! ehlerst 4: # $Id: loncommon.pm,v 1.738 2009/01/30 11:39:38 tempelho 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.685 tempelho 64: use Apache::lonnet();
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.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
1.558 albertel 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 412: var url = '/adm/pickstudent?';
413: var filter;
1.558 albertel 414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
1.74 www 417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
1.111 www 424: if (roleflag) { url+="&roles=1"; }
1.102 www 425: var title = 'Student_Browser';
1.74 www 426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
1.42 matthew 434:
1.74 www 435: sub selectstudent_link {
1.111 www 436: my ($form,$unameele,$udomele)=@_;
1.258 albertel 437: if ($env{'request.course.id'}) {
1.302 albertel 438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
1.111 www 441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 445: }
1.258 albertel 446: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 449: }
450: return '';
1.91 www 451: }
452:
1.653 raeburn 453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
1.91 www 472: sub coursebrowser_javascript {
1.468 raeburn 473: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 474: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 475: my $output = '
1.538 albertel 476: <script type="text/javascript">
1.468 raeburn 477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
1.377 raeburn 479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 480: var url = '/adm/pickcourse?';
1.468 raeburn 481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
1.91 www 493: }
1.128 albertel 494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
1.91 www 499: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
1.468 raeburn 502: if (extra_element !=null && extra_element != '') {
1.594 raeburn 503: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
1.234 raeburn 508: }
1.468 raeburn 509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
1.230 raeburn 514: }
1.293 raeburn 515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
1.377 raeburn 518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
1.102 www 530: var title = 'Course_Browser';
1.91 www 531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
1.468 raeburn 536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
1.91 www 554: ENDSTDBRW
1.468 raeburn 555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
1.629 raeburn 567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
1.468 raeburn 571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
1.91 www 597: }
1.468 raeburn 598: |;
599: return $setsections;
600: }
601:
1.91 www 602:
603: sub selectcourse_link {
1.377 raeburn 604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 607: }
1.42 matthew 608:
1.653 raeburn 609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
1.273 raeburn 615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
1.543 albertel 631: }
632: } else {
1.273 raeburn 633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
1.656 www 640: sub select_timezone {
1.659 raeburn 641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
1.657 raeburn 650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
1.656 www 657: }
658: $output.="</select>";
659: return $output;
660: }
1.273 raeburn 661:
1.687 raeburn 662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 680: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
1.42 matthew 713: =pod
1.36 matthew 714:
1.648 raeburn 715: =item * &linked_select_forms(...)
1.36 matthew 716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 721: order unless a defined order is provided.
1.36 matthew 722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
1.112 bowersj2 727: =item * $formname, the name of the <form> tag
1.36 matthew 728:
1.112 bowersj2 729: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 730:
1.112 bowersj2 731: =item * $firstdefault, the default value for the first menu
1.36 matthew 732:
1.112 bowersj2 733: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 734:
1.112 bowersj2 735: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 736:
1.112 bowersj2 737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 738:
1.609 raeburn 739: =item * $menuorder, the order of values in the first menu
740:
1.41 ng 741: =back
742:
1.36 matthew 743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
1.41 ng 746: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
1.112 bowersj2 750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
1.609 raeburn 757: },
758: order => ['B4','B3','B1','B2'],
1.112 bowersj2 759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
1.609 raeburn 766: },
767: order => ['C2','C1','C3'],
1.112 bowersj2 768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
1.609 raeburn 779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 781: }
782: );
1.36 matthew 783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
1.609 raeburn 792: $hashref,
793: $menuorder,
1.36 matthew 794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
1.219 albertel 799: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 807: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
1.36 matthew 812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
1.143 matthew 838: $second.options[i].value = values[i];
1.36 matthew 839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
1.36 matthew 854: $result.=" <option value=\"$value\" ";
1.253 albertel 855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
1.36 matthew 869: $result.=" <option value=\"$value\" ";
1.253 albertel 870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 871: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
1.45 matthew 878: =pod
1.44 bowersj2 879:
1.648 raeburn 880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 881:
1.112 bowersj2 882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
1.44 bowersj2 899:
900: =cut
901:
902: sub help_open_topic {
1.48 bowersj2 903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
1.44 bowersj2 905: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 906: if ($env{'browser.interface'} eq 'textual') {
1.79 www 907: $stayOnPage=1;
908: }
1.44 bowersj2 909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
1.48 bowersj2 914: my $template = "";
915: my $link;
1.572 banghart 916:
1.159 www 917: $topic=~s/\W/\_/g;
1.44 bowersj2 918:
1.572 banghart 919: if (!$stayOnPage) {
1.72 bowersj2 920: $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 921: } else {
1.48 bowersj2 922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
1.572 banghart 926: if ($text ne "") {
1.77 www 927: $template .=
1.572 banghart 928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 929: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.48 bowersj2 930: }
931:
932: # Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 935: $template .= <<"ENDTEMPLATE";
1.436 albertel 936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 937: ENDTEMPLATE
1.705 tempelho 938: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 939: return $template;
940:
1.106 bowersj2 941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
1.732 raeburn 946: my ($topic,$text,$not_author) = @_;
947: my $out;
1.106 bowersj2 948: my $addOther = '';
1.732 raeburn 949: if ($topic) {
950: $addOther = &Apache::loncommon::help_open_topic($topic,$text,
951: undef, undef, 600).
1.106 bowersj2 952: '</td><td>';
953: }
1.732 raeburn 954: $out = '<table><tr><td>'.
955: $addOther .
956: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
957: undef,undef,600).
958: '</td><td>'.
959: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
960: undef,undef,600).
961: '</td>';
962: unless ($not_author) {
963: $out .= '<td>'.
964: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
965: undef,undef,600).
966: '</td>';
967: }
968: $out .= '</tr></table>';
969: return $out;
1.172 www 970: }
971:
1.430 albertel 972: sub general_help {
973: my $helptopic='Student_Intro';
974: if ($env{'request.role'}=~/^(ca|au)/) {
975: $helptopic='Authoring_Intro';
976: } elsif ($env{'request.role'}=~/^cc/) {
977: $helptopic='Course_Coordination_Intro';
1.672 raeburn 978: } elsif ($env{'request.role'}=~/^dc/) {
979: $helptopic='Domain_Coordination_Intro';
1.430 albertel 980: }
981: return $helptopic;
982: }
983:
984: sub update_help_link {
985: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
986: my $origurl = $ENV{'REQUEST_URI'};
987: $origurl=~s|^/~|/priv/|;
988: my $timestamp = time;
989: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
990: $$datum = &escape($$datum);
991: }
992:
993: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
994: my $output .= <<"ENDOUTPUT";
995: <script type="text/javascript">
996: banner_link = '$banner_link';
997: </script>
998: ENDOUTPUT
999: return $output;
1000: }
1001:
1002: # now just updates the help link and generates a blue icon
1.193 raeburn 1003: sub help_open_menu {
1.430 albertel 1004: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1005: = @_;
1.430 albertel 1006: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1007: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1008: # if environment.remote is on (using remote control UI)
1.572 banghart 1009: if ($env{'browser.interface'} eq 'textual' ||
1010: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1011: $stayOnPage=1;
1.430 albertel 1012: }
1013: my $output;
1014: if ($component_help) {
1015: if (!$text) {
1016: $output=&help_open_topic($component_help,undef,$stayOnPage,
1017: $width,$height);
1018: } else {
1019: my $help_text;
1020: $help_text=&unescape($topic);
1021: $output='<table><tr><td>'.
1022: &help_open_topic($component_help,$help_text,$stayOnPage,
1023: $width,$height).'</td></tr></table>';
1024: }
1025: }
1026: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1027: return $output.$banner_link;
1028: }
1029:
1030: sub top_nav_help {
1031: my ($text) = @_;
1.436 albertel 1032: $text = &mt($text);
1.572 banghart 1033: my $stay_on_page =
1.436 albertel 1034: ($env{'browser.interface'} eq 'textual' ||
1035: $env{'environment.remote'} eq 'off' );
1.572 banghart 1036: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1037: : "javascript:helpMenu('open')";
1.572 banghart 1038: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1039:
1.201 raeburn 1040: my $title = &mt('Get help');
1.436 albertel 1041:
1042: return <<"END";
1043: $banner_link
1044: <a href="$link" title="$title">$text</a>
1045: END
1046: }
1047:
1048: sub help_menu_js {
1049: my ($text) = @_;
1050:
1051: my $stayOnPage =
1052: ($env{'browser.interface'} eq 'textual' ||
1053: $env{'environment.remote'} eq 'off' );
1054:
1055: my $width = 620;
1056: my $height = 600;
1.430 albertel 1057: my $helptopic=&general_help();
1058: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1059: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1060: my $start_page =
1061: &Apache::loncommon::start_page('Help Menu', undef,
1062: {'frameset' => 1,
1063: 'js_ready' => 1,
1064: 'add_entries' => {
1065: 'border' => '0',
1.579 raeburn 1066: 'rows' => "110,*",},});
1.331 albertel 1067: my $end_page =
1068: &Apache::loncommon::end_page({'frameset' => 1,
1069: 'js_ready' => 1,});
1070:
1.436 albertel 1071: my $template .= <<"ENDTEMPLATE";
1072: <script type="text/javascript">
1.253 albertel 1073: // <!-- BEGIN LON-CAPA Internal
1074: // <![CDATA[
1.430 albertel 1075: var banner_link = '';
1.243 raeburn 1076: function helpMenu(target) {
1077: var caller = this;
1078: if (target == 'open') {
1079: var newWindow = null;
1080: try {
1.262 albertel 1081: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1082: }
1083: catch(error) {
1084: writeHelp(caller);
1085: return;
1086: }
1087: if (newWindow) {
1088: caller = newWindow;
1089: }
1.193 raeburn 1090: }
1.243 raeburn 1091: writeHelp(caller);
1092: return;
1093: }
1094: function writeHelp(caller) {
1.430 albertel 1095: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1096: caller.document.close()
1097: caller.focus()
1.193 raeburn 1098: }
1.253 albertel 1099: // ]]>
1.219 albertel 1100: // END LON-CAPA Internal -->
1.436 albertel 1101: </script>
1.193 raeburn 1102: ENDTEMPLATE
1103: return $template;
1104: }
1105:
1.172 www 1106: sub help_open_bug {
1107: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1108: unless ($env{'user.adv'}) { return ''; }
1.172 www 1109: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1110: $text = "" if (not defined $text);
1111: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1112: if ($env{'browser.interface'} eq 'textual' ||
1113: $env{'environment.remote'} eq 'off' ) {
1.172 www 1114: $stayOnPage=1;
1115: }
1.184 albertel 1116: $width = 600 if (not defined $width);
1117: $height = 600 if (not defined $height);
1.172 www 1118:
1119: $topic=~s/\W+/\+/g;
1120: my $link='';
1121: my $template='';
1.379 albertel 1122: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1123: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1124: if (!$stayOnPage)
1125: {
1126: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1127: }
1128: else
1129: {
1130: $link = $url;
1131: }
1132: # Add the text
1133: if ($text ne "")
1134: {
1135: $template .=
1136: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1137: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1138: }
1139:
1140: # Add the graphic
1.179 matthew 1141: my $title = &mt('Report a Bug');
1.215 albertel 1142: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1143: $template .= <<"ENDTEMPLATE";
1.436 albertel 1144: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1145: ENDTEMPLATE
1146: if ($text ne '') { $template.='</td></tr></table>' };
1147: return $template;
1148:
1149: }
1150:
1151: sub help_open_faq {
1152: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1153: unless ($env{'user.adv'}) { return ''; }
1.172 www 1154: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1155: $text = "" if (not defined $text);
1156: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1157: if ($env{'browser.interface'} eq 'textual' ||
1158: $env{'environment.remote'} eq 'off' ) {
1.172 www 1159: $stayOnPage=1;
1160: }
1161: $width = 350 if (not defined $width);
1162: $height = 400 if (not defined $height);
1163:
1164: $topic=~s/\W+/\+/g;
1165: my $link='';
1166: my $template='';
1167: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1168: if (!$stayOnPage)
1169: {
1170: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1171: }
1172: else
1173: {
1174: $link = $url;
1175: }
1176:
1177: # Add the text
1178: if ($text ne "")
1179: {
1180: $template .=
1.173 www 1181: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1182: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1183: }
1184:
1185: # Add the graphic
1.179 matthew 1186: my $title = &mt('View the FAQ');
1.215 albertel 1187: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1188: $template .= <<"ENDTEMPLATE";
1.436 albertel 1189: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1190: ENDTEMPLATE
1191: if ($text ne '') { $template.='</td></tr></table>' };
1192: return $template;
1193:
1.44 bowersj2 1194: }
1.37 matthew 1195:
1.180 matthew 1196: ###############################################################
1197: ###############################################################
1198:
1.45 matthew 1199: =pod
1200:
1.648 raeburn 1201: =item * &change_content_javascript():
1.256 matthew 1202:
1203: This and the next function allow you to create small sections of an
1204: otherwise static HTML page that you can update on the fly with
1205: Javascript, even in Netscape 4.
1206:
1207: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1208: must be written to the HTML page once. It will prove the Javascript
1209: function "change(name, content)". Calling the change function with the
1210: name of the section
1211: you want to update, matching the name passed to C<changable_area>, and
1212: the new content you want to put in there, will put the content into
1213: that area.
1214:
1215: B<Note>: Netscape 4 only reserves enough space for the changable area
1216: to contain room for the original contents. You need to "make space"
1217: for whatever changes you wish to make, and be B<sure> to check your
1218: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1219: it's adequate for updating a one-line status display, but little more.
1220: This script will set the space to 100% width, so you only need to
1221: worry about height in Netscape 4.
1222:
1223: Modern browsers are much less limiting, and if you can commit to the
1224: user not using Netscape 4, this feature may be used freely with
1225: pretty much any HTML.
1226:
1227: =cut
1228:
1229: sub change_content_javascript {
1230: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1231: if ($env{'browser.type'} eq 'netscape' &&
1232: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1233: return (<<NETSCAPE4);
1234: function change(name, content) {
1235: doc = document.layers[name+"___escape"].layers[0].document;
1236: doc.open();
1237: doc.write(content);
1238: doc.close();
1239: }
1240: NETSCAPE4
1241: } else {
1242: # Otherwise, we need to use semi-standards-compliant code
1243: # (technically, "innerHTML" isn't standard but the equivalent
1244: # is really scary, and every useful browser supports it
1245: return (<<DOMBASED);
1246: function change(name, content) {
1247: element = document.getElementById(name);
1248: element.innerHTML = content;
1249: }
1250: DOMBASED
1251: }
1252: }
1253:
1254: =pod
1255:
1.648 raeburn 1256: =item * &changable_area($name,$origContent):
1.256 matthew 1257:
1258: This provides a "changable area" that can be modified on the fly via
1259: the Javascript code provided in C<change_content_javascript>. $name is
1260: the name you will use to reference the area later; do not repeat the
1261: same name on a given HTML page more then once. $origContent is what
1262: the area will originally contain, which can be left blank.
1263:
1264: =cut
1265:
1266: sub changable_area {
1267: my ($name, $origContent) = @_;
1268:
1.258 albertel 1269: if ($env{'browser.type'} eq 'netscape' &&
1270: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1271: # If this is netscape 4, we need to use the Layer tag
1272: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1273: } else {
1274: return "<span id='$name'>$origContent</span>";
1275: }
1276: }
1277:
1278: =pod
1279:
1.648 raeburn 1280: =item * &viewport_geometry_js
1.590 raeburn 1281:
1282: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1283:
1284: =cut
1285:
1286:
1287: sub viewport_geometry_js {
1288: return <<"GEOMETRY";
1289: var Geometry = {};
1290: function init_geometry() {
1291: if (Geometry.init) { return };
1292: Geometry.init=1;
1293: if (window.innerHeight) {
1294: Geometry.getViewportHeight = function() { return window.innerHeight; };
1295: Geometry.getViewportWidth = function() { return window.innerWidth; };
1296: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1297: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1298: }
1299: else if (document.documentElement && document.documentElement.clientHeight) {
1300: Geometry.getViewportHeight =
1301: function() { return document.documentElement.clientHeight; };
1302: Geometry.getViewportWidth =
1303: function() { return document.documentElement.clientWidth; };
1304:
1305: Geometry.getHorizontalScroll =
1306: function() { return document.documentElement.scrollLeft; };
1307: Geometry.getVerticalScroll =
1308: function() { return document.documentElement.scrollTop; };
1309: }
1310: else if (document.body.clientHeight) {
1311: Geometry.getViewportHeight =
1312: function() { return document.body.clientHeight; };
1313: Geometry.getViewportWidth =
1314: function() { return document.body.clientWidth; };
1315: Geometry.getHorizontalScroll =
1316: function() { return document.body.scrollLeft; };
1317: Geometry.getVerticalScroll =
1318: function() { return document.body.scrollTop; };
1319: }
1320: }
1321:
1322: GEOMETRY
1323: }
1324:
1325: =pod
1326:
1.648 raeburn 1327: =item * &viewport_size_js()
1.590 raeburn 1328:
1329: 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.
1330:
1331: =cut
1332:
1333: sub viewport_size_js {
1334: my $geometry = &viewport_geometry_js();
1335: return <<"DIMS";
1336:
1337: $geometry
1338:
1339: function getViewportDims(width,height) {
1340: init_geometry();
1341: width.value = Geometry.getViewportWidth();
1342: height.value = Geometry.getViewportHeight();
1343: return;
1344: }
1345:
1346: DIMS
1347: }
1348:
1349: =pod
1350:
1.648 raeburn 1351: =item * &resize_textarea_js()
1.565 albertel 1352:
1353: emits the needed javascript to resize a textarea to be as big as possible
1354:
1355: creates a function resize_textrea that takes two IDs first should be
1356: the id of the element to resize, second should be the id of a div that
1357: surrounds everything that comes after the textarea, this routine needs
1358: to be attached to the <body> for the onload and onresize events.
1359:
1.648 raeburn 1360: =back
1.565 albertel 1361:
1362: =cut
1363:
1364: sub resize_textarea_js {
1.590 raeburn 1365: my $geometry = &viewport_geometry_js();
1.565 albertel 1366: return <<"RESIZE";
1367: <script type="text/javascript">
1.590 raeburn 1368: $geometry
1.565 albertel 1369:
1.588 albertel 1370: function getX(element) {
1371: var x = 0;
1372: while (element) {
1373: x += element.offsetLeft;
1374: element = element.offsetParent;
1375: }
1376: return x;
1377: }
1378: function getY(element) {
1379: var y = 0;
1380: while (element) {
1381: y += element.offsetTop;
1382: element = element.offsetParent;
1383: }
1384: return y;
1385: }
1386:
1387:
1.565 albertel 1388: function resize_textarea(textarea_id,bottom_id) {
1389: init_geometry();
1390: var textarea = document.getElementById(textarea_id);
1391: //alert(textarea);
1392:
1.588 albertel 1393: var textarea_top = getY(textarea);
1.565 albertel 1394: var textarea_height = textarea.offsetHeight;
1395: var bottom = document.getElementById(bottom_id);
1.588 albertel 1396: var bottom_top = getY(bottom);
1.565 albertel 1397: var bottom_height = bottom.offsetHeight;
1398: var window_height = Geometry.getViewportHeight();
1.588 albertel 1399: var fudge = 23;
1.565 albertel 1400: var new_height = window_height-fudge-textarea_top-bottom_height;
1401: if (new_height < 300) {
1402: new_height = 300;
1403: }
1404: textarea.style.height=new_height+'px';
1405: }
1406: </script>
1407: RESIZE
1408:
1409: }
1410:
1411: =pod
1412:
1.256 matthew 1413: =head1 Excel and CSV file utility routines
1414:
1415: =over 4
1416:
1417: =cut
1418:
1419: ###############################################################
1420: ###############################################################
1421:
1422: =pod
1423:
1.648 raeburn 1424: =item * &csv_translate($text)
1.37 matthew 1425:
1.185 www 1426: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1427: format.
1428:
1429: =cut
1430:
1.180 matthew 1431: ###############################################################
1432: ###############################################################
1.37 matthew 1433: sub csv_translate {
1434: my $text = shift;
1435: $text =~ s/\"/\"\"/g;
1.209 albertel 1436: $text =~ s/\n/ /g;
1.37 matthew 1437: return $text;
1438: }
1.180 matthew 1439:
1440: ###############################################################
1441: ###############################################################
1442:
1443: =pod
1444:
1.648 raeburn 1445: =item * &define_excel_formats()
1.180 matthew 1446:
1447: Define some commonly used Excel cell formats.
1448:
1449: Currently supported formats:
1450:
1451: =over 4
1452:
1453: =item header
1454:
1455: =item bold
1456:
1457: =item h1
1458:
1459: =item h2
1460:
1461: =item h3
1462:
1.256 matthew 1463: =item h4
1464:
1465: =item i
1466:
1.180 matthew 1467: =item date
1468:
1469: =back
1470:
1471: Inputs: $workbook
1472:
1473: Returns: $format, a hash reference.
1474:
1475: =cut
1476:
1477: ###############################################################
1478: ###############################################################
1479: sub define_excel_formats {
1480: my ($workbook) = @_;
1481: my $format;
1482: $format->{'header'} = $workbook->add_format(bold => 1,
1483: bottom => 1,
1484: align => 'center');
1485: $format->{'bold'} = $workbook->add_format(bold=>1);
1486: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1487: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1488: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1489: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1490: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1491: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1492: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1493: return $format;
1494: }
1495:
1496: ###############################################################
1497: ###############################################################
1.113 bowersj2 1498:
1499: =pod
1500:
1.648 raeburn 1501: =item * &create_workbook()
1.255 matthew 1502:
1503: Create an Excel worksheet. If it fails, output message on the
1504: request object and return undefs.
1505:
1506: Inputs: Apache request object
1507:
1508: Returns (undef) on failure,
1509: Excel worksheet object, scalar with filename, and formats
1510: from &Apache::loncommon::define_excel_formats on success
1511:
1512: =cut
1513:
1514: ###############################################################
1515: ###############################################################
1516: sub create_workbook {
1517: my ($r) = @_;
1518: #
1519: # Create the excel spreadsheet
1520: my $filename = '/prtspool/'.
1.258 albertel 1521: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1522: time.'_'.rand(1000000000).'.xls';
1523: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1524: if (! defined($workbook)) {
1525: $r->log_error("Error creating excel spreadsheet $filename: $!");
1526: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1527: "This error has been logged. ".
1528: "Please alert your LON-CAPA administrator").
1529: '</p>');
1530: return (undef);
1531: }
1532: #
1533: $workbook->set_tempdir('/home/httpd/perl/tmp');
1534: #
1535: my $format = &Apache::loncommon::define_excel_formats($workbook);
1536: return ($workbook,$filename,$format);
1537: }
1538:
1539: ###############################################################
1540: ###############################################################
1541:
1542: =pod
1543:
1.648 raeburn 1544: =item * &create_text_file()
1.113 bowersj2 1545:
1.542 raeburn 1546: Create a file to write to and eventually make available to the user.
1.256 matthew 1547: If file creation fails, outputs an error message on the request object and
1548: return undefs.
1.113 bowersj2 1549:
1.256 matthew 1550: Inputs: Apache request object, and file suffix
1.113 bowersj2 1551:
1.256 matthew 1552: Returns (undef) on failure,
1553: Filehandle and filename on success.
1.113 bowersj2 1554:
1555: =cut
1556:
1.256 matthew 1557: ###############################################################
1558: ###############################################################
1559: sub create_text_file {
1560: my ($r,$suffix) = @_;
1561: if (! defined($suffix)) { $suffix = 'txt'; };
1562: my $fh;
1563: my $filename = '/prtspool/'.
1.258 albertel 1564: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1565: time.'_'.rand(1000000000).'.'.$suffix;
1566: $fh = Apache::File->new('>/home/httpd'.$filename);
1567: if (! defined($fh)) {
1568: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1569: $r->print(&mt('Problems occurred in creating the output file. '
1570: .'This error has been logged. '
1571: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1572: }
1.256 matthew 1573: return ($fh,$filename)
1.113 bowersj2 1574: }
1575:
1576:
1.256 matthew 1577: =pod
1.113 bowersj2 1578:
1579: =back
1580:
1581: =cut
1.37 matthew 1582:
1583: ###############################################################
1.33 matthew 1584: ## Home server <option> list generating code ##
1585: ###############################################################
1.35 matthew 1586:
1.169 www 1587: # ------------------------------------------
1588:
1589: sub domain_select {
1590: my ($name,$value,$multiple)=@_;
1591: my %domains=map {
1.514 albertel 1592: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1593: } &Apache::lonnet::all_domains();
1.169 www 1594: if ($multiple) {
1595: $domains{''}=&mt('Any domain');
1.550 albertel 1596: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1597: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1598: } else {
1.550 albertel 1599: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1600: return &select_form($name,$value,%domains);
1601: }
1602: }
1603:
1.282 albertel 1604: #-------------------------------------------
1605:
1606: =pod
1607:
1.519 raeburn 1608: =head1 Routines for form select boxes
1609:
1610: =over 4
1611:
1.648 raeburn 1612: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1613:
1614: Returns a string containing a <select> element int multiple mode
1615:
1616:
1617: Args:
1618: $name - name of the <select> element
1.506 raeburn 1619: $value - scalar or array ref of values that should already be selected
1.282 albertel 1620: $size - number of rows long the select element is
1.283 albertel 1621: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1622: (shown text should already have been &mt())
1.506 raeburn 1623: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1624:
1.282 albertel 1625: =cut
1626:
1627: #-------------------------------------------
1.169 www 1628: sub multiple_select_form {
1.284 albertel 1629: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1630: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1631: my $output='';
1.191 matthew 1632: if (! defined($size)) {
1633: $size = 4;
1.283 albertel 1634: if (scalar(keys(%$hash))<4) {
1635: $size = scalar(keys(%$hash));
1.191 matthew 1636: }
1637: }
1.734 bisitz 1638: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1639: my @order;
1.506 raeburn 1640: if (ref($order) eq 'ARRAY') {
1641: @order = @{$order};
1642: } else {
1643: @order = sort(keys(%$hash));
1.501 banghart 1644: }
1645: if (exists($$hash{'select_form_order'})) {
1646: @order = @{$$hash{'select_form_order'}};
1647: }
1648:
1.284 albertel 1649: foreach my $key (@order) {
1.356 albertel 1650: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1651: $output.='selected="selected" ' if ($selected{$key});
1652: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1653: }
1654: $output.="</select>\n";
1655: return $output;
1656: }
1657:
1.88 www 1658: #-------------------------------------------
1659:
1660: =pod
1661:
1.648 raeburn 1662: =item * &select_form($defdom,$name,%hash)
1.88 www 1663:
1664: Returns a string containing a <select name='$name' size='1'> form to
1665: allow a user to select options from a hash option_name => displayed text.
1666: See lonrights.pm for an example invocation and use.
1667:
1668: =cut
1669:
1670: #-------------------------------------------
1671: sub select_form {
1672: my ($def,$name,%hash) = @_;
1673: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1674: my @keys;
1675: if (exists($hash{'select_form_order'})) {
1676: @keys=@{$hash{'select_form_order'}};
1677: } else {
1678: @keys=sort(keys(%hash));
1679: }
1.356 albertel 1680: foreach my $key (@keys) {
1681: $selectform.=
1682: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1683: ($key eq $def ? 'selected="selected" ' : '').
1684: ">".&mt($hash{$key})."</option>\n";
1.88 www 1685: }
1686: $selectform.="</select>";
1687: return $selectform;
1688: }
1689:
1.475 www 1690: # For display filters
1691:
1692: sub display_filter {
1693: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1694: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1695: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1696: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1697: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1698: '</label></span> <span class="LC_nobreak">'.
1.475 www 1699: &mt('Filter [_1]',
1.477 www 1700: &select_form($env{'form.displayfilter'},
1701: 'displayfilter',
1702: ('currentfolder' => 'Current folder/page',
1703: 'containing' => 'Containing phrase',
1704: 'none' => 'None'))).
1.714 bisitz 1705: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1706: }
1707:
1.167 www 1708: sub gradeleveldescription {
1709: my $gradelevel=shift;
1710: my %gradelevels=(0 => 'Not specified',
1711: 1 => 'Grade 1',
1712: 2 => 'Grade 2',
1713: 3 => 'Grade 3',
1714: 4 => 'Grade 4',
1715: 5 => 'Grade 5',
1716: 6 => 'Grade 6',
1717: 7 => 'Grade 7',
1718: 8 => 'Grade 8',
1719: 9 => 'Grade 9',
1720: 10 => 'Grade 10',
1721: 11 => 'Grade 11',
1722: 12 => 'Grade 12',
1723: 13 => 'Grade 13',
1724: 14 => '100 Level',
1725: 15 => '200 Level',
1726: 16 => '300 Level',
1727: 17 => '400 Level',
1728: 18 => 'Graduate Level');
1729: return &mt($gradelevels{$gradelevel});
1730: }
1731:
1.163 www 1732: sub select_level_form {
1733: my ($deflevel,$name)=@_;
1734: unless ($deflevel) { $deflevel=0; }
1.167 www 1735: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1736: for (my $i=0; $i<=18; $i++) {
1737: $selectform.="<option value=\"$i\" ".
1.253 albertel 1738: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1739: ">".&gradeleveldescription($i)."</option>\n";
1740: }
1741: $selectform.="</select>";
1742: return $selectform;
1.163 www 1743: }
1.167 www 1744:
1.35 matthew 1745: #-------------------------------------------
1746:
1.45 matthew 1747: =pod
1748:
1.648 raeburn 1749: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1750:
1751: Returns a string containing a <select name='$name' size='1'> form to
1752: allow a user to select the domain to preform an operation in.
1753: See loncreateuser.pm for an example invocation and use.
1754:
1.90 www 1755: If the $includeempty flag is set, it also includes an empty choice ("no domain
1756: selected");
1757:
1.563 raeburn 1758: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1759:
1.35 matthew 1760: =cut
1761:
1762: #-------------------------------------------
1.34 matthew 1763: sub select_dom_form {
1.563 raeburn 1764: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1765: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1766: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1767: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1768: foreach my $dom (@domains) {
1769: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1770: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1771: if ($showdomdesc) {
1772: if ($dom ne '') {
1773: my $domdesc = &Apache::lonnet::domain($dom,'description');
1774: if ($domdesc ne '') {
1775: $selectdomain .= ' ('.$domdesc.')';
1776: }
1777: }
1778: }
1779: $selectdomain .= "</option>\n";
1.34 matthew 1780: }
1781: $selectdomain.="</select>";
1782: return $selectdomain;
1783: }
1784:
1.35 matthew 1785: #-------------------------------------------
1786:
1.45 matthew 1787: =pod
1788:
1.648 raeburn 1789: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1790:
1.586 raeburn 1791: input: 4 arguments (two required, two optional) -
1792: $domain - domain of new user
1793: $name - name of form element
1794: $default - Value of 'default' causes a default item to be first
1795: option, and selected by default.
1796: $hide - Value of 'hide' causes hiding of the name of the server,
1797: if 1 server found, or default, if 0 found.
1.594 raeburn 1798: output: returns 2 items:
1.586 raeburn 1799: (a) form element which contains either:
1800: (i) <select name="$name">
1801: <option value="$hostid1">$hostid $servers{$hostid}</option>
1802: <option value="$hostid2">$hostid $servers{$hostid}</option>
1803: </select>
1804: form item if there are multiple library servers in $domain, or
1805: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1806: if there is only one library server in $domain.
1807:
1808: (b) number of library servers found.
1809:
1810: See loncreateuser.pm for example of use.
1.35 matthew 1811:
1812: =cut
1813:
1814: #-------------------------------------------
1.586 raeburn 1815: sub home_server_form_item {
1816: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1817: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1818: my $result;
1819: my $numlib = keys(%servers);
1820: if ($numlib > 1) {
1821: $result .= '<select name="'.$name.'" />'."\n";
1822: if ($default) {
1823: $result .= '<option value="default" selected>'.&mt('default').
1824: '</option>'."\n";
1825: }
1826: foreach my $hostid (sort(keys(%servers))) {
1827: $result.= '<option value="'.$hostid.'">'.
1828: $hostid.' '.$servers{$hostid}."</option>\n";
1829: }
1830: $result .= '</select>'."\n";
1831: } elsif ($numlib == 1) {
1832: my $hostid;
1833: foreach my $item (keys(%servers)) {
1834: $hostid = $item;
1835: }
1836: $result .= '<input type="hidden" name="'.$name.'" value="'.
1837: $hostid.'" />';
1838: if (!$hide) {
1839: $result .= $hostid.' '.$servers{$hostid};
1840: }
1841: $result .= "\n";
1842: } elsif ($default) {
1843: $result .= '<input type="hidden" name="'.$name.
1844: '" value="default" />';
1845: if (!$hide) {
1846: $result .= &mt('default');
1847: }
1848: $result .= "\n";
1.33 matthew 1849: }
1.586 raeburn 1850: return ($result,$numlib);
1.33 matthew 1851: }
1.112 bowersj2 1852:
1853: =pod
1854:
1.534 albertel 1855: =back
1856:
1.112 bowersj2 1857: =cut
1.87 matthew 1858:
1859: ###############################################################
1.112 bowersj2 1860: ## Decoding User Agent ##
1.87 matthew 1861: ###############################################################
1862:
1863: =pod
1864:
1.112 bowersj2 1865: =head1 Decoding the User Agent
1866:
1867: =over 4
1868:
1869: =item * &decode_user_agent()
1.87 matthew 1870:
1871: Inputs: $r
1872:
1873: Outputs:
1874:
1875: =over 4
1876:
1.112 bowersj2 1877: =item * $httpbrowser
1.87 matthew 1878:
1.112 bowersj2 1879: =item * $clientbrowser
1.87 matthew 1880:
1.112 bowersj2 1881: =item * $clientversion
1.87 matthew 1882:
1.112 bowersj2 1883: =item * $clientmathml
1.87 matthew 1884:
1.112 bowersj2 1885: =item * $clientunicode
1.87 matthew 1886:
1.112 bowersj2 1887: =item * $clientos
1.87 matthew 1888:
1889: =back
1890:
1.157 matthew 1891: =back
1892:
1.87 matthew 1893: =cut
1894:
1895: ###############################################################
1896: ###############################################################
1897: sub decode_user_agent {
1.247 albertel 1898: my ($r)=@_;
1.87 matthew 1899: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1900: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1901: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1902: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1903: my $clientbrowser='unknown';
1904: my $clientversion='0';
1905: my $clientmathml='';
1906: my $clientunicode='0';
1907: for (my $i=0;$i<=$#browsertype;$i++) {
1908: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1909: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1910: $clientbrowser=$bname;
1911: $httpbrowser=~/$vreg/i;
1912: $clientversion=$1;
1913: $clientmathml=($clientversion>=$minv);
1914: $clientunicode=($clientversion>=$univ);
1915: }
1916: }
1917: my $clientos='unknown';
1918: if (($httpbrowser=~/linux/i) ||
1919: ($httpbrowser=~/unix/i) ||
1920: ($httpbrowser=~/ux/i) ||
1921: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1922: if (($httpbrowser=~/vax/i) ||
1923: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1924: if ($httpbrowser=~/next/i) { $clientos='next'; }
1925: if (($httpbrowser=~/mac/i) ||
1926: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1927: if ($httpbrowser=~/win/i) { $clientos='win'; }
1928: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1929: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1930: $clientunicode,$clientos,);
1931: }
1932:
1.32 matthew 1933: ###############################################################
1934: ## Authentication changing form generation subroutines ##
1935: ###############################################################
1936: ##
1937: ## All of the authform_xxxxxxx subroutines take their inputs in a
1938: ## hash, and have reasonable default values.
1939: ##
1940: ## formname = the name given in the <form> tag.
1.35 matthew 1941: #-------------------------------------------
1942:
1.45 matthew 1943: =pod
1944:
1.112 bowersj2 1945: =head1 Authentication Routines
1946:
1947: =over 4
1948:
1.648 raeburn 1949: =item * &authform_xxxxxx()
1.35 matthew 1950:
1951: The authform_xxxxxx subroutines provide javascript and html forms which
1952: handle some of the conveniences required for authentication forms.
1953: This is not an optimal method, but it works.
1954:
1955: =over 4
1956:
1.112 bowersj2 1957: =item * authform_header
1.35 matthew 1958:
1.112 bowersj2 1959: =item * authform_authorwarning
1.35 matthew 1960:
1.112 bowersj2 1961: =item * authform_nochange
1.35 matthew 1962:
1.112 bowersj2 1963: =item * authform_kerberos
1.35 matthew 1964:
1.112 bowersj2 1965: =item * authform_internal
1.35 matthew 1966:
1.112 bowersj2 1967: =item * authform_filesystem
1.35 matthew 1968:
1969: =back
1970:
1.648 raeburn 1971: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1972:
1.35 matthew 1973: =cut
1974:
1975: #-------------------------------------------
1.32 matthew 1976: sub authform_header{
1977: my %in = (
1978: formname => 'cu',
1.80 albertel 1979: kerb_def_dom => '',
1.32 matthew 1980: @_,
1981: );
1982: $in{'formname'} = 'document.' . $in{'formname'};
1983: my $result='';
1.80 albertel 1984:
1985: #---------------------------------------------- Code for upper case translation
1986: my $Javascript_toUpperCase;
1987: unless ($in{kerb_def_dom}) {
1988: $Javascript_toUpperCase =<<"END";
1989: switch (choice) {
1990: case 'krb': currentform.elements[choicearg].value =
1991: currentform.elements[choicearg].value.toUpperCase();
1992: break;
1993: default:
1994: }
1995: END
1996: } else {
1997: $Javascript_toUpperCase = "";
1998: }
1999:
1.165 raeburn 2000: my $radioval = "'nochange'";
1.591 raeburn 2001: if (defined($in{'curr_authtype'})) {
2002: if ($in{'curr_authtype'} ne '') {
2003: $radioval = "'".$in{'curr_authtype'}."arg'";
2004: }
1.174 matthew 2005: }
1.165 raeburn 2006: my $argfield = 'null';
1.591 raeburn 2007: if (defined($in{'mode'})) {
1.165 raeburn 2008: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2009: if (defined($in{'curr_autharg'})) {
2010: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2011: $argfield = "'$in{'curr_autharg'}'";
2012: }
2013: }
2014: }
2015: }
2016:
1.32 matthew 2017: $result.=<<"END";
2018: var current = new Object();
1.165 raeburn 2019: current.radiovalue = $radioval;
2020: current.argfield = $argfield;
1.32 matthew 2021:
2022: function changed_radio(choice,currentform) {
2023: var choicearg = choice + 'arg';
2024: // If a radio button in changed, we need to change the argfield
2025: if (current.radiovalue != choice) {
2026: current.radiovalue = choice;
2027: if (current.argfield != null) {
2028: currentform.elements[current.argfield].value = '';
2029: }
2030: if (choice == 'nochange') {
2031: current.argfield = null;
2032: } else {
2033: current.argfield = choicearg;
2034: switch(choice) {
2035: case 'krb':
2036: currentform.elements[current.argfield].value =
2037: "$in{'kerb_def_dom'}";
2038: break;
2039: default:
2040: break;
2041: }
2042: }
2043: }
2044: return;
2045: }
1.22 www 2046:
1.32 matthew 2047: function changed_text(choice,currentform) {
2048: var choicearg = choice + 'arg';
2049: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2050: $Javascript_toUpperCase
1.32 matthew 2051: // clear old field
2052: if ((current.argfield != choicearg) && (current.argfield != null)) {
2053: currentform.elements[current.argfield].value = '';
2054: }
2055: current.argfield = choicearg;
2056: }
2057: set_auth_radio_buttons(choice,currentform);
2058: return;
1.20 www 2059: }
1.32 matthew 2060:
2061: function set_auth_radio_buttons(newvalue,currentform) {
2062: var i=0;
2063: while (i < currentform.login.length) {
2064: if (currentform.login[i].value == newvalue) { break; }
2065: i++;
2066: }
2067: if (i == currentform.login.length) {
2068: return;
2069: }
2070: current.radiovalue = newvalue;
2071: currentform.login[i].checked = true;
2072: return;
2073: }
2074: END
2075: return $result;
2076: }
2077:
2078: sub authform_authorwarning{
2079: my $result='';
1.144 matthew 2080: $result='<i>'.
2081: &mt('As a general rule, only authors or co-authors should be '.
2082: 'filesystem authenticated '.
2083: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2084: return $result;
2085: }
2086:
2087: sub authform_nochange{
2088: my %in = (
2089: formname => 'document.cu',
2090: kerb_def_dom => 'MSU.EDU',
2091: @_,
2092: );
1.586 raeburn 2093: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2094: my $result;
2095: if (keys(%can_assign) == 0) {
2096: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2097: } else {
2098: $result = '<label>'.&mt('[_1] Do not change login data',
2099: '<input type="radio" name="login" value="nochange" '.
2100: 'checked="checked" onclick="'.
1.281 albertel 2101: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2102: '</label>';
1.586 raeburn 2103: }
1.32 matthew 2104: return $result;
2105: }
2106:
1.591 raeburn 2107: sub authform_kerberos {
1.32 matthew 2108: my %in = (
2109: formname => 'document.cu',
2110: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2111: kerb_def_auth => 'krb4',
1.32 matthew 2112: @_,
2113: );
1.586 raeburn 2114: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2115: $autharg,$jscall);
2116: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2117: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2118: $check5 = ' checked="on"';
1.80 albertel 2119: } else {
1.586 raeburn 2120: $check4 = ' checked="on"';
1.80 albertel 2121: }
1.165 raeburn 2122: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2123: if (defined($in{'curr_authtype'})) {
2124: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2125: $krbcheck = ' checked="on"';
1.623 raeburn 2126: if (defined($in{'mode'})) {
2127: if ($in{'mode'} eq 'modifyuser') {
2128: $krbcheck = '';
2129: }
2130: }
1.591 raeburn 2131: if (defined($in{'curr_kerb_ver'})) {
2132: if ($in{'curr_krb_ver'} eq '5') {
2133: $check5 = ' checked="on"';
2134: $check4 = '';
2135: } else {
2136: $check4 = ' checked="on"';
2137: $check5 = '';
2138: }
1.586 raeburn 2139: }
1.591 raeburn 2140: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2141: $krbarg = $in{'curr_autharg'};
2142: }
1.586 raeburn 2143: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2144: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2145: $result =
2146: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2147: $in{'curr_autharg'},$krbver);
2148: } else {
2149: $result =
2150: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2151: }
2152: return $result;
2153: }
2154: }
2155: } else {
2156: if ($authnum == 1) {
2157: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2158: }
2159: }
1.586 raeburn 2160: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2161: return;
1.587 raeburn 2162: } elsif ($authtype eq '') {
1.591 raeburn 2163: if (defined($in{'mode'})) {
1.587 raeburn 2164: if ($in{'mode'} eq 'modifycourse') {
2165: if ($authnum == 1) {
2166: $authtype = '<input type="hidden" name="login" value="krb">';
2167: }
2168: }
2169: }
1.586 raeburn 2170: }
2171: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2172: if ($authtype eq '') {
2173: $authtype = '<input type="radio" name="login" value="krb" '.
2174: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2175: $krbcheck.' />';
2176: }
2177: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2178: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2179: $in{'curr_authtype'} eq 'krb5') ||
2180: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2181: $in{'curr_authtype'} eq 'krb4')) {
2182: $result .= &mt
1.144 matthew 2183: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2184: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2185: '<label>'.$authtype,
1.281 albertel 2186: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2187: 'value="'.$krbarg.'" '.
1.144 matthew 2188: 'onchange="'.$jscall.'" />',
1.281 albertel 2189: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2190: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2191: '</label>');
1.586 raeburn 2192: } elsif ($can_assign{'krb4'}) {
2193: $result .= &mt
2194: ('[_1] Kerberos authenticated with domain [_2] '.
2195: '[_3] Version 4 [_4]',
2196: '<label>'.$authtype,
2197: '</label><input type="text" size="10" name="krbarg" '.
2198: 'value="'.$krbarg.'" '.
2199: 'onchange="'.$jscall.'" />',
2200: '<label><input type="hidden" name="krbver" value="4" />',
2201: '</label>');
2202: } elsif ($can_assign{'krb5'}) {
2203: $result .= &mt
2204: ('[_1] Kerberos authenticated with domain [_2] '.
2205: '[_3] Version 5 [_4]',
2206: '<label>'.$authtype,
2207: '</label><input type="text" size="10" name="krbarg" '.
2208: 'value="'.$krbarg.'" '.
2209: 'onchange="'.$jscall.'" />',
2210: '<label><input type="hidden" name="krbver" value="5" />',
2211: '</label>');
2212: }
1.32 matthew 2213: return $result;
2214: }
2215:
2216: sub authform_internal{
1.586 raeburn 2217: my %in = (
1.32 matthew 2218: formname => 'document.cu',
2219: kerb_def_dom => 'MSU.EDU',
2220: @_,
2221: );
1.586 raeburn 2222: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2223: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2224: if (defined($in{'curr_authtype'})) {
2225: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2226: if ($can_assign{'int'}) {
2227: $intcheck = 'checked="on" ';
1.623 raeburn 2228: if (defined($in{'mode'})) {
2229: if ($in{'mode'} eq 'modifyuser') {
2230: $intcheck = '';
2231: }
2232: }
1.591 raeburn 2233: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2234: $intarg = $in{'curr_autharg'};
2235: }
2236: } else {
2237: $result = &mt('Currently internally authenticated.');
2238: return $result;
1.165 raeburn 2239: }
2240: }
1.586 raeburn 2241: } else {
2242: if ($authnum == 1) {
2243: $authtype = '<input type="hidden" name="login" value="int">';
2244: }
2245: }
2246: if (!$can_assign{'int'}) {
2247: return;
1.587 raeburn 2248: } elsif ($authtype eq '') {
1.591 raeburn 2249: if (defined($in{'mode'})) {
1.587 raeburn 2250: if ($in{'mode'} eq 'modifycourse') {
2251: if ($authnum == 1) {
2252: $authtype = '<input type="hidden" name="login" value="int">';
2253: }
2254: }
2255: }
1.165 raeburn 2256: }
1.586 raeburn 2257: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2258: if ($authtype eq '') {
2259: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2260: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2261: }
1.605 bisitz 2262: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2263: $intarg.'" onchange="'.$jscall.'" />';
2264: $result = &mt
1.144 matthew 2265: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2266: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2267: $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2268: return $result;
2269: }
2270:
2271: sub authform_local{
2272: my %in = (
2273: formname => 'document.cu',
2274: kerb_def_dom => 'MSU.EDU',
2275: @_,
2276: );
1.586 raeburn 2277: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2278: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2279: if (defined($in{'curr_authtype'})) {
2280: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2281: if ($can_assign{'loc'}) {
2282: $loccheck = 'checked="on" ';
1.623 raeburn 2283: if (defined($in{'mode'})) {
2284: if ($in{'mode'} eq 'modifyuser') {
2285: $loccheck = '';
2286: }
2287: }
1.591 raeburn 2288: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2289: $locarg = $in{'curr_autharg'};
2290: }
2291: } else {
2292: $result = &mt('Currently using local (institutional) authentication.');
2293: return $result;
1.165 raeburn 2294: }
2295: }
1.586 raeburn 2296: } else {
2297: if ($authnum == 1) {
2298: $authtype = '<input type="hidden" name="login" value="loc">';
2299: }
2300: }
2301: if (!$can_assign{'loc'}) {
2302: return;
1.587 raeburn 2303: } elsif ($authtype eq '') {
1.591 raeburn 2304: if (defined($in{'mode'})) {
1.587 raeburn 2305: if ($in{'mode'} eq 'modifycourse') {
2306: if ($authnum == 1) {
2307: $authtype = '<input type="hidden" name="login" value="loc">';
2308: }
2309: }
2310: }
1.165 raeburn 2311: }
1.586 raeburn 2312: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2313: if ($authtype eq '') {
2314: $authtype = '<input type="radio" name="login" value="loc" '.
2315: $loccheck.' onchange="'.$jscall.'" onclick="'.
2316: $jscall.'" />';
2317: }
2318: $autharg = '<input type="text" size="10" name="locarg" value="'.
2319: $locarg.'" onchange="'.$jscall.'" />';
2320: $result = &mt('[_1] Local Authentication with argument [_2]',
2321: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2322: return $result;
2323: }
2324:
2325: sub authform_filesystem{
2326: my %in = (
2327: formname => 'document.cu',
2328: kerb_def_dom => 'MSU.EDU',
2329: @_,
2330: );
1.586 raeburn 2331: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2332: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2333: if (defined($in{'curr_authtype'})) {
2334: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2335: if ($can_assign{'fsys'}) {
2336: $fsyscheck = 'checked="on" ';
1.623 raeburn 2337: if (defined($in{'mode'})) {
2338: if ($in{'mode'} eq 'modifyuser') {
2339: $fsyscheck = '';
2340: }
2341: }
1.586 raeburn 2342: } else {
2343: $result = &mt('Currently Filesystem Authenticated.');
2344: return $result;
2345: }
2346: }
2347: } else {
2348: if ($authnum == 1) {
2349: $authtype = '<input type="hidden" name="login" value="fsys">';
2350: }
2351: }
2352: if (!$can_assign{'fsys'}) {
2353: return;
1.587 raeburn 2354: } elsif ($authtype eq '') {
1.591 raeburn 2355: if (defined($in{'mode'})) {
1.587 raeburn 2356: if ($in{'mode'} eq 'modifycourse') {
2357: if ($authnum == 1) {
2358: $authtype = '<input type="hidden" name="login" value="fsys">';
2359: }
2360: }
2361: }
1.586 raeburn 2362: }
2363: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2364: if ($authtype eq '') {
2365: $authtype = '<input type="radio" name="login" value="fsys" '.
2366: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2367: $jscall.'" />';
2368: }
2369: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2370: ' onchange="'.$jscall.'" />';
2371: $result = &mt
1.144 matthew 2372: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2373: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2374: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2375: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2376: 'onchange="'.$jscall.'" />');
1.32 matthew 2377: return $result;
2378: }
2379:
1.586 raeburn 2380: sub get_assignable_auth {
2381: my ($dom) = @_;
2382: if ($dom eq '') {
2383: $dom = $env{'request.role.domain'};
2384: }
2385: my %can_assign = (
2386: krb4 => 1,
2387: krb5 => 1,
2388: int => 1,
2389: loc => 1,
2390: );
2391: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2392: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2393: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2394: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2395: my $context;
2396: if ($env{'request.role'} =~ /^au/) {
2397: $context = 'author';
2398: } elsif ($env{'request.role'} =~ /^dc/) {
2399: $context = 'domain';
2400: } elsif ($env{'request.course.id'}) {
2401: $context = 'course';
2402: }
2403: if ($context) {
2404: if (ref($authhash->{$context}) eq 'HASH') {
2405: %can_assign = %{$authhash->{$context}};
2406: }
2407: }
2408: }
2409: }
2410: my $authnum = 0;
2411: foreach my $key (keys(%can_assign)) {
2412: if ($can_assign{$key}) {
2413: $authnum ++;
2414: }
2415: }
2416: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2417: $authnum --;
2418: }
2419: return ($authnum,%can_assign);
2420: }
2421:
1.80 albertel 2422: ###############################################################
2423: ## Get Kerberos Defaults for Domain ##
2424: ###############################################################
2425: ##
2426: ## Returns default kerberos version and an associated argument
2427: ## as listed in file domain.tab. If not listed, provides
2428: ## appropriate default domain and kerberos version.
2429: ##
2430: #-------------------------------------------
2431:
2432: =pod
2433:
1.648 raeburn 2434: =item * &get_kerberos_defaults()
1.80 albertel 2435:
2436: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2437: version and domain. If not found, it defaults to version 4 and the
2438: domain of the server.
1.80 albertel 2439:
1.648 raeburn 2440: =over 4
2441:
1.80 albertel 2442: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2443:
1.648 raeburn 2444: =back
2445:
2446: =back
2447:
1.80 albertel 2448: =cut
2449:
2450: #-------------------------------------------
2451: sub get_kerberos_defaults {
2452: my $domain=shift;
1.641 raeburn 2453: my ($krbdef,$krbdefdom);
2454: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2455: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2456: $krbdef = $domdefaults{'auth_def'};
2457: $krbdefdom = $domdefaults{'auth_arg_def'};
2458: } else {
1.80 albertel 2459: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2460: my $krbdefdom=$1;
2461: $krbdefdom=~tr/a-z/A-Z/;
2462: $krbdef = "krb4";
2463: }
2464: return ($krbdef,$krbdefdom);
2465: }
1.112 bowersj2 2466:
1.32 matthew 2467:
1.46 matthew 2468: ###############################################################
2469: ## Thesaurus Functions ##
2470: ###############################################################
1.20 www 2471:
1.46 matthew 2472: =pod
1.20 www 2473:
1.112 bowersj2 2474: =head1 Thesaurus Functions
2475:
2476: =over 4
2477:
1.648 raeburn 2478: =item * &initialize_keywords()
1.46 matthew 2479:
2480: Initializes the package variable %Keywords if it is empty. Uses the
2481: package variable $thesaurus_db_file.
2482:
2483: =cut
2484:
2485: ###################################################
2486:
2487: sub initialize_keywords {
2488: return 1 if (scalar keys(%Keywords));
2489: # If we are here, %Keywords is empty, so fill it up
2490: # Make sure the file we need exists...
2491: if (! -e $thesaurus_db_file) {
2492: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2493: " failed because it does not exist");
2494: return 0;
2495: }
2496: # Set up the hash as a database
2497: my %thesaurus_db;
2498: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2499: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2500: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2501: $thesaurus_db_file);
2502: return 0;
2503: }
2504: # Get the average number of appearances of a word.
2505: my $avecount = $thesaurus_db{'average.count'};
2506: # Put keywords (those that appear > average) into %Keywords
2507: while (my ($word,$data)=each (%thesaurus_db)) {
2508: my ($count,undef) = split /:/,$data;
2509: $Keywords{$word}++ if ($count > $avecount);
2510: }
2511: untie %thesaurus_db;
2512: # Remove special values from %Keywords.
1.356 albertel 2513: foreach my $value ('total.count','average.count') {
2514: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2515: }
1.46 matthew 2516: return 1;
2517: }
2518:
2519: ###################################################
2520:
2521: =pod
2522:
1.648 raeburn 2523: =item * &keyword($word)
1.46 matthew 2524:
2525: Returns true if $word is a keyword. A keyword is a word that appears more
2526: than the average number of times in the thesaurus database. Calls
2527: &initialize_keywords
2528:
2529: =cut
2530:
2531: ###################################################
1.20 www 2532:
2533: sub keyword {
1.46 matthew 2534: return if (!&initialize_keywords());
2535: my $word=lc(shift());
2536: $word=~s/\W//g;
2537: return exists($Keywords{$word});
1.20 www 2538: }
1.46 matthew 2539:
2540: ###############################################################
2541:
2542: =pod
1.20 www 2543:
1.648 raeburn 2544: =item * &get_related_words()
1.46 matthew 2545:
1.160 matthew 2546: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2547: an array of words. If the keyword is not in the thesaurus, an empty array
2548: will be returned. The order of the words returned is determined by the
2549: database which holds them.
2550:
2551: Uses global $thesaurus_db_file.
2552:
2553: =cut
2554:
2555: ###############################################################
2556: sub get_related_words {
2557: my $keyword = shift;
2558: my %thesaurus_db;
2559: if (! -e $thesaurus_db_file) {
2560: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2561: "failed because the file does not exist");
2562: return ();
2563: }
2564: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2565: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2566: return ();
2567: }
2568: my @Words=();
1.429 www 2569: my $count=0;
1.46 matthew 2570: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2571: # The first element is the number of times
2572: # the word appears. We do not need it now.
1.429 www 2573: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2574: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2575: my $threshold=$mostfrequentcount/10;
2576: foreach my $possibleword (@RelatedWords) {
2577: my ($word,$wordcount)=split(/\,/,$possibleword);
2578: if ($wordcount>$threshold) {
2579: push(@Words,$word);
2580: $count++;
2581: if ($count>10) { last; }
2582: }
1.20 www 2583: }
2584: }
1.46 matthew 2585: untie %thesaurus_db;
2586: return @Words;
1.14 harris41 2587: }
1.46 matthew 2588:
1.112 bowersj2 2589: =pod
2590:
2591: =back
2592:
2593: =cut
1.61 www 2594:
2595: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2596: =pod
2597:
1.112 bowersj2 2598: =head1 User Name Functions
2599:
2600: =over 4
2601:
1.648 raeburn 2602: =item * &plainname($uname,$udom,$first)
1.81 albertel 2603:
1.112 bowersj2 2604: Takes a users logon name and returns it as a string in
1.226 albertel 2605: "first middle last generation" form
2606: if $first is set to 'lastname' then it returns it as
2607: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2608:
2609: =cut
1.61 www 2610:
1.295 www 2611:
1.81 albertel 2612: ###############################################################
1.61 www 2613: sub plainname {
1.226 albertel 2614: my ($uname,$udom,$first)=@_;
1.537 albertel 2615: return if (!defined($uname) || !defined($udom));
1.295 www 2616: my %names=&getnames($uname,$udom);
1.226 albertel 2617: my $name=&Apache::lonnet::format_name($names{'firstname'},
2618: $names{'middlename'},
2619: $names{'lastname'},
2620: $names{'generation'},$first);
2621: $name=~s/^\s+//;
1.62 www 2622: $name=~s/\s+$//;
2623: $name=~s/\s+/ /g;
1.353 albertel 2624: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2625: return $name;
1.61 www 2626: }
1.66 www 2627:
2628: # -------------------------------------------------------------------- Nickname
1.81 albertel 2629: =pod
2630:
1.648 raeburn 2631: =item * &nickname($uname,$udom)
1.81 albertel 2632:
2633: Gets a users name and returns it as a string as
2634:
2635: ""nickname""
1.66 www 2636:
1.81 albertel 2637: if the user has a nickname or
2638:
2639: "first middle last generation"
2640:
2641: if the user does not
2642:
2643: =cut
1.66 www 2644:
2645: sub nickname {
2646: my ($uname,$udom)=@_;
1.537 albertel 2647: return if (!defined($uname) || !defined($udom));
1.295 www 2648: my %names=&getnames($uname,$udom);
1.68 albertel 2649: my $name=$names{'nickname'};
1.66 www 2650: if ($name) {
2651: $name='"'.$name.'"';
2652: } else {
2653: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2654: $names{'lastname'}.' '.$names{'generation'};
2655: $name=~s/\s+$//;
2656: $name=~s/\s+/ /g;
2657: }
2658: return $name;
2659: }
2660:
1.295 www 2661: sub getnames {
2662: my ($uname,$udom)=@_;
1.537 albertel 2663: return if (!defined($uname) || !defined($udom));
1.433 albertel 2664: if ($udom eq 'public' && $uname eq 'public') {
2665: return ('lastname' => &mt('Public'));
2666: }
1.295 www 2667: my $id=$uname.':'.$udom;
2668: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2669: if ($cached) {
2670: return %{$names};
2671: } else {
2672: my %loadnames=&Apache::lonnet::get('environment',
2673: ['firstname','middlename','lastname','generation','nickname'],
2674: $udom,$uname);
2675: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2676: return %loadnames;
2677: }
2678: }
1.61 www 2679:
1.542 raeburn 2680: # -------------------------------------------------------------------- getemails
1.648 raeburn 2681:
1.542 raeburn 2682: =pod
2683:
1.648 raeburn 2684: =item * &getemails($uname,$udom)
1.542 raeburn 2685:
2686: Gets a user's email information and returns it as a hash with keys:
2687: notification, critnotification, permanentemail
2688:
2689: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2690: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2691:
1.648 raeburn 2692:
1.542 raeburn 2693: =cut
2694:
1.648 raeburn 2695:
1.466 albertel 2696: sub getemails {
2697: my ($uname,$udom)=@_;
2698: if ($udom eq 'public' && $uname eq 'public') {
2699: return;
2700: }
1.467 www 2701: if (!$udom) { $udom=$env{'user.domain'}; }
2702: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2703: my $id=$uname.':'.$udom;
2704: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2705: if ($cached) {
2706: return %{$names};
2707: } else {
2708: my %loadnames=&Apache::lonnet::get('environment',
2709: ['notification','critnotification',
2710: 'permanentemail'],
2711: $udom,$uname);
2712: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2713: return %loadnames;
2714: }
2715: }
2716:
1.551 albertel 2717: sub flush_email_cache {
2718: my ($uname,$udom)=@_;
2719: if (!$udom) { $udom =$env{'user.domain'}; }
2720: if (!$uname) { $uname=$env{'user.name'}; }
2721: return if ($udom eq 'public' && $uname eq 'public');
2722: my $id=$uname.':'.$udom;
2723: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2724: }
2725:
1.728 raeburn 2726: # -------------------------------------------------------------------- getlangs
2727:
2728: =pod
2729:
2730: =item * &getlangs($uname,$udom)
2731:
2732: Gets a user's language preference and returns it as a hash with key:
2733: language.
2734:
2735: =cut
2736:
2737:
2738: sub getlangs {
2739: my ($uname,$udom) = @_;
2740: if (!$udom) { $udom =$env{'user.domain'}; }
2741: if (!$uname) { $uname=$env{'user.name'}; }
2742: my $id=$uname.':'.$udom;
2743: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2744: if ($cached) {
2745: return %{$langs};
2746: } else {
2747: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2748: $udom,$uname);
2749: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2750: return %loadlangs;
2751: }
2752: }
2753:
2754: sub flush_langs_cache {
2755: my ($uname,$udom)=@_;
2756: if (!$udom) { $udom =$env{'user.domain'}; }
2757: if (!$uname) { $uname=$env{'user.name'}; }
2758: return if ($udom eq 'public' && $uname eq 'public');
2759: my $id=$uname.':'.$udom;
2760: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2761: }
2762:
1.61 www 2763: # ------------------------------------------------------------------ Screenname
1.81 albertel 2764:
2765: =pod
2766:
1.648 raeburn 2767: =item * &screenname($uname,$udom)
1.81 albertel 2768:
2769: Gets a users screenname and returns it as a string
2770:
2771: =cut
1.61 www 2772:
2773: sub screenname {
2774: my ($uname,$udom)=@_;
1.258 albertel 2775: if ($uname eq $env{'user.name'} &&
2776: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2777: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2778: return $names{'screenname'};
1.62 www 2779: }
2780:
1.212 albertel 2781:
1.62 www 2782: # ------------------------------------------------------------- Message Wrapper
2783:
2784: sub messagewrapper {
1.369 www 2785: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2786: return
1.441 albertel 2787: '<a href="/adm/email?compose=individual&'.
2788: 'recname='.$username.'&recdom='.$domain.
2789: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2790: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2791: }
2792: # --------------------------------------------------------------- Notes Wrapper
2793:
2794: sub noteswrapper {
2795: my ($link,$un,$do)=@_;
2796: return
2797: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2798: }
2799: # ------------------------------------------------------------- Aboutme Wrapper
2800:
2801: sub aboutmewrapper {
1.166 www 2802: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2803: if (!defined($username) && !defined($domain)) {
2804: return;
2805: }
1.205 www 2806: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2807: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2808: }
2809:
2810: # ------------------------------------------------------------ Syllabus Wrapper
2811:
2812:
2813: sub syllabuswrapper {
1.707 bisitz 2814: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2815: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2816: }
1.14 harris41 2817:
1.208 matthew 2818: sub track_student_link {
1.268 albertel 2819: my ($linktext,$sname,$sdom,$target,$start) = @_;
2820: my $link ="/adm/trackstudent?";
1.208 matthew 2821: my $title = 'View recent activity';
2822: if (defined($sname) && $sname !~ /^\s*$/ &&
2823: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2824: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2825: $title .= ' of this student';
1.268 albertel 2826: }
1.208 matthew 2827: if (defined($target) && $target !~ /^\s*$/) {
2828: $target = qq{target="$target"};
2829: } else {
2830: $target = '';
2831: }
1.268 albertel 2832: if ($start) { $link.='&start='.$start; }
1.554 albertel 2833: $title = &mt($title);
2834: $linktext = &mt($linktext);
1.448 albertel 2835: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2836: &help_open_topic('View_recent_activity');
1.208 matthew 2837: }
2838:
1.508 www 2839: # ===================================================== Display a student photo
2840:
2841:
1.509 albertel 2842: sub student_image_tag {
1.508 www 2843: my ($domain,$user)=@_;
2844: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2845: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2846: return '<img src="'.$imgsrc.'" align="right" />';
2847: } else {
2848: return '';
2849: }
2850: }
2851:
1.112 bowersj2 2852: =pod
2853:
2854: =back
2855:
2856: =head1 Access .tab File Data
2857:
2858: =over 4
2859:
1.648 raeburn 2860: =item * &languageids()
1.112 bowersj2 2861:
2862: returns list of all language ids
2863:
2864: =cut
2865:
1.14 harris41 2866: sub languageids {
1.16 harris41 2867: return sort(keys(%language));
1.14 harris41 2868: }
2869:
1.112 bowersj2 2870: =pod
2871:
1.648 raeburn 2872: =item * &languagedescription()
1.112 bowersj2 2873:
2874: returns description of a specified language id
2875:
2876: =cut
2877:
1.14 harris41 2878: sub languagedescription {
1.125 www 2879: my $code=shift;
2880: return ($supported_language{$code}?'* ':'').
2881: $language{$code}.
1.126 www 2882: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2883: }
2884:
2885: sub plainlanguagedescription {
2886: my $code=shift;
2887: return $language{$code};
2888: }
2889:
2890: sub supportedlanguagecode {
2891: my $code=shift;
2892: return $supported_language{$code};
1.97 www 2893: }
2894:
1.112 bowersj2 2895: =pod
2896:
1.648 raeburn 2897: =item * ©rightids()
1.112 bowersj2 2898:
2899: returns list of all copyrights
2900:
2901: =cut
2902:
2903: sub copyrightids {
2904: return sort(keys(%cprtag));
2905: }
2906:
2907: =pod
2908:
1.648 raeburn 2909: =item * ©rightdescription()
1.112 bowersj2 2910:
2911: returns description of a specified copyright id
2912:
2913: =cut
2914:
2915: sub copyrightdescription {
1.166 www 2916: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2917: }
1.197 matthew 2918:
2919: =pod
2920:
1.648 raeburn 2921: =item * &source_copyrightids()
1.192 taceyjo1 2922:
2923: returns list of all source copyrights
2924:
2925: =cut
2926:
2927: sub source_copyrightids {
2928: return sort(keys(%scprtag));
2929: }
2930:
2931: =pod
2932:
1.648 raeburn 2933: =item * &source_copyrightdescription()
1.192 taceyjo1 2934:
2935: returns description of a specified source copyright id
2936:
2937: =cut
2938:
2939: sub source_copyrightdescription {
2940: return &mt($scprtag{shift(@_)});
2941: }
1.112 bowersj2 2942:
2943: =pod
2944:
1.648 raeburn 2945: =item * &filecategories()
1.112 bowersj2 2946:
2947: returns list of all file categories
2948:
2949: =cut
2950:
2951: sub filecategories {
2952: return sort(keys(%category_extensions));
2953: }
2954:
2955: =pod
2956:
1.648 raeburn 2957: =item * &filecategorytypes()
1.112 bowersj2 2958:
2959: returns list of file types belonging to a given file
2960: category
2961:
2962: =cut
2963:
2964: sub filecategorytypes {
1.356 albertel 2965: my ($cat) = @_;
2966: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2967: }
2968:
2969: =pod
2970:
1.648 raeburn 2971: =item * &fileembstyle()
1.112 bowersj2 2972:
2973: returns embedding style for a specified file type
2974:
2975: =cut
2976:
2977: sub fileembstyle {
2978: return $fe{lc(shift(@_))};
1.169 www 2979: }
2980:
1.351 www 2981: sub filemimetype {
2982: return $fm{lc(shift(@_))};
2983: }
2984:
1.169 www 2985:
2986: sub filecategoryselect {
2987: my ($name,$value)=@_;
1.189 matthew 2988: return &select_form($value,$name,
1.169 www 2989: '' => &mt('Any category'),
2990: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2991: }
2992:
2993: =pod
2994:
1.648 raeburn 2995: =item * &filedescription()
1.112 bowersj2 2996:
2997: returns description for a specified file type
2998:
2999: =cut
3000:
3001: sub filedescription {
1.188 matthew 3002: my $file_description = $fd{lc(shift())};
3003: $file_description =~ s:([\[\]]):~$1:g;
3004: return &mt($file_description);
1.112 bowersj2 3005: }
3006:
3007: =pod
3008:
1.648 raeburn 3009: =item * &filedescriptionex()
1.112 bowersj2 3010:
3011: returns description for a specified file type with
3012: extra formatting
3013:
3014: =cut
3015:
3016: sub filedescriptionex {
3017: my $ex=shift;
1.188 matthew 3018: my $file_description = $fd{lc($ex)};
3019: $file_description =~ s:([\[\]]):~$1:g;
3020: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3021: }
3022:
3023: # End of .tab access
3024: =pod
3025:
3026: =back
3027:
3028: =cut
3029:
3030: # ------------------------------------------------------------------ File Types
3031: sub fileextensions {
3032: return sort(keys(%fe));
3033: }
3034:
1.97 www 3035: # ----------------------------------------------------------- Display Languages
3036: # returns a hash with all desired display languages
3037: #
3038:
3039: sub display_languages {
3040: my %languages=();
1.695 raeburn 3041: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3042: $languages{$lang}=1;
1.97 www 3043: }
3044: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3045: if ($env{'form.displaylanguage'}) {
1.356 albertel 3046: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3047: $languages{$lang}=1;
1.97 www 3048: }
3049: }
3050: return %languages;
1.14 harris41 3051: }
3052:
1.582 albertel 3053: sub languages {
3054: my ($possible_langs) = @_;
1.695 raeburn 3055: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3056: if (!ref($possible_langs)) {
3057: if( wantarray ) {
3058: return @preferred_langs;
3059: } else {
3060: return $preferred_langs[0];
3061: }
3062: }
3063: my %possibilities = map { $_ => 1 } (@$possible_langs);
3064: my @preferred_possibilities;
3065: foreach my $preferred_lang (@preferred_langs) {
3066: if (exists($possibilities{$preferred_lang})) {
3067: push(@preferred_possibilities, $preferred_lang);
3068: }
3069: }
3070: if( wantarray ) {
3071: return @preferred_possibilities;
3072: }
3073: return $preferred_possibilities[0];
3074: }
3075:
1.112 bowersj2 3076: ###############################################################
3077: ## Student Answer Attempts ##
3078: ###############################################################
3079:
3080: =pod
3081:
3082: =head1 Alternate Problem Views
3083:
3084: =over 4
3085:
1.648 raeburn 3086: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3087: $getattempt, $regexp, $gradesub)
3088:
3089: Return string with previous attempt on problem. Arguments:
3090:
3091: =over 4
3092:
3093: =item * $symb: Problem, including path
3094:
3095: =item * $username: username of the desired student
3096:
3097: =item * $domain: domain of the desired student
1.14 harris41 3098:
1.112 bowersj2 3099: =item * $course: Course ID
1.14 harris41 3100:
1.112 bowersj2 3101: =item * $getattempt: Leave blank for all attempts, otherwise put
3102: something
1.14 harris41 3103:
1.112 bowersj2 3104: =item * $regexp: if string matches this regexp, the string will be
3105: sent to $gradesub
1.14 harris41 3106:
1.112 bowersj2 3107: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3108:
1.112 bowersj2 3109: =back
1.14 harris41 3110:
1.112 bowersj2 3111: The output string is a table containing all desired attempts, if any.
1.16 harris41 3112:
1.112 bowersj2 3113: =cut
1.1 albertel 3114:
3115: sub get_previous_attempt {
1.43 ng 3116: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3117: my $prevattempts='';
1.43 ng 3118: no strict 'refs';
1.1 albertel 3119: if ($symb) {
1.3 albertel 3120: my (%returnhash)=
3121: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3122: if ($returnhash{'version'}) {
3123: my %lasthash=();
3124: my $version;
3125: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3126: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3127: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3128: }
1.1 albertel 3129: }
1.596 albertel 3130: $prevattempts=&start_data_table().&start_data_table_header_row();
3131: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3132: foreach my $key (sort(keys(%lasthash))) {
3133: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3134: if ($#parts > 0) {
1.31 albertel 3135: my $data=$parts[-1];
3136: pop(@parts);
1.596 albertel 3137: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3138: } else {
1.41 ng 3139: if ($#parts == 0) {
3140: $prevattempts.='<th>'.$parts[0].'</th>';
3141: } else {
3142: $prevattempts.='<th>'.$ign.'</th>';
3143: }
1.31 albertel 3144: }
1.16 harris41 3145: }
1.596 albertel 3146: $prevattempts.=&end_data_table_header_row();
1.40 ng 3147: if ($getattempt eq '') {
3148: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3149: $prevattempts.=&start_data_table_row().
3150: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3151: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3152: my $value = &format_previous_attempt_value($key,
3153: $returnhash{$version.':'.$key});
3154: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3155: }
1.596 albertel 3156: $prevattempts.=&end_data_table_row();
1.40 ng 3157: }
1.1 albertel 3158: }
1.596 albertel 3159: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3160: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3161: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3162: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3163: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3164: }
1.596 albertel 3165: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3166: } else {
1.596 albertel 3167: $prevattempts=
3168: &start_data_table().&start_data_table_row().
3169: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3170: &end_data_table_row().&end_data_table();
1.1 albertel 3171: }
3172: } else {
1.596 albertel 3173: $prevattempts=
3174: &start_data_table().&start_data_table_row().
3175: '<td>'.&mt('No data.').'</td>'.
3176: &end_data_table_row().&end_data_table();
1.1 albertel 3177: }
1.10 albertel 3178: }
3179:
1.581 albertel 3180: sub format_previous_attempt_value {
3181: my ($key,$value) = @_;
3182: if ($key =~ /timestamp/) {
3183: $value = &Apache::lonlocal::locallocaltime($value);
3184: } elsif (ref($value) eq 'ARRAY') {
3185: $value = '('.join(', ', @{ $value }).')';
3186: } else {
3187: $value = &unescape($value);
3188: }
3189: return $value;
3190: }
3191:
3192:
1.107 albertel 3193: sub relative_to_absolute {
3194: my ($url,$output)=@_;
3195: my $parser=HTML::TokeParser->new(\$output);
3196: my $token;
3197: my $thisdir=$url;
3198: my @rlinks=();
3199: while ($token=$parser->get_token) {
3200: if ($token->[0] eq 'S') {
3201: if ($token->[1] eq 'a') {
3202: if ($token->[2]->{'href'}) {
3203: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3204: }
3205: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3206: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3207: } elsif ($token->[1] eq 'base') {
3208: $thisdir=$token->[2]->{'href'};
3209: }
3210: }
3211: }
3212: $thisdir=~s-/[^/]*$--;
1.356 albertel 3213: foreach my $link (@rlinks) {
1.726 raeburn 3214: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3215: ($link=~/^\//) ||
3216: ($link=~/^javascript:/i) ||
3217: ($link=~/^mailto:/i) ||
3218: ($link=~/^\#/)) {
3219: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3220: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3221: }
3222: }
3223: # -------------------------------------------------- Deal with Applet codebases
3224: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3225: return $output;
3226: }
3227:
1.112 bowersj2 3228: =pod
3229:
1.648 raeburn 3230: =item * &get_student_view()
1.112 bowersj2 3231:
3232: show a snapshot of what student was looking at
3233:
3234: =cut
3235:
1.10 albertel 3236: sub get_student_view {
1.186 albertel 3237: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3238: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3239: my (%form);
1.10 albertel 3240: my @elements=('symb','courseid','domain','username');
3241: foreach my $element (@elements) {
1.186 albertel 3242: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3243: }
1.186 albertel 3244: if (defined($moreenv)) {
3245: %form=(%form,%{$moreenv});
3246: }
1.236 albertel 3247: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3248: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3249: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3250: $userview=~s/\<body[^\>]*\>//gi;
3251: $userview=~s/\<\/body\>//gi;
3252: $userview=~s/\<html\>//gi;
3253: $userview=~s/\<\/html\>//gi;
3254: $userview=~s/\<head\>//gi;
3255: $userview=~s/\<\/head\>//gi;
3256: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3257: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3258: if (wantarray) {
3259: return ($userview,$response);
3260: } else {
3261: return $userview;
3262: }
3263: }
3264:
3265: sub get_student_view_with_retries {
3266: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3267:
3268: my $ok = 0; # True if we got a good response.
3269: my $content;
3270: my $response;
3271:
3272: # Try to get the student_view done. within the retries count:
3273:
3274: do {
3275: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3276: $ok = $response->is_success;
3277: if (!$ok) {
3278: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3279: }
3280: $retries--;
3281: } while (!$ok && ($retries > 0));
3282:
3283: if (!$ok) {
3284: $content = ''; # On error return an empty content.
3285: }
1.651 www 3286: if (wantarray) {
3287: return ($content, $response);
3288: } else {
3289: return $content;
3290: }
1.11 albertel 3291: }
3292:
1.112 bowersj2 3293: =pod
3294:
1.648 raeburn 3295: =item * &get_student_answers()
1.112 bowersj2 3296:
3297: show a snapshot of how student was answering problem
3298:
3299: =cut
3300:
1.11 albertel 3301: sub get_student_answers {
1.100 sakharuk 3302: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3303: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3304: my (%moreenv);
1.11 albertel 3305: my @elements=('symb','courseid','domain','username');
3306: foreach my $element (@elements) {
1.186 albertel 3307: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3308: }
1.186 albertel 3309: $moreenv{'grade_target'}='answer';
3310: %moreenv=(%form,%moreenv);
1.497 raeburn 3311: $feedurl = &Apache::lonnet::clutter($feedurl);
3312: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3313: return $userview;
1.1 albertel 3314: }
1.116 albertel 3315:
3316: =pod
3317:
3318: =item * &submlink()
3319:
1.242 albertel 3320: Inputs: $text $uname $udom $symb $target
1.116 albertel 3321:
3322: Returns: A link to grades.pm such as to see the SUBM view of a student
3323:
3324: =cut
3325:
3326: ###############################################
3327: sub submlink {
1.242 albertel 3328: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3329: if (!($uname && $udom)) {
3330: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3331: &Apache::lonnet::whichuser($symb);
1.116 albertel 3332: if (!$symb) { $symb=$cursymb; }
3333: }
1.254 matthew 3334: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3335: $symb=&escape($symb);
1.242 albertel 3336: if ($target) { $target="target=\"$target\""; }
3337: return '<a href="/adm/grades?&command=submission&'.
3338: 'symb='.$symb.'&student='.$uname.
3339: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3340: }
3341: ##############################################
3342:
3343: =pod
3344:
3345: =item * &pgrdlink()
3346:
3347: Inputs: $text $uname $udom $symb $target
3348:
3349: Returns: A link to grades.pm such as to see the PGRD view of a student
3350:
3351: =cut
3352:
3353: ###############################################
3354: sub pgrdlink {
3355: my $link=&submlink(@_);
3356: $link=~s/(&command=submission)/$1&showgrading=yes/;
3357: return $link;
3358: }
3359: ##############################################
3360:
3361: =pod
3362:
3363: =item * &pprmlink()
3364:
3365: Inputs: $text $uname $udom $symb $target
3366:
3367: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3368: student and a specific resource
1.242 albertel 3369:
3370: =cut
3371:
3372: ###############################################
3373: sub pprmlink {
3374: my ($text,$uname,$udom,$symb,$target)=@_;
3375: if (!($uname && $udom)) {
3376: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3377: &Apache::lonnet::whichuser($symb);
1.242 albertel 3378: if (!$symb) { $symb=$cursymb; }
3379: }
1.254 matthew 3380: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3381: $symb=&escape($symb);
1.242 albertel 3382: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3383: return '<a href="/adm/parmset?command=set&'.
3384: 'symb='.$symb.'&uname='.$uname.
3385: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3386: }
3387: ##############################################
1.37 matthew 3388:
1.112 bowersj2 3389: =pod
3390:
3391: =back
3392:
3393: =cut
3394:
1.37 matthew 3395: ###############################################
1.51 www 3396:
3397:
3398: sub timehash {
1.687 raeburn 3399: my ($thistime) = @_;
3400: my $timezone = &Apache::lonlocal::gettimezone();
3401: my $dt = DateTime->from_epoch(epoch => $thistime)
3402: ->set_time_zone($timezone);
3403: my $wday = $dt->day_of_week();
3404: if ($wday == 7) { $wday = 0; }
3405: return ( 'second' => $dt->second(),
3406: 'minute' => $dt->minute(),
3407: 'hour' => $dt->hour(),
3408: 'day' => $dt->day_of_month(),
3409: 'month' => $dt->month(),
3410: 'year' => $dt->year(),
3411: 'weekday' => $wday,
3412: 'dayyear' => $dt->day_of_year(),
3413: 'dlsav' => $dt->is_dst() );
1.51 www 3414: }
3415:
1.370 www 3416: sub utc_string {
3417: my ($date)=@_;
1.371 www 3418: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3419: }
3420:
1.51 www 3421: sub maketime {
3422: my %th=@_;
1.687 raeburn 3423: my ($epoch_time,$timezone,$dt);
3424: $timezone = &Apache::lonlocal::gettimezone();
3425: eval {
3426: $dt = DateTime->new( year => $th{'year'},
3427: month => $th{'month'},
3428: day => $th{'day'},
3429: hour => $th{'hour'},
3430: minute => $th{'minute'},
3431: second => $th{'second'},
3432: time_zone => $timezone,
3433: );
3434: };
3435: if (!$@) {
3436: $epoch_time = $dt->epoch;
3437: if ($epoch_time) {
3438: return $epoch_time;
3439: }
3440: }
1.51 www 3441: return POSIX::mktime(
3442: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3443: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3444: }
3445:
3446: #########################################
1.51 www 3447:
3448: sub findallcourses {
1.482 raeburn 3449: my ($roles,$uname,$udom) = @_;
1.355 albertel 3450: my %roles;
3451: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3452: my %courses;
1.51 www 3453: my $now=time;
1.482 raeburn 3454: if (!defined($uname)) {
3455: $uname = $env{'user.name'};
3456: }
3457: if (!defined($udom)) {
3458: $udom = $env{'user.domain'};
3459: }
3460: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3461: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3462: if (!%roles) {
3463: %roles = (
3464: cc => 1,
3465: in => 1,
3466: ep => 1,
3467: ta => 1,
3468: cr => 1,
3469: st => 1,
3470: );
3471: }
3472: foreach my $entry (keys(%roleshash)) {
3473: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3474: if ($trole =~ /^cr/) {
3475: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3476: } else {
3477: next if (!exists($roles{$trole}));
3478: }
3479: if ($tend) {
3480: next if ($tend < $now);
3481: }
3482: if ($tstart) {
3483: next if ($tstart > $now);
3484: }
3485: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3486: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3487: if ($secpart eq '') {
3488: ($cnum,$role) = split(/_/,$cnumpart);
3489: $sec = 'none';
3490: $realsec = '';
3491: } else {
3492: $cnum = $cnumpart;
3493: ($sec,$role) = split(/_/,$secpart);
3494: $realsec = $sec;
1.490 raeburn 3495: }
1.482 raeburn 3496: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3497: }
3498: } else {
3499: foreach my $key (keys(%env)) {
1.483 albertel 3500: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3501: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3502: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3503: next if ($role eq 'ca' || $role eq 'aa');
3504: next if (%roles && !exists($roles{$role}));
3505: my ($starttime,$endtime)=split(/\./,$env{$key});
3506: my $active=1;
3507: if ($starttime) {
3508: if ($now<$starttime) { $active=0; }
3509: }
3510: if ($endtime) {
3511: if ($now>$endtime) { $active=0; }
3512: }
3513: if ($active) {
3514: if ($sec eq '') {
3515: $sec = 'none';
3516: }
3517: $courses{$cdom.'_'.$cnum}{$sec} =
3518: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3519: }
3520: }
1.51 www 3521: }
3522: }
1.474 raeburn 3523: return %courses;
1.51 www 3524: }
1.37 matthew 3525:
1.54 www 3526: ###############################################
1.474 raeburn 3527:
3528: sub blockcheck {
1.482 raeburn 3529: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3530:
3531: if (!defined($udom)) {
3532: $udom = $env{'user.domain'};
3533: }
3534: if (!defined($uname)) {
3535: $uname = $env{'user.name'};
3536: }
3537:
3538: # If uname and udom are for a course, check for blocks in the course.
3539:
3540: if (&Apache::lonnet::is_course($udom,$uname)) {
3541: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3542: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3543: return ($startblock,$endblock);
3544: }
1.474 raeburn 3545:
1.502 raeburn 3546: my $startblock = 0;
3547: my $endblock = 0;
1.482 raeburn 3548: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3549:
1.490 raeburn 3550: # If uname is for a user, and activity is course-specific, i.e.,
3551: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3552:
1.490 raeburn 3553: if (($activity eq 'boards' || $activity eq 'chat' ||
3554: $activity eq 'groups') && ($env{'request.course.id'})) {
3555: foreach my $key (keys(%live_courses)) {
3556: if ($key ne $env{'request.course.id'}) {
3557: delete($live_courses{$key});
3558: }
3559: }
3560: }
3561:
3562: my $otheruser = 0;
3563: my %own_courses;
3564: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3565: # Resource belongs to user other than current user.
3566: $otheruser = 1;
3567: # Gather courses for current user
3568: %own_courses =
3569: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3570: }
3571:
3572: # Gather active course roles - course coordinator, instructor,
3573: # exam proctor, ta, student, or custom role.
1.474 raeburn 3574:
3575: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3576: my ($cdom,$cnum);
3577: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3578: $cdom = $env{'course.'.$course.'.domain'};
3579: $cnum = $env{'course.'.$course.'.num'};
3580: } else {
1.490 raeburn 3581: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3582: }
3583: my $no_ownblock = 0;
3584: my $no_userblock = 0;
1.533 raeburn 3585: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3586: # Check if current user has 'evb' priv for this
3587: if (defined($own_courses{$course})) {
3588: foreach my $sec (keys(%{$own_courses{$course}})) {
3589: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3590: if ($sec ne 'none') {
3591: $checkrole .= '/'.$sec;
3592: }
3593: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3594: $no_ownblock = 1;
3595: last;
3596: }
3597: }
3598: }
3599: # if they have 'evb' priv and are currently not playing student
3600: next if (($no_ownblock) &&
3601: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3602: }
1.474 raeburn 3603: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3604: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3605: if ($sec ne 'none') {
1.482 raeburn 3606: $checkrole .= '/'.$sec;
1.474 raeburn 3607: }
1.490 raeburn 3608: if ($otheruser) {
3609: # Resource belongs to user other than current user.
3610: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3611: my ($trole,$tdom,$tnum,$tsec);
3612: my $entry = $live_courses{$course}{$sec};
3613: if ($entry =~ /^cr/) {
3614: ($trole,$tdom,$tnum,$tsec) =
3615: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3616: } else {
3617: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3618: }
3619: my ($spec,$area,$trest,%allroles,%userroles);
3620: $area = '/'.$tdom.'/'.$tnum;
3621: $trest = $tnum;
3622: if ($tsec ne '') {
3623: $area .= '/'.$tsec;
3624: $trest .= '/'.$tsec;
3625: }
3626: $spec = $trole.'.'.$area;
3627: if ($trole =~ /^cr/) {
3628: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3629: $tdom,$spec,$trest,$area);
3630: } else {
3631: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3632: $tdom,$spec,$trest,$area);
3633: }
3634: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3635: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3636: if ($1) {
3637: $no_userblock = 1;
3638: last;
3639: }
3640: }
1.490 raeburn 3641: } else {
3642: # Resource belongs to current user
3643: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3644: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3645: $no_ownblock = 1;
3646: last;
3647: }
1.474 raeburn 3648: }
3649: }
3650: # if they have the evb priv and are currently not playing student
1.482 raeburn 3651: next if (($no_ownblock) &&
1.491 albertel 3652: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3653: next if ($no_userblock);
1.474 raeburn 3654:
1.490 raeburn 3655: # Retrieve blocking times and identity of blocker for course
3656: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3657:
3658: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3659: if (($start != 0) &&
3660: (($startblock == 0) || ($startblock > $start))) {
3661: $startblock = $start;
3662: }
3663: if (($end != 0) &&
3664: (($endblock == 0) || ($endblock < $end))) {
3665: $endblock = $end;
3666: }
1.490 raeburn 3667: }
3668: return ($startblock,$endblock);
3669: }
3670:
3671: sub get_blocks {
3672: my ($setters,$activity,$cdom,$cnum) = @_;
3673: my $startblock = 0;
3674: my $endblock = 0;
3675: my $course = $cdom.'_'.$cnum;
3676: $setters->{$course} = {};
3677: $setters->{$course}{'staff'} = [];
3678: $setters->{$course}{'times'} = [];
3679: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3680: foreach my $record (keys(%records)) {
3681: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3682: if ($start <= time && $end >= time) {
3683: my ($staff_name,$staff_dom,$title,$blocks) =
3684: &parse_block_record($records{$record});
3685: if ($blocks->{$activity} eq 'on') {
3686: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3687: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3688: if ( ($startblock == 0) || ($startblock > $start) ) {
3689: $startblock = $start;
1.490 raeburn 3690: }
1.491 albertel 3691: if ( ($endblock == 0) || ($endblock < $end) ) {
3692: $endblock = $end;
1.474 raeburn 3693: }
3694: }
3695: }
3696: }
3697: return ($startblock,$endblock);
3698: }
3699:
3700: sub parse_block_record {
3701: my ($record) = @_;
3702: my ($setuname,$setudom,$title,$blocks);
3703: if (ref($record) eq 'HASH') {
3704: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3705: $title = &unescape($record->{'event'});
3706: $blocks = $record->{'blocks'};
3707: } else {
3708: my @data = split(/:/,$record,3);
3709: if (scalar(@data) eq 2) {
3710: $title = $data[1];
3711: ($setuname,$setudom) = split(/@/,$data[0]);
3712: } else {
3713: ($setuname,$setudom,$title) = @data;
3714: }
3715: $blocks = { 'com' => 'on' };
3716: }
3717: return ($setuname,$setudom,$title,$blocks);
3718: }
3719:
3720: sub build_block_table {
3721: my ($startblock,$endblock,$setters) = @_;
3722: my %lt = &Apache::lonlocal::texthash(
3723: 'cacb' => 'Currently active communication blocks',
3724: 'cour' => 'Course',
3725: 'dura' => 'Duration',
3726: 'blse' => 'Block set by'
3727: );
3728: my $output;
1.476 raeburn 3729: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3730: $output .= &start_data_table();
3731: $output .= '
3732: <tr>
3733: <th>'.$lt{'cour'}.'</th>
3734: <th>'.$lt{'dura'}.'</th>
3735: <th>'.$lt{'blse'}.'</th>
3736: </tr>
3737: ';
3738: foreach my $course (keys(%{$setters})) {
3739: my %courseinfo=&Apache::lonnet::coursedescription($course);
3740: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3741: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3742: my $fullname = &plainname($uname,$udom);
3743: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3744: && $env{'user.name'} ne 'public'
3745: && $env{'user.domain'} ne 'public') {
3746: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3747: }
1.474 raeburn 3748: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3749: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3750: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3751: $output .= &Apache::loncommon::start_data_table_row().
3752: '<td>'.$courseinfo{'description'}.'</td>'.
3753: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3754: '<td>'.$fullname.'</td>'.
1.474 raeburn 3755: &Apache::loncommon::end_data_table_row();
3756: }
3757: }
3758: $output .= &end_data_table();
3759: }
3760:
1.490 raeburn 3761: sub blocking_status {
3762: my ($activity,$uname,$udom) = @_;
3763: my %setters;
3764: my ($blocked,$output,$ownitem,$is_course);
3765: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3766: if ($startblock && $endblock) {
3767: $blocked = 1;
3768: if (wantarray) {
3769: my $category;
3770: if ($activity eq 'boards') {
3771: $category = 'Discussion posts in this course';
3772: } elsif ($activity eq 'blogs') {
3773: $category = 'Blogs';
3774: } elsif ($activity eq 'port') {
3775: if (defined($uname) && defined($udom)) {
3776: if ($uname eq $env{'user.name'} &&
3777: $udom eq $env{'user.domain'}) {
3778: $ownitem = 1;
3779: }
3780: }
3781: $is_course = &Apache::lonnet::is_course($udom,$uname);
3782: if ($ownitem) {
3783: $category = 'Your portfolio files';
3784: } elsif ($is_course) {
3785: my $coursedesc;
3786: foreach my $course (keys(%setters)) {
3787: my %courseinfo =
3788: &Apache::lonnet::coursedescription($course);
3789: $coursedesc = $courseinfo{'description'};
3790: }
3791: $category = "Group files in the course '$coursedesc'";
3792: } else {
3793: $category = 'Portfolio files belonging to ';
3794: if ($env{'user.name'} eq 'public' &&
3795: $env{'user.domain'} eq 'public') {
3796: $category .= &plainname($uname,$udom);
3797: } else {
3798: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3799: }
3800: }
3801: } elsif ($activity eq 'groups') {
3802: $category = 'Groups in this course';
3803: }
3804: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3805: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3806: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3807: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3808: $output .= &build_block_table($startblock,$endblock,\%setters);
3809: }
3810: }
3811: }
3812: if (wantarray) {
3813: return ($blocked,$output);
3814: } else {
3815: return $blocked;
3816: }
3817: }
3818:
1.60 matthew 3819: ###############################################
3820:
1.682 raeburn 3821: sub check_ip_acc {
3822: my ($acc)=@_;
3823: &Apache::lonxml::debug("acc is $acc");
3824: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3825: return 1;
3826: }
3827: my $allowed=0;
3828: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3829:
3830: my $name;
3831: foreach my $pattern (split(',',$acc)) {
3832: $pattern =~ s/^\s*//;
3833: $pattern =~ s/\s*$//;
3834: if ($pattern =~ /\*$/) {
3835: #35.8.*
3836: $pattern=~s/\*//;
3837: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3838: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3839: #35.8.3.[34-56]
3840: my $low=$2;
3841: my $high=$3;
3842: $pattern=$1;
3843: if ($ip =~ /^\Q$pattern\E/) {
3844: my $last=(split(/\./,$ip))[3];
3845: if ($last <=$high && $last >=$low) { $allowed=1; }
3846: }
3847: } elsif ($pattern =~ /^\*/) {
3848: #*.msu.edu
3849: $pattern=~s/\*//;
3850: if (!defined($name)) {
3851: use Socket;
3852: my $netaddr=inet_aton($ip);
3853: ($name)=gethostbyaddr($netaddr,AF_INET);
3854: }
3855: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3856: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3857: #127.0.0.1
3858: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3859: } else {
3860: #some.name.com
3861: if (!defined($name)) {
3862: use Socket;
3863: my $netaddr=inet_aton($ip);
3864: ($name)=gethostbyaddr($netaddr,AF_INET);
3865: }
3866: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3867: }
3868: if ($allowed) { last; }
3869: }
3870: return $allowed;
3871: }
3872:
3873: ###############################################
3874:
1.60 matthew 3875: =pod
3876:
1.112 bowersj2 3877: =head1 Domain Template Functions
3878:
3879: =over 4
3880:
3881: =item * &determinedomain()
1.60 matthew 3882:
3883: Inputs: $domain (usually will be undef)
3884:
1.63 www 3885: Returns: Determines which domain should be used for designs
1.60 matthew 3886:
3887: =cut
1.54 www 3888:
1.60 matthew 3889: ###############################################
1.63 www 3890: sub determinedomain {
3891: my $domain=shift;
1.531 albertel 3892: if (! $domain) {
1.60 matthew 3893: # Determine domain if we have not been given one
3894: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3895: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3896: if ($env{'request.role.domain'}) {
3897: $domain=$env{'request.role.domain'};
1.60 matthew 3898: }
3899: }
1.63 www 3900: return $domain;
3901: }
3902: ###############################################
1.517 raeburn 3903:
1.518 albertel 3904: sub devalidate_domconfig_cache {
3905: my ($udom)=@_;
3906: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3907: }
3908:
3909: # ---------------------- Get domain configuration for a domain
3910: sub get_domainconf {
3911: my ($udom) = @_;
3912: my $cachetime=1800;
3913: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3914: if (defined($cached)) { return %{$result}; }
3915:
3916: my %domconfig = &Apache::lonnet::get_dom('configuration',
3917: ['login','rolecolors'],$udom);
1.632 raeburn 3918: my (%designhash,%legacy);
1.518 albertel 3919: if (keys(%domconfig) > 0) {
3920: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3921: if (keys(%{$domconfig{'login'}})) {
3922: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3923: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3924: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3925: $designhash{$udom.'.login.'.$key.'_'.$img} =
3926: $domconfig{'login'}{$key}{$img};
3927: }
3928: } else {
3929: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3930: }
1.632 raeburn 3931: }
3932: } else {
3933: $legacy{'login'} = 1;
1.518 albertel 3934: }
1.632 raeburn 3935: } else {
3936: $legacy{'login'} = 1;
1.518 albertel 3937: }
3938: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3939: if (keys(%{$domconfig{'rolecolors'}})) {
3940: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3941: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3942: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3943: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3944: }
1.518 albertel 3945: }
3946: }
1.632 raeburn 3947: } else {
3948: $legacy{'rolecolors'} = 1;
1.518 albertel 3949: }
1.632 raeburn 3950: } else {
3951: $legacy{'rolecolors'} = 1;
1.518 albertel 3952: }
1.632 raeburn 3953: if (keys(%legacy) > 0) {
3954: my %legacyhash = &get_legacy_domconf($udom);
3955: foreach my $item (keys(%legacyhash)) {
3956: if ($item =~ /^\Q$udom\E\.login/) {
3957: if ($legacy{'login'}) {
3958: $designhash{$item} = $legacyhash{$item};
3959: }
3960: } else {
3961: if ($legacy{'rolecolors'}) {
3962: $designhash{$item} = $legacyhash{$item};
3963: }
1.518 albertel 3964: }
3965: }
3966: }
1.632 raeburn 3967: } else {
3968: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3969: }
3970: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3971: $cachetime);
3972: return %designhash;
3973: }
3974:
1.632 raeburn 3975: sub get_legacy_domconf {
3976: my ($udom) = @_;
3977: my %legacyhash;
3978: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3979: my $designfile = $designdir.'/'.$udom.'.tab';
3980: if (-e $designfile) {
3981: if ( open (my $fh,"<$designfile") ) {
3982: while (my $line = <$fh>) {
3983: next if ($line =~ /^\#/);
3984: chomp($line);
3985: my ($key,$val)=(split(/\=/,$line));
3986: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3987: }
3988: close($fh);
3989: }
3990: }
3991: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3992: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3993: }
3994: return %legacyhash;
3995: }
3996:
1.63 www 3997: =pod
3998:
1.112 bowersj2 3999: =item * &domainlogo()
1.63 www 4000:
4001: Inputs: $domain (usually will be undef)
4002:
4003: Returns: A link to a domain logo, if the domain logo exists.
4004: If the domain logo does not exist, a description of the domain.
4005:
4006: =cut
1.112 bowersj2 4007:
1.63 www 4008: ###############################################
4009: sub domainlogo {
1.517 raeburn 4010: my $domain = &determinedomain(shift);
1.518 albertel 4011: my %designhash = &get_domainconf($domain);
1.517 raeburn 4012: # See if there is a logo
4013: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4014: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4015: if ($imgsrc =~ m{^/(adm|res)/}) {
4016: if ($imgsrc =~ m{^/res/}) {
4017: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4018: &Apache::lonnet::repcopy($local_name);
4019: }
4020: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4021: }
4022: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4023: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4024: return &Apache::lonnet::domain($domain,'description');
1.59 www 4025: } else {
1.60 matthew 4026: return '';
1.59 www 4027: }
4028: }
1.63 www 4029: ##############################################
4030:
4031: =pod
4032:
1.112 bowersj2 4033: =item * &designparm()
1.63 www 4034:
4035: Inputs: $which parameter; $domain (usually will be undef)
4036:
4037: Returns: value of designparamter $which
4038:
4039: =cut
1.112 bowersj2 4040:
1.397 albertel 4041:
1.400 albertel 4042: ##############################################
1.397 albertel 4043: sub designparm {
4044: my ($which,$domain)=@_;
1.258 albertel 4045: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4046: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4047: return '#000000';
4048: }
1.635 raeburn 4049: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4050: return '#FFFFFF';
4051: }
4052: if ($which=~/\.tabbg$/) {
4053: return '#CCCCCC';
4054: }
4055: }
1.397 albertel 4056: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4057: return $env{'environment.color.'.$which};
1.96 www 4058: }
1.63 www 4059: $domain=&determinedomain($domain);
1.518 albertel 4060: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4061: my $output;
1.517 raeburn 4062: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4063: $output = $domdesign{$domain.'.'.$which};
1.63 www 4064: } else {
1.520 raeburn 4065: $output = $defaultdesign{$which};
4066: }
4067: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4068: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4069: if ($output =~ m{^/(adm|res)/}) {
4070: if ($output =~ m{^/res/}) {
4071: my $local_name = &Apache::lonnet::filelocation('',$output);
4072: &Apache::lonnet::repcopy($local_name);
4073: }
1.520 raeburn 4074: $output = &lonhttpdurl($output);
4075: }
1.63 www 4076: }
1.520 raeburn 4077: return $output;
1.63 www 4078: }
1.59 www 4079:
1.60 matthew 4080: ###############################################
4081: ###############################################
4082:
4083: =pod
4084:
1.112 bowersj2 4085: =back
4086:
1.549 albertel 4087: =head1 HTML Helpers
1.112 bowersj2 4088:
4089: =over 4
4090:
4091: =item * &bodytag()
1.60 matthew 4092:
4093: Returns a uniform header for LON-CAPA web pages.
4094:
4095: Inputs:
4096:
1.112 bowersj2 4097: =over 4
4098:
4099: =item * $title, A title to be displayed on the page.
4100:
4101: =item * $function, the current role (can be undef).
4102:
4103: =item * $addentries, extra parameters for the <body> tag.
4104:
4105: =item * $bodyonly, if defined, only return the <body> tag.
4106:
4107: =item * $domain, if defined, force a given domain.
4108:
4109: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4110: text interface only)
1.60 matthew 4111:
1.326 albertel 4112: =item * $customtitle, alternate text to use instead of $title
4113: in the title box that appears, this text
4114: is not auto translated like the $title is
1.309 albertel 4115:
4116: =item * $notopbar, if true, keep the 'what is this' info but remove the
4117: navigational links
1.317 albertel 4118:
1.338 albertel 4119: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4120:
4121: =item * $notitle, if true keep the nav controls, but remove the title bar
4122:
1.361 albertel 4123: =item * $no_inline_link, if true and in remote mode, don't show the
4124: 'Switch To Inline Menu' link
4125:
1.460 albertel 4126: =item * $args, optional argument valid values are
4127: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4128: inherit_jsmath -> when creating popup window in a page,
4129: should it have jsmath forced on by the
4130: current page
1.460 albertel 4131:
1.112 bowersj2 4132: =back
4133:
1.60 matthew 4134: Returns: A uniform header for LON-CAPA web pages.
4135: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4136: If $bodyonly is undef or zero, an html string containing a <body> tag and
4137: other decorations will be returned.
4138:
4139: =cut
4140:
1.54 www 4141: sub bodytag {
1.309 albertel 4142: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4143: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4144:
1.460 albertel 4145: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4146:
1.183 matthew 4147: $function = &get_users_function() if (!$function);
1.339 albertel 4148: my $img = &designparm($function.'.img',$domain);
4149: my $font = &designparm($function.'.font',$domain);
4150: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4151:
4152: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4153: 'bgcolor' => $pgbg,
1.339 albertel 4154: 'text' => $font,
4155: 'alink' => &designparm($function.'.alink',$domain),
4156: 'vlink' => &designparm($function.'.vlink',$domain),
4157: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4158: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4159:
1.63 www 4160: # role and realm
1.378 raeburn 4161: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4162: if ($role eq 'ca') {
1.479 albertel 4163: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4164: $realm = &plainname($rname,$rdom);
1.378 raeburn 4165: }
1.55 www 4166: # realm
1.258 albertel 4167: if ($env{'request.course.id'}) {
1.378 raeburn 4168: if ($env{'request.role'} !~ /^cr/) {
4169: $role = &Apache::lonnet::plaintext($role,&course_type());
4170: }
1.359 albertel 4171: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4172: } else {
4173: $role = &Apache::lonnet::plaintext($role);
1.54 www 4174: }
1.433 albertel 4175:
1.359 albertel 4176: if (!$realm) { $realm=' '; }
1.55 www 4177: # Set messages
1.60 matthew 4178: my $messages=&domainlogo($domain);
1.330 albertel 4179:
1.438 albertel 4180: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4181:
1.101 www 4182: # construct main body tag
1.359 albertel 4183: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4184: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4185:
1.530 albertel 4186: if ($bodyonly) {
1.60 matthew 4187: return $bodytag;
1.258 albertel 4188: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4189: # Accessibility
1.224 raeburn 4190:
1.337 albertel 4191: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4192: if (!$notitle) {
1.337 albertel 4193: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4194: }
4195: return $bodytag;
1.359 albertel 4196: }
4197:
1.410 albertel 4198: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4199: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4200: undef($role);
1.434 albertel 4201: } else {
4202: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4203: }
1.359 albertel 4204:
4205: my $roleinfo=(<<ENDROLE);
4206: <td class="LC_title_bar_who">
4207: <div class="LC_title_bar_name">
1.410 albertel 4208: $name
1.361 albertel 4209:
1.359 albertel 4210: </div>
4211: <div class="LC_title_bar_role">
1.361 albertel 4212: $role
1.359 albertel 4213: </div>
4214: <div class="LC_title_bar_realm">
1.361 albertel 4215: $realm
1.359 albertel 4216: </div>
1.206 albertel 4217: </td>
4218: ENDROLE
1.235 raeburn 4219:
1.359 albertel 4220: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4221: if ($customtitle) {
4222: $titleinfo = $customtitle;
4223: }
4224: #
4225: # Extra info if you are the DC
4226: my $dc_info = '';
4227: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4228: $env{'course.'.$env{'request.course.id'}.
4229: '.domain'}.'/'})) {
4230: my $cid = $env{'request.course.id'};
4231: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4232: $dc_info =~ s/\s+$//;
1.359 albertel 4233: $dc_info = '('.$dc_info.')';
4234: }
4235:
1.644 www 4236: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4237: # No Remote
1.258 albertel 4238: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4239: $forcereg=1;
4240: }
4241:
4242: if (!$customtitle && $env{'request.state'} eq 'construct') {
4243: # this is for resources; directories have customtitle, and crumbs
4244: # and select recent are created in lonpubdir.pm
1.229 albertel 4245: my ($uname,$thisdisfn)=
1.258 albertel 4246: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4247: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4248: $formaction=~s/\/+/\//g;
4249:
1.359 albertel 4250: my $parentpath = '';
4251: my $lastitem = '';
4252: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4253: $parentpath = $1;
4254: $lastitem = $2;
4255: } else {
4256: $lastitem = $thisdisfn;
4257: }
4258: $titleinfo =
1.640 bisitz 4259: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4260: .'<b>'.&mt('Construction Space').'</b>: '
4261: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4262: .'" target="_top"><tt><b>'
1.705 tempelho 4263: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4264: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4265: .'</form>'
4266: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4267: }
1.359 albertel 4268:
1.337 albertel 4269: my $titletable;
1.338 albertel 4270: if (!$notitle) {
1.337 albertel 4271: $titletable =
1.359 albertel 4272: '<table id="LC_title_bar">'.
4273: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4274: '</tr></table>';
1.337 albertel 4275: }
1.359 albertel 4276: if ($notopbar) {
4277: $bodytag .= $titletable;
4278: } else {
4279: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4280: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4281: $titletable);
1.272 raeburn 4282: } else {
1.336 albertel 4283: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4284: $titletable;
1.272 raeburn 4285: }
1.235 raeburn 4286: }
4287: return $bodytag;
1.94 www 4288: }
1.95 www 4289:
1.93 www 4290: #
1.95 www 4291: # Top frame rendering, Remote is up
1.93 www 4292: #
1.359 albertel 4293:
1.517 raeburn 4294: my $imgsrc = $img;
4295: if ($img =~ /^\/adm/) {
1.575 albertel 4296: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4297: }
4298: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4299:
1.305 www 4300: # Explicit link to get inline menu
1.361 albertel 4301: my $menu= ($no_inline_link?''
4302: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4303: #
1.338 albertel 4304: if ($notitle) {
1.337 albertel 4305: return $bodytag;
4306: }
1.94 www 4307: return(<<ENDBODY);
1.60 matthew 4308: $bodytag
1.359 albertel 4309: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4310: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4311: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4312: </tr>
1.359 albertel 4313: <tr><td>$titleinfo $dc_info $menu</td>
4314: $roleinfo
1.368 albertel 4315: </tr>
1.356 albertel 4316: </table>
1.54 www 4317: ENDBODY
1.182 matthew 4318: }
4319:
1.330 albertel 4320: sub make_attr_string {
4321: my ($register,$attr_ref) = @_;
4322:
4323: if ($attr_ref && !ref($attr_ref)) {
4324: die("addentries Must be a hash ref ".
4325: join(':',caller(1))." ".
4326: join(':',caller(0))." ");
4327: }
4328:
4329: if ($register) {
1.339 albertel 4330: my ($on_load,$on_unload);
4331: foreach my $key (keys(%{$attr_ref})) {
4332: if (lc($key) eq 'onload') {
4333: $on_load.=$attr_ref->{$key}.';';
4334: delete($attr_ref->{$key});
4335:
4336: } elsif (lc($key) eq 'onunload') {
4337: $on_unload.=$attr_ref->{$key}.';';
4338: delete($attr_ref->{$key});
4339: }
4340: }
4341: $attr_ref->{'onload'} =
4342: &Apache::lonmenu::loadevents(). $on_load;
4343: $attr_ref->{'onunload'}=
4344: &Apache::lonmenu::unloadevents().$on_unload;
4345: }
4346:
4347: # Accessibility font enhance
4348: if ($env{'browser.fontenhance'} eq 'on') {
4349: my $style;
4350: foreach my $key (keys(%{$attr_ref})) {
4351: if (lc($key) eq 'style') {
4352: $style.=$attr_ref->{$key}.';';
4353: delete($attr_ref->{$key});
4354: }
4355: }
4356: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4357: }
1.339 albertel 4358:
4359: if ($env{'browser.blackwhite'} eq 'on') {
4360: delete($attr_ref->{'font'});
4361: delete($attr_ref->{'link'});
4362: delete($attr_ref->{'alink'});
4363: delete($attr_ref->{'vlink'});
4364: delete($attr_ref->{'bgcolor'});
4365: delete($attr_ref->{'background'});
4366: }
4367:
1.330 albertel 4368: my $attr_string;
4369: foreach my $attr (keys(%$attr_ref)) {
4370: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4371: }
4372: return $attr_string;
4373: }
4374:
4375:
1.182 matthew 4376: ###############################################
1.251 albertel 4377: ###############################################
4378:
4379: =pod
4380:
4381: =item * &endbodytag()
4382:
4383: Returns a uniform footer for LON-CAPA web pages.
4384:
1.635 raeburn 4385: Inputs: 1 - optional reference to an args hash
4386: If in the hash, key for noredirectlink has a value which evaluates to true,
4387: a 'Continue' link is not displayed if the page contains an
4388: internal redirect in the <head></head> section,
4389: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4390:
4391: =cut
4392:
4393: sub endbodytag {
1.635 raeburn 4394: my ($args) = @_;
1.251 albertel 4395: my $endbodytag='</body>';
1.269 albertel 4396: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4397: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4398: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4399: $endbodytag=
4400: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4401: &mt('Continue').'</a>'.
4402: $endbodytag;
4403: }
1.315 albertel 4404: }
1.251 albertel 4405: return $endbodytag;
4406: }
4407:
1.352 albertel 4408: =pod
4409:
4410: =item * &standard_css()
4411:
4412: Returns a style sheet
4413:
4414: Inputs: (all optional)
4415: domain -> force to color decorate a page for a specific
4416: domain
4417: function -> force usage of a specific rolish color scheme
4418: bgcolor -> override the default page bgcolor
4419:
4420: =cut
4421:
1.343 albertel 4422: sub standard_css {
1.345 albertel 4423: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4424: $function = &get_users_function() if (!$function);
4425: my $img = &designparm($function.'.img', $domain);
4426: my $tabbg = &designparm($function.'.tabbg', $domain);
4427: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4428: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4429: my $pgbg_or_bgcolor =
4430: $bgcolor ||
1.352 albertel 4431: &designparm($function.'.pgbg', $domain);
1.382 albertel 4432: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4433: my $alink = &designparm($function.'.alink', $domain);
4434: my $vlink = &designparm($function.'.vlink', $domain);
4435: my $link = &designparm($function.'.link', $domain);
4436:
1.704 muellerd 4437: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4438: my $bgcol = &designparm('login.bgcol',$domain);
4439: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4440:
1.602 albertel 4441: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4442: my $mono = 'monospace';
1.352 albertel 4443: my $data_table_head = $tabbg;
4444: my $data_table_light = '#EEEEEE';
1.470 banghart 4445: my $data_table_dark = '#DDDDDD';
4446: my $data_table_darker = '#CCCCCC';
1.349 albertel 4447: my $data_table_highlight = '#FFFF00';
1.352 albertel 4448: my $mail_new = '#FFBB77';
4449: my $mail_new_hover = '#DD9955';
4450: my $mail_read = '#BBBB77';
4451: my $mail_read_hover = '#999944';
4452: my $mail_replied = '#AAAA88';
4453: my $mail_replied_hover = '#888855';
4454: my $mail_other = '#99BBBB';
4455: my $mail_other_hover = '#669999';
1.391 albertel 4456: my $table_header = '#DDDDDD';
1.489 raeburn 4457: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4458: my $lg_border_color = '#C8C8C8';
1.392 albertel 4459:
1.608 albertel 4460: my $border = ($env{'browser.type'} eq 'explorer' ||
4461: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4462: : '0px 3px 0px 4px';
1.448 albertel 4463:
1.523 albertel 4464:
1.343 albertel 4465: return <<END;
1.698 harmsja 4466: body{
4467: font-family: $sans;
4468: line-height:130%;
1.701 harmsja 4469: font-size:0.83em;
1.698 harmsja 4470: color:$font;
4471: }
1.701 harmsja 4472: a:link, a:visited { font-size:100%; }
1.698 harmsja 4473:
1.343 albertel 4474: a:focus { color: red; background: yellow }
1.510 albertel 4475: table.thinborder,
4476: table.thinborder tr th {
4477: border-style: solid;
4478: border-width: 1px;
1.698 harmsja 4479: border-color: $lg_border_color;
1.510 albertel 4480: background: $tabbg;
4481: }
1.523 albertel 4482: table.thinborder tr td {
1.510 albertel 4483: border-style: solid;
1.698 harmsja 4484: border-width: 1px;
4485: border-color: $lg_border_color;
1.510 albertel 4486: }
1.426 albertel 4487:
1.343 albertel 4488: form, .inline { display: inline; }
1.721 harmsja 4489:
4490: .LC_center { text-align: center; }
4491: .LC_left { text-align:left; }
4492: .LC_right {text-align:right;}
4493: .LC_middle {vertical-align:middle;}
4494: .LC_top {vertical-align:top;}
4495: .LC_bottom {vertical-align:bottom;}
4496:
4497: /* just for tests */
4498: .LC_300Box { width:300px; }
4499: .LC_200Box {width:200px; }
4500: .LC_500Box {width:500px; }
4501: .LC_600Box {width:600px; }
4502: /* end */
4503:
1.593 albertel 4504: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4505: .LC_error {
4506: color: red;
4507: font-size: larger;
4508: }
1.457 albertel 4509: .LC_warning,
4510: .LC_diff_removed {
1.733 bisitz 4511: color: red;
1.394 albertel 4512: }
1.532 albertel 4513:
4514: .LC_info,
1.457 albertel 4515: .LC_success,
4516: .LC_diff_added {
1.350 albertel 4517: color: green;
4518: }
1.543 albertel 4519: .LC_unknown {
4520: color: yellow;
4521: }
4522:
1.440 albertel 4523: .LC_icon {
4524: border: 0px;
4525: }
1.539 albertel 4526: .LC_indexer_icon {
4527: border: 0px;
4528: height: 22px;
4529: }
1.543 albertel 4530: .LC_docs_spacer {
4531: width: 25px;
4532: height: 1px;
4533: border: 0px;
4534: }
1.346 albertel 4535:
1.532 albertel 4536: .LC_internal_info {
1.735 bisitz 4537: color: #999999;
1.532 albertel 4538: }
4539:
1.458 albertel 4540: table.LC_pastsubmission {
4541: border: 1px solid black;
4542: margin: 2px;
4543: }
4544:
1.606 albertel 4545: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4546: width: 100%;
4547: background: $pgbg;
1.392 albertel 4548: border: 2px;
1.402 albertel 4549: border-collapse: separate;
1.403 albertel 4550: padding: 0px;
1.345 albertel 4551: }
1.392 albertel 4552:
1.606 albertel 4553: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4554: table#LC_title_bar.LC_with_remote {
1.359 albertel 4555: width: 100%;
1.392 albertel 4556: border-color: $pgbg;
4557: border-style: solid;
4558: border-width: $border;
4559:
1.379 albertel 4560: background: $pgbg;
4561: font-family: $sans;
1.392 albertel 4562: border-collapse: collapse;
1.403 albertel 4563: padding: 0px;
1.359 albertel 4564: }
1.409 albertel 4565: table.LC_docs_path {
4566: width: 100%;
4567: border: 0;
4568: background: $pgbg;
4569: font-family: $sans;
4570: border-collapse: collapse;
4571: padding: 0px;
4572: }
4573:
1.359 albertel 4574: table#LC_title_bar td {
4575: background: $tabbg;
4576: }
4577: table#LC_title_bar td.LC_title_bar_who {
4578: background: $tabbg;
4579: color: $font;
1.427 albertel 4580: font: small $sans;
1.359 albertel 4581: text-align: right;
4582: }
1.469 banghart 4583: span.LC_metadata {
4584: font-family: $sans;
4585: }
1.359 albertel 4586: span.LC_title_bar_title {
1.416 albertel 4587: font: bold x-large $sans;
1.359 albertel 4588: }
4589: table#LC_title_bar td.LC_title_bar_domain_logo {
4590: background: $sidebg;
4591: text-align: right;
1.368 albertel 4592: padding: 0px;
4593: }
4594: table#LC_title_bar td.LC_title_bar_role_logo {
4595: background: $sidebg;
4596: padding: 0px;
1.359 albertel 4597: }
4598:
1.706 harmsja 4599: table#LC_menubuttons img{
1.346 albertel 4600: border: 0px;
4601: }
1.345 albertel 4602: table#LC_top_nav td {
4603: background: $tabbg;
1.392 albertel 4604: border: 0px;
1.407 albertel 4605: font-size: small;
1.706 harmsja 4606: vertical-align:top;
4607: padding:2px 5px 2px 5px;
1.345 albertel 4608: }
4609: table#LC_top_nav td a, div#LC_top_nav a {
4610: color: $font;
4611: font-family: $sans;
4612: }
1.364 albertel 4613: table#LC_top_nav td.LC_top_nav_logo {
4614: background: $tabbg;
1.432 albertel 4615: text-align: left;
1.408 albertel 4616: white-space: nowrap;
1.432 albertel 4617: width: 31px;
1.408 albertel 4618: }
4619: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4620: border: 0px;
1.408 albertel 4621: vertical-align: bottom;
1.364 albertel 4622: }
1.432 albertel 4623: table#LC_top_nav td.LC_top_nav_exit,
4624: table#LC_top_nav td.LC_top_nav_help {
4625: width: 2.0em;
4626: }
1.442 albertel 4627: table#LC_top_nav td.LC_top_nav_login {
4628: width: 4.0em;
4629: text-align: center;
4630: }
1.409 albertel 4631: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4632: background: $tabbg;
4633: color: $font;
4634: font-family: $sans;
1.358 albertel 4635: font-size: smaller;
1.357 albertel 4636: }
1.411 albertel 4637: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4638: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4639: background: $tabbg;
4640: color: $font;
4641: font-family: $sans;
4642: font-size: larger;
4643: text-align: right;
4644: }
1.383 albertel 4645: td.LC_table_cell_checkbox {
4646: text-align: center;
4647: }
1.522 albertel 4648: table#LC_mainmenu td.LC_mainmenu_column {
4649: vertical-align: top;
4650: }
4651:
1.705 tempelho 4652: .LC_fontsize_small
4653: {
4654: font-size: 70%;
4655: }
4656:
4657: .LC_fontsize_medium
4658: {
4659: font-size: 85%;
4660: }
4661:
4662: .LC_fontsize_large
4663: {
4664: font-size: 120%;
4665: }
4666:
4667: .LC_fontcolor_red
4668: {
4669: color: #FF0000;
4670: }
4671:
1.346 albertel 4672: .LC_menubuttons_inline_text {
4673: color: $font;
4674: font-family: $sans;
1.698 harmsja 4675: font-size: 90%;
1.701 harmsja 4676: padding-left:3px;
1.346 albertel 4677: }
4678:
1.526 www 4679: .LC_menubuttons_link {
4680: text-decoration: none;
4681: }
1.698 harmsja 4682: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4683: .LC_menubuttons_category {
1.521 www 4684: color: $font;
1.526 www 4685: background: $pgbg;
1.521 www 4686: font-family: $sans;
4687: font-size: larger;
4688: font-weight: bold;
4689: }
4690:
1.346 albertel 4691: td.LC_menubuttons_text {
1.701 harmsja 4692: color: $font;
1.346 albertel 4693: }
1.706 harmsja 4694:
4695:
1.526 www 4696:
1.346 albertel 4697: .LC_current_location {
4698: font-family: $sans;
4699: background: $tabbg;
4700: }
4701: .LC_new_mail {
4702: font-family: $sans;
1.634 www 4703: background: $tabbg;
1.346 albertel 4704: font-weight: bold;
4705: }
1.347 albertel 4706:
1.526 www 4707:
1.527 www 4708: .LC_dropadd_labeltext {
4709: font-family: $sans;
4710: text-align: right;
4711: }
4712:
4713: .LC_preferences_labeltext {
4714: font-family: $sans;
4715: text-align: right;
4716: }
4717:
1.666 raeburn 4718: .LC_roleslog_note {
1.701 harmsja 4719: font-size: small;
1.666 raeburn 4720: }
4721:
1.715 raeburn 4722: .LC_mail_functions {
4723: font-weight: bold;
4724: }
4725:
1.440 albertel 4726: table.LC_aboutme_port {
4727: border: 0px;
4728: border-collapse: collapse;
4729: border-spacing: 0px;
4730: }
1.349 albertel 4731: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4732: border: 1px solid #000000;
1.402 albertel 4733: border-collapse: separate;
1.426 albertel 4734: border-spacing: 1px;
1.610 albertel 4735: background: $pgbg;
1.347 albertel 4736: }
1.422 albertel 4737: .LC_data_table_dense {
4738: font-size: small;
4739: }
1.507 raeburn 4740: table.LC_nested_outer {
4741: border: 1px solid #000000;
1.589 raeburn 4742: border-collapse: collapse;
1.507 raeburn 4743: border-spacing: 0px;
4744: width: 100%;
4745: }
4746: table.LC_nested {
4747: border: 0px;
1.589 raeburn 4748: border-collapse: collapse;
1.507 raeburn 4749: border-spacing: 0px;
4750: width: 100%;
4751: }
1.523 albertel 4752: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4753: table.LC_prior_tries tr th {
1.349 albertel 4754: font-weight: bold;
4755: background-color: $data_table_head;
1.701 harmsja 4756: font-size:90%;
1.347 albertel 4757: }
1.711 raeburn 4758: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4759: background-color: #CCCCCC;
1.711 raeburn 4760: font-weight: bold;
4761: text-align: left;
4762: }
1.610 albertel 4763: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4764: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4765: table.LC_aboutme_port tr td {
1.349 albertel 4766: background-color: $data_table_light;
1.425 albertel 4767: padding: 2px;
1.347 albertel 4768: }
1.610 albertel 4769: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4770: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4771: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4772: background-color: $data_table_dark;
1.709 bisitz 4773: padding: 2px;
1.347 albertel 4774: }
1.425 albertel 4775: table.LC_data_table tr.LC_data_table_highlight td {
4776: background-color: $data_table_darker;
4777: }
1.639 raeburn 4778: table.LC_data_table tr td.LC_leftcol_header {
4779: background-color: $data_table_head;
4780: font-weight: bold;
4781: }
1.451 albertel 4782: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4783: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4784: background-color: #FFFFFF;
1.421 albertel 4785: font-weight: bold;
4786: font-style: italic;
4787: text-align: center;
4788: padding: 8px;
1.347 albertel 4789: }
1.507 raeburn 4790: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4791: padding: 4ex
4792: }
1.507 raeburn 4793: table.LC_nested_outer tr th {
4794: font-weight: bold;
4795: background-color: $data_table_head;
1.701 harmsja 4796: font-size: small;
1.507 raeburn 4797: border-bottom: 1px solid #000000;
4798: }
4799: table.LC_nested_outer tr td.LC_subheader {
4800: background-color: $data_table_head;
4801: font-weight: bold;
4802: font-size: small;
4803: border-bottom: 1px solid #000000;
4804: text-align: right;
1.451 albertel 4805: }
1.507 raeburn 4806: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4807: background-color: #CCCCCC;
1.451 albertel 4808: font-weight: bold;
4809: font-size: small;
1.507 raeburn 4810: text-align: center;
4811: }
1.589 raeburn 4812: table.LC_nested tr.LC_info_row td.LC_left_item,
4813: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4814: text-align: left;
1.451 albertel 4815: }
1.507 raeburn 4816: table.LC_nested td {
1.735 bisitz 4817: background-color: #FFFFFF;
1.451 albertel 4818: font-size: small;
1.507 raeburn 4819: }
4820: table.LC_nested_outer tr th.LC_right_item,
4821: table.LC_nested tr.LC_info_row td.LC_right_item,
4822: table.LC_nested tr.LC_odd_row td.LC_right_item,
4823: table.LC_nested tr td.LC_right_item {
1.451 albertel 4824: text-align: right;
4825: }
4826:
1.507 raeburn 4827: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4828: background-color: #EEEEEE;
1.451 albertel 4829: }
4830:
1.473 raeburn 4831: table.LC_createuser {
4832: }
4833:
4834: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4835: font-size: small;
1.473 raeburn 4836: }
4837:
4838: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 4839: background-color: #CCCCCC;
1.473 raeburn 4840: font-weight: bold;
4841: text-align: center;
4842: }
4843:
1.349 albertel 4844: table.LC_calendar {
4845: border: 1px solid #000000;
4846: border-collapse: collapse;
4847: }
4848: table.LC_calendar_pickdate {
4849: font-size: xx-small;
4850: }
4851: table.LC_calendar tr td {
4852: border: 1px solid #000000;
4853: vertical-align: top;
4854: }
4855: table.LC_calendar tr td.LC_calendar_day_empty {
4856: background-color: $data_table_dark;
4857: }
4858: table.LC_calendar tr td.LC_calendar_day_current {
4859: background-color: $data_table_highlight;
4860: }
4861:
4862: table.LC_mail_list tr.LC_mail_new {
4863: background-color: $mail_new;
4864: }
4865: table.LC_mail_list tr.LC_mail_new:hover {
4866: background-color: $mail_new_hover;
4867: }
4868: table.LC_mail_list tr.LC_mail_read {
4869: background-color: $mail_read;
4870: }
4871: table.LC_mail_list tr.LC_mail_read:hover {
4872: background-color: $mail_read_hover;
4873: }
4874: table.LC_mail_list tr.LC_mail_replied {
4875: background-color: $mail_replied;
4876: }
4877: table.LC_mail_list tr.LC_mail_replied:hover {
4878: background-color: $mail_replied_hover;
4879: }
4880: table.LC_mail_list tr.LC_mail_other {
4881: background-color: $mail_other;
4882: }
4883: table.LC_mail_list tr.LC_mail_other:hover {
4884: background-color: $mail_other_hover;
4885: }
1.494 raeburn 4886: table.LC_mail_list tr.LC_mail_even {
4887: }
4888: table.LC_mail_list tr.LC_mail_odd {
4889: }
4890:
1.696 bisitz 4891: table.LC_data_table tr > td.LC_browser_file,
4892: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4893: background: #CCFF88;
4894: }
1.696 bisitz 4895: table.LC_data_table tr > td.LC_browser_file_locked,
4896: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4897: background: #FFAA99;
1.387 albertel 4898: }
1.696 bisitz 4899: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4900: background: #AAAAAA;
1.387 albertel 4901: }
1.696 bisitz 4902: table.LC_data_table tr > td.LC_browser_file_modified,
4903: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4904: background: #FFFF77;
1.387 albertel 4905: }
1.696 bisitz 4906: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4907: background: #CCCCFF;
1.387 albertel 4908: }
1.696 bisitz 4909:
1.707 bisitz 4910: table.LC_data_table tr > td.LC_roles_is {
4911: /* background: #77FF77; */
4912: }
4913: table.LC_data_table tr > td.LC_roles_future {
4914: background: #FFFF77;
4915: }
4916: table.LC_data_table tr > td.LC_roles_will {
4917: background: #FFAA77;
4918: }
4919: table.LC_data_table tr > td.LC_roles_expired {
4920: background: #FF7777;
4921: }
4922: table.LC_data_table tr > td.LC_roles_will_not {
4923: background: #AAFF77;
4924: }
4925: table.LC_data_table tr > td.LC_roles_selected {
4926: background: #11CC55;
4927: }
4928:
1.388 albertel 4929: span.LC_current_location {
1.701 harmsja 4930: font-size:larger;
1.388 albertel 4931: background: $pgbg;
4932: }
1.387 albertel 4933:
1.395 albertel 4934: span.LC_parm_menu_item {
4935: font-size: larger;
4936: font-family: $sans;
4937: }
4938: span.LC_parm_scope_all {
4939: color: red;
4940: }
4941: span.LC_parm_scope_folder {
4942: color: green;
4943: }
4944: span.LC_parm_scope_resource {
4945: color: orange;
4946: }
4947: span.LC_parm_part {
4948: color: blue;
4949: }
4950: span.LC_parm_folder, span.LC_parm_symb {
4951: font-size: x-small;
4952: font-family: $mono;
4953: color: #AAAAAA;
4954: }
4955:
1.396 albertel 4956: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4957: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4958: border: 1px solid black;
4959: border-collapse: collapse;
4960: }
4961: table.LC_parm_overview_restrictions td {
4962: border-width: 1px 4px 1px 4px;
4963: border-style: solid;
4964: border-color: $pgbg;
4965: text-align: center;
4966: }
4967: table.LC_parm_overview_restrictions th {
4968: background: $tabbg;
4969: border-width: 1px 4px 1px 4px;
4970: border-style: solid;
4971: border-color: $pgbg;
4972: }
1.398 albertel 4973: table#LC_helpmenu {
4974: border: 0px;
4975: height: 55px;
4976: border-spacing: 0px;
4977: }
4978:
4979: table#LC_helpmenu fieldset legend {
4980: font-size: larger;
4981: font-weight: bold;
4982: }
1.397 albertel 4983: table#LC_helpmenu_links {
4984: width: 100%;
4985: border: 1px solid black;
4986: background: $pgbg;
4987: padding: 0px;
4988: border-spacing: 1px;
4989: }
4990: table#LC_helpmenu_links tr td {
4991: padding: 1px;
4992: background: $tabbg;
1.399 albertel 4993: text-align: center;
4994: font-weight: bold;
1.397 albertel 4995: }
1.396 albertel 4996:
1.397 albertel 4997: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4998: table#LC_helpmenu_links a:active {
4999: text-decoration: none;
5000: color: $font;
5001: }
5002: table#LC_helpmenu_links a:hover {
5003: text-decoration: underline;
5004: color: $vlink;
5005: }
1.396 albertel 5006:
1.417 albertel 5007: .LC_chrt_popup_exists {
5008: border: 1px solid #339933;
5009: margin: -1px;
5010: }
5011: .LC_chrt_popup_up {
5012: border: 1px solid yellow;
5013: margin: -1px;
5014: }
5015: .LC_chrt_popup {
5016: border: 1px solid #8888FF;
5017: background: #CCCCFF;
5018: }
1.421 albertel 5019: table.LC_pick_box {
5020: border-collapse: separate;
5021: background: white;
5022: border: 1px solid black;
5023: border-spacing: 1px;
5024: }
5025: table.LC_pick_box td.LC_pick_box_title {
5026: background: $tabbg;
5027: font-weight: bold;
5028: text-align: right;
5029: width: 184px;
5030: padding: 8px;
5031: }
1.645 raeburn 5032: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5033: background: $tabbg;
5034: font-weight: bold;
5035: text-align: right;
5036: width: 350px;
5037: padding: 8px;
5038: }
5039:
1.579 raeburn 5040: table.LC_pick_box td.LC_pick_box_value {
5041: text-align: left;
5042: padding: 8px;
5043: }
5044: table.LC_pick_box td.LC_pick_box_select {
5045: text-align: left;
5046: padding: 8px;
5047: }
1.424 albertel 5048: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5049: padding: 0px;
5050: height: 1px;
5051: background: black;
5052: }
5053: table.LC_pick_box td.LC_pick_box_submit {
5054: text-align: right;
5055: }
1.579 raeburn 5056: table.LC_pick_box td.LC_evenrow_value {
5057: text-align: left;
5058: padding: 8px;
5059: background-color: $data_table_light;
5060: }
5061: table.LC_pick_box td.LC_oddrow_value {
5062: text-align: left;
5063: padding: 8px;
5064: background-color: $data_table_light;
5065: }
5066: table.LC_helpform_receipt {
5067: width: 620px;
5068: border-collapse: separate;
5069: background: white;
5070: border: 1px solid black;
5071: border-spacing: 1px;
5072: }
5073: table.LC_helpform_receipt td.LC_pick_box_title {
5074: background: $tabbg;
5075: font-weight: bold;
5076: text-align: right;
5077: width: 184px;
5078: padding: 8px;
5079: }
5080: table.LC_helpform_receipt td.LC_evenrow_value {
5081: text-align: left;
5082: padding: 8px;
5083: background-color: $data_table_light;
5084: }
5085: table.LC_helpform_receipt td.LC_oddrow_value {
5086: text-align: left;
5087: padding: 8px;
5088: background-color: $data_table_light;
5089: }
5090: table.LC_helpform_receipt td.LC_pick_box_separator {
5091: padding: 0px;
5092: height: 1px;
5093: background: black;
5094: }
5095: span.LC_helpform_receipt_cat {
5096: font-weight: bold;
5097: }
1.424 albertel 5098: table.LC_group_priv_box {
5099: background: white;
5100: border: 1px solid black;
5101: border-spacing: 1px;
5102: }
5103: table.LC_group_priv_box td.LC_pick_box_title {
5104: background: $tabbg;
5105: font-weight: bold;
5106: text-align: right;
5107: width: 184px;
5108: }
5109: table.LC_group_priv_box td.LC_groups_fixed {
5110: background: $data_table_light;
5111: text-align: center;
5112: }
5113: table.LC_group_priv_box td.LC_groups_optional {
5114: background: $data_table_dark;
5115: text-align: center;
5116: }
5117: table.LC_group_priv_box td.LC_groups_functionality {
5118: background: $data_table_darker;
5119: text-align: center;
5120: font-weight: bold;
5121: }
5122: table.LC_group_priv td {
5123: text-align: left;
5124: padding: 0px;
5125: }
5126:
1.421 albertel 5127: table.LC_notify_front_page {
5128: background: white;
5129: border: 1px solid black;
5130: padding: 8px;
5131: }
5132: table.LC_notify_front_page td {
5133: padding: 8px;
5134: }
1.424 albertel 5135: .LC_navbuttons {
5136: margin: 2ex 0ex 2ex 0ex;
5137: }
1.423 albertel 5138: .LC_topic_bar {
5139: font-family: $sans;
5140: font-weight: bold;
5141: width: 100%;
5142: background: $tabbg;
5143: vertical-align: middle;
5144: margin: 2ex 0ex 2ex 0ex;
5145: }
5146: .LC_topic_bar span {
5147: vertical-align: middle;
5148: }
5149: .LC_topic_bar img {
5150: vertical-align: bottom;
5151: }
5152: table.LC_course_group_status {
5153: margin: 20px;
5154: }
5155: table.LC_status_selector td {
5156: vertical-align: top;
5157: text-align: center;
1.424 albertel 5158: padding: 4px;
5159: }
5160: table.LC_descriptive_input td.LC_description {
5161: vertical-align: top;
5162: text-align: right;
5163: font-weight: bold;
1.423 albertel 5164: }
1.599 albertel 5165: div.LC_feedback_link {
1.616 albertel 5166: clear: both;
1.599 albertel 5167: background: white;
5168: width: 100%;
1.489 raeburn 5169: }
5170: span.LC_feedback_link {
1.599 albertel 5171: background: $feedback_link_bg;
5172: font-size: larger;
5173: }
5174: span.LC_message_link {
5175: background: $feedback_link_bg;
5176: font-size: larger;
5177: position: absolute;
5178: right: 1em;
1.489 raeburn 5179: }
1.421 albertel 5180:
1.515 albertel 5181: table.LC_prior_tries {
1.524 albertel 5182: border: 1px solid #000000;
5183: border-collapse: separate;
5184: border-spacing: 1px;
1.515 albertel 5185: }
1.523 albertel 5186:
1.515 albertel 5187: table.LC_prior_tries td {
1.524 albertel 5188: padding: 2px;
1.515 albertel 5189: }
1.523 albertel 5190:
5191: .LC_answer_correct {
5192: background: #AAFFAA;
5193: color: black;
5194: }
5195: .LC_answer_charged_try {
5196: background: #FFAAAA ! important;
5197: color: black;
5198: }
5199: .LC_answer_not_charged_try,
5200: .LC_answer_no_grade,
5201: .LC_answer_late {
5202: background: #FFFFAA;
5203: color: black;
5204: }
5205: .LC_answer_previous {
5206: background: #AAAAFF;
5207: color: black;
5208: }
5209: .LC_answer_no_message {
5210: background: #FFFFFF;
5211: color: black;
5212: }
5213: .LC_answer_unknown {
5214: background: orange;
5215: color: black;
5216: }
5217:
5218:
1.529 albertel 5219: span.LC_prior_numerical,
5220: span.LC_prior_string,
5221: span.LC_prior_custom,
5222: span.LC_prior_reaction,
5223: span.LC_prior_math {
1.523 albertel 5224: font-family: monospace;
5225: white-space: pre;
5226: }
5227:
1.525 albertel 5228: span.LC_prior_string {
5229: font-family: monospace;
5230: white-space: pre;
5231: }
5232:
1.523 albertel 5233: table.LC_prior_option {
5234: width: 100%;
5235: border-collapse: collapse;
5236: }
1.528 albertel 5237: table.LC_prior_rank, table.LC_prior_match {
5238: border-collapse: collapse;
5239: }
5240: table.LC_prior_option tr td,
5241: table.LC_prior_rank tr td,
5242: table.LC_prior_match tr td {
1.524 albertel 5243: border: 1px solid #000000;
1.515 albertel 5244: }
5245:
1.519 raeburn 5246: span.LC_nobreak {
1.544 albertel 5247: white-space: nowrap;
1.519 raeburn 5248: }
5249:
1.576 raeburn 5250: span.LC_cusr_emph {
5251: font-style: italic;
5252: }
5253:
1.633 raeburn 5254: span.LC_cusr_subheading {
5255: font-weight: normal;
5256: font-size: 85%;
5257: }
5258:
1.545 albertel 5259: table.LC_docs_documents {
5260: background: #BBBBBB;
1.547 albertel 5261: border-width: 0px;
1.545 albertel 5262: border-collapse: collapse;
5263: }
5264:
5265: table.LC_docs_documents td.LC_docs_document {
5266: border: 2px solid black;
5267: padding: 4px;
5268: }
5269:
5270: .LC_docs_entry_move {
5271: border: 0px;
5272: border-collapse: collapse;
1.544 albertel 5273: }
5274:
1.545 albertel 5275: .LC_docs_entry_move td {
5276: border: 2px solid #BBBBBB;
5277: background: #DDDDDD;
5278: }
5279:
5280: .LC_docs_editor td.LC_docs_entry_commands {
5281: background: #DDDDDD;
5282: font-size: x-small;
5283: }
1.544 albertel 5284: .LC_docs_copy {
1.545 albertel 5285: color: #000099;
1.544 albertel 5286: }
5287: .LC_docs_cut {
1.545 albertel 5288: color: #550044;
1.544 albertel 5289: }
5290: .LC_docs_rename {
1.545 albertel 5291: color: #009900;
1.544 albertel 5292: }
5293: .LC_docs_remove {
1.545 albertel 5294: color: #990000;
5295: }
5296:
1.547 albertel 5297: .LC_docs_reinit_warn,
5298: .LC_docs_ext_edit {
5299: font-size: x-small;
5300: }
5301:
1.545 albertel 5302: .LC_docs_editor td.LC_docs_entry_title,
5303: .LC_docs_editor td.LC_docs_entry_icon {
5304: background: #FFFFBB;
5305: }
5306: .LC_docs_editor td.LC_docs_entry_parameter {
5307: background: #BBBBFF;
5308: font-size: x-small;
5309: white-space: nowrap;
5310: }
5311:
5312: table.LC_docs_adddocs td,
5313: table.LC_docs_adddocs th {
5314: border: 1px solid #BBBBBB;
5315: padding: 4px;
5316: background: #DDDDDD;
1.543 albertel 5317: }
5318:
1.584 albertel 5319: table.LC_sty_begin {
5320: background: #BBFFBB;
5321: }
5322: table.LC_sty_end {
5323: background: #FFBBBB;
5324: }
5325:
1.589 raeburn 5326: table.LC_double_column {
5327: border-width: 0px;
5328: border-collapse: collapse;
5329: width: 100%;
5330: padding: 2px;
5331: }
5332:
5333: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5334: top: 2px;
1.589 raeburn 5335: left: 2px;
5336: width: 47%;
5337: vertical-align: top;
5338: }
5339:
5340: table.LC_double_column tr td.LC_right_col {
5341: top: 2px;
5342: right: 2px;
5343: width: 47%;
5344: vertical-align: top;
5345: }
5346:
1.594 raeburn 5347: span.LC_role_level {
5348: font-weight: bold;
5349: }
5350:
1.591 raeburn 5351: div.LC_left_float {
5352: float: left;
5353: padding-right: 5%;
1.597 albertel 5354: padding-bottom: 4px;
1.591 raeburn 5355: }
5356:
5357: div.LC_clear_float_header {
1.597 albertel 5358: padding-bottom: 2px;
1.591 raeburn 5359: }
5360:
5361: div.LC_clear_float_footer {
1.597 albertel 5362: padding-top: 10px;
1.591 raeburn 5363: clear: both;
5364: }
5365:
1.597 albertel 5366:
5367: div.LC_grade_show_user {
5368: margin-top: 20px;
5369: border: 1px solid black;
5370: }
5371: div.LC_grade_user_name {
5372: background: #DDDDEE;
5373: border-bottom: 1px solid black;
1.705 tempelho 5374: font-weight: bold;
5375: font-size: large;
1.597 albertel 5376: }
5377: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5378: background: #DDEEDD;
5379: }
5380:
5381: div.LC_grade_show_problem,
5382: div.LC_grade_submissions,
5383: div.LC_grade_message_center,
5384: div.LC_grade_info_links,
5385: div.LC_grade_assign {
5386: margin: 5px;
5387: width: 99%;
5388: background: #FFFFFF;
5389: }
5390: div.LC_grade_show_problem_header,
5391: div.LC_grade_submissions_header,
5392: div.LC_grade_message_center_header,
5393: div.LC_grade_assign_header {
1.705 tempelho 5394: font-weight: bold;
5395: font-size: large;
1.597 albertel 5396: }
5397: div.LC_grade_show_problem_problem,
5398: div.LC_grade_submissions_body,
5399: div.LC_grade_message_center_body,
5400: div.LC_grade_assign_body {
5401: border: 1px solid black;
5402: width: 99%;
5403: background: #FFFFFF;
5404: }
1.598 albertel 5405: span.LC_grade_check_note {
1.705 tempelho 5406: font-weight: normal;
5407: font-size: medium;
1.598 albertel 5408: display: inline;
5409: position: absolute;
5410: right: 1em;
5411: }
1.597 albertel 5412:
1.613 albertel 5413: table.LC_scantron_action {
5414: width: 100%;
5415: }
5416: table.LC_scantron_action tr th {
1.698 harmsja 5417: font-weight:bold;
5418: font-style:normal;
1.613 albertel 5419: }
1.698 harmsja 5420: .LC_edit_problem_header,
1.614 albertel 5421: div.LC_edit_problem_footer {
1.705 tempelho 5422: font-weight: normal;
5423: font-size: medium;
1.602 albertel 5424: margin: 2px;
1.600 albertel 5425: }
5426: div.LC_edit_problem_header,
1.602 albertel 5427: div.LC_edit_problem_header div,
1.614 albertel 5428: div.LC_edit_problem_footer,
5429: div.LC_edit_problem_footer div,
1.602 albertel 5430: div.LC_edit_problem_editxml_header,
5431: div.LC_edit_problem_editxml_header div {
1.600 albertel 5432: margin-top: 5px;
5433: }
1.602 albertel 5434: div.LC_edit_problem_header_edit_row {
5435: background: $tabbg;
5436: padding: 3px;
5437: margin-bottom: 5px;
5438: }
1.600 albertel 5439: div.LC_edit_problem_header_title {
1.705 tempelho 5440: font-weight: bold;
5441: font-size: larger;
1.602 albertel 5442: background: $tabbg;
5443: padding: 3px;
5444: }
5445: table.LC_edit_problem_header_title {
1.705 tempelho 5446: font-size: larger;
5447: font-weight: bold;
1.602 albertel 5448: width: 100%;
5449: border-color: $pgbg;
5450: border-style: solid;
5451: border-width: $border;
5452:
1.600 albertel 5453: background: $tabbg;
1.602 albertel 5454: border-collapse: collapse;
5455: padding: 0px
5456: }
5457:
5458: div.LC_edit_problem_discards {
5459: float: left;
5460: padding-bottom: 5px;
5461: }
5462: div.LC_edit_problem_saves {
5463: float: right;
5464: padding-bottom: 5px;
1.600 albertel 5465: }
5466: hr.LC_edit_problem_divide {
1.602 albertel 5467: clear: both;
1.600 albertel 5468: color: $tabbg;
5469: background-color: $tabbg;
5470: height: 3px;
5471: border: 0px;
5472: }
1.679 riegler 5473: img.stift{
1.678 riegler 5474: border-width:0;
1.679 riegler 5475: vertical-align:middle;
1.677 riegler 5476: }
1.680 riegler 5477:
1.681 riegler 5478: table#LC_mainmenu{
5479: margin-top:10px;
5480: width:80%;
5481:
5482: }
5483:
1.680 riegler 5484: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5485: vertical-align: top;
5486: width: 45%;
5487: }
5488: .LC_mainmenu_fieldset_category {
5489: color: $font;
5490: background: $pgbg;
5491: font-family: $sans;
5492: font-size: small;
5493: font-weight: bold;
5494: }
5495:
1.716 raeburn 5496: div.LC_createcourse {
5497: margin: 10px 10px 10px 10px;
5498: }
5499:
1.693 droeschl 5500: /* ---- Remove when done ----
5501: # The following styles is part of the redesign of LON-CAPA and are
5502: # subject to change during this project.
5503: # Don't rely on their current functionality as they might be
5504: # changed or removed.
5505: # --------------------------*/
5506:
1.698 harmsja 5507: a:hover,
1.721 harmsja 5508: ol.LC_smallMenu a:hover,
5509: ol#LC_MenuBreadcrumbs a:hover,
5510: ol#LC_PathBreadcrumbs a:hover,
5511: ul#LC_TabMainMenuContent a:hover,
5512: .LC_FormSectionClearButton input:hover
5513: ul.LC_TabContent li:hover a{
1.698 harmsja 5514: color:#BF2317;
5515: text-decoration:none;
1.693 droeschl 5516: }
5517:
5518: h1 {
1.721 harmsja 5519: padding:5px 10px 5px 20px;
1.693 droeschl 5520: line-height:130%;
5521: }
1.698 harmsja 5522:
1.693 droeschl 5523: h2,h3,h4,h5,h6
5524: {
1.721 harmsja 5525: margin:5px 0px 5px 0px;
5526: padding:0px;
5527: line-height:130%;
1.693 droeschl 5528: }
1.721 harmsja 5529: .LC_hcell{
1.698 harmsja 5530: padding:3px 15px 3px 15px;
5531: margin:0px;
1.703 harmsja 5532: background-color:$tabbg;
5533: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5534: }
1.721 harmsja 5535: .LC_noBorder {
1.698 harmsja 5536: border:0px;
5537: }
1.693 droeschl 5538:
1.722 harmsja 5539: .LC_bgLightGrey{
1.723 riegler 5540: background:URL(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.722 harmsja 5541: }
5542: .LC_bgLightGreyYellow {
5543: background-color:#EFECE0;
5544: }
1.693 droeschl 5545:
1.698 harmsja 5546: /* Main Header with discription of Person, Course, etc. */
1.721 harmsja 5547: .LC_HeadRight {
1.693 droeschl 5548: text-align: right;
5549: float: right;
5550: margin: 0px;
5551: padding: 0px;
1.698 harmsja 5552: right:0;
1.693 droeschl 5553: position:absolute;
1.698 harmsja 5554: overflow:hidden;
1.693 droeschl 5555: }
5556:
1.721 harmsja 5557: p, .LC_ContentBox {
1.698 harmsja 5558: padding: 10px;
5559:
5560: }
1.721 harmsja 5561: .LC_FormSectionClearButton input {
5562:
1.698 harmsja 5563: border:0px;
5564: cursor:pointer;
5565: text-decoration:underline;
1.693 droeschl 5566: }
5567:
5568:
1.698 harmsja 5569: dl,ul,div,fieldset {
5570: margin: 10px 10px 10px 0px;
1.693 droeschl 5571: overflow:hidden;
5572: }
1.721 harmsja 5573: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698 harmsja 5574: margin: 0px;
1.693 droeschl 5575: }
5576:
1.721 harmsja 5577: ol.LC_smallMenu li {
1.693 droeschl 5578: display: inline;
5579: padding: 5px 5px 0px 10px;
5580: vertical-align: top;
5581: }
5582:
1.721 harmsja 5583: ol.LC_smallMenu li img {
1.693 droeschl 5584: vertical-align: bottom;
5585: }
5586:
1.721 harmsja 5587: ol.LC_smallMenu a {
1.693 droeschl 5588: font-size: 90%;
5589: color: RGB(80, 80, 80);
5590: text-decoration: none;
5591: }
5592:
1.721 harmsja 5593: ol#LC_TabMainMenuContent {
5594: display:block;
5595: list-style:none;
1.693 droeschl 5596: margin: 0px 0px 10px 0px;
5597: padding: 0px;
5598: }
5599:
1.721 harmsja 5600: ol#LC_TabMainMenuContent li {
1.693 droeschl 5601: display: inline;
5602: vertical-align: bottom;
5603: border-bottom: solid 1px RGB(175, 175, 175);
5604: border-right: solid 1px RGB(175, 175, 175);
1.721 harmsja 5605: padding: 5px 10px 5px 10px;
5606: margin-right:3px;
1.693 droeschl 5607: line-height: 140%;
5608: font-weight: bold;
1.721 harmsja 5609: white-space:nowrap;
1.723 riegler 5610: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5611: }
5612:
1.721 harmsja 5613: ol#LC_TabMainMenuContent li a{
1.693 droeschl 5614: color: RGB(47, 47, 47);
5615: text-decoration: none;
5616: }
1.721 harmsja 5617: ul.LC_TabContent {
5618: margin:0px;
5619: padding:0px;
5620: display:block;
5621: list-style:none;
5622: min-height:1.5em;
5623: }
5624: ul.LC_TabContent li{
5625: display:inline;
5626: vertical-align:top;
5627: border-bottom:solid 1px $lg_border_color;
5628: border-right:solid 1px $lg_border_color;
5629: padding:5px 10px 5px 10px;
5630: margin-right:2px;
1.723 riegler 5631: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.721 harmsja 5632: }
5633: ul.LC_TabContent li a, ul.LC_TabContent li{
5634: color:rgb(47,47,47);
5635: text-decoration:none;
5636: font-size:95%;
5637: font-weight:bold;
5638: white-space:nowrap;
5639: }
1.738 tempelho 5640:
5641: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.737 tempelho 5642: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5643: color:#BF2317;
5644: text-decoration:none;
5645: }
5646:
1.721 harmsja 5647: .LC_hideThis
5648: {
5649: display:none;
5650: visibility:hidden;
1.693 droeschl 5651: }
5652:
1.721 harmsja 5653: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs {
1.693 droeschl 5654: border-top: solid 1px RGB(255, 255, 255);
5655: height: 20px;
5656: line-height: 20px;
5657: vertical-align: bottom;
5658: margin: 0px 0px 30px 0px;
5659: padding-left: 10px;
5660: list-style-position: inside;
1.723 riegler 5661: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5662: }
5663:
1.721 harmsja 5664: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li {
1.723 riegler 5665: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.693 droeschl 5666: display: inline;
5667: padding: 0px 0px 0px 10px;
5668: vertical-align: bottom;
5669: overflow:hidden;
5670: }
5671:
1.721 harmsja 5672: ol#LC_MenuBreadcrumbs li a {
1.693 droeschl 5673: text-decoration: none;
5674: font-size:90%;
5675: }
1.721 harmsja 5676: ol#LC_PathBreadcrumbs li a{
1.698 harmsja 5677: text-decoration:none;
5678: font-size:100%;
5679: font-weight:bold;
1.693 droeschl 5680: }
1.721 harmsja 5681: .LC_ContentBoxSpecial
1.693 droeschl 5682: {
1.701 harmsja 5683: border: solid 1px $lg_border_color;
1.698 harmsja 5684: }
1.721 harmsja 5685: .LC_PopUp
1.693 droeschl 5686: {
1.698 harmsja 5687: padding:10px;
5688: border-left:solid 1px $lg_border_color;
5689: border-top:solid 1px $lg_border_color;
5690: border-bottom:outset 1px $lg_border_color;
5691: border-right:outset 1px $lg_border_color;
5692: display:none;
5693: position:absolute;
5694: right:0;
5695: background-color:white;
5696: z-index:5;
1.693 droeschl 5697: }
5698:
1.721 harmsja 5699: dl.LC_ListStyleClean dt {
1.693 droeschl 5700: padding-right: 5px;
5701: display: table-header-group;
5702: }
5703:
1.721 harmsja 5704: dl.LC_ListStyleClean dd {
1.693 droeschl 5705: display: table-row;
5706: }
5707:
1.721 harmsja 5708: .LC_ListStyleClean,
5709: .LC_ListStyleSimple,
5710: .LC_ListStyleNormal,
5711: .LC_ListStyleNormal_Border,
5712: .LC_ListStyleSpecial
1.693 droeschl 5713: {
5714: /*display:block; */
5715: list-style-position: inside;
5716: list-style-type: none;
5717: overflow: hidden;
5718: padding: 0px;
5719: }
5720:
1.721 harmsja 5721: .LC_ListStyleSimple li,
5722: .LC_ListStyleSimple dd,
5723: .LC_ListStyleNormal li,
5724: .LC_ListStyleNormal dd,
5725: .LC_ListStyleSpecial li,
5726: .LC_ListStyleSpecial dd
1.693 droeschl 5727: {
5728: margin: 0px;
5729: padding: 5px 5px 5px 10px;
5730: clear: both;
5731: }
5732:
1.721 harmsja 5733: .LC_ListStyleClean li,
5734: .LC_ListStyleClean dd {
1.693 droeschl 5735: padding-top: 0px;
5736: padding-bottom: 0px;
5737: }
5738:
1.721 harmsja 5739: .LC_ListStyleSimple dd,
5740: .LC_ListStyleSimple li{
1.698 harmsja 5741: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5742: }
5743:
1.721 harmsja 5744: .LC_ListStyleSpecial li,
5745: .LC_ListStyleSpecial dd {
1.693 droeschl 5746: list-style-type: none;
5747: background-color: RGB(220, 220, 220);
5748: margin-bottom: 4px;
5749: }
5750:
1.721 harmsja 5751: table.LC_SimpleTable {
1.698 harmsja 5752: margin:5px;
5753: border:solid 1px $lg_border_color;
1.693 droeschl 5754: }
5755:
1.721 harmsja 5756: table.LC_SimpleTable tr {
1.698 harmsja 5757: padding:0px;
5758: border:solid 1px $lg_border_color;
1.693 droeschl 5759: }
1.721 harmsja 5760: table.LC_SimpleTable thead{
1.698 harmsja 5761: background:rgb(220,220,220);
1.693 droeschl 5762: }
5763:
1.721 harmsja 5764: div.LC_columnSection {
1.693 droeschl 5765: display: block;
5766: clear: both;
5767: overflow: hidden;
5768: margin:0px;
5769: }
5770:
1.721 harmsja 5771: div.LC_columnSection>* {
1.693 droeschl 5772: float: left;
5773: margin: 10px 20px 10px 0px;
5774: overflow:hidden;
5775: }
1.721 harmsja 5776: div.LC_columnSection > .LC_ContentBox,
5777: div.LC_columnSection > .LC_ContentBoxSpecial
1.693 droeschl 5778: {
1.721 harmsja 5779: width: 400px;
1.693 droeschl 5780: }
1.721 harmsja 5781:
1.719 ehlerst 5782: .ContentBoxSpecialTemplate
5783: {
5784: border: solid 1px $lg_border_color;
5785: }
5786: .ContentBoxTemplate {
5787: padding:10px;
5788: }
5789:
1.721 harmsja 5790: div.LC_columnSection > .ContentBoxTemplate,
5791: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719 ehlerst 5792: {
5793: width: 600px;
5794:
5795: }
5796:
1.720 ehlerst 5797: .clear{
5798: clear: both;
5799: line-height: 0px;
5800: font-size: 0px;
5801: height: 0px;
5802: }
1.693 droeschl 5803:
1.694 tempelho 5804: .LC_loginpage_container {
5805: text-align:left;
5806: margin : 0 auto;
5807: width:65%;
5808: padding: 10px;
5809: height: auto;
1.712 muellerd 5810: background-color:#FFFFFF;
1.694 tempelho 5811: border:1px solid #CCCCCC;
5812: }
5813:
5814:
5815: .LC_loginpage_loginContainer {
5816: float:left;
1.712 muellerd 5817: width: 182px;
5818: border:1px solid #CCCCCC;
5819: background-color:$loginbg;
1.694 tempelho 5820: }
5821:
1.717 tempelho 5822: .LC_loginpage_loginContainer h2{
1.712 muellerd 5823: margin-top:0;
5824: display:block;
5825: background:$bgcol;
5826: color:$textcol;
5827: padding-left:5px;
5828: }
1.694 tempelho 5829: .LC_loginpage_loginInfo {
5830: margin-left:20px;
5831: float:left;
5832: width:30%;
5833: border:1px solid #CCCCCC;
5834: padding:10px;
5835: }
5836:
1.712 muellerd 5837: .LC_loginpage_loginDomain {
5838: margin-right:20px;
5839: width:20%;
5840: float:left;
5841: padding:10px;
5842: }
5843:
1.694 tempelho 5844: .LC_loginpage_space {
5845: clear:both;
5846: margin-bottom:20px;
5847: border-bottom: 1px solid #CCCCCC;
5848: }
5849:
1.343 albertel 5850: END
5851: }
5852:
1.306 albertel 5853: =pod
5854:
5855: =item * &headtag()
5856:
5857: Returns a uniform footer for LON-CAPA web pages.
5858:
1.307 albertel 5859: Inputs: $title - optional title for the head
5860: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5861: $args - optional arguments
1.319 albertel 5862: force_register - if is true call registerurl so the remote is
5863: informed
1.415 albertel 5864: redirect -> array ref of
5865: 1- seconds before redirect occurs
5866: 2- url to redirect to
5867: 3- whether the side effect should occur
1.315 albertel 5868: (side effect of setting
5869: $env{'internal.head.redirect'} to the url
5870: redirected too)
1.352 albertel 5871: domain -> force to color decorate a page for a specific
5872: domain
5873: function -> force usage of a specific rolish color scheme
5874: bgcolor -> override the default page bgcolor
1.460 albertel 5875: no_auto_mt_title
5876: -> prevent &mt()ing the title arg
1.464 albertel 5877:
1.306 albertel 5878: =cut
5879:
5880: sub headtag {
1.313 albertel 5881: my ($title,$head_extra,$args) = @_;
1.306 albertel 5882:
1.363 albertel 5883: my $function = $args->{'function'} || &get_users_function();
5884: my $domain = $args->{'domain'} || &determinedomain();
5885: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5886: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5887: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5888: #time(),
1.418 albertel 5889: $env{'environment.color.timestamp'},
1.363 albertel 5890: $function,$domain,$bgcolor);
5891:
1.369 www 5892: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5893:
1.308 albertel 5894: my $result =
5895: '<head>'.
1.461 albertel 5896: &font_settings();
1.319 albertel 5897:
1.461 albertel 5898: if (!$args->{'frameset'}) {
5899: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5900: }
1.319 albertel 5901: if ($args->{'force_register'}) {
5902: $result .= &Apache::lonmenu::registerurl(1);
5903: }
1.436 albertel 5904: if (!$args->{'no_nav_bar'}
5905: && !$args->{'only_body'}
5906: && !$args->{'frameset'}) {
5907: $result .= &help_menu_js();
5908: }
1.319 albertel 5909:
1.314 albertel 5910: if (ref($args->{'redirect'})) {
1.414 albertel 5911: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5912: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5913: if (!$inhibit_continue) {
5914: $env{'internal.head.redirect'} = $url;
5915: }
1.313 albertel 5916: $result.=<<ADDMETA
5917: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5918: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5919: ADDMETA
5920: }
1.306 albertel 5921: if (!defined($title)) {
5922: $title = 'The LearningOnline Network with CAPA';
5923: }
1.460 albertel 5924: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5925: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5926: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5927: .$head_extra;
1.306 albertel 5928: return $result;
5929: }
5930:
5931: =pod
5932:
1.340 albertel 5933: =item * &font_settings()
5934:
5935: Returns neccessary <meta> to set the proper encoding
5936:
5937: Inputs: none
5938:
5939: =cut
5940:
5941: sub font_settings {
5942: my $headerstring='';
1.647 www 5943: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5944: $headerstring.=
5945: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5946: }
5947: return $headerstring;
5948: }
5949:
1.341 albertel 5950: =pod
5951:
5952: =item * &xml_begin()
5953:
5954: Returns the needed doctype and <html>
5955:
5956: Inputs: none
5957:
5958: =cut
5959:
5960: sub xml_begin {
5961: my $output='';
5962:
1.592 albertel 5963: if ($env{'internal.start_page'}==1) {
5964: &Apache::lonhtmlcommon::init_htmlareafields();
5965: }
1.342 albertel 5966:
1.341 albertel 5967: if ($env{'browser.mathml'}) {
5968: $output='<?xml version="1.0"?>'
5969: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5970: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5971:
5972: # .'<!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">] >'
5973: .'<!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">'
5974: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5975: .'xmlns="http://www.w3.org/1999/xhtml">';
5976: } else {
5977: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5978: }
5979: return $output;
5980: }
1.340 albertel 5981:
5982: =pod
5983:
1.306 albertel 5984: =item * &endheadtag()
5985:
5986: Returns a uniform </head> for LON-CAPA web pages.
5987:
5988: Inputs: none
5989:
5990: =cut
5991:
5992: sub endheadtag {
5993: return '</head>';
5994: }
5995:
5996: =pod
5997:
5998: =item * &head()
5999:
6000: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6001:
1.648 raeburn 6002: Inputs:
6003:
6004: =over 4
6005:
6006: $title - optional title for the page
6007:
6008: $head_extra - optional extra HTML to put inside the <head>
6009:
6010: =back
1.405 albertel 6011:
1.306 albertel 6012: =cut
6013:
6014: sub head {
1.325 albertel 6015: my ($title,$head_extra,$args) = @_;
6016: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6017: }
6018:
6019: =pod
6020:
6021: =item * &start_page()
6022:
6023: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6024:
1.648 raeburn 6025: Inputs:
6026:
6027: =over 4
6028:
6029: $title - optional title for the page
6030:
6031: $head_extra - optional extra HTML to incude inside the <head>
6032:
6033: $args - additional optional args supported are:
6034:
6035: =over 8
6036:
6037: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6038: arg on
1.648 raeburn 6039: no_nav_bar -> is true will set &bodytag() notopbar arg on
6040: add_entries -> additional attributes to add to the <body>
6041: domain -> force to color decorate a page for a
1.317 albertel 6042: specific domain
1.648 raeburn 6043: function -> force usage of a specific rolish color
1.317 albertel 6044: scheme
1.648 raeburn 6045: redirect -> see &headtag()
6046: bgcolor -> override the default page bg color
6047: js_ready -> return a string ready for being used in
1.317 albertel 6048: a javascript writeln
1.648 raeburn 6049: html_encode -> return a string ready for being used in
1.320 albertel 6050: a html attribute
1.648 raeburn 6051: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6052: $forcereg arg
1.648 raeburn 6053: body_title -> alternate text to use instead of $title
1.326 albertel 6054: in the title box that appears, this text
6055: is not auto translated like the $title is
1.648 raeburn 6056: frameset -> if true will start with a <frameset>
1.330 albertel 6057: rather than <body>
1.648 raeburn 6058: no_title -> if true the title bar won't be shown
6059: skip_phases -> hash ref of
1.338 albertel 6060: head -> skip the <html><head> generation
6061: body -> skip all <body> generation
1.648 raeburn 6062: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6063: 'Switch To Inline Menu' link
1.648 raeburn 6064: no_auto_mt_title -> prevent &mt()ing the title arg
6065: inherit_jsmath -> when creating popup window in a page,
6066: should it have jsmath forced on by the
6067: current page
1.361 albertel 6068:
1.648 raeburn 6069: =back
1.460 albertel 6070:
1.648 raeburn 6071: =back
1.562 albertel 6072:
1.306 albertel 6073: =cut
6074:
6075: sub start_page {
1.309 albertel 6076: my ($title,$head_extra,$args) = @_;
1.318 albertel 6077: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6078: my %head_args;
1.352 albertel 6079: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6080: 'bgcolor','frameset','no_nav_bar','only_body',
6081: 'no_auto_mt_title') {
1.319 albertel 6082: if (defined($args->{$arg})) {
1.324 raeburn 6083: $head_args{$arg} = $args->{$arg};
1.319 albertel 6084: }
1.313 albertel 6085: }
1.319 albertel 6086:
1.315 albertel 6087: $env{'internal.start_page'}++;
1.338 albertel 6088: my $result;
6089: if (! exists($args->{'skip_phases'}{'head'}) ) {
6090: $result.=
1.341 albertel 6091: &xml_begin().
1.338 albertel 6092: &headtag($title,$head_extra,\%head_args).&endheadtag();
6093: }
6094:
6095: if (! exists($args->{'skip_phases'}{'body'}) ) {
6096: if ($args->{'frameset'}) {
6097: my $attr_string = &make_attr_string($args->{'force_register'},
6098: $args->{'add_entries'});
6099: $result .= "\n<frameset $attr_string>\n";
6100: } else {
6101: $result .=
6102: &bodytag($title,
6103: $args->{'function'}, $args->{'add_entries'},
6104: $args->{'only_body'}, $args->{'domain'},
6105: $args->{'force_register'}, $args->{'body_title'},
6106: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6107: $args->{'no_title'}, $args->{'no_inline_link'},
6108: $args);
1.338 albertel 6109: }
1.330 albertel 6110: }
1.338 albertel 6111:
1.315 albertel 6112: if ($args->{'js_ready'}) {
1.713 kaisler 6113: $result = &js_ready($result);
1.315 albertel 6114: }
1.320 albertel 6115: if ($args->{'html_encode'}) {
1.713 kaisler 6116: $result = &html_encode($result);
6117: }
6118:
1.718 raeburn 6119: if (exists($args->{'bread_crumbs'})) {
6120: &Apache::lonhtmlcommon::clear_breadcrumbs();
6121: if (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6122: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6123: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6124: }
6125: }
6126: $result .= &Apache::lonhtmlcommon::breadcrumbs();
1.320 albertel 6127: }
1.713 kaisler 6128:
1.315 albertel 6129: return $result;
1.306 albertel 6130: }
6131:
1.330 albertel 6132:
1.306 albertel 6133: =pod
6134:
6135: =item * &head()
6136:
6137: Returns a complete </body></html> section for LON-CAPA web pages.
6138:
1.315 albertel 6139: Inputs: $args - additional optional args supported are:
6140: js_ready -> return a string ready for being used in
6141: a javascript writeln
1.320 albertel 6142: html_encode -> return a string ready for being used in
6143: a html attribute
1.330 albertel 6144: frameset -> if true will start with a <frameset>
6145: rather than <body>
1.493 albertel 6146: dicsussion -> if true will get discussion from
6147: lonxml::xmlend
6148: (you can pass the target and parser arguments
6149: through optional 'target' and 'parser' args
6150: to this routine)
1.306 albertel 6151:
6152: =cut
6153:
6154: sub end_page {
1.315 albertel 6155: my ($args) = @_;
6156: $env{'internal.end_page'}++;
1.330 albertel 6157: my $result;
1.335 albertel 6158: if ($args->{'discussion'}) {
6159: my ($target,$parser);
6160: if (ref($args->{'discussion'})) {
6161: ($target,$parser) =($args->{'discussion'}{'target'},
6162: $args->{'discussion'}{'parser'});
6163: }
6164: $result .= &Apache::lonxml::xmlend($target,$parser);
6165: }
6166:
1.330 albertel 6167: if ($args->{'frameset'}) {
6168: $result .= '</frameset>';
6169: } else {
1.635 raeburn 6170: $result .= &endbodytag($args);
1.330 albertel 6171: }
6172: $result .= "\n</html>";
6173:
1.315 albertel 6174: if ($args->{'js_ready'}) {
1.317 albertel 6175: $result = &js_ready($result);
1.315 albertel 6176: }
1.335 albertel 6177:
1.320 albertel 6178: if ($args->{'html_encode'}) {
6179: $result = &html_encode($result);
6180: }
1.335 albertel 6181:
1.315 albertel 6182: return $result;
6183: }
6184:
1.320 albertel 6185: sub html_encode {
6186: my ($result) = @_;
6187:
1.322 albertel 6188: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6189:
6190: return $result;
6191: }
1.317 albertel 6192: sub js_ready {
6193: my ($result) = @_;
6194:
1.323 albertel 6195: $result =~ s/[\n\r]/ /xmsg;
6196: $result =~ s/\\/\\\\/xmsg;
6197: $result =~ s/'/\\'/xmsg;
1.372 albertel 6198: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6199:
6200: return $result;
6201: }
6202:
1.315 albertel 6203: sub validate_page {
6204: if ( exists($env{'internal.start_page'})
1.316 albertel 6205: && $env{'internal.start_page'} > 1) {
6206: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6207: $env{'internal.start_page'}.' '.
1.316 albertel 6208: $ENV{'request.filename'});
1.315 albertel 6209: }
6210: if ( exists($env{'internal.end_page'})
1.316 albertel 6211: && $env{'internal.end_page'} > 1) {
6212: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6213: $env{'internal.end_page'}.' '.
1.316 albertel 6214: $env{'request.filename'});
1.315 albertel 6215: }
6216: if ( exists($env{'internal.start_page'})
6217: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6218: &Apache::lonnet::logthis('start_page called without end_page '.
6219: $env{'request.filename'});
1.315 albertel 6220: }
6221: if ( ! exists($env{'internal.start_page'})
6222: && exists($env{'internal.end_page'})) {
1.316 albertel 6223: &Apache::lonnet::logthis('end_page called without start_page'.
6224: $env{'request.filename'});
1.315 albertel 6225: }
1.306 albertel 6226: }
1.315 albertel 6227:
1.318 albertel 6228: sub simple_error_page {
6229: my ($r,$title,$msg) = @_;
6230: my $page =
6231: &Apache::loncommon::start_page($title).
6232: &mt($msg).
6233: &Apache::loncommon::end_page();
6234: if (ref($r)) {
6235: $r->print($page);
1.327 albertel 6236: return;
1.318 albertel 6237: }
6238: return $page;
6239: }
1.347 albertel 6240:
6241: {
1.610 albertel 6242: my @row_count;
1.347 albertel 6243: sub start_data_table {
1.422 albertel 6244: my ($add_class) = @_;
6245: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6246: unshift(@row_count,0);
1.422 albertel 6247: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6248: }
6249:
6250: sub end_data_table {
1.610 albertel 6251: shift(@row_count);
1.389 albertel 6252: return '</table>'."\n";;
1.347 albertel 6253: }
6254:
6255: sub start_data_table_row {
1.422 albertel 6256: my ($add_class) = @_;
1.610 albertel 6257: $row_count[0]++;
6258: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6259: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6260: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6261: }
1.471 banghart 6262:
6263: sub continue_data_table_row {
6264: my ($add_class) = @_;
1.610 albertel 6265: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6266: $css_class = (join(' ',$css_class,$add_class));
6267: return '<tr class="'.$css_class.'">'."\n";;
6268: }
1.347 albertel 6269:
6270: sub end_data_table_row {
1.389 albertel 6271: return '</tr>'."\n";;
1.347 albertel 6272: }
1.367 www 6273:
1.421 albertel 6274: sub start_data_table_empty_row {
1.707 bisitz 6275: # $row_count[0]++;
1.421 albertel 6276: return '<tr class="LC_empty_row" >'."\n";;
6277: }
6278:
6279: sub end_data_table_empty_row {
6280: return '</tr>'."\n";;
6281: }
6282:
1.367 www 6283: sub start_data_table_header_row {
1.389 albertel 6284: return '<tr class="LC_header_row">'."\n";;
1.367 www 6285: }
6286:
6287: sub end_data_table_header_row {
1.389 albertel 6288: return '</tr>'."\n";;
1.367 www 6289: }
1.347 albertel 6290: }
6291:
1.548 albertel 6292: =pod
6293:
6294: =item * &inhibit_menu_check($arg)
6295:
6296: Checks for a inhibitmenu state and generates output to preserve it
6297:
6298: Inputs: $arg - can be any of
6299: - undef - in which case the return value is a string
6300: to add into arguments list of a uri
6301: - 'input' - in which case the return value is a HTML
6302: <form> <input> field of type hidden to
6303: preserve the value
6304: - a url - in which case the return value is the url with
6305: the neccesary cgi args added to preserve the
6306: inhibitmenu state
6307: - a ref to a url - no return value, but the string is
6308: updated to include the neccessary cgi
6309: args to preserve the inhibitmenu state
6310:
6311: =cut
6312:
6313: sub inhibit_menu_check {
6314: my ($arg) = @_;
6315: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6316: if ($arg eq 'input') {
6317: if ($env{'form.inhibitmenu'}) {
6318: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6319: } else {
6320: return
6321: }
6322: }
6323: if ($env{'form.inhibitmenu'}) {
6324: if (ref($arg)) {
6325: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6326: } elsif ($arg eq '') {
6327: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6328: } else {
6329: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6330: }
6331: }
6332: if (!ref($arg)) {
6333: return $arg;
6334: }
6335: }
6336:
1.251 albertel 6337: ###############################################
1.182 matthew 6338:
6339: =pod
6340:
1.549 albertel 6341: =back
6342:
6343: =head1 User Information Routines
6344:
6345: =over 4
6346:
1.405 albertel 6347: =item * &get_users_function()
1.182 matthew 6348:
6349: Used by &bodytag to determine the current users primary role.
6350: Returns either 'student','coordinator','admin', or 'author'.
6351:
6352: =cut
6353:
6354: ###############################################
6355: sub get_users_function {
6356: my $function = 'student';
1.258 albertel 6357: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6358: $function='coordinator';
6359: }
1.258 albertel 6360: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6361: $function='admin';
6362: }
1.258 albertel 6363: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6364: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6365: $function='author';
6366: }
6367: return $function;
1.54 www 6368: }
1.99 www 6369:
6370: ###############################################
6371:
1.233 raeburn 6372: =pod
6373:
1.542 raeburn 6374: =item * &check_user_status()
1.274 raeburn 6375:
6376: Determines current status of supplied role for a
6377: specific user. Roles can be active, previous or future.
6378:
6379: Inputs:
6380: user's domain, user's username, course's domain,
1.375 raeburn 6381: course's number, optional section ID.
1.274 raeburn 6382:
6383: Outputs:
6384: role status: active, previous or future.
6385:
6386: =cut
6387:
6388: sub check_user_status {
1.412 raeburn 6389: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6390: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6391: my @uroles = keys %userinfo;
6392: my $srchstr;
6393: my $active_chk = 'none';
1.412 raeburn 6394: my $now = time;
1.274 raeburn 6395: if (@uroles > 0) {
1.412 raeburn 6396: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6397: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6398: } else {
1.412 raeburn 6399: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6400: }
6401: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6402: my $role_end = 0;
6403: my $role_start = 0;
6404: $active_chk = 'active';
1.412 raeburn 6405: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6406: $role_end = $1;
6407: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6408: $role_start = $1;
1.274 raeburn 6409: }
6410: }
6411: if ($role_start > 0) {
1.412 raeburn 6412: if ($now < $role_start) {
1.274 raeburn 6413: $active_chk = 'future';
6414: }
6415: }
6416: if ($role_end > 0) {
1.412 raeburn 6417: if ($now > $role_end) {
1.274 raeburn 6418: $active_chk = 'previous';
6419: }
6420: }
6421: }
6422: }
6423: return $active_chk;
6424: }
6425:
6426: ###############################################
6427:
6428: =pod
6429:
1.405 albertel 6430: =item * &get_sections()
1.233 raeburn 6431:
6432: Determines all the sections for a course including
6433: sections with students and sections containing other roles.
1.419 raeburn 6434: Incoming parameters:
6435:
6436: 1. domain
6437: 2. course number
6438: 3. reference to array containing roles for which sections should
6439: be gathered (optional).
6440: 4. reference to array containing status types for which sections
6441: should be gathered (optional).
6442:
6443: If the third argument is undefined, sections are gathered for any role.
6444: If the fourth argument is undefined, sections are gathered for any status.
6445: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6446:
1.374 raeburn 6447: Returns section hash (keys are section IDs, values are
6448: number of users in each section), subject to the
1.419 raeburn 6449: optional roles filter, optional status filter
1.233 raeburn 6450:
6451: =cut
6452:
6453: ###############################################
6454: sub get_sections {
1.419 raeburn 6455: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6456: if (!defined($cdom) || !defined($cnum)) {
6457: my $cid = $env{'request.course.id'};
6458:
6459: return if (!defined($cid));
6460:
6461: $cdom = $env{'course.'.$cid.'.domain'};
6462: $cnum = $env{'course.'.$cid.'.num'};
6463: }
6464:
6465: my %sectioncount;
1.419 raeburn 6466: my $now = time;
1.240 albertel 6467:
1.366 albertel 6468: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6469: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6470: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6471: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6472: my $start_index = &Apache::loncoursedata::CL_START();
6473: my $end_index = &Apache::loncoursedata::CL_END();
6474: my $status;
1.366 albertel 6475: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6476: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6477: $data->[$status_index],
6478: $data->[$start_index],
6479: $data->[$end_index]);
6480: if ($stu_status eq 'Active') {
6481: $status = 'active';
6482: } elsif ($end < $now) {
6483: $status = 'previous';
6484: } elsif ($start > $now) {
6485: $status = 'future';
6486: }
6487: if ($section ne '-1' && $section !~ /^\s*$/) {
6488: if ((!defined($possible_status)) || (($status ne '') &&
6489: (grep/^\Q$status\E$/,@{$possible_status}))) {
6490: $sectioncount{$section}++;
6491: }
1.240 albertel 6492: }
6493: }
6494: }
6495: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6496: foreach my $user (sort(keys(%courseroles))) {
6497: if ($user !~ /^(\w{2})/) { next; }
6498: my ($role) = ($user =~ /^(\w{2})/);
6499: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6500: my ($section,$status);
1.240 albertel 6501: if ($role eq 'cr' &&
6502: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6503: $section=$1;
6504: }
6505: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6506: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6507: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6508: if ($end == -1 && $start == -1) {
6509: next; #deleted role
6510: }
6511: if (!defined($possible_status)) {
6512: $sectioncount{$section}++;
6513: } else {
6514: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6515: $status = 'active';
6516: } elsif ($end < $now) {
6517: $status = 'future';
6518: } elsif ($start > $now) {
6519: $status = 'previous';
6520: }
6521: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6522: $sectioncount{$section}++;
6523: }
6524: }
1.233 raeburn 6525: }
1.366 albertel 6526: return %sectioncount;
1.233 raeburn 6527: }
6528:
1.274 raeburn 6529: ###############################################
1.294 raeburn 6530:
6531: =pod
1.405 albertel 6532:
6533: =item * &get_course_users()
6534:
1.275 raeburn 6535: Retrieves usernames:domains for users in the specified course
6536: with specific role(s), and access status.
6537:
6538: Incoming parameters:
1.277 albertel 6539: 1. course domain
6540: 2. course number
6541: 3. access status: users must have - either active,
1.275 raeburn 6542: previous, future, or all.
1.277 albertel 6543: 4. reference to array of permissible roles
1.288 raeburn 6544: 5. reference to array of section restrictions (optional)
6545: 6. reference to results object (hash of hashes).
6546: 7. reference to optional userdata hash
1.609 raeburn 6547: 8. reference to optional statushash
1.630 raeburn 6548: 9. flag if privileged users (except those set to unhide in
6549: course settings) should be excluded
1.609 raeburn 6550: Keys of top level results hash are roles.
1.275 raeburn 6551: Keys of inner hashes are username:domain, with
6552: values set to access type.
1.288 raeburn 6553: Optional userdata hash returns an array with arguments in the
6554: same order as loncoursedata::get_classlist() for student data.
6555:
1.609 raeburn 6556: Optional statushash returns
6557:
1.288 raeburn 6558: Entries for end, start, section and status are blank because
6559: of the possibility of multiple values for non-student roles.
6560:
1.275 raeburn 6561: =cut
1.405 albertel 6562:
1.275 raeburn 6563: ###############################################
1.405 albertel 6564:
1.275 raeburn 6565: sub get_course_users {
1.630 raeburn 6566: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6567: my %idx = ();
1.419 raeburn 6568: my %seclists;
1.288 raeburn 6569:
6570: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6571: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6572: $idx{end} = &Apache::loncoursedata::CL_END();
6573: $idx{start} = &Apache::loncoursedata::CL_START();
6574: $idx{id} = &Apache::loncoursedata::CL_ID();
6575: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6576: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6577: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6578:
1.290 albertel 6579: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6580: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6581: my $now = time;
1.277 albertel 6582: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6583: my $match = 0;
1.412 raeburn 6584: my $secmatch = 0;
1.419 raeburn 6585: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6586: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6587: if ($section eq '') {
6588: $section = 'none';
6589: }
1.291 albertel 6590: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6591: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6592: $secmatch = 1;
6593: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6594: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6595: $secmatch = 1;
6596: }
6597: } else {
1.419 raeburn 6598: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6599: $secmatch = 1;
6600: }
1.290 albertel 6601: }
1.412 raeburn 6602: if (!$secmatch) {
6603: next;
6604: }
1.419 raeburn 6605: }
1.275 raeburn 6606: if (defined($$types{'active'})) {
1.288 raeburn 6607: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6608: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6609: $match = 1;
1.275 raeburn 6610: }
6611: }
6612: if (defined($$types{'previous'})) {
1.609 raeburn 6613: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6614: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6615: $match = 1;
1.275 raeburn 6616: }
6617: }
6618: if (defined($$types{'future'})) {
1.609 raeburn 6619: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6620: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6621: $match = 1;
1.275 raeburn 6622: }
6623: }
1.609 raeburn 6624: if ($match) {
6625: push(@{$seclists{$student}},$section);
6626: if (ref($userdata) eq 'HASH') {
6627: $$userdata{$student} = $$classlist{$student};
6628: }
6629: if (ref($statushash) eq 'HASH') {
6630: $statushash->{$student}{'st'}{$section} = $status;
6631: }
1.288 raeburn 6632: }
1.275 raeburn 6633: }
6634: }
1.412 raeburn 6635: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6636: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6637: my $now = time;
1.609 raeburn 6638: my %displaystatus = ( previous => 'Expired',
6639: active => 'Active',
6640: future => 'Future',
6641: );
1.630 raeburn 6642: my %nothide;
6643: if ($hidepriv) {
6644: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6645: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6646: if ($user !~ /:/) {
6647: $nothide{join(':',split(/[\@]/,$user))}=1;
6648: } else {
6649: $nothide{$user} = 1;
6650: }
6651: }
6652: }
1.439 raeburn 6653: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6654: my $match = 0;
1.412 raeburn 6655: my $secmatch = 0;
1.439 raeburn 6656: my $status;
1.412 raeburn 6657: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6658: $user =~ s/:$//;
1.439 raeburn 6659: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6660: if ($end == -1 || $start == -1) {
6661: next;
6662: }
6663: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6664: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6665: my ($uname,$udom) = split(/:/,$user);
6666: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6667: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6668: $secmatch = 1;
6669: } elsif ($usec eq '') {
1.420 albertel 6670: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6671: $secmatch = 1;
6672: }
6673: } else {
6674: if (grep(/^\Q$usec\E$/,@{$sections})) {
6675: $secmatch = 1;
6676: }
6677: }
6678: if (!$secmatch) {
6679: next;
6680: }
1.288 raeburn 6681: }
1.419 raeburn 6682: if ($usec eq '') {
6683: $usec = 'none';
6684: }
1.275 raeburn 6685: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6686: if ($hidepriv) {
6687: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6688: (!$nothide{$uname.':'.$udom})) {
6689: next;
6690: }
6691: }
1.503 raeburn 6692: if ($end > 0 && $end < $now) {
1.439 raeburn 6693: $status = 'previous';
6694: } elsif ($start > $now) {
6695: $status = 'future';
6696: } else {
6697: $status = 'active';
6698: }
1.277 albertel 6699: foreach my $type (keys(%{$types})) {
1.275 raeburn 6700: if ($status eq $type) {
1.420 albertel 6701: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6702: push(@{$$users{$role}{$user}},$type);
6703: }
1.288 raeburn 6704: $match = 1;
6705: }
6706: }
1.419 raeburn 6707: if (($match) && (ref($userdata) eq 'HASH')) {
6708: if (!exists($$userdata{$uname.':'.$udom})) {
6709: &get_user_info($udom,$uname,\%idx,$userdata);
6710: }
1.420 albertel 6711: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6712: push(@{$seclists{$uname.':'.$udom}},$usec);
6713: }
1.609 raeburn 6714: if (ref($statushash) eq 'HASH') {
6715: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6716: }
1.275 raeburn 6717: }
6718: }
6719: }
6720: }
1.290 albertel 6721: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6722: if ((defined($cdom)) && (defined($cnum))) {
6723: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6724: if ( defined($csettings{'internal.courseowner'}) ) {
6725: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6726: next if ($owner eq '');
6727: my ($ownername,$ownerdom);
6728: if ($owner =~ /^([^:]+):([^:]+)$/) {
6729: $ownername = $1;
6730: $ownerdom = $2;
6731: } else {
6732: $ownername = $owner;
6733: $ownerdom = $cdom;
6734: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6735: }
6736: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6737: if (defined($userdata) &&
1.609 raeburn 6738: !exists($$userdata{$owner})) {
6739: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6740: if (!grep(/^none$/,@{$seclists{$owner}})) {
6741: push(@{$seclists{$owner}},'none');
6742: }
6743: if (ref($statushash) eq 'HASH') {
6744: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6745: }
1.290 albertel 6746: }
1.279 raeburn 6747: }
6748: }
6749: }
1.419 raeburn 6750: foreach my $user (keys(%seclists)) {
6751: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6752: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6753: }
1.275 raeburn 6754: }
6755: return;
6756: }
6757:
1.288 raeburn 6758: sub get_user_info {
6759: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6760: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6761: &plainname($uname,$udom,'lastname');
1.291 albertel 6762: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6763: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6764: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6765: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6766: return;
6767: }
1.275 raeburn 6768:
1.472 raeburn 6769: ###############################################
6770:
6771: =pod
6772:
6773: =item * &get_user_quota()
6774:
6775: Retrieves quota assigned for storage of portfolio files for a user
6776:
6777: Incoming parameters:
6778: 1. user's username
6779: 2. user's domain
6780:
6781: Returns:
1.536 raeburn 6782: 1. Disk quota (in Mb) assigned to student.
6783: 2. (Optional) Type of setting: custom or default
6784: (individually assigned or default for user's
6785: institutional status).
6786: 3. (Optional) - User's institutional status (e.g., faculty, staff
6787: or student - types as defined in localenroll::inst_usertypes
6788: for user's domain, which determines default quota for user.
6789: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6790:
6791: If a value has been stored in the user's environment,
1.536 raeburn 6792: it will return that, otherwise it returns the maximal default
6793: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6794:
6795: =cut
6796:
6797: ###############################################
6798:
6799:
6800: sub get_user_quota {
6801: my ($uname,$udom) = @_;
1.536 raeburn 6802: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6803: if (!defined($udom)) {
6804: $udom = $env{'user.domain'};
6805: }
6806: if (!defined($uname)) {
6807: $uname = $env{'user.name'};
6808: }
6809: if (($udom eq '' || $uname eq '') ||
6810: ($udom eq 'public') && ($uname eq 'public')) {
6811: $quota = 0;
1.536 raeburn 6812: $quotatype = 'default';
6813: $defquota = 0;
1.472 raeburn 6814: } else {
1.536 raeburn 6815: my $inststatus;
1.472 raeburn 6816: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6817: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6818: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6819: } else {
1.536 raeburn 6820: my %userenv =
6821: &Apache::lonnet::get('environment',['portfolioquota',
6822: 'inststatus'],$udom,$uname);
1.472 raeburn 6823: my ($tmp) = keys(%userenv);
6824: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6825: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6826: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6827: } else {
6828: undef(%userenv);
6829: }
6830: }
1.536 raeburn 6831: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6832: if ($quota eq '') {
1.536 raeburn 6833: $quota = $defquota;
6834: $quotatype = 'default';
6835: } else {
6836: $quotatype = 'custom';
1.472 raeburn 6837: }
6838: }
1.536 raeburn 6839: if (wantarray) {
6840: return ($quota,$quotatype,$settingstatus,$defquota);
6841: } else {
6842: return $quota;
6843: }
1.472 raeburn 6844: }
6845:
6846: ###############################################
6847:
6848: =pod
6849:
6850: =item * &default_quota()
6851:
1.536 raeburn 6852: Retrieves default quota assigned for storage of user portfolio files,
6853: given an (optional) user's institutional status.
1.472 raeburn 6854:
6855: Incoming parameters:
6856: 1. domain
1.536 raeburn 6857: 2. (Optional) institutional status(es). This is a : separated list of
6858: status types (e.g., faculty, staff, student etc.)
6859: which apply to the user for whom the default is being retrieved.
6860: If the institutional status string in undefined, the domain
6861: default quota will be returned.
1.472 raeburn 6862:
6863: Returns:
6864: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6865: 2. (Optional) institutional type which determined the value of the
6866: default quota.
1.472 raeburn 6867:
6868: If a value has been stored in the domain's configuration db,
6869: it will return that, otherwise it returns 20 (for backwards
6870: compatibility with domains which have not set up a configuration
6871: db file; the original statically defined portfolio quota was 20 Mb).
6872:
1.536 raeburn 6873: If the user's status includes multiple types (e.g., staff and student),
6874: the largest default quota which applies to the user determines the
6875: default quota returned.
6876:
1.472 raeburn 6877: =cut
6878:
6879: ###############################################
6880:
6881:
6882: sub default_quota {
1.536 raeburn 6883: my ($udom,$inststatus) = @_;
6884: my ($defquota,$settingstatus);
6885: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6886: ['quotas'],$udom);
6887: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6888: if ($inststatus ne '') {
6889: my @statuses = split(/:/,$inststatus);
6890: foreach my $item (@statuses) {
1.711 raeburn 6891: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
6892: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
6893: if ($defquota eq '') {
6894: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
6895: $settingstatus = $item;
6896: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
6897: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
6898: $settingstatus = $item;
6899: }
6900: }
6901: } else {
6902: if ($quotahash{'quotas'}{$item} ne '') {
6903: if ($defquota eq '') {
6904: $defquota = $quotahash{'quotas'}{$item};
6905: $settingstatus = $item;
6906: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6907: $defquota = $quotahash{'quotas'}{$item};
6908: $settingstatus = $item;
6909: }
1.536 raeburn 6910: }
6911: }
6912: }
6913: }
6914: if ($defquota eq '') {
1.711 raeburn 6915: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
6916: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
6917: } else {
6918: $defquota = $quotahash{'quotas'}{'default'};
6919: }
1.536 raeburn 6920: $settingstatus = 'default';
6921: }
6922: } else {
6923: $settingstatus = 'default';
6924: $defquota = 20;
6925: }
6926: if (wantarray) {
6927: return ($defquota,$settingstatus);
1.472 raeburn 6928: } else {
1.536 raeburn 6929: return $defquota;
1.472 raeburn 6930: }
6931: }
6932:
1.384 raeburn 6933: sub get_secgrprole_info {
6934: my ($cdom,$cnum,$needroles,$type) = @_;
6935: my %sections_count = &get_sections($cdom,$cnum);
6936: my @sections = (sort {$a <=> $b} keys(%sections_count));
6937: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6938: my @groups = sort(keys(%curr_groups));
6939: my $allroles = [];
6940: my $rolehash;
6941: my $accesshash = {
6942: active => 'Currently has access',
6943: future => 'Will have future access',
6944: previous => 'Previously had access',
6945: };
6946: if ($needroles) {
6947: $rolehash = {'all' => 'all'};
1.385 albertel 6948: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6949: if (&Apache::lonnet::error(%user_roles)) {
6950: undef(%user_roles);
6951: }
6952: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6953: my ($role)=split(/\:/,$item,2);
6954: if ($role eq 'cr') { next; }
6955: if ($role =~ /^cr/) {
6956: $$rolehash{$role} = (split('/',$role))[3];
6957: } else {
6958: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6959: }
6960: }
6961: foreach my $key (sort(keys(%{$rolehash}))) {
6962: push(@{$allroles},$key);
6963: }
6964: push (@{$allroles},'st');
6965: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6966: }
6967: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6968: }
6969:
1.555 raeburn 6970: sub user_picker {
1.627 raeburn 6971: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6972: my $currdom = $dom;
6973: my %curr_selected = (
6974: srchin => 'dom',
1.580 raeburn 6975: srchby => 'lastname',
1.555 raeburn 6976: );
6977: my $srchterm;
1.625 raeburn 6978: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6979: if ($srch->{'srchby'} ne '') {
6980: $curr_selected{'srchby'} = $srch->{'srchby'};
6981: }
6982: if ($srch->{'srchin'} ne '') {
6983: $curr_selected{'srchin'} = $srch->{'srchin'};
6984: }
6985: if ($srch->{'srchtype'} ne '') {
6986: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6987: }
6988: if ($srch->{'srchdomain'} ne '') {
6989: $currdom = $srch->{'srchdomain'};
6990: }
6991: $srchterm = $srch->{'srchterm'};
6992: }
6993: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6994: 'usr' => 'Search criteria',
1.563 raeburn 6995: 'doma' => 'Domain/institution to search',
1.558 albertel 6996: 'uname' => 'username',
6997: 'lastname' => 'last name',
1.555 raeburn 6998: 'lastfirst' => 'last name, first name',
1.558 albertel 6999: 'crs' => 'in this course',
1.576 raeburn 7000: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7001: 'alc' => 'all LON-CAPA',
1.573 raeburn 7002: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7003: 'exact' => 'is',
7004: 'contains' => 'contains',
1.569 raeburn 7005: 'begins' => 'begins with',
1.571 raeburn 7006: 'youm' => "You must include some text to search for.",
7007: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7008: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7009: 'yomc' => "You must choose a domain when using an institutional directory search.",
7010: 'ymcd' => "You must choose a domain when using a domain search.",
7011: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7012: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7013: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7014: );
1.563 raeburn 7015: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7016: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7017:
7018: my @srchins = ('crs','dom','alc','instd');
7019:
7020: foreach my $option (@srchins) {
7021: # FIXME 'alc' option unavailable until
7022: # loncreateuser::print_user_query_page()
7023: # has been completed.
7024: next if ($option eq 'alc');
7025: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7026: if ($curr_selected{'srchin'} eq $option) {
7027: $srchinsel .= '
7028: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7029: } else {
7030: $srchinsel .= '
7031: <option value="'.$option.'">'.$lt{$option}.'</option>';
7032: }
1.555 raeburn 7033: }
1.563 raeburn 7034: $srchinsel .= "\n </select>\n";
1.555 raeburn 7035:
7036: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7037: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7038: if ($curr_selected{'srchby'} eq $option) {
7039: $srchbysel .= '
7040: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7041: } else {
7042: $srchbysel .= '
7043: <option value="'.$option.'">'.$lt{$option}.'</option>';
7044: }
7045: }
7046: $srchbysel .= "\n </select>\n";
7047:
7048: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7049: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7050: if ($curr_selected{'srchtype'} eq $option) {
7051: $srchtypesel .= '
7052: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7053: } else {
7054: $srchtypesel .= '
7055: <option value="'.$option.'">'.$lt{$option}.'</option>';
7056: }
7057: }
7058: $srchtypesel .= "\n </select>\n";
7059:
1.558 albertel 7060: my ($newuserscript,$new_user_create);
1.556 raeburn 7061:
7062: if ($forcenewuser) {
1.576 raeburn 7063: if (ref($srch) eq 'HASH') {
7064: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7065: if ($cancreate) {
7066: $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>';
7067: } else {
7068: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
7069: my %usertypetext = (
7070: official => 'institutional',
7071: unofficial => 'non-institutional',
7072: );
7073: $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
7074: }
1.576 raeburn 7075: }
7076: }
7077:
1.556 raeburn 7078: $newuserscript = <<"ENDSCRIPT";
7079:
1.570 raeburn 7080: function setSearch(createnew,callingForm) {
1.556 raeburn 7081: if (createnew == 1) {
1.570 raeburn 7082: for (var i=0; i<callingForm.srchby.length; i++) {
7083: if (callingForm.srchby.options[i].value == 'uname') {
7084: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7085: }
7086: }
1.570 raeburn 7087: for (var i=0; i<callingForm.srchin.length; i++) {
7088: if ( callingForm.srchin.options[i].value == 'dom') {
7089: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7090: }
7091: }
1.570 raeburn 7092: for (var i=0; i<callingForm.srchtype.length; i++) {
7093: if (callingForm.srchtype.options[i].value == 'exact') {
7094: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7095: }
7096: }
1.570 raeburn 7097: for (var i=0; i<callingForm.srchdomain.length; i++) {
7098: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7099: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7100: }
7101: }
7102: }
7103: }
7104: ENDSCRIPT
1.558 albertel 7105:
1.556 raeburn 7106: }
7107:
1.555 raeburn 7108: my $output = <<"END_BLOCK";
1.556 raeburn 7109: <script type="text/javascript">
1.570 raeburn 7110: function validateEntry(callingForm) {
1.558 albertel 7111:
1.556 raeburn 7112: var checkok = 1;
1.558 albertel 7113: var srchin;
1.570 raeburn 7114: for (var i=0; i<callingForm.srchin.length; i++) {
7115: if ( callingForm.srchin[i].checked ) {
7116: srchin = callingForm.srchin[i].value;
1.558 albertel 7117: }
7118: }
7119:
1.570 raeburn 7120: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7121: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7122: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7123: var srchterm = callingForm.srchterm.value;
7124: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7125: var msg = "";
7126:
7127: if (srchterm == "") {
7128: checkok = 0;
1.571 raeburn 7129: msg += "$lt{'youm'}\\n";
1.556 raeburn 7130: }
7131:
1.569 raeburn 7132: if (srchtype== 'begins') {
7133: if (srchterm.length < 2) {
7134: checkok = 0;
1.571 raeburn 7135: msg += "$lt{'thte'}\\n";
1.569 raeburn 7136: }
7137: }
7138:
1.556 raeburn 7139: if (srchtype== 'contains') {
7140: if (srchterm.length < 3) {
7141: checkok = 0;
1.571 raeburn 7142: msg += "$lt{'thet'}\\n";
1.556 raeburn 7143: }
7144: }
7145: if (srchin == 'instd') {
7146: if (srchdomain == '') {
7147: checkok = 0;
1.571 raeburn 7148: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7149: }
7150: }
7151: if (srchin == 'dom') {
7152: if (srchdomain == '') {
7153: checkok = 0;
1.571 raeburn 7154: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7155: }
7156: }
7157: if (srchby == 'lastfirst') {
7158: if (srchterm.indexOf(",") == -1) {
7159: checkok = 0;
1.571 raeburn 7160: msg += "$lt{'whus'}\\n";
1.556 raeburn 7161: }
7162: if (srchterm.indexOf(",") == srchterm.length -1) {
7163: checkok = 0;
1.571 raeburn 7164: msg += "$lt{'whse'}\\n";
1.556 raeburn 7165: }
7166: }
7167: if (checkok == 0) {
1.571 raeburn 7168: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7169: return;
7170: }
7171: if (checkok == 1) {
1.570 raeburn 7172: callingForm.submit();
1.556 raeburn 7173: }
7174: }
7175:
7176: $newuserscript
7177:
7178: </script>
1.558 albertel 7179:
7180: $new_user_create
7181:
1.555 raeburn 7182: <table>
1.558 albertel 7183: <tr>
1.573 raeburn 7184: <td>$lt{'doma'}:</td>
7185: <td>$domform</td>
7186: </td>
7187: </tr>
7188: <tr>
7189: <td>$lt{'usr'}:</td>
1.563 raeburn 7190: <td>$srchbysel
7191: $srchtypesel
7192: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7193: $srchinsel
1.563 raeburn 7194: </td>
7195: </tr>
1.555 raeburn 7196: </table>
7197: <br />
7198: END_BLOCK
1.558 albertel 7199:
1.555 raeburn 7200: return $output;
7201: }
7202:
1.612 raeburn 7203: sub user_rule_check {
1.615 raeburn 7204: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7205: my $response;
7206: if (ref($usershash) eq 'HASH') {
7207: foreach my $user (keys(%{$usershash})) {
7208: my ($uname,$udom) = split(/:/,$user);
7209: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7210: my ($id,$newuser);
1.612 raeburn 7211: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7212: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7213: $id = $usershash->{$user}->{'id'};
7214: }
7215: my $inst_response;
7216: if (ref($checks) eq 'HASH') {
7217: if (defined($checks->{'username'})) {
1.615 raeburn 7218: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7219: &Apache::lonnet::get_instuser($udom,$uname);
7220: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7221: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7222: &Apache::lonnet::get_instuser($udom,undef,$id);
7223: }
1.615 raeburn 7224: } else {
7225: ($inst_response,%{$inst_results->{$user}}) =
7226: &Apache::lonnet::get_instuser($udom,$uname);
7227: return;
1.612 raeburn 7228: }
1.615 raeburn 7229: if (!$got_rules->{$udom}) {
1.612 raeburn 7230: my %domconfig = &Apache::lonnet::get_dom('configuration',
7231: ['usercreation'],$udom);
7232: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7233: foreach my $item ('username','id') {
1.612 raeburn 7234: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7235: $$curr_rules{$udom}{$item} =
7236: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7237: }
7238: }
7239: }
1.615 raeburn 7240: $got_rules->{$udom} = 1;
1.585 raeburn 7241: }
1.612 raeburn 7242: foreach my $item (keys(%{$checks})) {
7243: if (ref($$curr_rules{$udom}) eq 'HASH') {
7244: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7245: if (@{$$curr_rules{$udom}{$item}} > 0) {
7246: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7247: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7248: if ($rule_check{$rule}) {
7249: $$rulematch{$user}{$item} = $rule;
7250: if ($inst_response eq 'ok') {
1.615 raeburn 7251: if (ref($inst_results) eq 'HASH') {
7252: if (ref($inst_results->{$user}) eq 'HASH') {
7253: if (keys(%{$inst_results->{$user}}) == 0) {
7254: $$alerts{$item}{$udom}{$uname} = 1;
7255: }
1.612 raeburn 7256: }
7257: }
1.615 raeburn 7258: }
7259: last;
1.585 raeburn 7260: }
7261: }
7262: }
7263: }
7264: }
7265: }
7266: }
7267: }
1.612 raeburn 7268: return;
7269: }
7270:
7271: sub user_rule_formats {
7272: my ($domain,$domdesc,$curr_rules,$check) = @_;
7273: my %text = (
7274: 'username' => 'Usernames',
7275: 'id' => 'IDs',
7276: );
7277: my $output;
7278: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7279: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7280: if (@{$ruleorder} > 0) {
7281: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
7282: foreach my $rule (@{$ruleorder}) {
7283: if (ref($curr_rules) eq 'ARRAY') {
7284: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7285: if (ref($rules->{$rule}) eq 'HASH') {
7286: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7287: $rules->{$rule}{'desc'}.'</li>';
7288: }
7289: }
7290: }
7291: }
7292: $output .= '</ul>';
7293: }
7294: }
7295: return $output;
7296: }
7297:
7298: sub instrule_disallow_msg {
1.615 raeburn 7299: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7300: my $response;
7301: my %text = (
7302: item => 'username',
7303: items => 'usernames',
7304: match => 'matches',
7305: do => 'does',
7306: action => 'a username',
7307: one => 'one',
7308: );
7309: if ($count > 1) {
7310: $text{'item'} = 'usernames';
7311: $text{'match'} ='match';
7312: $text{'do'} = 'do';
7313: $text{'action'} = 'usernames',
7314: $text{'one'} = 'ones';
7315: }
7316: if ($checkitem eq 'id') {
7317: $text{'items'} = 'IDs';
7318: $text{'item'} = 'ID';
7319: $text{'action'} = 'an ID';
1.615 raeburn 7320: if ($count > 1) {
7321: $text{'item'} = 'IDs';
7322: $text{'action'} = 'IDs';
7323: }
1.612 raeburn 7324: }
1.674 bisitz 7325: $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 7326: if ($mode eq 'upload') {
7327: if ($checkitem eq 'username') {
7328: $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'}.");
7329: } elsif ($checkitem eq 'id') {
1.674 bisitz 7330: $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 7331: }
1.669 raeburn 7332: } elsif ($mode eq 'selfcreate') {
7333: if ($checkitem eq 'id') {
7334: $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.");
7335: }
1.615 raeburn 7336: } else {
7337: if ($checkitem eq 'username') {
7338: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7339: } elsif ($checkitem eq 'id') {
7340: $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.");
7341: }
1.612 raeburn 7342: }
7343: return $response;
1.585 raeburn 7344: }
7345:
1.624 raeburn 7346: sub personal_data_fieldtitles {
7347: my %fieldtitles = &Apache::lonlocal::texthash (
7348: id => 'Student/Employee ID',
7349: permanentemail => 'E-mail address',
7350: lastname => 'Last Name',
7351: firstname => 'First Name',
7352: middlename => 'Middle Name',
7353: generation => 'Generation',
7354: gen => 'Generation',
7355: );
7356: return %fieldtitles;
7357: }
7358:
1.642 raeburn 7359: sub sorted_inst_types {
7360: my ($dom) = @_;
7361: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7362: my $othertitle = &mt('All users');
7363: if ($env{'request.course.id'}) {
1.668 raeburn 7364: $othertitle = &mt('Any users');
1.642 raeburn 7365: }
7366: my @types;
7367: if (ref($order) eq 'ARRAY') {
7368: @types = @{$order};
7369: }
7370: if (@types == 0) {
7371: if (ref($usertypes) eq 'HASH') {
7372: @types = sort(keys(%{$usertypes}));
7373: }
7374: }
7375: if (keys(%{$usertypes}) > 0) {
7376: $othertitle = &mt('Other users');
7377: }
7378: return ($othertitle,$usertypes,\@types);
7379: }
7380:
1.645 raeburn 7381: sub get_institutional_codes {
7382: my ($settings,$allcourses,$LC_code) = @_;
7383: # Get complete list of course sections to update
7384: my @currsections = ();
7385: my @currxlists = ();
7386: my $coursecode = $$settings{'internal.coursecode'};
7387:
7388: if ($$settings{'internal.sectionnums'} ne '') {
7389: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7390: }
7391:
7392: if ($$settings{'internal.crosslistings'} ne '') {
7393: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7394: }
7395:
7396: if (@currxlists > 0) {
7397: foreach (@currxlists) {
7398: if (m/^([^:]+):(\w*)$/) {
7399: unless (grep/^$1$/,@{$allcourses}) {
7400: push @{$allcourses},$1;
7401: $$LC_code{$1} = $2;
7402: }
7403: }
7404: }
7405: }
7406:
7407: if (@currsections > 0) {
7408: foreach (@currsections) {
7409: if (m/^(\w+):(\w*)$/) {
7410: my $sec = $coursecode.$1;
7411: my $lc_sec = $2;
7412: unless (grep/^$sec$/,@{$allcourses}) {
7413: push @{$allcourses},$sec;
7414: $$LC_code{$sec} = $lc_sec;
7415: }
7416: }
7417: }
7418: }
7419: return;
7420: }
7421:
1.112 bowersj2 7422: =pod
7423:
1.549 albertel 7424: =back
7425:
7426: =head1 HTTP Helpers
7427:
7428: =over 4
7429:
1.648 raeburn 7430: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7431:
1.258 albertel 7432: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7433: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7434: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7435:
7436: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7437: $possible_names is an ref to an array of form element names. As an example:
7438: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7439: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7440:
7441: =cut
1.1 albertel 7442:
1.6 albertel 7443: sub get_unprocessed_cgi {
1.25 albertel 7444: my ($query,$possible_names)= @_;
1.26 matthew 7445: # $Apache::lonxml::debug=1;
1.356 albertel 7446: foreach my $pair (split(/&/,$query)) {
7447: my ($name, $value) = split(/=/,$pair);
1.369 www 7448: $name = &unescape($name);
1.25 albertel 7449: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7450: $value =~ tr/+/ /;
7451: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7452: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7453: }
1.16 harris41 7454: }
1.6 albertel 7455: }
7456:
1.112 bowersj2 7457: =pod
7458:
1.648 raeburn 7459: =item * &cacheheader()
1.112 bowersj2 7460:
7461: returns cache-controlling header code
7462:
7463: =cut
7464:
1.7 albertel 7465: sub cacheheader {
1.258 albertel 7466: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7467: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7468: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7469: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7470: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7471: return $output;
1.7 albertel 7472: }
7473:
1.112 bowersj2 7474: =pod
7475:
1.648 raeburn 7476: =item * &no_cache($r)
1.112 bowersj2 7477:
7478: specifies header code to not have cache
7479:
7480: =cut
7481:
1.9 albertel 7482: sub no_cache {
1.216 albertel 7483: my ($r) = @_;
7484: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7485: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7486: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7487: $r->no_cache(1);
7488: $r->header_out("Expires" => $date);
7489: $r->header_out("Pragma" => "no-cache");
1.123 www 7490: }
7491:
7492: sub content_type {
1.181 albertel 7493: my ($r,$type,$charset) = @_;
1.299 foxr 7494: if ($r) {
7495: # Note that printout.pl calls this with undef for $r.
7496: &no_cache($r);
7497: }
1.258 albertel 7498: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7499: unless ($charset) {
7500: $charset=&Apache::lonlocal::current_encoding;
7501: }
7502: if ($charset) { $type.='; charset='.$charset; }
7503: if ($r) {
7504: $r->content_type($type);
7505: } else {
7506: print("Content-type: $type\n\n");
7507: }
1.9 albertel 7508: }
1.25 albertel 7509:
1.112 bowersj2 7510: =pod
7511:
1.648 raeburn 7512: =item * &add_to_env($name,$value)
1.112 bowersj2 7513:
1.258 albertel 7514: adds $name to the %env hash with value
1.112 bowersj2 7515: $value, if $name already exists, the entry is converted to an array
7516: reference and $value is added to the array.
7517:
7518: =cut
7519:
1.25 albertel 7520: sub add_to_env {
7521: my ($name,$value)=@_;
1.258 albertel 7522: if (defined($env{$name})) {
7523: if (ref($env{$name})) {
1.25 albertel 7524: #already have multiple values
1.258 albertel 7525: push(@{ $env{$name} },$value);
1.25 albertel 7526: } else {
7527: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7528: my $first=$env{$name};
7529: undef($env{$name});
7530: push(@{ $env{$name} },$first,$value);
1.25 albertel 7531: }
7532: } else {
1.258 albertel 7533: $env{$name}=$value;
1.25 albertel 7534: }
1.31 albertel 7535: }
1.149 albertel 7536:
7537: =pod
7538:
1.648 raeburn 7539: =item * &get_env_multiple($name)
1.149 albertel 7540:
1.258 albertel 7541: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7542: values may be defined and end up as an array ref.
7543:
7544: returns an array of values
7545:
7546: =cut
7547:
7548: sub get_env_multiple {
7549: my ($name) = @_;
7550: my @values;
1.258 albertel 7551: if (defined($env{$name})) {
1.149 albertel 7552: # exists is it an array
1.258 albertel 7553: if (ref($env{$name})) {
7554: @values=@{ $env{$name} };
1.149 albertel 7555: } else {
1.258 albertel 7556: $values[0]=$env{$name};
1.149 albertel 7557: }
7558: }
7559: return(@values);
7560: }
7561:
1.660 raeburn 7562: sub ask_for_embedded_content {
7563: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7564: my $upload_output = '
7565: <form name="upload_embedded" action="'.$actionurl.'"
7566: method="post" enctype="multipart/form-data">';
7567: $upload_output .= $state;
1.661 raeburn 7568: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7569:
7570: my $num = 0;
7571: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7572: $upload_output .= &start_data_table_row().
7573: '<td>'.$embed_file.'</td><td>';
7574: if ($args->{'ignore_remote_references'}
7575: && $embed_file =~ m{^\w+://}) {
7576: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7577: } elsif ($args->{'error_on_invalid_names'}
7578: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7579:
7580: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7581:
7582: } else {
7583: $upload_output .='
1.661 raeburn 7584: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7585: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7586: my $attrib = join(':',@{$$allfiles{$embed_file}});
7587: $upload_output .=
7588: "\n\t\t".
7589: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7590: $attrib.'" />';
7591: if (exists($$codebase{$embed_file})) {
7592: $upload_output .=
7593: "\n\t\t".
7594: '<input name="codebase_'.$num.'" type="hidden" value="'.
7595: &escape($$codebase{$embed_file}).'" />';
7596: }
7597: }
7598: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7599: $num++;
7600: }
7601: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7602: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7603: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7604: '.&mt('(only files for which a location has been provided will be uploaded)').'
7605: </form>';
7606: return $upload_output;
7607: }
7608:
1.661 raeburn 7609: sub upload_embedded {
7610: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7611: $current_disk_usage) = @_;
7612: my $output;
7613: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7614: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7615: my $orig_uploaded_filename =
7616: $env{'form.embedded_item_'.$i.'.filename'};
7617:
7618: $env{'form.embedded_orig_'.$i} =
7619: &unescape($env{'form.embedded_orig_'.$i});
7620: my ($path,$fname) =
7621: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7622: # no path, whole string is fname
7623: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7624:
7625: $path = $env{'form.currentpath'}.$path;
7626: $fname = &Apache::lonnet::clean_filename($fname);
7627: # See if there is anything left
7628: next if ($fname eq '');
7629:
7630: # Check if file already exists as a file or directory.
7631: my ($state,$msg);
7632: if ($context eq 'portfolio') {
7633: my $port_path = $dirpath;
7634: if ($group ne '') {
7635: $port_path = "groups/$group/$port_path";
7636: }
7637: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7638: $dir_root,$port_path,$disk_quota,
7639: $current_disk_usage,$uname,$udom);
7640: if ($state eq 'will_exceed_quota'
7641: || $state eq 'file_locked'
7642: || $state eq 'file_exists' ) {
7643: $output .= $msg;
7644: next;
7645: }
7646: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7647: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7648: if ($state eq 'exists') {
7649: $output .= $msg;
7650: next;
7651: }
7652: }
7653: # Check if extension is valid
7654: if (($fname =~ /\.(\w+)$/) &&
7655: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7656: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7657: next;
7658: } elsif (($fname =~ /\.(\w+)$/) &&
7659: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7660: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7661: next;
7662: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7663: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7664: next;
7665: }
7666:
7667: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7668: if ($context eq 'portfolio') {
7669: my $result=
7670: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7671: $dirpath.$path);
7672: if ($result !~ m|^/uploaded/|) {
7673: $output .= '<span class="LC_error">'
7674: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7675: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7676: .'</span><br />';
7677: next;
7678: } else {
7679: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7680: $path.$fname.'</span>').'</p>';
7681: }
7682: } else {
7683: # Save the file
7684: my $target = $env{'form.embedded_item_'.$i};
7685: my $fullpath = $dir_root.$dirpath.'/'.$path;
7686: my $dest = $fullpath.$fname;
7687: my $url = $url_root.$dirpath.'/'.$path.$fname;
7688: my @parts=split(/\//,$fullpath);
7689: my $count;
7690: my $filepath = $dir_root;
7691: for ($count=4;$count<=$#parts;$count++) {
7692: $filepath .= "/$parts[$count]";
7693: if ((-e $filepath)!=1) {
7694: mkdir($filepath,0770);
7695: }
7696: }
7697: my $fh;
7698: if (!open($fh,'>'.$dest)) {
7699: &Apache::lonnet::logthis('Failed to create '.$dest);
7700: $output .= '<span class="LC_error">'.
7701: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7702: '</span><br />';
7703: } else {
7704: if (!print $fh $env{'form.embedded_item_'.$i}) {
7705: &Apache::lonnet::logthis('Failed to write to '.$dest);
7706: $output .= '<span class="LC_error">'.
7707: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7708: '</span><br />';
7709: } else {
7710: if ($context eq 'testbank') {
7711: $output .= &mt('Embedded file uploaded successfully:').
7712: ' <a href="'.$url.'">'.
7713: $orig_uploaded_filename.'</a><br />';
7714: } else {
1.705 tempelho 7715: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7716: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7717: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7718: }
7719: }
7720: close($fh);
7721: }
7722: }
7723: }
7724: return $output;
7725: }
7726:
7727: sub check_for_existing {
7728: my ($path,$fname,$element) = @_;
7729: my ($state,$msg);
7730: if (-d $path.'/'.$fname) {
7731: $state = 'exists';
7732: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7733: } elsif (-e $path.'/'.$fname) {
7734: $state = 'exists';
7735: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7736: }
7737: if ($state eq 'exists') {
7738: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7739: }
7740: return ($state,$msg);
7741: }
7742:
7743: sub check_for_upload {
7744: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7745: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7746: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7747: my $getpropath = 1;
7748: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7749: $getpropath);
7750: my $found_file = 0;
7751: my $locked_file = 0;
7752: foreach my $line (@dir_list) {
7753: my ($file_name)=split(/\&/,$line,2);
7754: if ($file_name eq $fname){
7755: $file_name = $path.$file_name;
7756: if ($group ne '') {
7757: $file_name = $group.$file_name;
7758: }
7759: $found_file = 1;
7760: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7761: $locked_file = 1;
7762: }
7763: }
7764: }
7765: if (($current_disk_usage + $filesize) > $disk_quota){
7766: my $msg = '<span class="LC_error">'.
7767: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7768: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7769: return ('will_exceed_quota',$msg);
7770: } elsif ($found_file) {
7771: if ($locked_file) {
7772: my $msg = '<span class="LC_error">';
7773: $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>');
7774: $msg .= '</span><br />';
7775: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7776: return ('file_locked',$msg);
7777: } else {
7778: my $msg = '<span class="LC_error">';
7779: $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
7780: $msg .= '</span>';
7781: $msg .= '<br />';
7782: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7783: return ('file_exists',$msg);
7784: }
7785: }
7786: }
7787:
1.31 albertel 7788:
1.41 ng 7789: =pod
1.45 matthew 7790:
1.464 albertel 7791: =back
1.41 ng 7792:
1.112 bowersj2 7793: =head1 CSV Upload/Handling functions
1.38 albertel 7794:
1.41 ng 7795: =over 4
7796:
1.648 raeburn 7797: =item * &upfile_store($r)
1.41 ng 7798:
7799: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7800: needs $env{'form.upfile'}
1.41 ng 7801: returns $datatoken to be put into hidden field
7802:
7803: =cut
1.31 albertel 7804:
7805: sub upfile_store {
7806: my $r=shift;
1.258 albertel 7807: $env{'form.upfile'}=~s/\r/\n/gs;
7808: $env{'form.upfile'}=~s/\f/\n/gs;
7809: $env{'form.upfile'}=~s/\n+/\n/gs;
7810: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7811:
1.258 albertel 7812: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7813: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7814: {
1.158 raeburn 7815: my $datafile = $r->dir_config('lonDaemons').
7816: '/tmp/'.$datatoken.'.tmp';
7817: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7818: print $fh $env{'form.upfile'};
1.158 raeburn 7819: close($fh);
7820: }
1.31 albertel 7821: }
7822: return $datatoken;
7823: }
7824:
1.56 matthew 7825: =pod
7826:
1.648 raeburn 7827: =item * &load_tmp_file($r)
1.41 ng 7828:
7829: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7830: needs $env{'form.datatoken'},
7831: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7832:
7833: =cut
1.31 albertel 7834:
7835: sub load_tmp_file {
7836: my $r=shift;
7837: my @studentdata=();
7838: {
1.158 raeburn 7839: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7840: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7841: if ( open(my $fh,"<$studentfile") ) {
7842: @studentdata=<$fh>;
7843: close($fh);
7844: }
1.31 albertel 7845: }
1.258 albertel 7846: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7847: }
7848:
1.56 matthew 7849: =pod
7850:
1.648 raeburn 7851: =item * &upfile_record_sep()
1.41 ng 7852:
7853: Separate uploaded file into records
7854: returns array of records,
1.258 albertel 7855: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7856:
7857: =cut
1.31 albertel 7858:
7859: sub upfile_record_sep {
1.258 albertel 7860: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7861: } else {
1.248 albertel 7862: my @records;
1.258 albertel 7863: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7864: if ($line=~/^\s*$/) { next; }
7865: push(@records,$line);
7866: }
7867: return @records;
1.31 albertel 7868: }
7869: }
7870:
1.56 matthew 7871: =pod
7872:
1.648 raeburn 7873: =item * &record_sep($record)
1.41 ng 7874:
1.258 albertel 7875: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7876:
7877: =cut
7878:
1.263 www 7879: sub takeleft {
7880: my $index=shift;
7881: return substr('0000'.$index,-4,4);
7882: }
7883:
1.31 albertel 7884: sub record_sep {
7885: my $record=shift;
7886: my %components=();
1.258 albertel 7887: if ($env{'form.upfiletype'} eq 'xml') {
7888: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7889: my $i=0;
1.356 albertel 7890: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7891: $field=~s/^(\"|\')//;
7892: $field=~s/(\"|\')$//;
1.263 www 7893: $components{&takeleft($i)}=$field;
1.31 albertel 7894: $i++;
7895: }
1.258 albertel 7896: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7897: my $i=0;
1.356 albertel 7898: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7899: $field=~s/^(\"|\')//;
7900: $field=~s/(\"|\')$//;
1.263 www 7901: $components{&takeleft($i)}=$field;
1.31 albertel 7902: $i++;
7903: }
7904: } else {
1.561 www 7905: my $separator=',';
1.480 banghart 7906: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7907: $separator=';';
1.480 banghart 7908: }
1.31 albertel 7909: my $i=0;
1.561 www 7910: # the character we are looking for to indicate the end of a quote or a record
7911: my $looking_for=$separator;
7912: # do not add the characters to the fields
7913: my $ignore=0;
7914: # we just encountered a separator (or the beginning of the record)
7915: my $just_found_separator=1;
7916: # store the field we are working on here
7917: my $field='';
7918: # work our way through all characters in record
7919: foreach my $character ($record=~/(.)/g) {
7920: if ($character eq $looking_for) {
7921: if ($character ne $separator) {
7922: # Found the end of a quote, again looking for separator
7923: $looking_for=$separator;
7924: $ignore=1;
7925: } else {
7926: # Found a separator, store away what we got
7927: $components{&takeleft($i)}=$field;
7928: $i++;
7929: $just_found_separator=1;
7930: $ignore=0;
7931: $field='';
7932: }
7933: next;
7934: }
7935: # single or double quotation marks after a separator indicate beginning of a quote
7936: # we are now looking for the end of the quote and need to ignore separators
7937: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7938: $looking_for=$character;
7939: next;
7940: }
7941: # ignore would be true after we reached the end of a quote
7942: if ($ignore) { next; }
7943: if (($just_found_separator) && ($character=~/\s/)) { next; }
7944: $field.=$character;
7945: $just_found_separator=0;
1.31 albertel 7946: }
1.561 www 7947: # catch the very last entry, since we never encountered the separator
7948: $components{&takeleft($i)}=$field;
1.31 albertel 7949: }
7950: return %components;
7951: }
7952:
1.144 matthew 7953: ######################################################
7954: ######################################################
7955:
1.56 matthew 7956: =pod
7957:
1.648 raeburn 7958: =item * &upfile_select_html()
1.41 ng 7959:
1.144 matthew 7960: Return HTML code to select a file from the users machine and specify
7961: the file type.
1.41 ng 7962:
7963: =cut
7964:
1.144 matthew 7965: ######################################################
7966: ######################################################
1.31 albertel 7967: sub upfile_select_html {
1.144 matthew 7968: my %Types = (
7969: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7970: semisv => &mt('Semicolon separated values'),
1.144 matthew 7971: space => &mt('Space separated'),
7972: tab => &mt('Tabulator separated'),
7973: # xml => &mt('HTML/XML'),
7974: );
7975: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 7976: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 7977: foreach my $type (sort(keys(%Types))) {
7978: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7979: }
7980: $Str .= "</select>\n";
7981: return $Str;
1.31 albertel 7982: }
7983:
1.301 albertel 7984: sub get_samples {
7985: my ($records,$toget) = @_;
7986: my @samples=({});
7987: my $got=0;
7988: foreach my $rec (@$records) {
7989: my %temp = &record_sep($rec);
7990: if (! grep(/\S/, values(%temp))) { next; }
7991: if (%temp) {
7992: $samples[$got]=\%temp;
7993: $got++;
7994: if ($got == $toget) { last; }
7995: }
7996: }
7997: return \@samples;
7998: }
7999:
1.144 matthew 8000: ######################################################
8001: ######################################################
8002:
1.56 matthew 8003: =pod
8004:
1.648 raeburn 8005: =item * &csv_print_samples($r,$records)
1.41 ng 8006:
8007: Prints a table of sample values from each column uploaded $r is an
8008: Apache Request ref, $records is an arrayref from
8009: &Apache::loncommon::upfile_record_sep
8010:
8011: =cut
8012:
1.144 matthew 8013: ######################################################
8014: ######################################################
1.31 albertel 8015: sub csv_print_samples {
8016: my ($r,$records) = @_;
1.662 bisitz 8017: my $samples = &get_samples($records,5);
1.301 albertel 8018:
1.594 raeburn 8019: $r->print(&mt('Samples').'<br />'.&start_data_table().
8020: &start_data_table_header_row());
1.356 albertel 8021: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8022: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8023: $r->print(&end_data_table_header_row());
1.301 albertel 8024: foreach my $hash (@$samples) {
1.594 raeburn 8025: $r->print(&start_data_table_row());
1.356 albertel 8026: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8027: $r->print('<td>');
1.356 albertel 8028: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8029: $r->print('</td>');
8030: }
1.594 raeburn 8031: $r->print(&end_data_table_row());
1.31 albertel 8032: }
1.594 raeburn 8033: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8034: }
8035:
1.144 matthew 8036: ######################################################
8037: ######################################################
8038:
1.56 matthew 8039: =pod
8040:
1.648 raeburn 8041: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8042:
8043: Prints a table to create associations between values and table columns.
1.144 matthew 8044:
1.41 ng 8045: $r is an Apache Request ref,
8046: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8047: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8048:
8049: =cut
8050:
1.144 matthew 8051: ######################################################
8052: ######################################################
1.31 albertel 8053: sub csv_print_select_table {
8054: my ($r,$records,$d) = @_;
1.301 albertel 8055: my $i=0;
8056: my $samples = &get_samples($records,1);
1.144 matthew 8057: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8058: &start_data_table().&start_data_table_header_row().
1.144 matthew 8059: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8060: '<th>'.&mt('Column').'</th>'.
8061: &end_data_table_header_row()."\n");
1.356 albertel 8062: foreach my $array_ref (@$d) {
8063: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8064: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8065:
8066: $r->print('<td><select name=f'.$i.
1.32 matthew 8067: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8068: $r->print('<option value="none"></option>');
1.356 albertel 8069: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8070: $r->print('<option value="'.$sample.'"'.
8071: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8072: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8073: }
1.594 raeburn 8074: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8075: $i++;
8076: }
1.594 raeburn 8077: $r->print(&end_data_table());
1.31 albertel 8078: $i--;
8079: return $i;
8080: }
1.56 matthew 8081:
1.144 matthew 8082: ######################################################
8083: ######################################################
8084:
1.56 matthew 8085: =pod
1.31 albertel 8086:
1.648 raeburn 8087: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8088:
8089: Prints a table of sample values from the upload and can make associate samples to internal names.
8090:
8091: $r is an Apache Request ref,
8092: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8093: $d is an array of 2 element arrays (internal name, displayed name)
8094:
8095: =cut
8096:
1.144 matthew 8097: ######################################################
8098: ######################################################
1.31 albertel 8099: sub csv_samples_select_table {
8100: my ($r,$records,$d) = @_;
8101: my $i=0;
1.144 matthew 8102: #
1.662 bisitz 8103: my $max_samples = 5;
8104: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8105: $r->print(&start_data_table().
8106: &start_data_table_header_row().'<th>'.
8107: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8108: &end_data_table_header_row());
1.301 albertel 8109:
8110: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8111: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8112: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8113: foreach my $option (@$d) {
8114: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8115: $r->print('<option value="'.$value.'"'.
1.253 albertel 8116: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8117: $display.'</option>');
1.31 albertel 8118: }
8119: $r->print('</select></td><td>');
1.662 bisitz 8120: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8121: if (defined($samples->[$line]{$key})) {
8122: $r->print($samples->[$line]{$key}."<br />\n");
8123: }
8124: }
1.594 raeburn 8125: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8126: $i++;
8127: }
1.594 raeburn 8128: $r->print(&end_data_table());
1.31 albertel 8129: $i--;
8130: return($i);
1.115 matthew 8131: }
8132:
1.144 matthew 8133: ######################################################
8134: ######################################################
8135:
1.115 matthew 8136: =pod
8137:
1.648 raeburn 8138: =item * &clean_excel_name($name)
1.115 matthew 8139:
8140: Returns a replacement for $name which does not contain any illegal characters.
8141:
8142: =cut
8143:
1.144 matthew 8144: ######################################################
8145: ######################################################
1.115 matthew 8146: sub clean_excel_name {
8147: my ($name) = @_;
8148: $name =~ s/[:\*\?\/\\]//g;
8149: if (length($name) > 31) {
8150: $name = substr($name,0,31);
8151: }
8152: return $name;
1.25 albertel 8153: }
1.84 albertel 8154:
1.85 albertel 8155: =pod
8156:
1.648 raeburn 8157: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8158:
8159: Returns either 1 or undef
8160:
8161: 1 if the part is to be hidden, undef if it is to be shown
8162:
8163: Arguments are:
8164:
8165: $id the id of the part to be checked
8166: $symb, optional the symb of the resource to check
8167: $udom, optional the domain of the user to check for
8168: $uname, optional the username of the user to check for
8169:
8170: =cut
1.84 albertel 8171:
8172: sub check_if_partid_hidden {
8173: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8174: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8175: $symb,$udom,$uname);
1.141 albertel 8176: my $truth=1;
8177: #if the string starts with !, then the list is the list to show not hide
8178: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8179: my @hiddenlist=split(/,/,$hiddenparts);
8180: foreach my $checkid (@hiddenlist) {
1.141 albertel 8181: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8182: }
1.141 albertel 8183: return !$truth;
1.84 albertel 8184: }
1.127 matthew 8185:
1.138 matthew 8186:
8187: ############################################################
8188: ############################################################
8189:
8190: =pod
8191:
1.157 matthew 8192: =back
8193:
1.138 matthew 8194: =head1 cgi-bin script and graphing routines
8195:
1.157 matthew 8196: =over 4
8197:
1.648 raeburn 8198: =item * &get_cgi_id()
1.138 matthew 8199:
8200: Inputs: none
8201:
8202: Returns an id which can be used to pass environment variables
8203: to various cgi-bin scripts. These environment variables will
8204: be removed from the users environment after a given time by
8205: the routine &Apache::lonnet::transfer_profile_to_env.
8206:
8207: =cut
8208:
8209: ############################################################
8210: ############################################################
1.152 albertel 8211: my $uniq=0;
1.136 matthew 8212: sub get_cgi_id {
1.154 albertel 8213: $uniq=($uniq+1)%100000;
1.280 albertel 8214: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8215: }
8216:
1.127 matthew 8217: ############################################################
8218: ############################################################
8219:
8220: =pod
8221:
1.648 raeburn 8222: =item * &DrawBarGraph()
1.127 matthew 8223:
1.138 matthew 8224: Facilitates the plotting of data in a (stacked) bar graph.
8225: Puts plot definition data into the users environment in order for
8226: graph.png to plot it. Returns an <img> tag for the plot.
8227: The bars on the plot are labeled '1','2',...,'n'.
8228:
8229: Inputs:
8230:
8231: =over 4
8232:
8233: =item $Title: string, the title of the plot
8234:
8235: =item $xlabel: string, text describing the X-axis of the plot
8236:
8237: =item $ylabel: string, text describing the Y-axis of the plot
8238:
8239: =item $Max: scalar, the maximum Y value to use in the plot
8240: If $Max is < any data point, the graph will not be rendered.
8241:
1.140 matthew 8242: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8243: they are plotted. If undefined, default values will be used.
8244:
1.178 matthew 8245: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8246:
1.138 matthew 8247: =item @Values: An array of array references. Each array reference holds data
8248: to be plotted in a stacked bar chart.
8249:
1.239 matthew 8250: =item If the final element of @Values is a hash reference the key/value
8251: pairs will be added to the graph definition.
8252:
1.138 matthew 8253: =back
8254:
8255: Returns:
8256:
8257: An <img> tag which references graph.png and the appropriate identifying
8258: information for the plot.
8259:
1.127 matthew 8260: =cut
8261:
8262: ############################################################
8263: ############################################################
1.134 matthew 8264: sub DrawBarGraph {
1.178 matthew 8265: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8266: #
8267: if (! defined($colors)) {
8268: $colors = ['#33ff00',
8269: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8270: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8271: ];
8272: }
1.228 matthew 8273: my $extra_settings = {};
8274: if (ref($Values[-1]) eq 'HASH') {
8275: $extra_settings = pop(@Values);
8276: }
1.127 matthew 8277: #
1.136 matthew 8278: my $identifier = &get_cgi_id();
8279: my $id = 'cgi.'.$identifier;
1.129 matthew 8280: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8281: return '';
8282: }
1.225 matthew 8283: #
8284: my @Labels;
8285: if (defined($labels)) {
8286: @Labels = @$labels;
8287: } else {
8288: for (my $i=0;$i<@{$Values[0]};$i++) {
8289: push (@Labels,$i+1);
8290: }
8291: }
8292: #
1.129 matthew 8293: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8294: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8295: my %ValuesHash;
8296: my $NumSets=1;
8297: foreach my $array (@Values) {
8298: next if (! ref($array));
1.136 matthew 8299: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8300: join(',',@$array);
1.129 matthew 8301: }
1.127 matthew 8302: #
1.136 matthew 8303: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8304: if ($NumBars < 3) {
8305: $width = 120+$NumBars*32;
1.220 matthew 8306: $xskip = 1;
1.225 matthew 8307: $bar_width = 30;
8308: } elsif ($NumBars < 5) {
8309: $width = 120+$NumBars*20;
8310: $xskip = 1;
8311: $bar_width = 20;
1.220 matthew 8312: } elsif ($NumBars < 10) {
1.136 matthew 8313: $width = 120+$NumBars*15;
8314: $xskip = 1;
8315: $bar_width = 15;
8316: } elsif ($NumBars <= 25) {
8317: $width = 120+$NumBars*11;
8318: $xskip = 5;
8319: $bar_width = 8;
8320: } elsif ($NumBars <= 50) {
8321: $width = 120+$NumBars*8;
8322: $xskip = 5;
8323: $bar_width = 4;
8324: } else {
8325: $width = 120+$NumBars*8;
8326: $xskip = 5;
8327: $bar_width = 4;
8328: }
8329: #
1.137 matthew 8330: $Max = 1 if ($Max < 1);
8331: if ( int($Max) < $Max ) {
8332: $Max++;
8333: $Max = int($Max);
8334: }
1.127 matthew 8335: $Title = '' if (! defined($Title));
8336: $xlabel = '' if (! defined($xlabel));
8337: $ylabel = '' if (! defined($ylabel));
1.369 www 8338: $ValuesHash{$id.'.title'} = &escape($Title);
8339: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8340: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8341: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8342: $ValuesHash{$id.'.NumBars'} = $NumBars;
8343: $ValuesHash{$id.'.NumSets'} = $NumSets;
8344: $ValuesHash{$id.'.PlotType'} = 'bar';
8345: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8346: $ValuesHash{$id.'.height'} = $height;
8347: $ValuesHash{$id.'.width'} = $width;
8348: $ValuesHash{$id.'.xskip'} = $xskip;
8349: $ValuesHash{$id.'.bar_width'} = $bar_width;
8350: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8351: #
1.228 matthew 8352: # Deal with other parameters
8353: while (my ($key,$value) = each(%$extra_settings)) {
8354: $ValuesHash{$id.'.'.$key} = $value;
8355: }
8356: #
1.646 raeburn 8357: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8358: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8359: }
8360:
8361: ############################################################
8362: ############################################################
8363:
8364: =pod
8365:
1.648 raeburn 8366: =item * &DrawXYGraph()
1.137 matthew 8367:
1.138 matthew 8368: Facilitates the plotting of data in an XY graph.
8369: Puts plot definition data into the users environment in order for
8370: graph.png to plot it. Returns an <img> tag for the plot.
8371:
8372: Inputs:
8373:
8374: =over 4
8375:
8376: =item $Title: string, the title of the plot
8377:
8378: =item $xlabel: string, text describing the X-axis of the plot
8379:
8380: =item $ylabel: string, text describing the Y-axis of the plot
8381:
8382: =item $Max: scalar, the maximum Y value to use in the plot
8383: If $Max is < any data point, the graph will not be rendered.
8384:
8385: =item $colors: Array ref containing the hex color codes for the data to be
8386: plotted in. If undefined, default values will be used.
8387:
8388: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8389:
8390: =item $Ydata: Array ref containing Array refs.
1.185 www 8391: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8392:
8393: =item %Values: hash indicating or overriding any default values which are
8394: passed to graph.png.
8395: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8396:
8397: =back
8398:
8399: Returns:
8400:
8401: An <img> tag which references graph.png and the appropriate identifying
8402: information for the plot.
8403:
1.137 matthew 8404: =cut
8405:
8406: ############################################################
8407: ############################################################
8408: sub DrawXYGraph {
8409: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8410: #
8411: # Create the identifier for the graph
8412: my $identifier = &get_cgi_id();
8413: my $id = 'cgi.'.$identifier;
8414: #
8415: $Title = '' if (! defined($Title));
8416: $xlabel = '' if (! defined($xlabel));
8417: $ylabel = '' if (! defined($ylabel));
8418: my %ValuesHash =
8419: (
1.369 www 8420: $id.'.title' => &escape($Title),
8421: $id.'.xlabel' => &escape($xlabel),
8422: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8423: $id.'.y_max_value'=> $Max,
8424: $id.'.labels' => join(',',@$Xlabels),
8425: $id.'.PlotType' => 'XY',
8426: );
8427: #
8428: if (defined($colors) && ref($colors) eq 'ARRAY') {
8429: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8430: }
8431: #
8432: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8433: return '';
8434: }
8435: my $NumSets=1;
1.138 matthew 8436: foreach my $array (@{$Ydata}){
1.137 matthew 8437: next if (! ref($array));
8438: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8439: }
1.138 matthew 8440: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8441: #
8442: # Deal with other parameters
8443: while (my ($key,$value) = each(%Values)) {
8444: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8445: }
8446: #
1.646 raeburn 8447: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8448: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8449: }
8450:
8451: ############################################################
8452: ############################################################
8453:
8454: =pod
8455:
1.648 raeburn 8456: =item * &DrawXYYGraph()
1.138 matthew 8457:
8458: Facilitates the plotting of data in an XY graph with two Y axes.
8459: Puts plot definition data into the users environment in order for
8460: graph.png to plot it. Returns an <img> tag for the plot.
8461:
8462: Inputs:
8463:
8464: =over 4
8465:
8466: =item $Title: string, the title of the plot
8467:
8468: =item $xlabel: string, text describing the X-axis of the plot
8469:
8470: =item $ylabel: string, text describing the Y-axis of the plot
8471:
8472: =item $colors: Array ref containing the hex color codes for the data to be
8473: plotted in. If undefined, default values will be used.
8474:
8475: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8476:
8477: =item $Ydata1: The first data set
8478:
8479: =item $Min1: The minimum value of the left Y-axis
8480:
8481: =item $Max1: The maximum value of the left Y-axis
8482:
8483: =item $Ydata2: The second data set
8484:
8485: =item $Min2: The minimum value of the right Y-axis
8486:
8487: =item $Max2: The maximum value of the left Y-axis
8488:
8489: =item %Values: hash indicating or overriding any default values which are
8490: passed to graph.png.
8491: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8492:
8493: =back
8494:
8495: Returns:
8496:
8497: An <img> tag which references graph.png and the appropriate identifying
8498: information for the plot.
1.136 matthew 8499:
8500: =cut
8501:
8502: ############################################################
8503: ############################################################
1.137 matthew 8504: sub DrawXYYGraph {
8505: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8506: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8507: #
8508: # Create the identifier for the graph
8509: my $identifier = &get_cgi_id();
8510: my $id = 'cgi.'.$identifier;
8511: #
8512: $Title = '' if (! defined($Title));
8513: $xlabel = '' if (! defined($xlabel));
8514: $ylabel = '' if (! defined($ylabel));
8515: my %ValuesHash =
8516: (
1.369 www 8517: $id.'.title' => &escape($Title),
8518: $id.'.xlabel' => &escape($xlabel),
8519: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8520: $id.'.labels' => join(',',@$Xlabels),
8521: $id.'.PlotType' => 'XY',
8522: $id.'.NumSets' => 2,
1.137 matthew 8523: $id.'.two_axes' => 1,
8524: $id.'.y1_max_value' => $Max1,
8525: $id.'.y1_min_value' => $Min1,
8526: $id.'.y2_max_value' => $Max2,
8527: $id.'.y2_min_value' => $Min2,
1.136 matthew 8528: );
8529: #
1.137 matthew 8530: if (defined($colors) && ref($colors) eq 'ARRAY') {
8531: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8532: }
8533: #
8534: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8535: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8536: return '';
8537: }
8538: my $NumSets=1;
1.137 matthew 8539: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8540: next if (! ref($array));
8541: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8542: }
8543: #
8544: # Deal with other parameters
8545: while (my ($key,$value) = each(%Values)) {
8546: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8547: }
8548: #
1.646 raeburn 8549: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8550: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8551: }
8552:
8553: ############################################################
8554: ############################################################
8555:
8556: =pod
8557:
1.157 matthew 8558: =back
8559:
1.139 matthew 8560: =head1 Statistics helper routines?
8561:
8562: Bad place for them but what the hell.
8563:
1.157 matthew 8564: =over 4
8565:
1.648 raeburn 8566: =item * &chartlink()
1.139 matthew 8567:
8568: Returns a link to the chart for a specific student.
8569:
8570: Inputs:
8571:
8572: =over 4
8573:
8574: =item $linktext: The text of the link
8575:
8576: =item $sname: The students username
8577:
8578: =item $sdomain: The students domain
8579:
8580: =back
8581:
1.157 matthew 8582: =back
8583:
1.139 matthew 8584: =cut
8585:
8586: ############################################################
8587: ############################################################
8588: sub chartlink {
8589: my ($linktext, $sname, $sdomain) = @_;
8590: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8591: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8592: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8593: '">'.$linktext.'</a>';
1.153 matthew 8594: }
8595:
8596: #######################################################
8597: #######################################################
8598:
8599: =pod
8600:
8601: =head1 Course Environment Routines
1.157 matthew 8602:
8603: =over 4
1.153 matthew 8604:
1.648 raeburn 8605: =item * &restore_course_settings()
1.153 matthew 8606:
1.648 raeburn 8607: =item * &store_course_settings()
1.153 matthew 8608:
8609: Restores/Store indicated form parameters from the course environment.
8610: Will not overwrite existing values of the form parameters.
8611:
8612: Inputs:
8613: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8614:
8615: a hash ref describing the data to be stored. For example:
8616:
8617: %Save_Parameters = ('Status' => 'scalar',
8618: 'chartoutputmode' => 'scalar',
8619: 'chartoutputdata' => 'scalar',
8620: 'Section' => 'array',
1.373 raeburn 8621: 'Group' => 'array',
1.153 matthew 8622: 'StudentData' => 'array',
8623: 'Maps' => 'array');
8624:
8625: Returns: both routines return nothing
8626:
1.631 raeburn 8627: =back
8628:
1.153 matthew 8629: =cut
8630:
8631: #######################################################
8632: #######################################################
8633: sub store_course_settings {
1.496 albertel 8634: return &store_settings($env{'request.course.id'},@_);
8635: }
8636:
8637: sub store_settings {
1.153 matthew 8638: # save to the environment
8639: # appenv the same items, just to be safe
1.300 albertel 8640: my $udom = $env{'user.domain'};
8641: my $uname = $env{'user.name'};
1.496 albertel 8642: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8643: my %SaveHash;
8644: my %AppHash;
8645: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8646: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8647: my $envname = 'environment.'.$basename;
1.258 albertel 8648: if (exists($env{'form.'.$setting})) {
1.153 matthew 8649: # Save this value away
8650: if ($type eq 'scalar' &&
1.258 albertel 8651: (! exists($env{$envname}) ||
8652: $env{$envname} ne $env{'form.'.$setting})) {
8653: $SaveHash{$basename} = $env{'form.'.$setting};
8654: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8655: } elsif ($type eq 'array') {
8656: my $stored_form;
1.258 albertel 8657: if (ref($env{'form.'.$setting})) {
1.153 matthew 8658: $stored_form = join(',',
8659: map {
1.369 www 8660: &escape($_);
1.258 albertel 8661: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8662: } else {
8663: $stored_form =
1.369 www 8664: &escape($env{'form.'.$setting});
1.153 matthew 8665: }
8666: # Determine if the array contents are the same.
1.258 albertel 8667: if ($stored_form ne $env{$envname}) {
1.153 matthew 8668: $SaveHash{$basename} = $stored_form;
8669: $AppHash{$envname} = $stored_form;
8670: }
8671: }
8672: }
8673: }
8674: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8675: $udom,$uname);
1.153 matthew 8676: if ($put_result !~ /^(ok|delayed)/) {
8677: &Apache::lonnet::logthis('unable to save form parameters, '.
8678: 'got error:'.$put_result);
8679: }
8680: # Make sure these settings stick around in this session, too
1.646 raeburn 8681: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8682: return;
8683: }
8684:
8685: sub restore_course_settings {
1.499 albertel 8686: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8687: }
8688:
8689: sub restore_settings {
8690: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8691: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8692: next if (exists($env{'form.'.$setting}));
1.496 albertel 8693: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8694: '.'.$setting;
1.258 albertel 8695: if (exists($env{$envname})) {
1.153 matthew 8696: if ($type eq 'scalar') {
1.258 albertel 8697: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8698: } elsif ($type eq 'array') {
1.258 albertel 8699: $env{'form.'.$setting} = [
1.153 matthew 8700: map {
1.369 www 8701: &unescape($_);
1.258 albertel 8702: } split(',',$env{$envname})
1.153 matthew 8703: ];
8704: }
8705: }
8706: }
1.127 matthew 8707: }
8708:
1.618 raeburn 8709: #######################################################
8710: #######################################################
8711:
8712: =pod
8713:
8714: =head1 Domain E-mail Routines
8715:
8716: =over 4
8717:
1.648 raeburn 8718: =item * &build_recipient_list()
1.618 raeburn 8719:
8720: Build recipient lists for three types of e-mail:
8721: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8722: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8723:
8724: Inputs:
1.619 raeburn 8725: defmail (scalar - email address of default recipient),
1.618 raeburn 8726: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8727: defdom (domain for which to retrieve configuration settings),
8728: origmail (scalar - email address of recipient from loncapa.conf,
8729: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8730:
1.655 raeburn 8731: Returns: comma separated list of addresses to which to send e-mail.
8732:
8733: =back
1.618 raeburn 8734:
8735: =cut
8736:
8737: ############################################################
8738: ############################################################
8739: sub build_recipient_list {
1.619 raeburn 8740: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8741: my @recipients;
8742: my $otheremails;
8743: my %domconfig =
8744: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8745: if (ref($domconfig{'contacts'}) eq 'HASH') {
8746: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8747: my @contacts = ('adminemail','supportemail');
8748: foreach my $item (@contacts) {
8749: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8750: my $addr = $domconfig{'contacts'}{$item};
8751: if (!grep(/^\Q$addr\E$/,@recipients)) {
8752: push(@recipients,$addr);
8753: }
1.618 raeburn 8754: }
8755: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8756: }
8757: }
1.619 raeburn 8758: } elsif ($origmail ne '') {
8759: push(@recipients,$origmail);
1.618 raeburn 8760: }
1.688 raeburn 8761: if (defined($defmail)) {
8762: if ($defmail ne '') {
8763: push(@recipients,$defmail);
8764: }
1.618 raeburn 8765: }
8766: if ($otheremails) {
1.619 raeburn 8767: my @others;
8768: if ($otheremails =~ /,/) {
8769: @others = split(/,/,$otheremails);
1.618 raeburn 8770: } else {
1.619 raeburn 8771: push(@others,$otheremails);
8772: }
8773: foreach my $addr (@others) {
8774: if (!grep(/^\Q$addr\E$/,@recipients)) {
8775: push(@recipients,$addr);
8776: }
1.618 raeburn 8777: }
8778: }
1.619 raeburn 8779: my $recipientlist = join(',',@recipients);
1.618 raeburn 8780: return $recipientlist;
8781: }
8782:
1.127 matthew 8783: ############################################################
8784: ############################################################
1.154 albertel 8785:
1.655 raeburn 8786: =pod
8787:
8788: =head1 Course Catalog Routines
8789:
8790: =over 4
8791:
8792: =item * &gather_categories()
8793:
8794: Converts category definitions - keys of categories hash stored in
8795: coursecategories in configuration.db on the primary library server in a
8796: domain - to an array. Also generates javascript and idx hash used to
8797: generate Domain Coordinator interface for editing Course Categories.
8798:
8799: Inputs:
1.663 raeburn 8800:
1.655 raeburn 8801: categories (reference to hash of category definitions).
1.663 raeburn 8802:
1.655 raeburn 8803: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8804: categories and subcategories).
1.663 raeburn 8805:
1.655 raeburn 8806: idx (reference to hash of counters used in Domain Coordinator interface for
8807: editing Course Categories).
1.663 raeburn 8808:
1.655 raeburn 8809: jsarray (reference to array of categories used to create Javascript arrays for
8810: Domain Coordinator interface for editing Course Categories).
8811:
8812: Returns: nothing
8813:
8814: Side effects: populates cats, idx and jsarray.
8815:
8816: =cut
8817:
8818: sub gather_categories {
8819: my ($categories,$cats,$idx,$jsarray) = @_;
8820: my %counters;
8821: my $num = 0;
8822: foreach my $item (keys(%{$categories})) {
8823: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8824: if ($container eq '' && $depth == 0) {
8825: $cats->[$depth][$categories->{$item}] = $cat;
8826: } else {
8827: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8828: }
8829: my ($escitem,$tail) = split(/:/,$item,2);
8830: if ($counters{$tail} eq '') {
8831: $counters{$tail} = $num;
8832: $num ++;
8833: }
8834: if (ref($idx) eq 'HASH') {
8835: $idx->{$item} = $counters{$tail};
8836: }
8837: if (ref($jsarray) eq 'ARRAY') {
8838: push(@{$jsarray->[$counters{$tail}]},$item);
8839: }
8840: }
8841: return;
8842: }
8843:
8844: =pod
8845:
8846: =item * &extract_categories()
8847:
8848: Used to generate breadcrumb trails for course categories.
8849:
8850: Inputs:
1.663 raeburn 8851:
1.655 raeburn 8852: categories (reference to hash of category definitions).
1.663 raeburn 8853:
1.655 raeburn 8854: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8855: categories and subcategories).
1.663 raeburn 8856:
1.655 raeburn 8857: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8858:
1.655 raeburn 8859: allitems (reference to hash - key is category key
8860: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8861:
1.655 raeburn 8862: idx (reference to hash of counters used in Domain Coordinator interface for
8863: editing Course Categories).
1.663 raeburn 8864:
1.655 raeburn 8865: jsarray (reference to array of categories used to create Javascript arrays for
8866: Domain Coordinator interface for editing Course Categories).
8867:
1.665 raeburn 8868: subcats (reference to hash of arrays containing all subcategories within each
8869: category, -recursive)
8870:
1.655 raeburn 8871: Returns: nothing
8872:
8873: Side effects: populates trails and allitems hash references.
8874:
8875: =cut
8876:
8877: sub extract_categories {
1.665 raeburn 8878: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8879: if (ref($categories) eq 'HASH') {
8880: &gather_categories($categories,$cats,$idx,$jsarray);
8881: if (ref($cats->[0]) eq 'ARRAY') {
8882: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8883: my $name = $cats->[0][$i];
8884: my $item = &escape($name).'::0';
8885: my $trailstr;
8886: if ($name eq 'instcode') {
8887: $trailstr = &mt('Official courses (with institutional codes)');
8888: } else {
8889: $trailstr = $name;
8890: }
8891: if ($allitems->{$item} eq '') {
8892: push(@{$trails},$trailstr);
8893: $allitems->{$item} = scalar(@{$trails})-1;
8894: }
8895: my @parents = ($name);
8896: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8897: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8898: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8899: if (ref($subcats) eq 'HASH') {
8900: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8901: }
8902: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8903: }
8904: } else {
8905: if (ref($subcats) eq 'HASH') {
8906: $subcats->{$item} = [];
1.655 raeburn 8907: }
8908: }
8909: }
8910: }
8911: }
8912: return;
8913: }
8914:
8915: =pod
8916:
8917: =item *&recurse_categories()
8918:
8919: Recursively used to generate breadcrumb trails for course categories.
8920:
8921: Inputs:
1.663 raeburn 8922:
1.655 raeburn 8923: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8924: categories and subcategories).
1.663 raeburn 8925:
1.655 raeburn 8926: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8927:
8928: category (current course category, for which breadcrumb trail is being generated).
8929:
8930: trails (reference to array of breadcrumb trails for each category).
8931:
1.655 raeburn 8932: allitems (reference to hash - key is category key
8933: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8934:
1.655 raeburn 8935: parents (array containing containers directories for current category,
8936: back to top level).
8937:
8938: Returns: nothing
8939:
8940: Side effects: populates trails and allitems hash references
8941:
8942: =cut
8943:
8944: sub recurse_categories {
1.665 raeburn 8945: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8946: my $shallower = $depth - 1;
8947: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8948: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8949: my $name = $cats->[$depth]{$category}[$k];
8950: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8951: my $trailstr = join(' -> ',(@{$parents},$category));
8952: if ($allitems->{$item} eq '') {
8953: push(@{$trails},$trailstr);
8954: $allitems->{$item} = scalar(@{$trails})-1;
8955: }
8956: my $deeper = $depth+1;
8957: push(@{$parents},$category);
1.665 raeburn 8958: if (ref($subcats) eq 'HASH') {
8959: my $subcat = &escape($name).':'.$category.':'.$depth;
8960: for (my $j=@{$parents}; $j>=0; $j--) {
8961: my $higher;
8962: if ($j > 0) {
8963: $higher = &escape($parents->[$j]).':'.
8964: &escape($parents->[$j-1]).':'.$j;
8965: } else {
8966: $higher = &escape($parents->[$j]).'::'.$j;
8967: }
8968: push(@{$subcats->{$higher}},$subcat);
8969: }
8970: }
8971: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8972: $subcats);
1.655 raeburn 8973: pop(@{$parents});
8974: }
8975: } else {
8976: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8977: my $trailstr = join(' -> ',(@{$parents},$category));
8978: if ($allitems->{$item} eq '') {
8979: push(@{$trails},$trailstr);
8980: $allitems->{$item} = scalar(@{$trails})-1;
8981: }
8982: }
8983: return;
8984: }
8985:
1.663 raeburn 8986: =pod
8987:
8988: =item *&assign_categories_table()
8989:
8990: Create a datatable for display of hierarchical categories in a domain,
8991: with checkboxes to allow a course to be categorized.
8992:
8993: Inputs:
8994:
8995: cathash - reference to hash of categories defined for the domain (from
8996: configuration.db)
8997:
8998: currcat - scalar with an & separated list of categories assigned to a course.
8999:
9000: Returns: $output (markup to be displayed)
9001:
9002: =cut
9003:
9004: sub assign_categories_table {
9005: my ($cathash,$currcat) = @_;
9006: my $output;
9007: if (ref($cathash) eq 'HASH') {
9008: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9009: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9010: $maxdepth = scalar(@cats);
9011: if (@cats > 0) {
9012: my $itemcount = 0;
9013: if (ref($cats[0]) eq 'ARRAY') {
9014: $output = &Apache::loncommon::start_data_table();
9015: my @currcategories;
9016: if ($currcat ne '') {
9017: @currcategories = split('&',$currcat);
9018: }
9019: for (my $i=0; $i<@{$cats[0]}; $i++) {
9020: my $parent = $cats[0][$i];
9021: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9022: next if ($parent eq 'instcode');
9023: my $item = &escape($parent).'::0';
9024: my $checked = '';
9025: if (@currcategories > 0) {
9026: if (grep(/^\Q$item\E$/,@currcategories)) {
9027: $checked = ' checked="checked" ';
9028: }
9029: }
1.675 raeburn 9030: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9031: '<input type="checkbox" name="usecategory" value="'.
9032: $item.'"'.$checked.' />'.$parent.'</span>'.
9033: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9034: my $depth = 1;
9035: push(@path,$parent);
9036: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9037: pop(@path);
9038: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9039: $itemcount ++;
9040: }
9041: $output .= &Apache::loncommon::end_data_table();
9042: }
9043: }
9044: }
9045: return $output;
9046: }
9047:
9048: =pod
9049:
9050: =item *&assign_category_rows()
9051:
9052: Create a datatable row for display of nested categories in a domain,
9053: with checkboxes to allow a course to be categorized,called recursively.
9054:
9055: Inputs:
9056:
9057: itemcount - track row number for alternating colors
9058:
9059: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9060: categories and subcategories.
9061:
9062: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9063:
9064: parent - parent of current category item
9065:
9066: path - Array containing all categories back up through the hierarchy from the
9067: current category to the top level.
9068:
9069: currcategories - reference to array of current categories assigned to the course
9070:
9071: Returns: $output (markup to be displayed).
9072:
9073: =cut
9074:
9075: sub assign_category_rows {
9076: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9077: my ($text,$name,$item,$chgstr);
9078: if (ref($cats) eq 'ARRAY') {
9079: my $maxdepth = scalar(@{$cats});
9080: if (ref($cats->[$depth]) eq 'HASH') {
9081: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9082: my $numchildren = @{$cats->[$depth]{$parent}};
9083: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9084: $text .= '<td><table class="LC_datatable">';
9085: for (my $j=0; $j<$numchildren; $j++) {
9086: $name = $cats->[$depth]{$parent}[$j];
9087: $item = &escape($name).':'.&escape($parent).':'.$depth;
9088: my $deeper = $depth+1;
9089: my $checked = '';
9090: if (ref($currcategories) eq 'ARRAY') {
9091: if (@{$currcategories} > 0) {
9092: if (grep(/^\Q$item\E$/,@{$currcategories})) {
9093: $checked = ' checked="checked" ';
9094: }
9095: }
9096: }
1.664 raeburn 9097: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9098: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9099: $item.'"'.$checked.' />'.$name.'</label></span>'.
9100: '<input type="hidden" name="catname" value="'.$name.'" />'.
9101: '</td><td>';
1.663 raeburn 9102: if (ref($path) eq 'ARRAY') {
9103: push(@{$path},$name);
9104: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9105: pop(@{$path});
9106: }
9107: $text .= '</td></tr>';
9108: }
9109: $text .= '</table></td>';
9110: }
9111: }
9112: }
9113: return $text;
9114: }
9115:
1.655 raeburn 9116: ############################################################
9117: ############################################################
9118:
9119:
1.443 albertel 9120: sub commit_customrole {
1.664 raeburn 9121: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9122: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9123: ($start?', '.&mt('starting').' '.localtime($start):'').
9124: ($end?', ending '.localtime($end):'').': <b>'.
9125: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9126: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9127: '</b><br />';
9128: return $output;
9129: }
9130:
9131: sub commit_standardrole {
1.541 raeburn 9132: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9133: my ($output,$logmsg,$linefeed);
9134: if ($context eq 'auto') {
9135: $linefeed = "\n";
9136: } else {
9137: $linefeed = "<br />\n";
9138: }
1.443 albertel 9139: if ($three eq 'st') {
1.541 raeburn 9140: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9141: $one,$two,$sec,$context);
9142: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9143: ($result eq 'unknown_course') || ($result eq 'refused')) {
9144: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9145: } else {
1.541 raeburn 9146: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9147: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9148: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9149: if ($context eq 'auto') {
9150: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9151: } else {
9152: $output .= '<b>'.$result.'</b>'.$linefeed.
9153: &mt('Add to classlist').': <b>ok</b>';
9154: }
9155: $output .= $linefeed;
1.443 albertel 9156: }
9157: } else {
9158: $output = &mt('Assigning').' '.$three.' in '.$url.
9159: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9160: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9161: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9162: if ($context eq 'auto') {
9163: $output .= $result.$linefeed;
9164: } else {
9165: $output .= '<b>'.$result.'</b>'.$linefeed;
9166: }
1.443 albertel 9167: }
9168: return $output;
9169: }
9170:
9171: sub commit_studentrole {
1.541 raeburn 9172: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9173: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9174: if ($context eq 'auto') {
9175: $linefeed = "\n";
9176: } else {
9177: $linefeed = '<br />'."\n";
9178: }
1.443 albertel 9179: if (defined($one) && defined($two)) {
9180: my $cid=$one.'_'.$two;
9181: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9182: my $secchange = 0;
9183: my $expire_role_result;
9184: my $modify_section_result;
1.628 raeburn 9185: if ($oldsec ne '-1') {
9186: if ($oldsec ne $sec) {
1.443 albertel 9187: $secchange = 1;
1.628 raeburn 9188: my $now = time;
1.443 albertel 9189: my $uurl='/'.$cid;
9190: $uurl=~s/\_/\//g;
9191: if ($oldsec) {
9192: $uurl.='/'.$oldsec;
9193: }
1.626 raeburn 9194: $oldsecurl = $uurl;
1.628 raeburn 9195: $expire_role_result =
1.652 raeburn 9196: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9197: if ($env{'request.course.sec'} ne '') {
9198: if ($expire_role_result eq 'refused') {
9199: my @roles = ('st');
9200: my @statuses = ('previous');
9201: my @roledoms = ($one);
9202: my $withsec = 1;
9203: my %roleshash =
9204: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9205: \@statuses,\@roles,\@roledoms,$withsec);
9206: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9207: my ($oldstart,$oldend) =
9208: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9209: if ($oldend > 0 && $oldend <= $now) {
9210: $expire_role_result = 'ok';
9211: }
9212: }
9213: }
9214: }
1.443 albertel 9215: $result = $expire_role_result;
9216: }
9217: }
9218: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9219: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9220: if ($modify_section_result =~ /^ok/) {
9221: if ($secchange == 1) {
1.628 raeburn 9222: if ($sec eq '') {
9223: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9224: } else {
9225: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9226: }
1.443 albertel 9227: } elsif ($oldsec eq '-1') {
1.628 raeburn 9228: if ($sec eq '') {
9229: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9230: } else {
9231: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9232: }
1.443 albertel 9233: } else {
1.628 raeburn 9234: if ($sec eq '') {
9235: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9236: } else {
9237: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9238: }
1.443 albertel 9239: }
9240: } else {
1.628 raeburn 9241: if ($secchange) {
9242: $$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;
9243: } else {
9244: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9245: }
1.443 albertel 9246: }
9247: $result = $modify_section_result;
9248: } elsif ($secchange == 1) {
1.628 raeburn 9249: if ($oldsec eq '') {
9250: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9251: } else {
9252: $$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;
9253: }
1.626 raeburn 9254: if ($expire_role_result eq 'refused') {
9255: my $newsecurl = '/'.$cid;
9256: $newsecurl =~ s/\_/\//g;
9257: if ($sec ne '') {
9258: $newsecurl.='/'.$sec;
9259: }
9260: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9261: if ($sec eq '') {
9262: $$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;
9263: } else {
9264: $$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;
9265: }
9266: }
9267: }
1.443 albertel 9268: }
9269: } else {
1.626 raeburn 9270: $$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 9271: $result = "error: incomplete course id\n";
9272: }
9273: return $result;
9274: }
9275:
9276: ############################################################
9277: ############################################################
9278:
1.566 albertel 9279: sub check_clone {
1.578 raeburn 9280: my ($args,$linefeed) = @_;
1.566 albertel 9281: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9282: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9283: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9284: my $clonemsg;
9285: my $can_clone = 0;
9286:
9287: if ($clonehome eq 'no_host') {
1.578 raeburn 9288: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
1.566 albertel 9289: } else {
9290: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9291: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9292: $can_clone = 1;
9293: } else {
9294: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9295: $args->{'clonedomain'},$args->{'clonecourse'});
9296: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9297: if (grep(/^\*$/,@cloners)) {
9298: $can_clone = 1;
9299: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9300: $can_clone = 1;
9301: } else {
9302: my %roleshash =
9303: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9304: $args->{'ccdomain'},
9305: 'userroles',['active'],['cc'],
9306: [$args->{'clonedomain'}]);
9307: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9308: $can_clone = 1;
9309: } else {
9310: $clonemsg = &mt('No new course created.').$linefeed.&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]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
9311: }
1.566 albertel 9312: }
1.578 raeburn 9313: }
1.566 albertel 9314: }
9315: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9316: }
9317:
1.444 albertel 9318: sub construct_course {
1.541 raeburn 9319: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9320: my $outcome;
1.541 raeburn 9321: my $linefeed = '<br />'."\n";
9322: if ($context eq 'auto') {
9323: $linefeed = "\n";
9324: }
1.566 albertel 9325:
9326: #
9327: # Are we cloning?
9328: #
9329: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9330: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9331: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9332: if ($context ne 'auto') {
1.578 raeburn 9333: if ($clonemsg ne '') {
9334: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9335: }
1.566 albertel 9336: }
9337: $outcome .= $clonemsg.$linefeed;
9338:
9339: if (!$can_clone) {
9340: return (0,$outcome);
9341: }
9342: }
9343:
1.444 albertel 9344: #
9345: # Open course
9346: #
9347: my $crstype = lc($args->{'crstype'});
9348: my %cenv=();
9349: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9350: $args->{'cdescr'},
9351: $args->{'curl'},
9352: $args->{'course_home'},
9353: $args->{'nonstandard'},
9354: $args->{'crscode'},
9355: $args->{'ccuname'}.':'.
9356: $args->{'ccdomain'},
9357: $args->{'crstype'});
9358:
9359: # Note: The testing routines depend on this being output; see
9360: # Utils::Course. This needs to at least be output as a comment
9361: # if anyone ever decides to not show this, and Utils::Course::new
9362: # will need to be suitably modified.
1.541 raeburn 9363: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9364: #
9365: # Check if created correctly
9366: #
1.479 albertel 9367: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9368: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9369: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9370:
1.444 albertel 9371: #
1.566 albertel 9372: # Do the cloning
9373: #
9374: if ($can_clone && $cloneid) {
9375: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9376: if ($context ne 'auto') {
9377: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9378: }
9379: $outcome .= $clonemsg.$linefeed;
9380: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9381: # Copy all files
1.637 www 9382: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9383: # Restore URL
1.566 albertel 9384: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9385: # Restore title
1.566 albertel 9386: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9387: # Mark as cloned
1.566 albertel 9388: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9389: # Need to clone grading mode
9390: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9391: $cenv{'grading'}=$newenv{'grading'};
9392: # Do not clone these environment entries
9393: &Apache::lonnet::del('environment',
9394: ['default_enrollment_start_date',
9395: 'default_enrollment_end_date',
9396: 'question.email',
9397: 'policy.email',
9398: 'comment.email',
9399: 'pch.users.denied',
1.725 raeburn 9400: 'plc.users.denied',
9401: 'hidefromcat',
9402: 'categories'],
1.638 www 9403: $$crsudom,$$crsunum);
1.444 albertel 9404: }
1.566 albertel 9405:
1.444 albertel 9406: #
9407: # Set environment (will override cloned, if existing)
9408: #
9409: my @sections = ();
9410: my @xlists = ();
9411: if ($args->{'crstype'}) {
9412: $cenv{'type'}=$args->{'crstype'};
9413: }
9414: if ($args->{'crsid'}) {
9415: $cenv{'courseid'}=$args->{'crsid'};
9416: }
9417: if ($args->{'crscode'}) {
9418: $cenv{'internal.coursecode'}=$args->{'crscode'};
9419: }
9420: if ($args->{'crsquota'} ne '') {
9421: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9422: } else {
9423: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9424: }
9425: if ($args->{'ccuname'}) {
9426: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9427: ':'.$args->{'ccdomain'};
9428: } else {
9429: $cenv{'internal.courseowner'} = $args->{'curruser'};
9430: }
9431: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9432: if ($args->{'crssections'}) {
9433: $cenv{'internal.sectionnums'} = '';
9434: if ($args->{'crssections'} =~ m/,/) {
9435: @sections = split/,/,$args->{'crssections'};
9436: } else {
9437: $sections[0] = $args->{'crssections'};
9438: }
9439: if (@sections > 0) {
9440: foreach my $item (@sections) {
9441: my ($sec,$gp) = split/:/,$item;
9442: my $class = $args->{'crscode'}.$sec;
9443: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9444: $cenv{'internal.sectionnums'} .= $item.',';
9445: unless ($addcheck eq 'ok') {
9446: push @badclasses, $class;
9447: }
9448: }
9449: $cenv{'internal.sectionnums'} =~ s/,$//;
9450: }
9451: }
9452: # do not hide course coordinator from staff listing,
9453: # even if privileged
9454: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9455: # add crosslistings
9456: if ($args->{'crsxlist'}) {
9457: $cenv{'internal.crosslistings'}='';
9458: if ($args->{'crsxlist'} =~ m/,/) {
9459: @xlists = split/,/,$args->{'crsxlist'};
9460: } else {
9461: $xlists[0] = $args->{'crsxlist'};
9462: }
9463: if (@xlists > 0) {
9464: foreach my $item (@xlists) {
9465: my ($xl,$gp) = split/:/,$item;
9466: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9467: $cenv{'internal.crosslistings'} .= $item.',';
9468: unless ($addcheck eq 'ok') {
9469: push @badclasses, $xl;
9470: }
9471: }
9472: $cenv{'internal.crosslistings'} =~ s/,$//;
9473: }
9474: }
9475: if ($args->{'autoadds'}) {
9476: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9477: }
9478: if ($args->{'autodrops'}) {
9479: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9480: }
9481: # check for notification of enrollment changes
9482: my @notified = ();
9483: if ($args->{'notify_owner'}) {
9484: if ($args->{'ccuname'} ne '') {
9485: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9486: }
9487: }
9488: if ($args->{'notify_dc'}) {
9489: if ($uname ne '') {
1.630 raeburn 9490: push(@notified,$uname.':'.$udom);
1.444 albertel 9491: }
9492: }
9493: if (@notified > 0) {
9494: my $notifylist;
9495: if (@notified > 1) {
9496: $notifylist = join(',',@notified);
9497: } else {
9498: $notifylist = $notified[0];
9499: }
9500: $cenv{'internal.notifylist'} = $notifylist;
9501: }
9502: if (@badclasses > 0) {
9503: my %lt=&Apache::lonlocal::texthash(
9504: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course. However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
9505: 'dnhr' => 'does not have rights to access enrollment in these classes',
9506: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9507: );
1.541 raeburn 9508: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9509: ' ('.$lt{'adby'}.')';
9510: if ($context eq 'auto') {
9511: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9512: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9513: foreach my $item (@badclasses) {
9514: if ($context eq 'auto') {
9515: $outcome .= " - $item\n";
9516: } else {
9517: $outcome .= "<li>$item</li>\n";
9518: }
9519: }
9520: if ($context eq 'auto') {
9521: $outcome .= $linefeed;
9522: } else {
1.566 albertel 9523: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9524: }
9525: }
1.444 albertel 9526: }
9527: if ($args->{'no_end_date'}) {
9528: $args->{'endaccess'} = 0;
9529: }
9530: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9531: $cenv{'internal.autoend'}=$args->{'enrollend'};
9532: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9533: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9534: if ($args->{'showphotos'}) {
9535: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9536: }
9537: $cenv{'internal.authtype'} = $args->{'authtype'};
9538: $cenv{'internal.autharg'} = $args->{'autharg'};
9539: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9540: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9541: 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');
9542: if ($context eq 'auto') {
9543: $outcome .= $krb_msg;
9544: } else {
1.566 albertel 9545: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9546: }
9547: $outcome .= $linefeed;
1.444 albertel 9548: }
9549: }
9550: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9551: if ($args->{'setpolicy'}) {
9552: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9553: }
9554: if ($args->{'setcontent'}) {
9555: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9556: }
9557: }
9558: if ($args->{'reshome'}) {
9559: $cenv{'reshome'}=$args->{'reshome'}.'/';
9560: $cenv{'reshome'}=~s/\/+$/\//;
9561: }
9562: #
9563: # course has keyed access
9564: #
9565: if ($args->{'setkeys'}) {
9566: $cenv{'keyaccess'}='yes';
9567: }
9568: # if specified, key authority is not course, but user
9569: # only active if keyaccess is yes
9570: if ($args->{'keyauth'}) {
1.487 albertel 9571: my ($user,$domain) = split(':',$args->{'keyauth'});
9572: $user = &LONCAPA::clean_username($user);
9573: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9574: if ($user ne '' && $domain ne '') {
1.487 albertel 9575: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9576: }
9577: }
9578:
9579: if ($args->{'disresdis'}) {
9580: $cenv{'pch.roles.denied'}='st';
9581: }
9582: if ($args->{'disablechat'}) {
9583: $cenv{'plc.roles.denied'}='st';
9584: }
9585:
9586: # Record we've not yet viewed the Course Initialization Helper for this
9587: # course
9588: $cenv{'course.helper.not.run'} = 1;
9589: #
9590: # Use new Randomseed
9591: #
9592: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9593: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9594: #
9595: # The encryption code and receipt prefix for this course
9596: #
9597: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9598: $cenv{'internal.encpref'}=100+int(9*rand(99));
9599: #
9600: # By default, use standard grading
9601: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9602:
1.541 raeburn 9603: $outcome .= $linefeed.&mt('Setting environment').': '.
9604: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9605: #
9606: # Open all assignments
9607: #
9608: if ($args->{'openall'}) {
9609: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9610: my %storecontent = ($storeunder => time,
9611: $storeunder.'.type' => 'date_start');
9612:
9613: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9614: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9615: }
9616: #
9617: # Set first page
9618: #
9619: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9620: || ($cloneid)) {
1.445 albertel 9621: use LONCAPA::map;
1.444 albertel 9622: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9623:
9624: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9625: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9626:
1.444 albertel 9627: $outcome .= ($fatal?$errtext:'read ok').' - ';
9628: my $title; my $url;
9629: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9630: $title=&mt('Syllabus');
1.444 albertel 9631: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9632: } else {
1.690 bisitz 9633: $title=&mt('Navigate Contents');
1.444 albertel 9634: $url='/adm/navmaps';
9635: }
1.445 albertel 9636:
9637: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9638: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9639:
9640: if ($errtext) { $fatal=2; }
1.541 raeburn 9641: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9642: }
1.566 albertel 9643:
9644: return (1,$outcome);
1.444 albertel 9645: }
9646:
9647: ############################################################
9648: ############################################################
9649:
1.378 raeburn 9650: sub course_type {
9651: my ($cid) = @_;
9652: if (!defined($cid)) {
9653: $cid = $env{'request.course.id'};
9654: }
1.404 albertel 9655: if (defined($env{'course.'.$cid.'.type'})) {
9656: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9657: } else {
9658: return 'Course';
1.377 raeburn 9659: }
9660: }
1.156 albertel 9661:
1.406 raeburn 9662: sub group_term {
9663: my $crstype = &course_type();
9664: my %names = (
9665: 'Course' => 'group',
9666: 'Group' => 'team',
9667: );
9668: return $names{$crstype};
9669: }
9670:
1.156 albertel 9671: sub icon {
9672: my ($file)=@_;
1.505 albertel 9673: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9674: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9675: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9676: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9677: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9678: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9679: $curfext.".gif") {
9680: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9681: $curfext.".gif";
9682: }
9683: }
1.249 albertel 9684: return &lonhttpdurl($iconname);
1.154 albertel 9685: }
1.84 albertel 9686:
1.575 albertel 9687: sub lonhttpdurl {
1.692 www 9688: #
9689: # Had been used for "small fry" static images on separate port 8080.
9690: # Modify here if lightweight http functionality desired again.
9691: # Currently eliminated due to increasing firewall issues.
9692: #
1.575 albertel 9693: my ($url)=@_;
1.692 www 9694: return $url;
1.215 albertel 9695: }
9696:
1.213 albertel 9697: sub connection_aborted {
9698: my ($r)=@_;
9699: $r->print(" ");$r->rflush();
9700: my $c = $r->connection;
9701: return $c->aborted();
9702: }
9703:
1.221 foxr 9704: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9705: # strings as 'strings'.
9706: sub escape_single {
1.221 foxr 9707: my ($input) = @_;
1.223 albertel 9708: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9709: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9710: return $input;
9711: }
1.223 albertel 9712:
1.222 foxr 9713: # Same as escape_single, but escape's "'s This
9714: # can be used for "strings"
9715: sub escape_double {
9716: my ($input) = @_;
9717: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9718: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9719: return $input;
9720: }
1.223 albertel 9721:
1.222 foxr 9722: # Escapes the last element of a full URL.
9723: sub escape_url {
9724: my ($url) = @_;
1.238 raeburn 9725: my @urlslices = split(/\//, $url,-1);
1.369 www 9726: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9727: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9728: }
1.462 albertel 9729:
9730: # -------------------------------------------------------- Initliaze user login
9731: sub init_user_environment {
1.463 albertel 9732: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9733: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9734:
9735: my $public=($username eq 'public' && $domain eq 'public');
9736:
9737: # See if old ID present, if so, remove
9738:
9739: my ($filename,$cookie,$userroles);
9740: my $now=time;
9741:
9742: if ($public) {
9743: my $max_public=100;
9744: my $oldest;
9745: my $oldest_time=0;
9746: for(my $next=1;$next<=$max_public;$next++) {
9747: if (-e $lonids."/publicuser_$next.id") {
9748: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9749: if ($mtime<$oldest_time || !$oldest_time) {
9750: $oldest_time=$mtime;
9751: $oldest=$next;
9752: }
9753: } else {
9754: $cookie="publicuser_$next";
9755: last;
9756: }
9757: }
9758: if (!$cookie) { $cookie="publicuser_$oldest"; }
9759: } else {
1.463 albertel 9760: # if this isn't a robot, kill any existing non-robot sessions
9761: if (!$args->{'robot'}) {
9762: opendir(DIR,$lonids);
9763: while ($filename=readdir(DIR)) {
9764: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9765: unlink($lonids.'/'.$filename);
9766: }
1.462 albertel 9767: }
1.463 albertel 9768: closedir(DIR);
1.462 albertel 9769: }
9770: # Give them a new cookie
1.463 albertel 9771: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9772: : $now.$$.int(rand(10000)));
1.463 albertel 9773: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9774:
9775: # Initialize roles
9776:
9777: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9778: }
9779: # ------------------------------------ Check browser type and MathML capability
9780:
9781: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9782: $clientunicode,$clientos) = &decode_user_agent($r);
9783:
9784: # -------------------------------------- Any accessibility options to remember?
9785: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9786: foreach my $option ('imagesuppress','appletsuppress',
9787: 'embedsuppress','fontenhance','blackwhite') {
9788: if ($form->{$option} eq 'true') {
9789: &Apache::lonnet::put('environment',{$option => 'on'},
9790: $domain,$username);
9791: } else {
9792: &Apache::lonnet::del('environment',[$option],
9793: $domain,$username);
9794: }
9795: }
9796: }
9797: # ------------------------------------------------------------- Get environment
9798:
9799: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9800: my ($tmp) = keys(%userenv);
9801: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9802: # default remote control to off
9803: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9804: } else {
9805: undef(%userenv);
9806: }
9807: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9808: $form->{'interface'}=$userenv{'interface'};
9809: }
9810: $env{'environment.remote'}=$userenv{'remote'};
9811: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9812:
9813: # --------------- Do not trust query string to be put directly into environment
9814: foreach my $option ('imagesuppress','appletsuppress',
9815: 'embedsuppress','fontenhance','blackwhite',
9816: 'interface','localpath','localres') {
9817: $form->{$option}=~s/[\n\r\=]//gs;
9818: }
9819: # --------------------------------------------------------- Write first profile
9820:
9821: {
9822: my %initial_env =
9823: ("user.name" => $username,
9824: "user.domain" => $domain,
9825: "user.home" => $authhost,
9826: "browser.type" => $clientbrowser,
9827: "browser.version" => $clientversion,
9828: "browser.mathml" => $clientmathml,
9829: "browser.unicode" => $clientunicode,
9830: "browser.os" => $clientos,
9831: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9832: "request.course.fn" => '',
9833: "request.course.uri" => '',
9834: "request.course.sec" => '',
9835: "request.role" => 'cm',
9836: "request.role.adv" => $env{'user.adv'},
9837: "request.host" => $ENV{'REMOTE_ADDR'},);
9838:
9839: if ($form->{'localpath'}) {
9840: $initial_env{"browser.localpath"} = $form->{'localpath'};
9841: $initial_env{"browser.localres"} = $form->{'localres'};
9842: }
9843:
9844: if ($public) {
9845: $initial_env{"environment.remote"} = "off";
9846: }
9847: if ($form->{'interface'}) {
9848: $form->{'interface'}=~s/\W//gs;
9849: $initial_env{"browser.interface"} = $form->{'interface'};
9850: $env{'browser.interface'}=$form->{'interface'};
9851: foreach my $option ('imagesuppress','appletsuppress',
9852: 'embedsuppress','fontenhance','blackwhite') {
9853: if (($form->{$option} eq 'true') ||
9854: ($userenv{$option} eq 'on')) {
9855: $initial_env{"browser.$option"} = "on";
9856: }
9857: }
9858: }
9859:
1.724 raeburn 9860: foreach my $tool ('aboutme','blog','portfolio') {
9861: $userenv{'availabletools.'.$tool} =
9862: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
9863: }
9864:
1.462 albertel 9865: $env{'user.environment'} = "$lonids/$cookie.id";
9866:
9867: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9868: &GDBM_WRCREAT(),0640)) {
9869: &_add_to_env(\%disk_env,\%initial_env);
9870: &_add_to_env(\%disk_env,\%userenv,'environment.');
9871: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9872: if (ref($args->{'extra_env'})) {
9873: &_add_to_env(\%disk_env,$args->{'extra_env'});
9874: }
1.462 albertel 9875: untie(%disk_env);
9876: } else {
1.705 tempelho 9877: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
9878: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 9879: return 'error: '.$!;
9880: }
9881: }
9882: $env{'request.role'}='cm';
9883: $env{'request.role.adv'}=$env{'user.adv'};
9884: $env{'browser.type'}=$clientbrowser;
9885:
9886: return $cookie;
9887:
9888: }
9889:
9890: sub _add_to_env {
9891: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9892: if (ref($env_data) eq 'HASH') {
9893: while (my ($key,$value) = each(%$env_data)) {
9894: $idf->{$prefix.$key} = $value;
9895: $env{$prefix.$key} = $value;
9896: }
1.462 albertel 9897: }
9898: }
9899:
1.685 tempelho 9900: # --- Get the symbolic name of a problem and the url
9901: sub get_symb {
9902: my ($request,$silent) = @_;
1.726 raeburn 9903: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 9904: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9905: if ($symb eq '') {
9906: if (!$silent) {
9907: $request->print("Unable to handle ambiguous references:$url:.");
9908: return ();
9909: }
9910: }
9911: &Apache::lonenc::check_decrypt(\$symb);
9912: return ($symb);
9913: }
9914:
9915: # --------------------------------------------------------------Get annotation
9916:
9917: sub get_annotation {
9918: my ($symb,$enc) = @_;
9919:
9920: my $key = $symb;
9921: if (!$enc) {
9922: $key =
9923: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9924: }
9925: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9926: return $annotation{$key};
9927: }
9928:
9929: sub clean_symb {
1.731 raeburn 9930: my ($symb,$delete_enc) = @_;
1.685 tempelho 9931:
9932: &Apache::lonenc::check_decrypt(\$symb);
9933: my $enc = $env{'request.enc'};
1.731 raeburn 9934: if ($delete_enc) {
1.730 raeburn 9935: delete($env{'request.enc'});
9936: }
1.685 tempelho 9937:
9938: return ($symb,$enc);
9939: }
1.462 albertel 9940:
1.41 ng 9941: =pod
9942:
9943: =back
9944:
1.112 bowersj2 9945: =cut
1.41 ng 9946:
1.112 bowersj2 9947: 1;
9948: __END__;
1.41 ng 9949:
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