Annotation of loncom/interface/loncommon.pm, revision 1.782
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.782 ! bisitz 4: # $Id: loncommon.pm,v 1.781 2009/03/27 04:59:30 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.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');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.74 www 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";
1.776 bisitz 455: <script type="text/javascript" language="JavaScript">
1.653 raeburn 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.776 bisitz 476: <script type="text/javascript" language="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.776 bisitz 799: $result.='<script type="text/javascript" language="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.755 neumanie 926: if ($text ne "") {
1.763 bisitz 927: $template.='<span class="LC_help_open_topic">'
928: .'<a target="_top" href="'.$link.'">'
929: .$text.'</a>';
1.48 bowersj2 930: }
931:
1.763 bisitz 932: # (Always) Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 935: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
936: .'<img src="'.$helpicon.'" border="0"'
937: .' alt="'.&mt('Help: [_1]',$topic).'"'
938: .' title="'.$title.'"'
939: .' /></a>';
940: if ($text ne "") {
941: $template.='</span>';
942: }
1.44 bowersj2 943: return $template;
944:
1.106 bowersj2 945: }
946:
947: # This is a quicky function for Latex cheatsheet editing, since it
948: # appears in at least four places
949: sub helpLatexCheatsheet {
1.732 raeburn 950: my ($topic,$text,$not_author) = @_;
951: my $out;
1.106 bowersj2 952: my $addOther = '';
1.732 raeburn 953: if ($topic) {
1.763 bisitz 954: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
955: undef, undef, 600).
956: '</span> ';
957: }
958: $out = '<span>' # Start cheatsheet
959: .$addOther
960: .'<span>'
961: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
962: undef,undef,600)
963: .'</span> <span>'
964: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
965: undef,undef,600)
966: .'</span>';
1.732 raeburn 967: unless ($not_author) {
1.763 bisitz 968: $out .= ' <span>'
969: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
970: undef,undef,600)
971: .'</span>';
1.732 raeburn 972: }
1.763 bisitz 973: $out .= '</span>'; # End cheatsheet
1.732 raeburn 974: return $out;
1.172 www 975: }
976:
1.430 albertel 977: sub general_help {
978: my $helptopic='Student_Intro';
979: if ($env{'request.role'}=~/^(ca|au)/) {
980: $helptopic='Authoring_Intro';
981: } elsif ($env{'request.role'}=~/^cc/) {
982: $helptopic='Course_Coordination_Intro';
1.672 raeburn 983: } elsif ($env{'request.role'}=~/^dc/) {
984: $helptopic='Domain_Coordination_Intro';
1.430 albertel 985: }
986: return $helptopic;
987: }
988:
989: sub update_help_link {
990: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
991: my $origurl = $ENV{'REQUEST_URI'};
992: $origurl=~s|^/~|/priv/|;
993: my $timestamp = time;
994: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
995: $$datum = &escape($$datum);
996: }
997:
998: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
999: my $output .= <<"ENDOUTPUT";
1000: <script type="text/javascript">
1001: banner_link = '$banner_link';
1002: </script>
1003: ENDOUTPUT
1004: return $output;
1005: }
1006:
1007: # now just updates the help link and generates a blue icon
1.193 raeburn 1008: sub help_open_menu {
1.430 albertel 1009: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1010: = @_;
1.430 albertel 1011: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1012: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1013: # if environment.remote is on (using remote control UI)
1.572 banghart 1014: if ($env{'browser.interface'} eq 'textual' ||
1015: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1016: $stayOnPage=1;
1.430 albertel 1017: }
1018: my $output;
1019: if ($component_help) {
1020: if (!$text) {
1021: $output=&help_open_topic($component_help,undef,$stayOnPage,
1022: $width,$height);
1023: } else {
1024: my $help_text;
1025: $help_text=&unescape($topic);
1026: $output='<table><tr><td>'.
1027: &help_open_topic($component_help,$help_text,$stayOnPage,
1028: $width,$height).'</td></tr></table>';
1029: }
1030: }
1031: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1032: return $output.$banner_link;
1033: }
1034:
1035: sub top_nav_help {
1036: my ($text) = @_;
1.436 albertel 1037: $text = &mt($text);
1.572 banghart 1038: my $stay_on_page =
1.436 albertel 1039: ($env{'browser.interface'} eq 'textual' ||
1040: $env{'environment.remote'} eq 'off' );
1.572 banghart 1041: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1042: : "javascript:helpMenu('open')";
1.572 banghart 1043: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1044:
1.201 raeburn 1045: my $title = &mt('Get help');
1.436 albertel 1046:
1047: return <<"END";
1048: $banner_link
1049: <a href="$link" title="$title">$text</a>
1050: END
1051: }
1052:
1053: sub help_menu_js {
1054: my ($text) = @_;
1055:
1056: my $stayOnPage =
1057: ($env{'browser.interface'} eq 'textual' ||
1058: $env{'environment.remote'} eq 'off' );
1059:
1060: my $width = 620;
1061: my $height = 600;
1.430 albertel 1062: my $helptopic=&general_help();
1063: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1064: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1065: my $start_page =
1066: &Apache::loncommon::start_page('Help Menu', undef,
1067: {'frameset' => 1,
1068: 'js_ready' => 1,
1069: 'add_entries' => {
1070: 'border' => '0',
1.579 raeburn 1071: 'rows' => "110,*",},});
1.331 albertel 1072: my $end_page =
1073: &Apache::loncommon::end_page({'frameset' => 1,
1074: 'js_ready' => 1,});
1075:
1.436 albertel 1076: my $template .= <<"ENDTEMPLATE";
1077: <script type="text/javascript">
1.253 albertel 1078: // <!-- BEGIN LON-CAPA Internal
1079: // <![CDATA[
1.430 albertel 1080: var banner_link = '';
1.243 raeburn 1081: function helpMenu(target) {
1082: var caller = this;
1083: if (target == 'open') {
1084: var newWindow = null;
1085: try {
1.262 albertel 1086: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1087: }
1088: catch(error) {
1089: writeHelp(caller);
1090: return;
1091: }
1092: if (newWindow) {
1093: caller = newWindow;
1094: }
1.193 raeburn 1095: }
1.243 raeburn 1096: writeHelp(caller);
1097: return;
1098: }
1099: function writeHelp(caller) {
1.430 albertel 1100: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1101: caller.document.close()
1102: caller.focus()
1.193 raeburn 1103: }
1.253 albertel 1104: // ]]>
1.219 albertel 1105: // END LON-CAPA Internal -->
1.436 albertel 1106: </script>
1.193 raeburn 1107: ENDTEMPLATE
1108: return $template;
1109: }
1110:
1.172 www 1111: sub help_open_bug {
1112: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1113: unless ($env{'user.adv'}) { return ''; }
1.172 www 1114: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1115: $text = "" if (not defined $text);
1116: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1117: if ($env{'browser.interface'} eq 'textual' ||
1118: $env{'environment.remote'} eq 'off' ) {
1.172 www 1119: $stayOnPage=1;
1120: }
1.184 albertel 1121: $width = 600 if (not defined $width);
1122: $height = 600 if (not defined $height);
1.172 www 1123:
1124: $topic=~s/\W+/\+/g;
1125: my $link='';
1126: my $template='';
1.379 albertel 1127: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1128: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1129: if (!$stayOnPage)
1130: {
1131: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1132: }
1133: else
1134: {
1135: $link = $url;
1136: }
1137: # Add the text
1138: if ($text ne "")
1139: {
1140: $template .=
1141: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1142: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1143: }
1144:
1145: # Add the graphic
1.179 matthew 1146: my $title = &mt('Report a Bug');
1.215 albertel 1147: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1148: $template .= <<"ENDTEMPLATE";
1.436 albertel 1149: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1150: ENDTEMPLATE
1151: if ($text ne '') { $template.='</td></tr></table>' };
1152: return $template;
1153:
1154: }
1155:
1156: sub help_open_faq {
1157: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1158: unless ($env{'user.adv'}) { return ''; }
1.172 www 1159: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1160: $text = "" if (not defined $text);
1161: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1162: if ($env{'browser.interface'} eq 'textual' ||
1163: $env{'environment.remote'} eq 'off' ) {
1.172 www 1164: $stayOnPage=1;
1165: }
1166: $width = 350 if (not defined $width);
1167: $height = 400 if (not defined $height);
1168:
1169: $topic=~s/\W+/\+/g;
1170: my $link='';
1171: my $template='';
1172: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1173: if (!$stayOnPage)
1174: {
1175: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1176: }
1177: else
1178: {
1179: $link = $url;
1180: }
1181:
1182: # Add the text
1183: if ($text ne "")
1184: {
1185: $template .=
1.173 www 1186: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1187: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1188: }
1189:
1190: # Add the graphic
1.179 matthew 1191: my $title = &mt('View the FAQ');
1.215 albertel 1192: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1193: $template .= <<"ENDTEMPLATE";
1.436 albertel 1194: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1195: ENDTEMPLATE
1196: if ($text ne '') { $template.='</td></tr></table>' };
1197: return $template;
1198:
1.44 bowersj2 1199: }
1.37 matthew 1200:
1.180 matthew 1201: ###############################################################
1202: ###############################################################
1203:
1.45 matthew 1204: =pod
1205:
1.648 raeburn 1206: =item * &change_content_javascript():
1.256 matthew 1207:
1208: This and the next function allow you to create small sections of an
1209: otherwise static HTML page that you can update on the fly with
1210: Javascript, even in Netscape 4.
1211:
1212: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1213: must be written to the HTML page once. It will prove the Javascript
1214: function "change(name, content)". Calling the change function with the
1215: name of the section
1216: you want to update, matching the name passed to C<changable_area>, and
1217: the new content you want to put in there, will put the content into
1218: that area.
1219:
1220: B<Note>: Netscape 4 only reserves enough space for the changable area
1221: to contain room for the original contents. You need to "make space"
1222: for whatever changes you wish to make, and be B<sure> to check your
1223: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1224: it's adequate for updating a one-line status display, but little more.
1225: This script will set the space to 100% width, so you only need to
1226: worry about height in Netscape 4.
1227:
1228: Modern browsers are much less limiting, and if you can commit to the
1229: user not using Netscape 4, this feature may be used freely with
1230: pretty much any HTML.
1231:
1232: =cut
1233:
1234: sub change_content_javascript {
1235: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1236: if ($env{'browser.type'} eq 'netscape' &&
1237: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1238: return (<<NETSCAPE4);
1239: function change(name, content) {
1240: doc = document.layers[name+"___escape"].layers[0].document;
1241: doc.open();
1242: doc.write(content);
1243: doc.close();
1244: }
1245: NETSCAPE4
1246: } else {
1247: # Otherwise, we need to use semi-standards-compliant code
1248: # (technically, "innerHTML" isn't standard but the equivalent
1249: # is really scary, and every useful browser supports it
1250: return (<<DOMBASED);
1251: function change(name, content) {
1252: element = document.getElementById(name);
1253: element.innerHTML = content;
1254: }
1255: DOMBASED
1256: }
1257: }
1258:
1259: =pod
1260:
1.648 raeburn 1261: =item * &changable_area($name,$origContent):
1.256 matthew 1262:
1263: This provides a "changable area" that can be modified on the fly via
1264: the Javascript code provided in C<change_content_javascript>. $name is
1265: the name you will use to reference the area later; do not repeat the
1266: same name on a given HTML page more then once. $origContent is what
1267: the area will originally contain, which can be left blank.
1268:
1269: =cut
1270:
1271: sub changable_area {
1272: my ($name, $origContent) = @_;
1273:
1.258 albertel 1274: if ($env{'browser.type'} eq 'netscape' &&
1275: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1276: # If this is netscape 4, we need to use the Layer tag
1277: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1278: } else {
1279: return "<span id='$name'>$origContent</span>";
1280: }
1281: }
1282:
1283: =pod
1284:
1.648 raeburn 1285: =item * &viewport_geometry_js
1.590 raeburn 1286:
1287: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1288:
1289: =cut
1290:
1291:
1292: sub viewport_geometry_js {
1293: return <<"GEOMETRY";
1294: var Geometry = {};
1295: function init_geometry() {
1296: if (Geometry.init) { return };
1297: Geometry.init=1;
1298: if (window.innerHeight) {
1299: Geometry.getViewportHeight = function() { return window.innerHeight; };
1300: Geometry.getViewportWidth = function() { return window.innerWidth; };
1301: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1302: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1303: }
1304: else if (document.documentElement && document.documentElement.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.documentElement.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.documentElement.clientWidth; };
1309:
1310: Geometry.getHorizontalScroll =
1311: function() { return document.documentElement.scrollLeft; };
1312: Geometry.getVerticalScroll =
1313: function() { return document.documentElement.scrollTop; };
1314: }
1315: else if (document.body.clientHeight) {
1316: Geometry.getViewportHeight =
1317: function() { return document.body.clientHeight; };
1318: Geometry.getViewportWidth =
1319: function() { return document.body.clientWidth; };
1320: Geometry.getHorizontalScroll =
1321: function() { return document.body.scrollLeft; };
1322: Geometry.getVerticalScroll =
1323: function() { return document.body.scrollTop; };
1324: }
1325: }
1326:
1327: GEOMETRY
1328: }
1329:
1330: =pod
1331:
1.648 raeburn 1332: =item * &viewport_size_js()
1.590 raeburn 1333:
1334: 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.
1335:
1336: =cut
1337:
1338: sub viewport_size_js {
1339: my $geometry = &viewport_geometry_js();
1340: return <<"DIMS";
1341:
1342: $geometry
1343:
1344: function getViewportDims(width,height) {
1345: init_geometry();
1346: width.value = Geometry.getViewportWidth();
1347: height.value = Geometry.getViewportHeight();
1348: return;
1349: }
1350:
1351: DIMS
1352: }
1353:
1354: =pod
1355:
1.648 raeburn 1356: =item * &resize_textarea_js()
1.565 albertel 1357:
1358: emits the needed javascript to resize a textarea to be as big as possible
1359:
1360: creates a function resize_textrea that takes two IDs first should be
1361: the id of the element to resize, second should be the id of a div that
1362: surrounds everything that comes after the textarea, this routine needs
1363: to be attached to the <body> for the onload and onresize events.
1364:
1.648 raeburn 1365: =back
1.565 albertel 1366:
1367: =cut
1368:
1369: sub resize_textarea_js {
1.590 raeburn 1370: my $geometry = &viewport_geometry_js();
1.565 albertel 1371: return <<"RESIZE";
1372: <script type="text/javascript">
1.590 raeburn 1373: $geometry
1.565 albertel 1374:
1.588 albertel 1375: function getX(element) {
1376: var x = 0;
1377: while (element) {
1378: x += element.offsetLeft;
1379: element = element.offsetParent;
1380: }
1381: return x;
1382: }
1383: function getY(element) {
1384: var y = 0;
1385: while (element) {
1386: y += element.offsetTop;
1387: element = element.offsetParent;
1388: }
1389: return y;
1390: }
1391:
1392:
1.565 albertel 1393: function resize_textarea(textarea_id,bottom_id) {
1394: init_geometry();
1395: var textarea = document.getElementById(textarea_id);
1396: //alert(textarea);
1397:
1.588 albertel 1398: var textarea_top = getY(textarea);
1.565 albertel 1399: var textarea_height = textarea.offsetHeight;
1400: var bottom = document.getElementById(bottom_id);
1.588 albertel 1401: var bottom_top = getY(bottom);
1.565 albertel 1402: var bottom_height = bottom.offsetHeight;
1403: var window_height = Geometry.getViewportHeight();
1.588 albertel 1404: var fudge = 23;
1.565 albertel 1405: var new_height = window_height-fudge-textarea_top-bottom_height;
1406: if (new_height < 300) {
1407: new_height = 300;
1408: }
1409: textarea.style.height=new_height+'px';
1410: }
1411: </script>
1412: RESIZE
1413:
1414: }
1415:
1416: =pod
1417:
1.256 matthew 1418: =head1 Excel and CSV file utility routines
1419:
1420: =over 4
1421:
1422: =cut
1423:
1424: ###############################################################
1425: ###############################################################
1426:
1427: =pod
1428:
1.648 raeburn 1429: =item * &csv_translate($text)
1.37 matthew 1430:
1.185 www 1431: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1432: format.
1433:
1434: =cut
1435:
1.180 matthew 1436: ###############################################################
1437: ###############################################################
1.37 matthew 1438: sub csv_translate {
1439: my $text = shift;
1440: $text =~ s/\"/\"\"/g;
1.209 albertel 1441: $text =~ s/\n/ /g;
1.37 matthew 1442: return $text;
1443: }
1.180 matthew 1444:
1445: ###############################################################
1446: ###############################################################
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &define_excel_formats()
1.180 matthew 1451:
1452: Define some commonly used Excel cell formats.
1453:
1454: Currently supported formats:
1455:
1456: =over 4
1457:
1458: =item header
1459:
1460: =item bold
1461:
1462: =item h1
1463:
1464: =item h2
1465:
1466: =item h3
1467:
1.256 matthew 1468: =item h4
1469:
1470: =item i
1471:
1.180 matthew 1472: =item date
1473:
1474: =back
1475:
1476: Inputs: $workbook
1477:
1478: Returns: $format, a hash reference.
1479:
1480: =cut
1481:
1482: ###############################################################
1483: ###############################################################
1484: sub define_excel_formats {
1485: my ($workbook) = @_;
1486: my $format;
1487: $format->{'header'} = $workbook->add_format(bold => 1,
1488: bottom => 1,
1489: align => 'center');
1490: $format->{'bold'} = $workbook->add_format(bold=>1);
1491: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1492: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1493: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1494: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1495: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1496: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1497: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1498: return $format;
1499: }
1500:
1501: ###############################################################
1502: ###############################################################
1.113 bowersj2 1503:
1504: =pod
1505:
1.648 raeburn 1506: =item * &create_workbook()
1.255 matthew 1507:
1508: Create an Excel worksheet. If it fails, output message on the
1509: request object and return undefs.
1510:
1511: Inputs: Apache request object
1512:
1513: Returns (undef) on failure,
1514: Excel worksheet object, scalar with filename, and formats
1515: from &Apache::loncommon::define_excel_formats on success
1516:
1517: =cut
1518:
1519: ###############################################################
1520: ###############################################################
1521: sub create_workbook {
1522: my ($r) = @_;
1523: #
1524: # Create the excel spreadsheet
1525: my $filename = '/prtspool/'.
1.258 albertel 1526: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1527: time.'_'.rand(1000000000).'.xls';
1528: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1529: if (! defined($workbook)) {
1530: $r->log_error("Error creating excel spreadsheet $filename: $!");
1531: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1532: "This error has been logged. ".
1533: "Please alert your LON-CAPA administrator").
1534: '</p>');
1535: return (undef);
1536: }
1537: #
1538: $workbook->set_tempdir('/home/httpd/perl/tmp');
1539: #
1540: my $format = &Apache::loncommon::define_excel_formats($workbook);
1541: return ($workbook,$filename,$format);
1542: }
1543:
1544: ###############################################################
1545: ###############################################################
1546:
1547: =pod
1548:
1.648 raeburn 1549: =item * &create_text_file()
1.113 bowersj2 1550:
1.542 raeburn 1551: Create a file to write to and eventually make available to the user.
1.256 matthew 1552: If file creation fails, outputs an error message on the request object and
1553: return undefs.
1.113 bowersj2 1554:
1.256 matthew 1555: Inputs: Apache request object, and file suffix
1.113 bowersj2 1556:
1.256 matthew 1557: Returns (undef) on failure,
1558: Filehandle and filename on success.
1.113 bowersj2 1559:
1560: =cut
1561:
1.256 matthew 1562: ###############################################################
1563: ###############################################################
1564: sub create_text_file {
1565: my ($r,$suffix) = @_;
1566: if (! defined($suffix)) { $suffix = 'txt'; };
1567: my $fh;
1568: my $filename = '/prtspool/'.
1.258 albertel 1569: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1570: time.'_'.rand(1000000000).'.'.$suffix;
1571: $fh = Apache::File->new('>/home/httpd'.$filename);
1572: if (! defined($fh)) {
1573: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1574: $r->print(&mt('Problems occurred in creating the output file. '
1575: .'This error has been logged. '
1576: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1577: }
1.256 matthew 1578: return ($fh,$filename)
1.113 bowersj2 1579: }
1580:
1581:
1.256 matthew 1582: =pod
1.113 bowersj2 1583:
1584: =back
1585:
1586: =cut
1.37 matthew 1587:
1588: ###############################################################
1.33 matthew 1589: ## Home server <option> list generating code ##
1590: ###############################################################
1.35 matthew 1591:
1.169 www 1592: # ------------------------------------------
1593:
1594: sub domain_select {
1595: my ($name,$value,$multiple)=@_;
1596: my %domains=map {
1.514 albertel 1597: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1598: } &Apache::lonnet::all_domains();
1.169 www 1599: if ($multiple) {
1600: $domains{''}=&mt('Any domain');
1.550 albertel 1601: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1602: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1603: } else {
1.550 albertel 1604: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1605: return &select_form($name,$value,%domains);
1606: }
1607: }
1608:
1.282 albertel 1609: #-------------------------------------------
1610:
1611: =pod
1612:
1.519 raeburn 1613: =head1 Routines for form select boxes
1614:
1615: =over 4
1616:
1.648 raeburn 1617: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1618:
1619: Returns a string containing a <select> element int multiple mode
1620:
1621:
1622: Args:
1623: $name - name of the <select> element
1.506 raeburn 1624: $value - scalar or array ref of values that should already be selected
1.282 albertel 1625: $size - number of rows long the select element is
1.283 albertel 1626: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1627: (shown text should already have been &mt())
1.506 raeburn 1628: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1629:
1.282 albertel 1630: =cut
1631:
1632: #-------------------------------------------
1.169 www 1633: sub multiple_select_form {
1.284 albertel 1634: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1635: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1636: my $output='';
1.191 matthew 1637: if (! defined($size)) {
1638: $size = 4;
1.283 albertel 1639: if (scalar(keys(%$hash))<4) {
1640: $size = scalar(keys(%$hash));
1.191 matthew 1641: }
1642: }
1.734 bisitz 1643: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1644: my @order;
1.506 raeburn 1645: if (ref($order) eq 'ARRAY') {
1646: @order = @{$order};
1647: } else {
1648: @order = sort(keys(%$hash));
1.501 banghart 1649: }
1650: if (exists($$hash{'select_form_order'})) {
1651: @order = @{$$hash{'select_form_order'}};
1652: }
1653:
1.284 albertel 1654: foreach my $key (@order) {
1.356 albertel 1655: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1656: $output.='selected="selected" ' if ($selected{$key});
1657: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1658: }
1659: $output.="</select>\n";
1660: return $output;
1661: }
1662:
1.88 www 1663: #-------------------------------------------
1664:
1665: =pod
1666:
1.648 raeburn 1667: =item * &select_form($defdom,$name,%hash)
1.88 www 1668:
1669: Returns a string containing a <select name='$name' size='1'> form to
1670: allow a user to select options from a hash option_name => displayed text.
1671: See lonrights.pm for an example invocation and use.
1672:
1673: =cut
1674:
1675: #-------------------------------------------
1676: sub select_form {
1677: my ($def,$name,%hash) = @_;
1678: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1679: my @keys;
1680: if (exists($hash{'select_form_order'})) {
1681: @keys=@{$hash{'select_form_order'}};
1682: } else {
1683: @keys=sort(keys(%hash));
1684: }
1.356 albertel 1685: foreach my $key (@keys) {
1686: $selectform.=
1687: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1688: ($key eq $def ? 'selected="selected" ' : '').
1689: ">".&mt($hash{$key})."</option>\n";
1.88 www 1690: }
1691: $selectform.="</select>";
1692: return $selectform;
1693: }
1694:
1.475 www 1695: # For display filters
1696:
1697: sub display_filter {
1698: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1699: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1700: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1701: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1702: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1703: '</label></span> <span class="LC_nobreak">'.
1.475 www 1704: &mt('Filter [_1]',
1.477 www 1705: &select_form($env{'form.displayfilter'},
1706: 'displayfilter',
1707: ('currentfolder' => 'Current folder/page',
1708: 'containing' => 'Containing phrase',
1709: 'none' => 'None'))).
1.714 bisitz 1710: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1711: }
1712:
1.167 www 1713: sub gradeleveldescription {
1714: my $gradelevel=shift;
1715: my %gradelevels=(0 => 'Not specified',
1716: 1 => 'Grade 1',
1717: 2 => 'Grade 2',
1718: 3 => 'Grade 3',
1719: 4 => 'Grade 4',
1720: 5 => 'Grade 5',
1721: 6 => 'Grade 6',
1722: 7 => 'Grade 7',
1723: 8 => 'Grade 8',
1724: 9 => 'Grade 9',
1725: 10 => 'Grade 10',
1726: 11 => 'Grade 11',
1727: 12 => 'Grade 12',
1728: 13 => 'Grade 13',
1729: 14 => '100 Level',
1730: 15 => '200 Level',
1731: 16 => '300 Level',
1732: 17 => '400 Level',
1733: 18 => 'Graduate Level');
1734: return &mt($gradelevels{$gradelevel});
1735: }
1736:
1.163 www 1737: sub select_level_form {
1738: my ($deflevel,$name)=@_;
1739: unless ($deflevel) { $deflevel=0; }
1.167 www 1740: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1741: for (my $i=0; $i<=18; $i++) {
1742: $selectform.="<option value=\"$i\" ".
1.253 albertel 1743: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1744: ">".&gradeleveldescription($i)."</option>\n";
1745: }
1746: $selectform.="</select>";
1747: return $selectform;
1.163 www 1748: }
1.167 www 1749:
1.35 matthew 1750: #-------------------------------------------
1751:
1.45 matthew 1752: =pod
1753:
1.743 raeburn 1754: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1755:
1756: Returns a string containing a <select name='$name' size='1'> form to
1757: allow a user to select the domain to preform an operation in.
1758: See loncreateuser.pm for an example invocation and use.
1759:
1.90 www 1760: If the $includeempty flag is set, it also includes an empty choice ("no domain
1761: selected");
1762:
1.743 raeburn 1763: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1764:
1765: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1766:
1.35 matthew 1767: =cut
1768:
1769: #-------------------------------------------
1.34 matthew 1770: sub select_dom_form {
1.743 raeburn 1771: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1772: my $onchange;
1773: if ($autosubmit) {
1774: $onchange = ' onchange="this.form.submit()"';
1775: }
1.550 albertel 1776: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1777: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1778: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1779: foreach my $dom (@domains) {
1780: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1781: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1782: if ($showdomdesc) {
1783: if ($dom ne '') {
1784: my $domdesc = &Apache::lonnet::domain($dom,'description');
1785: if ($domdesc ne '') {
1786: $selectdomain .= ' ('.$domdesc.')';
1787: }
1788: }
1789: }
1790: $selectdomain .= "</option>\n";
1.34 matthew 1791: }
1792: $selectdomain.="</select>";
1793: return $selectdomain;
1794: }
1795:
1.35 matthew 1796: #-------------------------------------------
1797:
1.45 matthew 1798: =pod
1799:
1.648 raeburn 1800: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1801:
1.586 raeburn 1802: input: 4 arguments (two required, two optional) -
1803: $domain - domain of new user
1804: $name - name of form element
1805: $default - Value of 'default' causes a default item to be first
1806: option, and selected by default.
1807: $hide - Value of 'hide' causes hiding of the name of the server,
1808: if 1 server found, or default, if 0 found.
1.594 raeburn 1809: output: returns 2 items:
1.586 raeburn 1810: (a) form element which contains either:
1811: (i) <select name="$name">
1812: <option value="$hostid1">$hostid $servers{$hostid}</option>
1813: <option value="$hostid2">$hostid $servers{$hostid}</option>
1814: </select>
1815: form item if there are multiple library servers in $domain, or
1816: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1817: if there is only one library server in $domain.
1818:
1819: (b) number of library servers found.
1820:
1821: See loncreateuser.pm for example of use.
1.35 matthew 1822:
1823: =cut
1824:
1825: #-------------------------------------------
1.586 raeburn 1826: sub home_server_form_item {
1827: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1828: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1829: my $result;
1830: my $numlib = keys(%servers);
1831: if ($numlib > 1) {
1832: $result .= '<select name="'.$name.'" />'."\n";
1833: if ($default) {
1834: $result .= '<option value="default" selected>'.&mt('default').
1835: '</option>'."\n";
1836: }
1837: foreach my $hostid (sort(keys(%servers))) {
1838: $result.= '<option value="'.$hostid.'">'.
1839: $hostid.' '.$servers{$hostid}."</option>\n";
1840: }
1841: $result .= '</select>'."\n";
1842: } elsif ($numlib == 1) {
1843: my $hostid;
1844: foreach my $item (keys(%servers)) {
1845: $hostid = $item;
1846: }
1847: $result .= '<input type="hidden" name="'.$name.'" value="'.
1848: $hostid.'" />';
1849: if (!$hide) {
1850: $result .= $hostid.' '.$servers{$hostid};
1851: }
1852: $result .= "\n";
1853: } elsif ($default) {
1854: $result .= '<input type="hidden" name="'.$name.
1855: '" value="default" />';
1856: if (!$hide) {
1857: $result .= &mt('default');
1858: }
1859: $result .= "\n";
1.33 matthew 1860: }
1.586 raeburn 1861: return ($result,$numlib);
1.33 matthew 1862: }
1.112 bowersj2 1863:
1864: =pod
1865:
1.534 albertel 1866: =back
1867:
1.112 bowersj2 1868: =cut
1.87 matthew 1869:
1870: ###############################################################
1.112 bowersj2 1871: ## Decoding User Agent ##
1.87 matthew 1872: ###############################################################
1873:
1874: =pod
1875:
1.112 bowersj2 1876: =head1 Decoding the User Agent
1877:
1878: =over 4
1879:
1880: =item * &decode_user_agent()
1.87 matthew 1881:
1882: Inputs: $r
1883:
1884: Outputs:
1885:
1886: =over 4
1887:
1.112 bowersj2 1888: =item * $httpbrowser
1.87 matthew 1889:
1.112 bowersj2 1890: =item * $clientbrowser
1.87 matthew 1891:
1.112 bowersj2 1892: =item * $clientversion
1.87 matthew 1893:
1.112 bowersj2 1894: =item * $clientmathml
1.87 matthew 1895:
1.112 bowersj2 1896: =item * $clientunicode
1.87 matthew 1897:
1.112 bowersj2 1898: =item * $clientos
1.87 matthew 1899:
1900: =back
1901:
1.157 matthew 1902: =back
1903:
1.87 matthew 1904: =cut
1905:
1906: ###############################################################
1907: ###############################################################
1908: sub decode_user_agent {
1.247 albertel 1909: my ($r)=@_;
1.87 matthew 1910: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1911: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1912: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1913: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1914: my $clientbrowser='unknown';
1915: my $clientversion='0';
1916: my $clientmathml='';
1917: my $clientunicode='0';
1918: for (my $i=0;$i<=$#browsertype;$i++) {
1919: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1920: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1921: $clientbrowser=$bname;
1922: $httpbrowser=~/$vreg/i;
1923: $clientversion=$1;
1924: $clientmathml=($clientversion>=$minv);
1925: $clientunicode=($clientversion>=$univ);
1926: }
1927: }
1928: my $clientos='unknown';
1929: if (($httpbrowser=~/linux/i) ||
1930: ($httpbrowser=~/unix/i) ||
1931: ($httpbrowser=~/ux/i) ||
1932: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1933: if (($httpbrowser=~/vax/i) ||
1934: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1935: if ($httpbrowser=~/next/i) { $clientos='next'; }
1936: if (($httpbrowser=~/mac/i) ||
1937: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1938: if ($httpbrowser=~/win/i) { $clientos='win'; }
1939: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1940: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1941: $clientunicode,$clientos,);
1942: }
1943:
1.32 matthew 1944: ###############################################################
1945: ## Authentication changing form generation subroutines ##
1946: ###############################################################
1947: ##
1948: ## All of the authform_xxxxxxx subroutines take their inputs in a
1949: ## hash, and have reasonable default values.
1950: ##
1951: ## formname = the name given in the <form> tag.
1.35 matthew 1952: #-------------------------------------------
1953:
1.45 matthew 1954: =pod
1955:
1.112 bowersj2 1956: =head1 Authentication Routines
1957:
1958: =over 4
1959:
1.648 raeburn 1960: =item * &authform_xxxxxx()
1.35 matthew 1961:
1962: The authform_xxxxxx subroutines provide javascript and html forms which
1963: handle some of the conveniences required for authentication forms.
1964: This is not an optimal method, but it works.
1965:
1966: =over 4
1967:
1.112 bowersj2 1968: =item * authform_header
1.35 matthew 1969:
1.112 bowersj2 1970: =item * authform_authorwarning
1.35 matthew 1971:
1.112 bowersj2 1972: =item * authform_nochange
1.35 matthew 1973:
1.112 bowersj2 1974: =item * authform_kerberos
1.35 matthew 1975:
1.112 bowersj2 1976: =item * authform_internal
1.35 matthew 1977:
1.112 bowersj2 1978: =item * authform_filesystem
1.35 matthew 1979:
1980: =back
1981:
1.648 raeburn 1982: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1983:
1.35 matthew 1984: =cut
1985:
1986: #-------------------------------------------
1.32 matthew 1987: sub authform_header{
1988: my %in = (
1989: formname => 'cu',
1.80 albertel 1990: kerb_def_dom => '',
1.32 matthew 1991: @_,
1992: );
1993: $in{'formname'} = 'document.' . $in{'formname'};
1994: my $result='';
1.80 albertel 1995:
1996: #---------------------------------------------- Code for upper case translation
1997: my $Javascript_toUpperCase;
1998: unless ($in{kerb_def_dom}) {
1999: $Javascript_toUpperCase =<<"END";
2000: switch (choice) {
2001: case 'krb': currentform.elements[choicearg].value =
2002: currentform.elements[choicearg].value.toUpperCase();
2003: break;
2004: default:
2005: }
2006: END
2007: } else {
2008: $Javascript_toUpperCase = "";
2009: }
2010:
1.165 raeburn 2011: my $radioval = "'nochange'";
1.591 raeburn 2012: if (defined($in{'curr_authtype'})) {
2013: if ($in{'curr_authtype'} ne '') {
2014: $radioval = "'".$in{'curr_authtype'}."arg'";
2015: }
1.174 matthew 2016: }
1.165 raeburn 2017: my $argfield = 'null';
1.591 raeburn 2018: if (defined($in{'mode'})) {
1.165 raeburn 2019: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2020: if (defined($in{'curr_autharg'})) {
2021: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2022: $argfield = "'$in{'curr_autharg'}'";
2023: }
2024: }
2025: }
2026: }
2027:
1.32 matthew 2028: $result.=<<"END";
2029: var current = new Object();
1.165 raeburn 2030: current.radiovalue = $radioval;
2031: current.argfield = $argfield;
1.32 matthew 2032:
2033: function changed_radio(choice,currentform) {
2034: var choicearg = choice + 'arg';
2035: // If a radio button in changed, we need to change the argfield
2036: if (current.radiovalue != choice) {
2037: current.radiovalue = choice;
2038: if (current.argfield != null) {
2039: currentform.elements[current.argfield].value = '';
2040: }
2041: if (choice == 'nochange') {
2042: current.argfield = null;
2043: } else {
2044: current.argfield = choicearg;
2045: switch(choice) {
2046: case 'krb':
2047: currentform.elements[current.argfield].value =
2048: "$in{'kerb_def_dom'}";
2049: break;
2050: default:
2051: break;
2052: }
2053: }
2054: }
2055: return;
2056: }
1.22 www 2057:
1.32 matthew 2058: function changed_text(choice,currentform) {
2059: var choicearg = choice + 'arg';
2060: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2061: $Javascript_toUpperCase
1.32 matthew 2062: // clear old field
2063: if ((current.argfield != choicearg) && (current.argfield != null)) {
2064: currentform.elements[current.argfield].value = '';
2065: }
2066: current.argfield = choicearg;
2067: }
2068: set_auth_radio_buttons(choice,currentform);
2069: return;
1.20 www 2070: }
1.32 matthew 2071:
2072: function set_auth_radio_buttons(newvalue,currentform) {
2073: var i=0;
2074: while (i < currentform.login.length) {
2075: if (currentform.login[i].value == newvalue) { break; }
2076: i++;
2077: }
2078: if (i == currentform.login.length) {
2079: return;
2080: }
2081: current.radiovalue = newvalue;
2082: currentform.login[i].checked = true;
2083: return;
2084: }
2085: END
2086: return $result;
2087: }
2088:
2089: sub authform_authorwarning{
2090: my $result='';
1.144 matthew 2091: $result='<i>'.
2092: &mt('As a general rule, only authors or co-authors should be '.
2093: 'filesystem authenticated '.
2094: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2095: return $result;
2096: }
2097:
2098: sub authform_nochange{
2099: my %in = (
2100: formname => 'document.cu',
2101: kerb_def_dom => 'MSU.EDU',
2102: @_,
2103: );
1.586 raeburn 2104: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2105: my $result;
2106: if (keys(%can_assign) == 0) {
2107: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2108: } else {
2109: $result = '<label>'.&mt('[_1] Do not change login data',
2110: '<input type="radio" name="login" value="nochange" '.
2111: 'checked="checked" onclick="'.
1.281 albertel 2112: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2113: '</label>';
1.586 raeburn 2114: }
1.32 matthew 2115: return $result;
2116: }
2117:
1.591 raeburn 2118: sub authform_kerberos {
1.32 matthew 2119: my %in = (
2120: formname => 'document.cu',
2121: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2122: kerb_def_auth => 'krb4',
1.32 matthew 2123: @_,
2124: );
1.586 raeburn 2125: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2126: $autharg,$jscall);
2127: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2128: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2129: $check5 = ' checked="checked"';
1.80 albertel 2130: } else {
1.772 bisitz 2131: $check4 = ' checked="checked"';
1.80 albertel 2132: }
1.165 raeburn 2133: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2134: if (defined($in{'curr_authtype'})) {
2135: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2136: $krbcheck = ' checked="checked"';
1.623 raeburn 2137: if (defined($in{'mode'})) {
2138: if ($in{'mode'} eq 'modifyuser') {
2139: $krbcheck = '';
2140: }
2141: }
1.591 raeburn 2142: if (defined($in{'curr_kerb_ver'})) {
2143: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2144: $check5 = ' checked="checked"';
1.591 raeburn 2145: $check4 = '';
2146: } else {
1.772 bisitz 2147: $check4 = ' checked="checked"';
1.591 raeburn 2148: $check5 = '';
2149: }
1.586 raeburn 2150: }
1.591 raeburn 2151: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2152: $krbarg = $in{'curr_autharg'};
2153: }
1.586 raeburn 2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2155: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2156: $result =
2157: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2158: $in{'curr_autharg'},$krbver);
2159: } else {
2160: $result =
2161: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2162: }
2163: return $result;
2164: }
2165: }
2166: } else {
2167: if ($authnum == 1) {
2168: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2169: }
2170: }
1.586 raeburn 2171: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2172: return;
1.587 raeburn 2173: } elsif ($authtype eq '') {
1.591 raeburn 2174: if (defined($in{'mode'})) {
1.587 raeburn 2175: if ($in{'mode'} eq 'modifycourse') {
2176: if ($authnum == 1) {
2177: $authtype = '<input type="hidden" name="login" value="krb">';
2178: }
2179: }
2180: }
1.586 raeburn 2181: }
2182: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2183: if ($authtype eq '') {
2184: $authtype = '<input type="radio" name="login" value="krb" '.
2185: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2186: $krbcheck.' />';
2187: }
2188: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2189: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2190: $in{'curr_authtype'} eq 'krb5') ||
2191: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2192: $in{'curr_authtype'} eq 'krb4')) {
2193: $result .= &mt
1.144 matthew 2194: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2195: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2196: '<label>'.$authtype,
1.281 albertel 2197: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2198: 'value="'.$krbarg.'" '.
1.144 matthew 2199: 'onchange="'.$jscall.'" />',
1.281 albertel 2200: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2201: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2202: '</label>');
1.586 raeburn 2203: } elsif ($can_assign{'krb4'}) {
2204: $result .= &mt
2205: ('[_1] Kerberos authenticated with domain [_2] '.
2206: '[_3] Version 4 [_4]',
2207: '<label>'.$authtype,
2208: '</label><input type="text" size="10" name="krbarg" '.
2209: 'value="'.$krbarg.'" '.
2210: 'onchange="'.$jscall.'" />',
2211: '<label><input type="hidden" name="krbver" value="4" />',
2212: '</label>');
2213: } elsif ($can_assign{'krb5'}) {
2214: $result .= &mt
2215: ('[_1] Kerberos authenticated with domain [_2] '.
2216: '[_3] Version 5 [_4]',
2217: '<label>'.$authtype,
2218: '</label><input type="text" size="10" name="krbarg" '.
2219: 'value="'.$krbarg.'" '.
2220: 'onchange="'.$jscall.'" />',
2221: '<label><input type="hidden" name="krbver" value="5" />',
2222: '</label>');
2223: }
1.32 matthew 2224: return $result;
2225: }
2226:
2227: sub authform_internal{
1.586 raeburn 2228: my %in = (
1.32 matthew 2229: formname => 'document.cu',
2230: kerb_def_dom => 'MSU.EDU',
2231: @_,
2232: );
1.586 raeburn 2233: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2234: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2235: if (defined($in{'curr_authtype'})) {
2236: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2237: if ($can_assign{'int'}) {
1.772 bisitz 2238: $intcheck = 'checked="checked" ';
1.623 raeburn 2239: if (defined($in{'mode'})) {
2240: if ($in{'mode'} eq 'modifyuser') {
2241: $intcheck = '';
2242: }
2243: }
1.591 raeburn 2244: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2245: $intarg = $in{'curr_autharg'};
2246: }
2247: } else {
2248: $result = &mt('Currently internally authenticated.');
2249: return $result;
1.165 raeburn 2250: }
2251: }
1.586 raeburn 2252: } else {
2253: if ($authnum == 1) {
2254: $authtype = '<input type="hidden" name="login" value="int">';
2255: }
2256: }
2257: if (!$can_assign{'int'}) {
2258: return;
1.587 raeburn 2259: } elsif ($authtype eq '') {
1.591 raeburn 2260: if (defined($in{'mode'})) {
1.587 raeburn 2261: if ($in{'mode'} eq 'modifycourse') {
2262: if ($authnum == 1) {
2263: $authtype = '<input type="hidden" name="login" value="int">';
2264: }
2265: }
2266: }
1.165 raeburn 2267: }
1.586 raeburn 2268: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2269: if ($authtype eq '') {
2270: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2271: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2272: }
1.605 bisitz 2273: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2274: $intarg.'" onchange="'.$jscall.'" />';
2275: $result = &mt
1.144 matthew 2276: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2277: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2278: $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 2279: return $result;
2280: }
2281:
2282: sub authform_local{
2283: my %in = (
2284: formname => 'document.cu',
2285: kerb_def_dom => 'MSU.EDU',
2286: @_,
2287: );
1.586 raeburn 2288: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2289: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2290: if (defined($in{'curr_authtype'})) {
2291: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2292: if ($can_assign{'loc'}) {
1.772 bisitz 2293: $loccheck = 'checked="checked" ';
1.623 raeburn 2294: if (defined($in{'mode'})) {
2295: if ($in{'mode'} eq 'modifyuser') {
2296: $loccheck = '';
2297: }
2298: }
1.591 raeburn 2299: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2300: $locarg = $in{'curr_autharg'};
2301: }
2302: } else {
2303: $result = &mt('Currently using local (institutional) authentication.');
2304: return $result;
1.165 raeburn 2305: }
2306: }
1.586 raeburn 2307: } else {
2308: if ($authnum == 1) {
2309: $authtype = '<input type="hidden" name="login" value="loc">';
2310: }
2311: }
2312: if (!$can_assign{'loc'}) {
2313: return;
1.587 raeburn 2314: } elsif ($authtype eq '') {
1.591 raeburn 2315: if (defined($in{'mode'})) {
1.587 raeburn 2316: if ($in{'mode'} eq 'modifycourse') {
2317: if ($authnum == 1) {
2318: $authtype = '<input type="hidden" name="login" value="loc">';
2319: }
2320: }
2321: }
1.165 raeburn 2322: }
1.586 raeburn 2323: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2324: if ($authtype eq '') {
2325: $authtype = '<input type="radio" name="login" value="loc" '.
2326: $loccheck.' onchange="'.$jscall.'" onclick="'.
2327: $jscall.'" />';
2328: }
2329: $autharg = '<input type="text" size="10" name="locarg" value="'.
2330: $locarg.'" onchange="'.$jscall.'" />';
2331: $result = &mt('[_1] Local Authentication with argument [_2]',
2332: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2333: return $result;
2334: }
2335:
2336: sub authform_filesystem{
2337: my %in = (
2338: formname => 'document.cu',
2339: kerb_def_dom => 'MSU.EDU',
2340: @_,
2341: );
1.586 raeburn 2342: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2343: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2344: if (defined($in{'curr_authtype'})) {
2345: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2346: if ($can_assign{'fsys'}) {
1.772 bisitz 2347: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2348: if (defined($in{'mode'})) {
2349: if ($in{'mode'} eq 'modifyuser') {
2350: $fsyscheck = '';
2351: }
2352: }
1.586 raeburn 2353: } else {
2354: $result = &mt('Currently Filesystem Authenticated.');
2355: return $result;
2356: }
2357: }
2358: } else {
2359: if ($authnum == 1) {
2360: $authtype = '<input type="hidden" name="login" value="fsys">';
2361: }
2362: }
2363: if (!$can_assign{'fsys'}) {
2364: return;
1.587 raeburn 2365: } elsif ($authtype eq '') {
1.591 raeburn 2366: if (defined($in{'mode'})) {
1.587 raeburn 2367: if ($in{'mode'} eq 'modifycourse') {
2368: if ($authnum == 1) {
2369: $authtype = '<input type="hidden" name="login" value="fsys">';
2370: }
2371: }
2372: }
1.586 raeburn 2373: }
2374: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2375: if ($authtype eq '') {
2376: $authtype = '<input type="radio" name="login" value="fsys" '.
2377: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2378: $jscall.'" />';
2379: }
2380: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2381: ' onchange="'.$jscall.'" />';
2382: $result = &mt
1.144 matthew 2383: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2384: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2385: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2386: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2387: 'onchange="'.$jscall.'" />');
1.32 matthew 2388: return $result;
2389: }
2390:
1.586 raeburn 2391: sub get_assignable_auth {
2392: my ($dom) = @_;
2393: if ($dom eq '') {
2394: $dom = $env{'request.role.domain'};
2395: }
2396: my %can_assign = (
2397: krb4 => 1,
2398: krb5 => 1,
2399: int => 1,
2400: loc => 1,
2401: );
2402: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2403: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2404: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2405: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2406: my $context;
2407: if ($env{'request.role'} =~ /^au/) {
2408: $context = 'author';
2409: } elsif ($env{'request.role'} =~ /^dc/) {
2410: $context = 'domain';
2411: } elsif ($env{'request.course.id'}) {
2412: $context = 'course';
2413: }
2414: if ($context) {
2415: if (ref($authhash->{$context}) eq 'HASH') {
2416: %can_assign = %{$authhash->{$context}};
2417: }
2418: }
2419: }
2420: }
2421: my $authnum = 0;
2422: foreach my $key (keys(%can_assign)) {
2423: if ($can_assign{$key}) {
2424: $authnum ++;
2425: }
2426: }
2427: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2428: $authnum --;
2429: }
2430: return ($authnum,%can_assign);
2431: }
2432:
1.80 albertel 2433: ###############################################################
2434: ## Get Kerberos Defaults for Domain ##
2435: ###############################################################
2436: ##
2437: ## Returns default kerberos version and an associated argument
2438: ## as listed in file domain.tab. If not listed, provides
2439: ## appropriate default domain and kerberos version.
2440: ##
2441: #-------------------------------------------
2442:
2443: =pod
2444:
1.648 raeburn 2445: =item * &get_kerberos_defaults()
1.80 albertel 2446:
2447: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2448: version and domain. If not found, it defaults to version 4 and the
2449: domain of the server.
1.80 albertel 2450:
1.648 raeburn 2451: =over 4
2452:
1.80 albertel 2453: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2454:
1.648 raeburn 2455: =back
2456:
2457: =back
2458:
1.80 albertel 2459: =cut
2460:
2461: #-------------------------------------------
2462: sub get_kerberos_defaults {
2463: my $domain=shift;
1.641 raeburn 2464: my ($krbdef,$krbdefdom);
2465: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2466: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2467: $krbdef = $domdefaults{'auth_def'};
2468: $krbdefdom = $domdefaults{'auth_arg_def'};
2469: } else {
1.80 albertel 2470: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2471: my $krbdefdom=$1;
2472: $krbdefdom=~tr/a-z/A-Z/;
2473: $krbdef = "krb4";
2474: }
2475: return ($krbdef,$krbdefdom);
2476: }
1.112 bowersj2 2477:
1.32 matthew 2478:
1.46 matthew 2479: ###############################################################
2480: ## Thesaurus Functions ##
2481: ###############################################################
1.20 www 2482:
1.46 matthew 2483: =pod
1.20 www 2484:
1.112 bowersj2 2485: =head1 Thesaurus Functions
2486:
2487: =over 4
2488:
1.648 raeburn 2489: =item * &initialize_keywords()
1.46 matthew 2490:
2491: Initializes the package variable %Keywords if it is empty. Uses the
2492: package variable $thesaurus_db_file.
2493:
2494: =cut
2495:
2496: ###################################################
2497:
2498: sub initialize_keywords {
2499: return 1 if (scalar keys(%Keywords));
2500: # If we are here, %Keywords is empty, so fill it up
2501: # Make sure the file we need exists...
2502: if (! -e $thesaurus_db_file) {
2503: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2504: " failed because it does not exist");
2505: return 0;
2506: }
2507: # Set up the hash as a database
2508: my %thesaurus_db;
2509: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2510: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2511: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2512: $thesaurus_db_file);
2513: return 0;
2514: }
2515: # Get the average number of appearances of a word.
2516: my $avecount = $thesaurus_db{'average.count'};
2517: # Put keywords (those that appear > average) into %Keywords
2518: while (my ($word,$data)=each (%thesaurus_db)) {
2519: my ($count,undef) = split /:/,$data;
2520: $Keywords{$word}++ if ($count > $avecount);
2521: }
2522: untie %thesaurus_db;
2523: # Remove special values from %Keywords.
1.356 albertel 2524: foreach my $value ('total.count','average.count') {
2525: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2526: }
1.46 matthew 2527: return 1;
2528: }
2529:
2530: ###################################################
2531:
2532: =pod
2533:
1.648 raeburn 2534: =item * &keyword($word)
1.46 matthew 2535:
2536: Returns true if $word is a keyword. A keyword is a word that appears more
2537: than the average number of times in the thesaurus database. Calls
2538: &initialize_keywords
2539:
2540: =cut
2541:
2542: ###################################################
1.20 www 2543:
2544: sub keyword {
1.46 matthew 2545: return if (!&initialize_keywords());
2546: my $word=lc(shift());
2547: $word=~s/\W//g;
2548: return exists($Keywords{$word});
1.20 www 2549: }
1.46 matthew 2550:
2551: ###############################################################
2552:
2553: =pod
1.20 www 2554:
1.648 raeburn 2555: =item * &get_related_words()
1.46 matthew 2556:
1.160 matthew 2557: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2558: an array of words. If the keyword is not in the thesaurus, an empty array
2559: will be returned. The order of the words returned is determined by the
2560: database which holds them.
2561:
2562: Uses global $thesaurus_db_file.
2563:
2564: =cut
2565:
2566: ###############################################################
2567: sub get_related_words {
2568: my $keyword = shift;
2569: my %thesaurus_db;
2570: if (! -e $thesaurus_db_file) {
2571: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2572: "failed because the file does not exist");
2573: return ();
2574: }
2575: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2576: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2577: return ();
2578: }
2579: my @Words=();
1.429 www 2580: my $count=0;
1.46 matthew 2581: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2582: # The first element is the number of times
2583: # the word appears. We do not need it now.
1.429 www 2584: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2585: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2586: my $threshold=$mostfrequentcount/10;
2587: foreach my $possibleword (@RelatedWords) {
2588: my ($word,$wordcount)=split(/\,/,$possibleword);
2589: if ($wordcount>$threshold) {
2590: push(@Words,$word);
2591: $count++;
2592: if ($count>10) { last; }
2593: }
1.20 www 2594: }
2595: }
1.46 matthew 2596: untie %thesaurus_db;
2597: return @Words;
1.14 harris41 2598: }
1.46 matthew 2599:
1.112 bowersj2 2600: =pod
2601:
2602: =back
2603:
2604: =cut
1.61 www 2605:
2606: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2607: =pod
2608:
1.112 bowersj2 2609: =head1 User Name Functions
2610:
2611: =over 4
2612:
1.648 raeburn 2613: =item * &plainname($uname,$udom,$first)
1.81 albertel 2614:
1.112 bowersj2 2615: Takes a users logon name and returns it as a string in
1.226 albertel 2616: "first middle last generation" form
2617: if $first is set to 'lastname' then it returns it as
2618: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2619:
2620: =cut
1.61 www 2621:
1.295 www 2622:
1.81 albertel 2623: ###############################################################
1.61 www 2624: sub plainname {
1.226 albertel 2625: my ($uname,$udom,$first)=@_;
1.537 albertel 2626: return if (!defined($uname) || !defined($udom));
1.295 www 2627: my %names=&getnames($uname,$udom);
1.226 albertel 2628: my $name=&Apache::lonnet::format_name($names{'firstname'},
2629: $names{'middlename'},
2630: $names{'lastname'},
2631: $names{'generation'},$first);
2632: $name=~s/^\s+//;
1.62 www 2633: $name=~s/\s+$//;
2634: $name=~s/\s+/ /g;
1.353 albertel 2635: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2636: return $name;
1.61 www 2637: }
1.66 www 2638:
2639: # -------------------------------------------------------------------- Nickname
1.81 albertel 2640: =pod
2641:
1.648 raeburn 2642: =item * &nickname($uname,$udom)
1.81 albertel 2643:
2644: Gets a users name and returns it as a string as
2645:
2646: ""nickname""
1.66 www 2647:
1.81 albertel 2648: if the user has a nickname or
2649:
2650: "first middle last generation"
2651:
2652: if the user does not
2653:
2654: =cut
1.66 www 2655:
2656: sub nickname {
2657: my ($uname,$udom)=@_;
1.537 albertel 2658: return if (!defined($uname) || !defined($udom));
1.295 www 2659: my %names=&getnames($uname,$udom);
1.68 albertel 2660: my $name=$names{'nickname'};
1.66 www 2661: if ($name) {
2662: $name='"'.$name.'"';
2663: } else {
2664: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2665: $names{'lastname'}.' '.$names{'generation'};
2666: $name=~s/\s+$//;
2667: $name=~s/\s+/ /g;
2668: }
2669: return $name;
2670: }
2671:
1.295 www 2672: sub getnames {
2673: my ($uname,$udom)=@_;
1.537 albertel 2674: return if (!defined($uname) || !defined($udom));
1.433 albertel 2675: if ($udom eq 'public' && $uname eq 'public') {
2676: return ('lastname' => &mt('Public'));
2677: }
1.295 www 2678: my $id=$uname.':'.$udom;
2679: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2680: if ($cached) {
2681: return %{$names};
2682: } else {
2683: my %loadnames=&Apache::lonnet::get('environment',
2684: ['firstname','middlename','lastname','generation','nickname'],
2685: $udom,$uname);
2686: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2687: return %loadnames;
2688: }
2689: }
1.61 www 2690:
1.542 raeburn 2691: # -------------------------------------------------------------------- getemails
1.648 raeburn 2692:
1.542 raeburn 2693: =pod
2694:
1.648 raeburn 2695: =item * &getemails($uname,$udom)
1.542 raeburn 2696:
2697: Gets a user's email information and returns it as a hash with keys:
2698: notification, critnotification, permanentemail
2699:
2700: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2701: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2702:
1.648 raeburn 2703:
1.542 raeburn 2704: =cut
2705:
1.648 raeburn 2706:
1.466 albertel 2707: sub getemails {
2708: my ($uname,$udom)=@_;
2709: if ($udom eq 'public' && $uname eq 'public') {
2710: return;
2711: }
1.467 www 2712: if (!$udom) { $udom=$env{'user.domain'}; }
2713: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2714: my $id=$uname.':'.$udom;
2715: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2716: if ($cached) {
2717: return %{$names};
2718: } else {
2719: my %loadnames=&Apache::lonnet::get('environment',
2720: ['notification','critnotification',
2721: 'permanentemail'],
2722: $udom,$uname);
2723: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2724: return %loadnames;
2725: }
2726: }
2727:
1.551 albertel 2728: sub flush_email_cache {
2729: my ($uname,$udom)=@_;
2730: if (!$udom) { $udom =$env{'user.domain'}; }
2731: if (!$uname) { $uname=$env{'user.name'}; }
2732: return if ($udom eq 'public' && $uname eq 'public');
2733: my $id=$uname.':'.$udom;
2734: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2735: }
2736:
1.728 raeburn 2737: # -------------------------------------------------------------------- getlangs
2738:
2739: =pod
2740:
2741: =item * &getlangs($uname,$udom)
2742:
2743: Gets a user's language preference and returns it as a hash with key:
2744: language.
2745:
2746: =cut
2747:
2748:
2749: sub getlangs {
2750: my ($uname,$udom) = @_;
2751: if (!$udom) { $udom =$env{'user.domain'}; }
2752: if (!$uname) { $uname=$env{'user.name'}; }
2753: my $id=$uname.':'.$udom;
2754: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2755: if ($cached) {
2756: return %{$langs};
2757: } else {
2758: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2759: $udom,$uname);
2760: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2761: return %loadlangs;
2762: }
2763: }
2764:
2765: sub flush_langs_cache {
2766: my ($uname,$udom)=@_;
2767: if (!$udom) { $udom =$env{'user.domain'}; }
2768: if (!$uname) { $uname=$env{'user.name'}; }
2769: return if ($udom eq 'public' && $uname eq 'public');
2770: my $id=$uname.':'.$udom;
2771: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2772: }
2773:
1.61 www 2774: # ------------------------------------------------------------------ Screenname
1.81 albertel 2775:
2776: =pod
2777:
1.648 raeburn 2778: =item * &screenname($uname,$udom)
1.81 albertel 2779:
2780: Gets a users screenname and returns it as a string
2781:
2782: =cut
1.61 www 2783:
2784: sub screenname {
2785: my ($uname,$udom)=@_;
1.258 albertel 2786: if ($uname eq $env{'user.name'} &&
2787: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2788: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2789: return $names{'screenname'};
1.62 www 2790: }
2791:
1.212 albertel 2792:
1.62 www 2793: # ------------------------------------------------------------- Message Wrapper
2794:
2795: sub messagewrapper {
1.369 www 2796: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2797: return
1.441 albertel 2798: '<a href="/adm/email?compose=individual&'.
2799: 'recname='.$username.'&recdom='.$domain.
2800: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2801: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2802: }
2803: # --------------------------------------------------------------- Notes Wrapper
2804:
2805: sub noteswrapper {
2806: my ($link,$un,$do)=@_;
2807: return
2808: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2809: }
2810: # ------------------------------------------------------------- Aboutme Wrapper
2811:
2812: sub aboutmewrapper {
1.166 www 2813: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2814: if (!defined($username) && !defined($domain)) {
2815: return;
2816: }
1.205 www 2817: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756 weissno 2818: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 2819: }
2820:
2821: # ------------------------------------------------------------ Syllabus Wrapper
2822:
2823:
2824: sub syllabuswrapper {
1.707 bisitz 2825: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2826: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2827: }
1.14 harris41 2828:
1.208 matthew 2829: sub track_student_link {
1.268 albertel 2830: my ($linktext,$sname,$sdom,$target,$start) = @_;
2831: my $link ="/adm/trackstudent?";
1.208 matthew 2832: my $title = 'View recent activity';
2833: if (defined($sname) && $sname !~ /^\s*$/ &&
2834: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2835: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2836: $title .= ' of this student';
1.268 albertel 2837: }
1.208 matthew 2838: if (defined($target) && $target !~ /^\s*$/) {
2839: $target = qq{target="$target"};
2840: } else {
2841: $target = '';
2842: }
1.268 albertel 2843: if ($start) { $link.='&start='.$start; }
1.554 albertel 2844: $title = &mt($title);
2845: $linktext = &mt($linktext);
1.448 albertel 2846: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2847: &help_open_topic('View_recent_activity');
1.208 matthew 2848: }
2849:
1.781 raeburn 2850: sub slot_reservations_link {
2851: my ($linktext,$sname,$sdom,$target) = @_;
2852: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
2853: my $title = 'View slot reservation history';
2854: if (defined($sname) && $sname !~ /^\s*$/ &&
2855: defined($sdom) && $sdom !~ /^\s*$/) {
2856: $link .= "&uname=$sname&udom=$sdom";
2857: $title .= ' of this student';
2858: }
2859: if (defined($target) && $target !~ /^\s*$/) {
2860: $target = qq{target="$target"};
2861: } else {
2862: $target = '';
2863: }
2864: $title = &mt($title);
2865: $linktext = &mt($linktext);
2866: return qq{<a href="$link" title="$title" $target>$linktext</a>};
2867: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
2868:
2869: }
2870:
1.508 www 2871: # ===================================================== Display a student photo
2872:
2873:
1.509 albertel 2874: sub student_image_tag {
1.508 www 2875: my ($domain,$user)=@_;
2876: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2877: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2878: return '<img src="'.$imgsrc.'" align="right" />';
2879: } else {
2880: return '';
2881: }
2882: }
2883:
1.112 bowersj2 2884: =pod
2885:
2886: =back
2887:
2888: =head1 Access .tab File Data
2889:
2890: =over 4
2891:
1.648 raeburn 2892: =item * &languageids()
1.112 bowersj2 2893:
2894: returns list of all language ids
2895:
2896: =cut
2897:
1.14 harris41 2898: sub languageids {
1.16 harris41 2899: return sort(keys(%language));
1.14 harris41 2900: }
2901:
1.112 bowersj2 2902: =pod
2903:
1.648 raeburn 2904: =item * &languagedescription()
1.112 bowersj2 2905:
2906: returns description of a specified language id
2907:
2908: =cut
2909:
1.14 harris41 2910: sub languagedescription {
1.125 www 2911: my $code=shift;
2912: return ($supported_language{$code}?'* ':'').
2913: $language{$code}.
1.126 www 2914: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2915: }
2916:
2917: sub plainlanguagedescription {
2918: my $code=shift;
2919: return $language{$code};
2920: }
2921:
2922: sub supportedlanguagecode {
2923: my $code=shift;
2924: return $supported_language{$code};
1.97 www 2925: }
2926:
1.112 bowersj2 2927: =pod
2928:
1.648 raeburn 2929: =item * ©rightids()
1.112 bowersj2 2930:
2931: returns list of all copyrights
2932:
2933: =cut
2934:
2935: sub copyrightids {
2936: return sort(keys(%cprtag));
2937: }
2938:
2939: =pod
2940:
1.648 raeburn 2941: =item * ©rightdescription()
1.112 bowersj2 2942:
2943: returns description of a specified copyright id
2944:
2945: =cut
2946:
2947: sub copyrightdescription {
1.166 www 2948: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2949: }
1.197 matthew 2950:
2951: =pod
2952:
1.648 raeburn 2953: =item * &source_copyrightids()
1.192 taceyjo1 2954:
2955: returns list of all source copyrights
2956:
2957: =cut
2958:
2959: sub source_copyrightids {
2960: return sort(keys(%scprtag));
2961: }
2962:
2963: =pod
2964:
1.648 raeburn 2965: =item * &source_copyrightdescription()
1.192 taceyjo1 2966:
2967: returns description of a specified source copyright id
2968:
2969: =cut
2970:
2971: sub source_copyrightdescription {
2972: return &mt($scprtag{shift(@_)});
2973: }
1.112 bowersj2 2974:
2975: =pod
2976:
1.648 raeburn 2977: =item * &filecategories()
1.112 bowersj2 2978:
2979: returns list of all file categories
2980:
2981: =cut
2982:
2983: sub filecategories {
2984: return sort(keys(%category_extensions));
2985: }
2986:
2987: =pod
2988:
1.648 raeburn 2989: =item * &filecategorytypes()
1.112 bowersj2 2990:
2991: returns list of file types belonging to a given file
2992: category
2993:
2994: =cut
2995:
2996: sub filecategorytypes {
1.356 albertel 2997: my ($cat) = @_;
2998: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2999: }
3000:
3001: =pod
3002:
1.648 raeburn 3003: =item * &fileembstyle()
1.112 bowersj2 3004:
3005: returns embedding style for a specified file type
3006:
3007: =cut
3008:
3009: sub fileembstyle {
3010: return $fe{lc(shift(@_))};
1.169 www 3011: }
3012:
1.351 www 3013: sub filemimetype {
3014: return $fm{lc(shift(@_))};
3015: }
3016:
1.169 www 3017:
3018: sub filecategoryselect {
3019: my ($name,$value)=@_;
1.189 matthew 3020: return &select_form($value,$name,
1.169 www 3021: '' => &mt('Any category'),
3022: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3023: }
3024:
3025: =pod
3026:
1.648 raeburn 3027: =item * &filedescription()
1.112 bowersj2 3028:
3029: returns description for a specified file type
3030:
3031: =cut
3032:
3033: sub filedescription {
1.188 matthew 3034: my $file_description = $fd{lc(shift())};
3035: $file_description =~ s:([\[\]]):~$1:g;
3036: return &mt($file_description);
1.112 bowersj2 3037: }
3038:
3039: =pod
3040:
1.648 raeburn 3041: =item * &filedescriptionex()
1.112 bowersj2 3042:
3043: returns description for a specified file type with
3044: extra formatting
3045:
3046: =cut
3047:
3048: sub filedescriptionex {
3049: my $ex=shift;
1.188 matthew 3050: my $file_description = $fd{lc($ex)};
3051: $file_description =~ s:([\[\]]):~$1:g;
3052: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3053: }
3054:
3055: # End of .tab access
3056: =pod
3057:
3058: =back
3059:
3060: =cut
3061:
3062: # ------------------------------------------------------------------ File Types
3063: sub fileextensions {
3064: return sort(keys(%fe));
3065: }
3066:
1.97 www 3067: # ----------------------------------------------------------- Display Languages
3068: # returns a hash with all desired display languages
3069: #
3070:
3071: sub display_languages {
3072: my %languages=();
1.695 raeburn 3073: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3074: $languages{$lang}=1;
1.97 www 3075: }
3076: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3077: if ($env{'form.displaylanguage'}) {
1.356 albertel 3078: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3079: $languages{$lang}=1;
1.97 www 3080: }
3081: }
3082: return %languages;
1.14 harris41 3083: }
3084:
1.582 albertel 3085: sub languages {
3086: my ($possible_langs) = @_;
1.695 raeburn 3087: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3088: if (!ref($possible_langs)) {
3089: if( wantarray ) {
3090: return @preferred_langs;
3091: } else {
3092: return $preferred_langs[0];
3093: }
3094: }
3095: my %possibilities = map { $_ => 1 } (@$possible_langs);
3096: my @preferred_possibilities;
3097: foreach my $preferred_lang (@preferred_langs) {
3098: if (exists($possibilities{$preferred_lang})) {
3099: push(@preferred_possibilities, $preferred_lang);
3100: }
3101: }
3102: if( wantarray ) {
3103: return @preferred_possibilities;
3104: }
3105: return $preferred_possibilities[0];
3106: }
3107:
1.742 raeburn 3108: sub user_lang {
3109: my ($touname,$toudom,$fromcid) = @_;
3110: my @userlangs;
3111: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3112: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3113: $env{'course.'.$fromcid.'.languages'}));
3114: } else {
3115: my %langhash = &getlangs($touname,$toudom);
3116: if ($langhash{'languages'} ne '') {
3117: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3118: } else {
3119: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3120: if ($domdefs{'lang_def'} ne '') {
3121: @userlangs = ($domdefs{'lang_def'});
3122: }
3123: }
3124: }
3125: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3126: my $user_lh = Apache::localize->get_handle(@languages);
3127: return $user_lh;
3128: }
3129:
3130:
1.112 bowersj2 3131: ###############################################################
3132: ## Student Answer Attempts ##
3133: ###############################################################
3134:
3135: =pod
3136:
3137: =head1 Alternate Problem Views
3138:
3139: =over 4
3140:
1.648 raeburn 3141: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3142: $getattempt, $regexp, $gradesub)
3143:
3144: Return string with previous attempt on problem. Arguments:
3145:
3146: =over 4
3147:
3148: =item * $symb: Problem, including path
3149:
3150: =item * $username: username of the desired student
3151:
3152: =item * $domain: domain of the desired student
1.14 harris41 3153:
1.112 bowersj2 3154: =item * $course: Course ID
1.14 harris41 3155:
1.112 bowersj2 3156: =item * $getattempt: Leave blank for all attempts, otherwise put
3157: something
1.14 harris41 3158:
1.112 bowersj2 3159: =item * $regexp: if string matches this regexp, the string will be
3160: sent to $gradesub
1.14 harris41 3161:
1.112 bowersj2 3162: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3163:
1.112 bowersj2 3164: =back
1.14 harris41 3165:
1.112 bowersj2 3166: The output string is a table containing all desired attempts, if any.
1.16 harris41 3167:
1.112 bowersj2 3168: =cut
1.1 albertel 3169:
3170: sub get_previous_attempt {
1.43 ng 3171: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3172: my $prevattempts='';
1.43 ng 3173: no strict 'refs';
1.1 albertel 3174: if ($symb) {
1.3 albertel 3175: my (%returnhash)=
3176: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3177: if ($returnhash{'version'}) {
3178: my %lasthash=();
3179: my $version;
3180: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3181: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3182: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3183: }
1.1 albertel 3184: }
1.596 albertel 3185: $prevattempts=&start_data_table().&start_data_table_header_row();
3186: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3187: foreach my $key (sort(keys(%lasthash))) {
3188: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3189: if ($#parts > 0) {
1.31 albertel 3190: my $data=$parts[-1];
3191: pop(@parts);
1.596 albertel 3192: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3193: } else {
1.41 ng 3194: if ($#parts == 0) {
3195: $prevattempts.='<th>'.$parts[0].'</th>';
3196: } else {
3197: $prevattempts.='<th>'.$ign.'</th>';
3198: }
1.31 albertel 3199: }
1.16 harris41 3200: }
1.596 albertel 3201: $prevattempts.=&end_data_table_header_row();
1.40 ng 3202: if ($getattempt eq '') {
3203: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3204: $prevattempts.=&start_data_table_row().
3205: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3206: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3207: my $value = &format_previous_attempt_value($key,
3208: $returnhash{$version.':'.$key});
3209: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3210: }
1.596 albertel 3211: $prevattempts.=&end_data_table_row();
1.40 ng 3212: }
1.1 albertel 3213: }
1.596 albertel 3214: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3215: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3216: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3217: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3218: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3219: }
1.596 albertel 3220: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3221: } else {
1.596 albertel 3222: $prevattempts=
3223: &start_data_table().&start_data_table_row().
3224: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3225: &end_data_table_row().&end_data_table();
1.1 albertel 3226: }
3227: } else {
1.596 albertel 3228: $prevattempts=
3229: &start_data_table().&start_data_table_row().
3230: '<td>'.&mt('No data.').'</td>'.
3231: &end_data_table_row().&end_data_table();
1.1 albertel 3232: }
1.10 albertel 3233: }
3234:
1.581 albertel 3235: sub format_previous_attempt_value {
3236: my ($key,$value) = @_;
3237: if ($key =~ /timestamp/) {
3238: $value = &Apache::lonlocal::locallocaltime($value);
3239: } elsif (ref($value) eq 'ARRAY') {
3240: $value = '('.join(', ', @{ $value }).')';
3241: } else {
3242: $value = &unescape($value);
3243: }
3244: return $value;
3245: }
3246:
3247:
1.107 albertel 3248: sub relative_to_absolute {
3249: my ($url,$output)=@_;
3250: my $parser=HTML::TokeParser->new(\$output);
3251: my $token;
3252: my $thisdir=$url;
3253: my @rlinks=();
3254: while ($token=$parser->get_token) {
3255: if ($token->[0] eq 'S') {
3256: if ($token->[1] eq 'a') {
3257: if ($token->[2]->{'href'}) {
3258: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3259: }
3260: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3261: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3262: } elsif ($token->[1] eq 'base') {
3263: $thisdir=$token->[2]->{'href'};
3264: }
3265: }
3266: }
3267: $thisdir=~s-/[^/]*$--;
1.356 albertel 3268: foreach my $link (@rlinks) {
1.726 raeburn 3269: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3270: ($link=~/^\//) ||
3271: ($link=~/^javascript:/i) ||
3272: ($link=~/^mailto:/i) ||
3273: ($link=~/^\#/)) {
3274: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3275: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3276: }
3277: }
3278: # -------------------------------------------------- Deal with Applet codebases
3279: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3280: return $output;
3281: }
3282:
1.112 bowersj2 3283: =pod
3284:
1.648 raeburn 3285: =item * &get_student_view()
1.112 bowersj2 3286:
3287: show a snapshot of what student was looking at
3288:
3289: =cut
3290:
1.10 albertel 3291: sub get_student_view {
1.186 albertel 3292: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3293: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3294: my (%form);
1.10 albertel 3295: my @elements=('symb','courseid','domain','username');
3296: foreach my $element (@elements) {
1.186 albertel 3297: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3298: }
1.186 albertel 3299: if (defined($moreenv)) {
3300: %form=(%form,%{$moreenv});
3301: }
1.236 albertel 3302: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3303: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3304: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3305: $userview=~s/\<body[^\>]*\>//gi;
3306: $userview=~s/\<\/body\>//gi;
3307: $userview=~s/\<html\>//gi;
3308: $userview=~s/\<\/html\>//gi;
3309: $userview=~s/\<head\>//gi;
3310: $userview=~s/\<\/head\>//gi;
3311: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3312: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3313: if (wantarray) {
3314: return ($userview,$response);
3315: } else {
3316: return $userview;
3317: }
3318: }
3319:
3320: sub get_student_view_with_retries {
3321: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3322:
3323: my $ok = 0; # True if we got a good response.
3324: my $content;
3325: my $response;
3326:
3327: # Try to get the student_view done. within the retries count:
3328:
3329: do {
3330: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3331: $ok = $response->is_success;
3332: if (!$ok) {
3333: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3334: }
3335: $retries--;
3336: } while (!$ok && ($retries > 0));
3337:
3338: if (!$ok) {
3339: $content = ''; # On error return an empty content.
3340: }
1.651 www 3341: if (wantarray) {
3342: return ($content, $response);
3343: } else {
3344: return $content;
3345: }
1.11 albertel 3346: }
3347:
1.112 bowersj2 3348: =pod
3349:
1.648 raeburn 3350: =item * &get_student_answers()
1.112 bowersj2 3351:
3352: show a snapshot of how student was answering problem
3353:
3354: =cut
3355:
1.11 albertel 3356: sub get_student_answers {
1.100 sakharuk 3357: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3358: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3359: my (%moreenv);
1.11 albertel 3360: my @elements=('symb','courseid','domain','username');
3361: foreach my $element (@elements) {
1.186 albertel 3362: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3363: }
1.186 albertel 3364: $moreenv{'grade_target'}='answer';
3365: %moreenv=(%form,%moreenv);
1.497 raeburn 3366: $feedurl = &Apache::lonnet::clutter($feedurl);
3367: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3368: return $userview;
1.1 albertel 3369: }
1.116 albertel 3370:
3371: =pod
3372:
3373: =item * &submlink()
3374:
1.242 albertel 3375: Inputs: $text $uname $udom $symb $target
1.116 albertel 3376:
3377: Returns: A link to grades.pm such as to see the SUBM view of a student
3378:
3379: =cut
3380:
3381: ###############################################
3382: sub submlink {
1.242 albertel 3383: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3384: if (!($uname && $udom)) {
3385: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3386: &Apache::lonnet::whichuser($symb);
1.116 albertel 3387: if (!$symb) { $symb=$cursymb; }
3388: }
1.254 matthew 3389: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3390: $symb=&escape($symb);
1.242 albertel 3391: if ($target) { $target="target=\"$target\""; }
3392: return '<a href="/adm/grades?&command=submission&'.
3393: 'symb='.$symb.'&student='.$uname.
3394: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3395: }
3396: ##############################################
3397:
3398: =pod
3399:
3400: =item * &pgrdlink()
3401:
3402: Inputs: $text $uname $udom $symb $target
3403:
3404: Returns: A link to grades.pm such as to see the PGRD view of a student
3405:
3406: =cut
3407:
3408: ###############################################
3409: sub pgrdlink {
3410: my $link=&submlink(@_);
3411: $link=~s/(&command=submission)/$1&showgrading=yes/;
3412: return $link;
3413: }
3414: ##############################################
3415:
3416: =pod
3417:
3418: =item * &pprmlink()
3419:
3420: Inputs: $text $uname $udom $symb $target
3421:
3422: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3423: student and a specific resource
1.242 albertel 3424:
3425: =cut
3426:
3427: ###############################################
3428: sub pprmlink {
3429: my ($text,$uname,$udom,$symb,$target)=@_;
3430: if (!($uname && $udom)) {
3431: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3432: &Apache::lonnet::whichuser($symb);
1.242 albertel 3433: if (!$symb) { $symb=$cursymb; }
3434: }
1.254 matthew 3435: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3436: $symb=&escape($symb);
1.242 albertel 3437: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3438: return '<a href="/adm/parmset?command=set&'.
3439: 'symb='.$symb.'&uname='.$uname.
3440: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3441: }
3442: ##############################################
1.37 matthew 3443:
1.112 bowersj2 3444: =pod
3445:
3446: =back
3447:
3448: =cut
3449:
1.37 matthew 3450: ###############################################
1.51 www 3451:
3452:
3453: sub timehash {
1.687 raeburn 3454: my ($thistime) = @_;
3455: my $timezone = &Apache::lonlocal::gettimezone();
3456: my $dt = DateTime->from_epoch(epoch => $thistime)
3457: ->set_time_zone($timezone);
3458: my $wday = $dt->day_of_week();
3459: if ($wday == 7) { $wday = 0; }
3460: return ( 'second' => $dt->second(),
3461: 'minute' => $dt->minute(),
3462: 'hour' => $dt->hour(),
3463: 'day' => $dt->day_of_month(),
3464: 'month' => $dt->month(),
3465: 'year' => $dt->year(),
3466: 'weekday' => $wday,
3467: 'dayyear' => $dt->day_of_year(),
3468: 'dlsav' => $dt->is_dst() );
1.51 www 3469: }
3470:
1.370 www 3471: sub utc_string {
3472: my ($date)=@_;
1.371 www 3473: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3474: }
3475:
1.51 www 3476: sub maketime {
3477: my %th=@_;
1.687 raeburn 3478: my ($epoch_time,$timezone,$dt);
3479: $timezone = &Apache::lonlocal::gettimezone();
3480: eval {
3481: $dt = DateTime->new( year => $th{'year'},
3482: month => $th{'month'},
3483: day => $th{'day'},
3484: hour => $th{'hour'},
3485: minute => $th{'minute'},
3486: second => $th{'second'},
3487: time_zone => $timezone,
3488: );
3489: };
3490: if (!$@) {
3491: $epoch_time = $dt->epoch;
3492: if ($epoch_time) {
3493: return $epoch_time;
3494: }
3495: }
1.51 www 3496: return POSIX::mktime(
3497: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3498: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3499: }
3500:
3501: #########################################
1.51 www 3502:
3503: sub findallcourses {
1.482 raeburn 3504: my ($roles,$uname,$udom) = @_;
1.355 albertel 3505: my %roles;
3506: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3507: my %courses;
1.51 www 3508: my $now=time;
1.482 raeburn 3509: if (!defined($uname)) {
3510: $uname = $env{'user.name'};
3511: }
3512: if (!defined($udom)) {
3513: $udom = $env{'user.domain'};
3514: }
3515: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3516: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3517: if (!%roles) {
3518: %roles = (
3519: cc => 1,
3520: in => 1,
3521: ep => 1,
3522: ta => 1,
3523: cr => 1,
3524: st => 1,
3525: );
3526: }
3527: foreach my $entry (keys(%roleshash)) {
3528: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3529: if ($trole =~ /^cr/) {
3530: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3531: } else {
3532: next if (!exists($roles{$trole}));
3533: }
3534: if ($tend) {
3535: next if ($tend < $now);
3536: }
3537: if ($tstart) {
3538: next if ($tstart > $now);
3539: }
3540: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3541: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3542: if ($secpart eq '') {
3543: ($cnum,$role) = split(/_/,$cnumpart);
3544: $sec = 'none';
3545: $realsec = '';
3546: } else {
3547: $cnum = $cnumpart;
3548: ($sec,$role) = split(/_/,$secpart);
3549: $realsec = $sec;
1.490 raeburn 3550: }
1.482 raeburn 3551: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3552: }
3553: } else {
3554: foreach my $key (keys(%env)) {
1.483 albertel 3555: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3556: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3557: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3558: next if ($role eq 'ca' || $role eq 'aa');
3559: next if (%roles && !exists($roles{$role}));
3560: my ($starttime,$endtime)=split(/\./,$env{$key});
3561: my $active=1;
3562: if ($starttime) {
3563: if ($now<$starttime) { $active=0; }
3564: }
3565: if ($endtime) {
3566: if ($now>$endtime) { $active=0; }
3567: }
3568: if ($active) {
3569: if ($sec eq '') {
3570: $sec = 'none';
3571: }
3572: $courses{$cdom.'_'.$cnum}{$sec} =
3573: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3574: }
3575: }
1.51 www 3576: }
3577: }
1.474 raeburn 3578: return %courses;
1.51 www 3579: }
1.37 matthew 3580:
1.54 www 3581: ###############################################
1.474 raeburn 3582:
3583: sub blockcheck {
1.482 raeburn 3584: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3585:
3586: if (!defined($udom)) {
3587: $udom = $env{'user.domain'};
3588: }
3589: if (!defined($uname)) {
3590: $uname = $env{'user.name'};
3591: }
3592:
3593: # If uname and udom are for a course, check for blocks in the course.
3594:
3595: if (&Apache::lonnet::is_course($udom,$uname)) {
3596: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3597: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3598: return ($startblock,$endblock);
3599: }
1.474 raeburn 3600:
1.502 raeburn 3601: my $startblock = 0;
3602: my $endblock = 0;
1.482 raeburn 3603: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3604:
1.490 raeburn 3605: # If uname is for a user, and activity is course-specific, i.e.,
3606: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3607:
1.490 raeburn 3608: if (($activity eq 'boards' || $activity eq 'chat' ||
3609: $activity eq 'groups') && ($env{'request.course.id'})) {
3610: foreach my $key (keys(%live_courses)) {
3611: if ($key ne $env{'request.course.id'}) {
3612: delete($live_courses{$key});
3613: }
3614: }
3615: }
3616:
3617: my $otheruser = 0;
3618: my %own_courses;
3619: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3620: # Resource belongs to user other than current user.
3621: $otheruser = 1;
3622: # Gather courses for current user
3623: %own_courses =
3624: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3625: }
3626:
3627: # Gather active course roles - course coordinator, instructor,
3628: # exam proctor, ta, student, or custom role.
1.474 raeburn 3629:
3630: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3631: my ($cdom,$cnum);
3632: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3633: $cdom = $env{'course.'.$course.'.domain'};
3634: $cnum = $env{'course.'.$course.'.num'};
3635: } else {
1.490 raeburn 3636: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3637: }
3638: my $no_ownblock = 0;
3639: my $no_userblock = 0;
1.533 raeburn 3640: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3641: # Check if current user has 'evb' priv for this
3642: if (defined($own_courses{$course})) {
3643: foreach my $sec (keys(%{$own_courses{$course}})) {
3644: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3645: if ($sec ne 'none') {
3646: $checkrole .= '/'.$sec;
3647: }
3648: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3649: $no_ownblock = 1;
3650: last;
3651: }
3652: }
3653: }
3654: # if they have 'evb' priv and are currently not playing student
3655: next if (($no_ownblock) &&
3656: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3657: }
1.474 raeburn 3658: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3659: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3660: if ($sec ne 'none') {
1.482 raeburn 3661: $checkrole .= '/'.$sec;
1.474 raeburn 3662: }
1.490 raeburn 3663: if ($otheruser) {
3664: # Resource belongs to user other than current user.
3665: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3666: my ($trole,$tdom,$tnum,$tsec);
3667: my $entry = $live_courses{$course}{$sec};
3668: if ($entry =~ /^cr/) {
3669: ($trole,$tdom,$tnum,$tsec) =
3670: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3671: } else {
3672: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3673: }
3674: my ($spec,$area,$trest,%allroles,%userroles);
3675: $area = '/'.$tdom.'/'.$tnum;
3676: $trest = $tnum;
3677: if ($tsec ne '') {
3678: $area .= '/'.$tsec;
3679: $trest .= '/'.$tsec;
3680: }
3681: $spec = $trole.'.'.$area;
3682: if ($trole =~ /^cr/) {
3683: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3684: $tdom,$spec,$trest,$area);
3685: } else {
3686: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3687: $tdom,$spec,$trest,$area);
3688: }
3689: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3690: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3691: if ($1) {
3692: $no_userblock = 1;
3693: last;
3694: }
3695: }
1.490 raeburn 3696: } else {
3697: # Resource belongs to current user
3698: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3699: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3700: $no_ownblock = 1;
3701: last;
3702: }
1.474 raeburn 3703: }
3704: }
3705: # if they have the evb priv and are currently not playing student
1.482 raeburn 3706: next if (($no_ownblock) &&
1.491 albertel 3707: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3708: next if ($no_userblock);
1.474 raeburn 3709:
1.490 raeburn 3710: # Retrieve blocking times and identity of blocker for course
3711: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3712:
3713: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3714: if (($start != 0) &&
3715: (($startblock == 0) || ($startblock > $start))) {
3716: $startblock = $start;
3717: }
3718: if (($end != 0) &&
3719: (($endblock == 0) || ($endblock < $end))) {
3720: $endblock = $end;
3721: }
1.490 raeburn 3722: }
3723: return ($startblock,$endblock);
3724: }
3725:
3726: sub get_blocks {
3727: my ($setters,$activity,$cdom,$cnum) = @_;
3728: my $startblock = 0;
3729: my $endblock = 0;
3730: my $course = $cdom.'_'.$cnum;
3731: $setters->{$course} = {};
3732: $setters->{$course}{'staff'} = [];
3733: $setters->{$course}{'times'} = [];
3734: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3735: foreach my $record (keys(%records)) {
3736: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3737: if ($start <= time && $end >= time) {
3738: my ($staff_name,$staff_dom,$title,$blocks) =
3739: &parse_block_record($records{$record});
3740: if ($blocks->{$activity} eq 'on') {
3741: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3742: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3743: if ( ($startblock == 0) || ($startblock > $start) ) {
3744: $startblock = $start;
1.490 raeburn 3745: }
1.491 albertel 3746: if ( ($endblock == 0) || ($endblock < $end) ) {
3747: $endblock = $end;
1.474 raeburn 3748: }
3749: }
3750: }
3751: }
3752: return ($startblock,$endblock);
3753: }
3754:
3755: sub parse_block_record {
3756: my ($record) = @_;
3757: my ($setuname,$setudom,$title,$blocks);
3758: if (ref($record) eq 'HASH') {
3759: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3760: $title = &unescape($record->{'event'});
3761: $blocks = $record->{'blocks'};
3762: } else {
3763: my @data = split(/:/,$record,3);
3764: if (scalar(@data) eq 2) {
3765: $title = $data[1];
3766: ($setuname,$setudom) = split(/@/,$data[0]);
3767: } else {
3768: ($setuname,$setudom,$title) = @data;
3769: }
3770: $blocks = { 'com' => 'on' };
3771: }
3772: return ($setuname,$setudom,$title,$blocks);
3773: }
3774:
3775: sub build_block_table {
3776: my ($startblock,$endblock,$setters) = @_;
3777: my %lt = &Apache::lonlocal::texthash(
3778: 'cacb' => 'Currently active communication blocks',
3779: 'cour' => 'Course',
3780: 'dura' => 'Duration',
3781: 'blse' => 'Block set by'
3782: );
3783: my $output;
1.476 raeburn 3784: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3785: $output .= &start_data_table();
3786: $output .= '
3787: <tr>
3788: <th>'.$lt{'cour'}.'</th>
3789: <th>'.$lt{'dura'}.'</th>
3790: <th>'.$lt{'blse'}.'</th>
3791: </tr>
3792: ';
3793: foreach my $course (keys(%{$setters})) {
3794: my %courseinfo=&Apache::lonnet::coursedescription($course);
3795: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3796: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3797: my $fullname = &plainname($uname,$udom);
3798: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3799: && $env{'user.name'} ne 'public'
3800: && $env{'user.domain'} ne 'public') {
3801: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3802: }
1.474 raeburn 3803: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3804: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3805: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3806: $output .= &Apache::loncommon::start_data_table_row().
3807: '<td>'.$courseinfo{'description'}.'</td>'.
3808: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3809: '<td>'.$fullname.'</td>'.
1.474 raeburn 3810: &Apache::loncommon::end_data_table_row();
3811: }
3812: }
3813: $output .= &end_data_table();
3814: }
3815:
1.490 raeburn 3816: sub blocking_status {
3817: my ($activity,$uname,$udom) = @_;
3818: my %setters;
3819: my ($blocked,$output,$ownitem,$is_course);
3820: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3821: if ($startblock && $endblock) {
3822: $blocked = 1;
3823: if (wantarray) {
3824: my $category;
3825: if ($activity eq 'boards') {
3826: $category = 'Discussion posts in this course';
3827: } elsif ($activity eq 'blogs') {
3828: $category = 'Blogs';
3829: } elsif ($activity eq 'port') {
3830: if (defined($uname) && defined($udom)) {
3831: if ($uname eq $env{'user.name'} &&
3832: $udom eq $env{'user.domain'}) {
3833: $ownitem = 1;
3834: }
3835: }
3836: $is_course = &Apache::lonnet::is_course($udom,$uname);
3837: if ($ownitem) {
3838: $category = 'Your portfolio files';
3839: } elsif ($is_course) {
3840: my $coursedesc;
3841: foreach my $course (keys(%setters)) {
3842: my %courseinfo =
3843: &Apache::lonnet::coursedescription($course);
3844: $coursedesc = $courseinfo{'description'};
3845: }
1.764 weissno 3846: $category = "Group portfolio in the course '$coursedesc'";
1.490 raeburn 3847: } else {
3848: $category = 'Portfolio files belonging to ';
3849: if ($env{'user.name'} eq 'public' &&
3850: $env{'user.domain'} eq 'public') {
3851: $category .= &plainname($uname,$udom);
3852: } else {
3853: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3854: }
3855: }
3856: } elsif ($activity eq 'groups') {
3857: $category = 'Groups in this course';
3858: }
3859: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3860: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3861: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3862: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3863: $output .= &build_block_table($startblock,$endblock,\%setters);
3864: }
3865: }
3866: }
3867: if (wantarray) {
3868: return ($blocked,$output);
3869: } else {
3870: return $blocked;
3871: }
3872: }
3873:
1.60 matthew 3874: ###############################################
3875:
1.682 raeburn 3876: sub check_ip_acc {
3877: my ($acc)=@_;
3878: &Apache::lonxml::debug("acc is $acc");
3879: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3880: return 1;
3881: }
3882: my $allowed=0;
3883: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3884:
3885: my $name;
3886: foreach my $pattern (split(',',$acc)) {
3887: $pattern =~ s/^\s*//;
3888: $pattern =~ s/\s*$//;
3889: if ($pattern =~ /\*$/) {
3890: #35.8.*
3891: $pattern=~s/\*//;
3892: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3893: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3894: #35.8.3.[34-56]
3895: my $low=$2;
3896: my $high=$3;
3897: $pattern=$1;
3898: if ($ip =~ /^\Q$pattern\E/) {
3899: my $last=(split(/\./,$ip))[3];
3900: if ($last <=$high && $last >=$low) { $allowed=1; }
3901: }
3902: } elsif ($pattern =~ /^\*/) {
3903: #*.msu.edu
3904: $pattern=~s/\*//;
3905: if (!defined($name)) {
3906: use Socket;
3907: my $netaddr=inet_aton($ip);
3908: ($name)=gethostbyaddr($netaddr,AF_INET);
3909: }
3910: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3911: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3912: #127.0.0.1
3913: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3914: } else {
3915: #some.name.com
3916: if (!defined($name)) {
3917: use Socket;
3918: my $netaddr=inet_aton($ip);
3919: ($name)=gethostbyaddr($netaddr,AF_INET);
3920: }
3921: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3922: }
3923: if ($allowed) { last; }
3924: }
3925: return $allowed;
3926: }
3927:
3928: ###############################################
3929:
1.60 matthew 3930: =pod
3931:
1.112 bowersj2 3932: =head1 Domain Template Functions
3933:
3934: =over 4
3935:
3936: =item * &determinedomain()
1.60 matthew 3937:
3938: Inputs: $domain (usually will be undef)
3939:
1.63 www 3940: Returns: Determines which domain should be used for designs
1.60 matthew 3941:
3942: =cut
1.54 www 3943:
1.60 matthew 3944: ###############################################
1.63 www 3945: sub determinedomain {
3946: my $domain=shift;
1.531 albertel 3947: if (! $domain) {
1.60 matthew 3948: # Determine domain if we have not been given one
3949: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3950: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3951: if ($env{'request.role.domain'}) {
3952: $domain=$env{'request.role.domain'};
1.60 matthew 3953: }
3954: }
1.63 www 3955: return $domain;
3956: }
3957: ###############################################
1.517 raeburn 3958:
1.518 albertel 3959: sub devalidate_domconfig_cache {
3960: my ($udom)=@_;
3961: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3962: }
3963:
3964: # ---------------------- Get domain configuration for a domain
3965: sub get_domainconf {
3966: my ($udom) = @_;
3967: my $cachetime=1800;
3968: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3969: if (defined($cached)) { return %{$result}; }
3970:
3971: my %domconfig = &Apache::lonnet::get_dom('configuration',
3972: ['login','rolecolors'],$udom);
1.632 raeburn 3973: my (%designhash,%legacy);
1.518 albertel 3974: if (keys(%domconfig) > 0) {
3975: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3976: if (keys(%{$domconfig{'login'}})) {
3977: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3978: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3979: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3980: $designhash{$udom.'.login.'.$key.'_'.$img} =
3981: $domconfig{'login'}{$key}{$img};
3982: }
3983: } else {
3984: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3985: }
1.632 raeburn 3986: }
3987: } else {
3988: $legacy{'login'} = 1;
1.518 albertel 3989: }
1.632 raeburn 3990: } else {
3991: $legacy{'login'} = 1;
1.518 albertel 3992: }
3993: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3994: if (keys(%{$domconfig{'rolecolors'}})) {
3995: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3996: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3997: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3998: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3999: }
1.518 albertel 4000: }
4001: }
1.632 raeburn 4002: } else {
4003: $legacy{'rolecolors'} = 1;
1.518 albertel 4004: }
1.632 raeburn 4005: } else {
4006: $legacy{'rolecolors'} = 1;
1.518 albertel 4007: }
1.632 raeburn 4008: if (keys(%legacy) > 0) {
4009: my %legacyhash = &get_legacy_domconf($udom);
4010: foreach my $item (keys(%legacyhash)) {
4011: if ($item =~ /^\Q$udom\E\.login/) {
4012: if ($legacy{'login'}) {
4013: $designhash{$item} = $legacyhash{$item};
4014: }
4015: } else {
4016: if ($legacy{'rolecolors'}) {
4017: $designhash{$item} = $legacyhash{$item};
4018: }
1.518 albertel 4019: }
4020: }
4021: }
1.632 raeburn 4022: } else {
4023: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4024: }
4025: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4026: $cachetime);
4027: return %designhash;
4028: }
4029:
1.632 raeburn 4030: sub get_legacy_domconf {
4031: my ($udom) = @_;
4032: my %legacyhash;
4033: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4034: my $designfile = $designdir.'/'.$udom.'.tab';
4035: if (-e $designfile) {
4036: if ( open (my $fh,"<$designfile") ) {
4037: while (my $line = <$fh>) {
4038: next if ($line =~ /^\#/);
4039: chomp($line);
4040: my ($key,$val)=(split(/\=/,$line));
4041: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4042: }
4043: close($fh);
4044: }
4045: }
4046: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4047: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4048: }
4049: return %legacyhash;
4050: }
4051:
1.63 www 4052: =pod
4053:
1.112 bowersj2 4054: =item * &domainlogo()
1.63 www 4055:
4056: Inputs: $domain (usually will be undef)
4057:
4058: Returns: A link to a domain logo, if the domain logo exists.
4059: If the domain logo does not exist, a description of the domain.
4060:
4061: =cut
1.112 bowersj2 4062:
1.63 www 4063: ###############################################
4064: sub domainlogo {
1.517 raeburn 4065: my $domain = &determinedomain(shift);
1.518 albertel 4066: my %designhash = &get_domainconf($domain);
1.517 raeburn 4067: # See if there is a logo
4068: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4069: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4070: if ($imgsrc =~ m{^/(adm|res)/}) {
4071: if ($imgsrc =~ m{^/res/}) {
4072: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4073: &Apache::lonnet::repcopy($local_name);
4074: }
4075: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4076: }
4077: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4078: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4079: return &Apache::lonnet::domain($domain,'description');
1.59 www 4080: } else {
1.60 matthew 4081: return '';
1.59 www 4082: }
4083: }
1.63 www 4084: ##############################################
4085:
4086: =pod
4087:
1.112 bowersj2 4088: =item * &designparm()
1.63 www 4089:
4090: Inputs: $which parameter; $domain (usually will be undef)
4091:
4092: Returns: value of designparamter $which
4093:
4094: =cut
1.112 bowersj2 4095:
1.397 albertel 4096:
1.400 albertel 4097: ##############################################
1.397 albertel 4098: sub designparm {
4099: my ($which,$domain)=@_;
1.258 albertel 4100: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4101: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4102: return '#000000';
4103: }
1.635 raeburn 4104: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4105: return '#FFFFFF';
4106: }
4107: if ($which=~/\.tabbg$/) {
4108: return '#CCCCCC';
4109: }
4110: }
1.397 albertel 4111: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4112: return $env{'environment.color.'.$which};
1.96 www 4113: }
1.63 www 4114: $domain=&determinedomain($domain);
1.518 albertel 4115: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4116: my $output;
1.517 raeburn 4117: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4118: $output = $domdesign{$domain.'.'.$which};
1.63 www 4119: } else {
1.520 raeburn 4120: $output = $defaultdesign{$which};
4121: }
4122: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4123: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4124: if ($output =~ m{^/(adm|res)/}) {
4125: if ($output =~ m{^/res/}) {
4126: my $local_name = &Apache::lonnet::filelocation('',$output);
4127: &Apache::lonnet::repcopy($local_name);
4128: }
1.520 raeburn 4129: $output = &lonhttpdurl($output);
4130: }
1.63 www 4131: }
1.520 raeburn 4132: return $output;
1.63 www 4133: }
1.59 www 4134:
1.60 matthew 4135: ###############################################
4136: ###############################################
4137:
4138: =pod
4139:
1.112 bowersj2 4140: =back
4141:
1.549 albertel 4142: =head1 HTML Helpers
1.112 bowersj2 4143:
4144: =over 4
4145:
4146: =item * &bodytag()
1.60 matthew 4147:
4148: Returns a uniform header for LON-CAPA web pages.
4149:
4150: Inputs:
4151:
1.112 bowersj2 4152: =over 4
4153:
4154: =item * $title, A title to be displayed on the page.
4155:
4156: =item * $function, the current role (can be undef).
4157:
4158: =item * $addentries, extra parameters for the <body> tag.
4159:
4160: =item * $bodyonly, if defined, only return the <body> tag.
4161:
4162: =item * $domain, if defined, force a given domain.
4163:
4164: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4165: text interface only)
1.60 matthew 4166:
1.326 albertel 4167: =item * $customtitle, alternate text to use instead of $title
4168: in the title box that appears, this text
4169: is not auto translated like the $title is
1.309 albertel 4170:
4171: =item * $notopbar, if true, keep the 'what is this' info but remove the
4172: navigational links
1.317 albertel 4173:
1.338 albertel 4174: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4175:
4176: =item * $notitle, if true keep the nav controls, but remove the title bar
4177:
1.361 albertel 4178: =item * $no_inline_link, if true and in remote mode, don't show the
4179: 'Switch To Inline Menu' link
4180:
1.460 albertel 4181: =item * $args, optional argument valid values are
4182: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4183: inherit_jsmath -> when creating popup window in a page,
4184: should it have jsmath forced on by the
4185: current page
1.460 albertel 4186:
1.112 bowersj2 4187: =back
4188:
1.60 matthew 4189: Returns: A uniform header for LON-CAPA web pages.
4190: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4191: If $bodyonly is undef or zero, an html string containing a <body> tag and
4192: other decorations will be returned.
4193:
4194: =cut
4195:
1.54 www 4196: sub bodytag {
1.309 albertel 4197: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4198: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4199:
1.460 albertel 4200: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4201:
1.183 matthew 4202: $function = &get_users_function() if (!$function);
1.339 albertel 4203: my $img = &designparm($function.'.img',$domain);
4204: my $font = &designparm($function.'.font',$domain);
4205: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4206:
4207: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4208: 'bgcolor' => $pgbg,
1.339 albertel 4209: 'text' => $font,
4210: 'alink' => &designparm($function.'.alink',$domain),
4211: 'vlink' => &designparm($function.'.vlink',$domain),
4212: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4213: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4214:
1.63 www 4215: # role and realm
1.378 raeburn 4216: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4217: if ($role eq 'ca') {
1.479 albertel 4218: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4219: $realm = &plainname($rname,$rdom);
1.378 raeburn 4220: }
1.55 www 4221: # realm
1.258 albertel 4222: if ($env{'request.course.id'}) {
1.378 raeburn 4223: if ($env{'request.role'} !~ /^cr/) {
4224: $role = &Apache::lonnet::plaintext($role,&course_type());
4225: }
1.359 albertel 4226: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4227: } else {
4228: $role = &Apache::lonnet::plaintext($role);
1.54 www 4229: }
1.433 albertel 4230:
1.359 albertel 4231: if (!$realm) { $realm=' '; }
1.55 www 4232: # Set messages
1.60 matthew 4233: my $messages=&domainlogo($domain);
1.330 albertel 4234:
1.438 albertel 4235: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4236:
1.101 www 4237: # construct main body tag
1.359 albertel 4238: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4239: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4240:
1.530 albertel 4241: if ($bodyonly) {
1.60 matthew 4242: return $bodytag;
1.258 albertel 4243: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4244: # Accessibility
1.224 raeburn 4245:
1.337 albertel 4246: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4247: if (!$notitle) {
1.337 albertel 4248: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4249: }
4250: return $bodytag;
1.359 albertel 4251: }
4252:
1.410 albertel 4253: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4254: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4255: undef($role);
1.434 albertel 4256: } else {
4257: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4258: }
1.359 albertel 4259:
4260: my $roleinfo=(<<ENDROLE);
4261: <td class="LC_title_bar_who">
4262: <div class="LC_title_bar_name">
1.410 albertel 4263: $name
1.361 albertel 4264:
1.359 albertel 4265: </div>
4266: <div class="LC_title_bar_role">
1.361 albertel 4267: $role
1.359 albertel 4268: </div>
4269: <div class="LC_title_bar_realm">
1.361 albertel 4270: $realm
1.359 albertel 4271: </div>
1.206 albertel 4272: </td>
4273: ENDROLE
1.235 raeburn 4274:
1.762 bisitz 4275: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4276: if ($customtitle) {
4277: $titleinfo = $customtitle;
4278: }
4279: #
4280: # Extra info if you are the DC
4281: my $dc_info = '';
4282: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4283: $env{'course.'.$env{'request.course.id'}.
4284: '.domain'}.'/'})) {
4285: my $cid = $env{'request.course.id'};
4286: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4287: $dc_info =~ s/\s+$//;
1.359 albertel 4288: $dc_info = '('.$dc_info.')';
4289: }
4290:
1.644 www 4291: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4292: # No Remote
1.258 albertel 4293: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4294: $forcereg=1;
4295: }
4296:
4297: if (!$customtitle && $env{'request.state'} eq 'construct') {
4298: # this is for resources; directories have customtitle, and crumbs
4299: # and select recent are created in lonpubdir.pm
1.229 albertel 4300: my ($uname,$thisdisfn)=
1.258 albertel 4301: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4302: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4303: $formaction=~s/\/+/\//g;
4304:
1.359 albertel 4305: my $parentpath = '';
4306: my $lastitem = '';
4307: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4308: $parentpath = $1;
4309: $lastitem = $2;
4310: } else {
4311: $lastitem = $thisdisfn;
4312: }
4313: $titleinfo =
1.640 bisitz 4314: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4315: .'<b>'.&mt('Construction Space').'</b>: '
4316: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4317: .'" target="_top"><tt><b>'
1.705 tempelho 4318: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4319: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4320: .'</form>'
4321: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4322: }
1.359 albertel 4323:
1.337 albertel 4324: my $titletable;
1.338 albertel 4325: if (!$notitle) {
1.337 albertel 4326: $titletable =
1.359 albertel 4327: '<table id="LC_title_bar">'.
4328: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4329: '</tr></table>';
1.337 albertel 4330: }
1.359 albertel 4331: if ($notopbar) {
4332: $bodytag .= $titletable;
4333: } else {
4334: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4335: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4336: $titletable);
1.272 raeburn 4337: } else {
1.336 albertel 4338: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4339: $titletable;
1.272 raeburn 4340: }
1.235 raeburn 4341: }
4342: return $bodytag;
1.94 www 4343: }
1.95 www 4344:
1.93 www 4345: #
1.95 www 4346: # Top frame rendering, Remote is up
1.93 www 4347: #
1.359 albertel 4348:
1.517 raeburn 4349: my $imgsrc = $img;
4350: if ($img =~ /^\/adm/) {
1.575 albertel 4351: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4352: }
4353: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4354:
1.305 www 4355: # Explicit link to get inline menu
1.361 albertel 4356: my $menu= ($no_inline_link?''
4357: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4358: #
1.338 albertel 4359: if ($notitle) {
1.337 albertel 4360: return $bodytag;
4361: }
1.94 www 4362: return(<<ENDBODY);
1.60 matthew 4363: $bodytag
1.359 albertel 4364: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4365: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4366: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4367: </tr>
1.359 albertel 4368: <tr><td>$titleinfo $dc_info $menu</td>
4369: $roleinfo
1.368 albertel 4370: </tr>
1.356 albertel 4371: </table>
1.54 www 4372: ENDBODY
1.182 matthew 4373: }
4374:
1.330 albertel 4375: sub make_attr_string {
4376: my ($register,$attr_ref) = @_;
4377:
4378: if ($attr_ref && !ref($attr_ref)) {
4379: die("addentries Must be a hash ref ".
4380: join(':',caller(1))." ".
4381: join(':',caller(0))." ");
4382: }
4383:
4384: if ($register) {
1.339 albertel 4385: my ($on_load,$on_unload);
4386: foreach my $key (keys(%{$attr_ref})) {
4387: if (lc($key) eq 'onload') {
4388: $on_load.=$attr_ref->{$key}.';';
4389: delete($attr_ref->{$key});
4390:
4391: } elsif (lc($key) eq 'onunload') {
4392: $on_unload.=$attr_ref->{$key}.';';
4393: delete($attr_ref->{$key});
4394: }
4395: }
4396: $attr_ref->{'onload'} =
4397: &Apache::lonmenu::loadevents(). $on_load;
4398: $attr_ref->{'onunload'}=
4399: &Apache::lonmenu::unloadevents().$on_unload;
4400: }
4401:
4402: # Accessibility font enhance
4403: if ($env{'browser.fontenhance'} eq 'on') {
4404: my $style;
4405: foreach my $key (keys(%{$attr_ref})) {
4406: if (lc($key) eq 'style') {
4407: $style.=$attr_ref->{$key}.';';
4408: delete($attr_ref->{$key});
4409: }
4410: }
4411: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4412: }
1.339 albertel 4413:
4414: if ($env{'browser.blackwhite'} eq 'on') {
4415: delete($attr_ref->{'font'});
4416: delete($attr_ref->{'link'});
4417: delete($attr_ref->{'alink'});
4418: delete($attr_ref->{'vlink'});
4419: delete($attr_ref->{'bgcolor'});
4420: delete($attr_ref->{'background'});
4421: }
4422:
1.330 albertel 4423: my $attr_string;
4424: foreach my $attr (keys(%$attr_ref)) {
4425: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4426: }
4427: return $attr_string;
4428: }
4429:
4430:
1.182 matthew 4431: ###############################################
1.251 albertel 4432: ###############################################
4433:
4434: =pod
4435:
4436: =item * &endbodytag()
4437:
4438: Returns a uniform footer for LON-CAPA web pages.
4439:
1.635 raeburn 4440: Inputs: 1 - optional reference to an args hash
4441: If in the hash, key for noredirectlink has a value which evaluates to true,
4442: a 'Continue' link is not displayed if the page contains an
4443: internal redirect in the <head></head> section,
4444: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4445:
4446: =cut
4447:
4448: sub endbodytag {
1.635 raeburn 4449: my ($args) = @_;
1.251 albertel 4450: my $endbodytag='</body>';
1.269 albertel 4451: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4452: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4453: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4454: $endbodytag=
4455: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4456: &mt('Continue').'</a>'.
4457: $endbodytag;
4458: }
1.315 albertel 4459: }
1.251 albertel 4460: return $endbodytag;
4461: }
4462:
1.352 albertel 4463: =pod
4464:
4465: =item * &standard_css()
4466:
4467: Returns a style sheet
4468:
4469: Inputs: (all optional)
4470: domain -> force to color decorate a page for a specific
4471: domain
4472: function -> force usage of a specific rolish color scheme
4473: bgcolor -> override the default page bgcolor
4474:
4475: =cut
4476:
1.343 albertel 4477: sub standard_css {
1.345 albertel 4478: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4479: $function = &get_users_function() if (!$function);
4480: my $img = &designparm($function.'.img', $domain);
4481: my $tabbg = &designparm($function.'.tabbg', $domain);
4482: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4483: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4484: my $pgbg_or_bgcolor =
4485: $bgcolor ||
1.352 albertel 4486: &designparm($function.'.pgbg', $domain);
1.382 albertel 4487: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4488: my $alink = &designparm($function.'.alink', $domain);
4489: my $vlink = &designparm($function.'.vlink', $domain);
4490: my $link = &designparm($function.'.link', $domain);
4491:
1.704 muellerd 4492: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4493: my $bgcol = &designparm('login.bgcol',$domain);
4494: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4495:
1.602 albertel 4496: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4497: my $mono = 'monospace';
1.352 albertel 4498: my $data_table_head = $tabbg;
4499: my $data_table_light = '#EEEEEE';
1.470 banghart 4500: my $data_table_dark = '#DDDDDD';
4501: my $data_table_darker = '#CCCCCC';
1.349 albertel 4502: my $data_table_highlight = '#FFFF00';
1.352 albertel 4503: my $mail_new = '#FFBB77';
4504: my $mail_new_hover = '#DD9955';
4505: my $mail_read = '#BBBB77';
4506: my $mail_read_hover = '#999944';
4507: my $mail_replied = '#AAAA88';
4508: my $mail_replied_hover = '#888855';
4509: my $mail_other = '#99BBBB';
4510: my $mail_other_hover = '#669999';
1.391 albertel 4511: my $table_header = '#DDDDDD';
1.489 raeburn 4512: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4513: my $lg_border_color = '#C8C8C8';
1.392 albertel 4514:
1.608 albertel 4515: my $border = ($env{'browser.type'} eq 'explorer' ||
4516: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4517: : '0px 3px 0px 4px';
1.448 albertel 4518:
1.523 albertel 4519:
1.343 albertel 4520: return <<END;
1.698 harmsja 4521: body{
4522: font-family: $sans;
4523: line-height:130%;
1.701 harmsja 4524: font-size:0.83em;
1.698 harmsja 4525: color:$font;
4526: }
1.701 harmsja 4527: a:link, a:visited { font-size:100%; }
1.698 harmsja 4528:
1.779 bisitz 4529: a:focus { color: red; background: yellow }
1.510 albertel 4530: table.thinborder,
4531: table.thinborder tr th {
4532: border-style: solid;
4533: border-width: 1px;
1.698 harmsja 4534: border-color: $lg_border_color;
1.510 albertel 4535: background: $tabbg;
4536: }
1.523 albertel 4537: table.thinborder tr td {
1.510 albertel 4538: border-style: solid;
1.698 harmsja 4539: border-width: 1px;
4540: border-color: $lg_border_color;
1.510 albertel 4541: }
1.426 albertel 4542:
1.343 albertel 4543: form, .inline { display: inline; }
1.721 harmsja 4544:
4545: .LC_right {text-align:right;}
4546: .LC_middle {vertical-align:middle;}
4547:
4548: /* just for tests */
1.754 droeschl 4549: .LC_400Box {width:400px; }
1.721 harmsja 4550: /* end */
4551:
1.778 bisitz 4552: .LC_filename {
4553: font-family: $mono;
4554: white-space:pre;
4555: }
4556:
4557: .LC_fileicon {
4558: border: none;
4559: height: 1.3em;
4560: vertical-align: text-bottom;
4561: margin-right: 0.3em;
4562: text-decoration:none;
4563: }
4564:
1.350 albertel 4565: .LC_error {
4566: color: red;
4567: font-size: larger;
4568: }
1.457 albertel 4569: .LC_warning,
4570: .LC_diff_removed {
1.733 bisitz 4571: color: red;
1.394 albertel 4572: }
1.532 albertel 4573:
4574: .LC_info,
1.457 albertel 4575: .LC_success,
4576: .LC_diff_added {
1.350 albertel 4577: color: green;
4578: }
1.543 albertel 4579: .LC_unknown {
4580: color: yellow;
4581: }
4582:
1.440 albertel 4583: .LC_icon {
1.771 droeschl 4584: border: none;
4585: }
4586:
1.539 albertel 4587: .LC_indexer_icon {
4588: border: 0px;
4589: height: 22px;
4590: }
1.543 albertel 4591: .LC_docs_spacer {
4592: width: 25px;
4593: height: 1px;
1.771 droeschl 4594: border: none;
1.543 albertel 4595: }
1.346 albertel 4596:
1.532 albertel 4597: .LC_internal_info {
1.735 bisitz 4598: color: #999999;
1.532 albertel 4599: }
4600:
1.458 albertel 4601: table.LC_pastsubmission {
4602: border: 1px solid black;
4603: margin: 2px;
4604: }
4605:
1.606 albertel 4606: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4607: width: 100%;
4608: background: $pgbg;
1.392 albertel 4609: border: 2px;
1.402 albertel 4610: border-collapse: separate;
1.403 albertel 4611: padding: 0px;
1.345 albertel 4612: }
1.392 albertel 4613:
1.779 bisitz 4614: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4615: table#LC_title_bar.LC_with_remote {
1.359 albertel 4616: width: 100%;
1.392 albertel 4617: border-color: $pgbg;
4618: border-style: solid;
4619: border-width: $border;
4620:
1.379 albertel 4621: background: $pgbg;
4622: font-family: $sans;
1.392 albertel 4623: border-collapse: collapse;
1.403 albertel 4624: padding: 0px;
1.359 albertel 4625: }
1.409 albertel 4626: table.LC_docs_path {
4627: width: 100%;
4628: border: 0;
4629: background: $pgbg;
4630: font-family: $sans;
4631: border-collapse: collapse;
4632: padding: 0px;
4633: }
4634:
1.359 albertel 4635: table#LC_title_bar td {
4636: background: $tabbg;
4637: }
1.773 ehlerst 4638: table#LC_title_bar .LC_title_bar_who {
1.359 albertel 4639: background: $tabbg;
4640: color: $font;
1.427 albertel 4641: font: small $sans;
1.359 albertel 4642: text-align: right;
1.773 ehlerst 4643: margin: 0px;
4644: }
4645: table#LC_title_bar .LC_title_bar_name {
4646: margin: 0px;
4647: }
4648: table#LC_title_bar .LC_title_bar_role {
4649: margin: 0px;
4650: }
1.775 bisitz 4651: table#LC_title_bar .LC_title_bar_realm {
1.773 ehlerst 4652: margin: 0px;
1.359 albertel 4653: }
1.469 banghart 4654: span.LC_metadata {
4655: font-family: $sans;
4656: }
1.359 albertel 4657: table#LC_title_bar td.LC_title_bar_domain_logo {
4658: background: $sidebg;
4659: text-align: right;
1.368 albertel 4660: padding: 0px;
4661: }
4662: table#LC_title_bar td.LC_title_bar_role_logo {
4663: background: $sidebg;
4664: padding: 0px;
1.359 albertel 4665: }
4666:
1.706 harmsja 4667: table#LC_menubuttons img{
1.346 albertel 4668: border: 0px;
4669: }
1.345 albertel 4670: table#LC_top_nav td {
4671: background: $tabbg;
1.392 albertel 4672: border: 0px;
1.407 albertel 4673: font-size: small;
1.706 harmsja 4674: vertical-align:top;
4675: padding:2px 5px 2px 5px;
1.345 albertel 4676: }
4677: table#LC_top_nav td a, div#LC_top_nav a {
4678: color: $font;
4679: font-family: $sans;
4680: }
1.364 albertel 4681: table#LC_top_nav td.LC_top_nav_logo {
4682: background: $tabbg;
1.432 albertel 4683: text-align: left;
1.408 albertel 4684: white-space: nowrap;
1.432 albertel 4685: width: 31px;
1.408 albertel 4686: }
4687: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4688: border: 0px;
1.408 albertel 4689: vertical-align: bottom;
1.364 albertel 4690: }
1.777 tempelho 4691: table#LC_top_nav td.LC_top_nav_exit,
1.779 bisitz 4692: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4693: width: 2.0em;
4694: }
1.442 albertel 4695: table#LC_top_nav td.LC_top_nav_login {
4696: width: 4.0em;
4697: text-align: center;
4698: }
1.409 albertel 4699: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4700: background: $tabbg;
4701: color: $font;
4702: font-family: $sans;
1.358 albertel 4703: font-size: smaller;
1.357 albertel 4704: }
1.777 tempelho 4705: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4706: table.LC_docs_path td.LC_docs_path_component {
1.779 bisitz 4707: background: $tabbg;
1.777 tempelho 4708: color: $font;
4709: font-family: $sans;
1.779 bisitz 4710: font-size: larger;
4711: text-align: right;
1.777 tempelho 4712: }
1.383 albertel 4713: td.LC_table_cell_checkbox {
4714: text-align: center;
4715: }
1.779 bisitz 4716: table#LC_mainmenu td.LC_mainmenu_column {
4717: vertical-align: top;
1.777 tempelho 4718: }
1.522 albertel 4719:
1.705 tempelho 4720: .LC_fontsize_small
4721: {
4722: font-size: 70%;
4723: }
4724:
4725: .LC_fontsize_medium
4726: {
4727: font-size: 85%;
4728: }
4729:
4730: .LC_fontsize_large
4731: {
4732: font-size: 120%;
4733: }
4734:
1.346 albertel 4735: .LC_menubuttons_inline_text {
4736: color: $font;
4737: font-family: $sans;
1.698 harmsja 4738: font-size: 90%;
1.701 harmsja 4739: padding-left:3px;
1.346 albertel 4740: }
4741:
1.526 www 4742: .LC_menubuttons_link {
4743: text-decoration: none;
4744: }
1.698 harmsja 4745: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4746: .LC_menubuttons_category {
1.521 www 4747: color: $font;
1.526 www 4748: background: $pgbg;
1.521 www 4749: font-family: $sans;
4750: font-size: larger;
4751: font-weight: bold;
4752: }
4753:
1.346 albertel 4754: td.LC_menubuttons_text {
1.779 bisitz 4755: color: $font;
1.346 albertel 4756: }
1.706 harmsja 4757:
4758:
1.526 www 4759:
1.346 albertel 4760: .LC_current_location {
4761: font-family: $sans;
4762: background: $tabbg;
4763: }
4764: .LC_new_mail {
4765: font-family: $sans;
1.634 www 4766: background: $tabbg;
1.346 albertel 4767: font-weight: bold;
4768: }
1.347 albertel 4769:
1.526 www 4770:
1.527 www 4771: .LC_dropadd_labeltext {
4772: font-family: $sans;
4773: text-align: right;
4774: }
4775:
4776: .LC_preferences_labeltext {
4777: font-family: $sans;
4778: text-align: right;
4779: }
4780:
1.666 raeburn 4781: .LC_roleslog_note {
1.701 harmsja 4782: font-size: small;
1.666 raeburn 4783: }
4784:
1.715 raeburn 4785: .LC_mail_functions {
4786: font-weight: bold;
4787: }
4788:
1.440 albertel 4789: table.LC_aboutme_port {
4790: border: 0px;
4791: border-collapse: collapse;
4792: border-spacing: 0px;
4793: }
1.349 albertel 4794: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4795: border: 1px solid #000000;
1.402 albertel 4796: border-collapse: separate;
1.426 albertel 4797: border-spacing: 1px;
1.610 albertel 4798: background: $pgbg;
1.347 albertel 4799: }
1.422 albertel 4800: .LC_data_table_dense {
4801: font-size: small;
4802: }
1.507 raeburn 4803: table.LC_nested_outer {
4804: border: 1px solid #000000;
1.589 raeburn 4805: border-collapse: collapse;
1.507 raeburn 4806: border-spacing: 0px;
4807: width: 100%;
4808: }
4809: table.LC_nested {
4810: border: 0px;
1.589 raeburn 4811: border-collapse: collapse;
1.507 raeburn 4812: border-spacing: 0px;
4813: width: 100%;
4814: }
1.523 albertel 4815: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4816: table.LC_prior_tries tr th {
1.349 albertel 4817: font-weight: bold;
4818: background-color: $data_table_head;
1.701 harmsja 4819: font-size:90%;
1.347 albertel 4820: }
1.711 raeburn 4821: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4822: background-color: #CCCCCC;
1.711 raeburn 4823: font-weight: bold;
4824: text-align: left;
4825: }
1.779 bisitz 4826: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4827: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4828: table.LC_aboutme_port tr td {
1.349 albertel 4829: background-color: $data_table_light;
1.425 albertel 4830: padding: 2px;
1.347 albertel 4831: }
1.610 albertel 4832: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4833: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4834: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4835: background-color: $data_table_dark;
1.709 bisitz 4836: padding: 2px;
1.347 albertel 4837: }
1.425 albertel 4838: table.LC_data_table tr.LC_data_table_highlight td {
4839: background-color: $data_table_darker;
4840: }
1.639 raeburn 4841: table.LC_data_table tr td.LC_leftcol_header {
4842: background-color: $data_table_head;
4843: font-weight: bold;
4844: }
1.451 albertel 4845: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4846: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4847: background-color: #FFFFFF;
1.421 albertel 4848: font-weight: bold;
4849: font-style: italic;
4850: text-align: center;
4851: padding: 8px;
1.347 albertel 4852: }
1.507 raeburn 4853: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4854: padding: 4ex
4855: }
1.507 raeburn 4856: table.LC_nested_outer tr th {
4857: font-weight: bold;
4858: background-color: $data_table_head;
1.701 harmsja 4859: font-size: small;
1.507 raeburn 4860: border-bottom: 1px solid #000000;
4861: }
4862: table.LC_nested_outer tr td.LC_subheader {
4863: background-color: $data_table_head;
4864: font-weight: bold;
4865: font-size: small;
4866: border-bottom: 1px solid #000000;
4867: text-align: right;
1.451 albertel 4868: }
1.507 raeburn 4869: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4870: background-color: #CCCCCC;
1.451 albertel 4871: font-weight: bold;
4872: font-size: small;
1.507 raeburn 4873: text-align: center;
4874: }
1.589 raeburn 4875: table.LC_nested tr.LC_info_row td.LC_left_item,
4876: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4877: text-align: left;
1.451 albertel 4878: }
1.507 raeburn 4879: table.LC_nested td {
1.735 bisitz 4880: background-color: #FFFFFF;
1.451 albertel 4881: font-size: small;
1.507 raeburn 4882: }
4883: table.LC_nested_outer tr th.LC_right_item,
4884: table.LC_nested tr.LC_info_row td.LC_right_item,
4885: table.LC_nested tr.LC_odd_row td.LC_right_item,
4886: table.LC_nested tr td.LC_right_item {
1.451 albertel 4887: text-align: right;
4888: }
4889:
1.507 raeburn 4890: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4891: background-color: #EEEEEE;
1.451 albertel 4892: }
4893:
1.473 raeburn 4894: table.LC_createuser {
4895: }
4896:
4897: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4898: font-size: small;
1.473 raeburn 4899: }
4900:
4901: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 4902: background-color: #CCCCCC;
1.473 raeburn 4903: font-weight: bold;
4904: text-align: center;
4905: }
4906:
1.349 albertel 4907: table.LC_calendar {
4908: border: 1px solid #000000;
4909: border-collapse: collapse;
4910: }
4911: table.LC_calendar_pickdate {
4912: font-size: xx-small;
4913: }
4914: table.LC_calendar tr td {
4915: border: 1px solid #000000;
4916: vertical-align: top;
4917: }
4918: table.LC_calendar tr td.LC_calendar_day_empty {
4919: background-color: $data_table_dark;
4920: }
1.779 bisitz 4921: table.LC_calendar tr td.LC_calendar_day_current {
4922: background-color: $data_table_highlight;
1.777 tempelho 4923: }
1.349 albertel 4924: table.LC_mail_list tr.LC_mail_new {
4925: background-color: $mail_new;
4926: }
4927: table.LC_mail_list tr.LC_mail_new:hover {
4928: background-color: $mail_new_hover;
4929: }
1.777 tempelho 4930: table.LC_mail_list tr.LC_mail_even{
4931: }
4932: table.LC_mail_list tr.LC_mail_odd{
4933: }
1.349 albertel 4934: table.LC_mail_list tr.LC_mail_read {
4935: background-color: $mail_read;
4936: }
4937: table.LC_mail_list tr.LC_mail_read:hover {
4938: background-color: $mail_read_hover;
4939: }
4940: table.LC_mail_list tr.LC_mail_replied {
4941: background-color: $mail_replied;
4942: }
4943: table.LC_mail_list tr.LC_mail_replied:hover {
4944: background-color: $mail_replied_hover;
4945: }
4946: table.LC_mail_list tr.LC_mail_other {
4947: background-color: $mail_other;
4948: }
4949: table.LC_mail_list tr.LC_mail_other:hover {
4950: background-color: $mail_other_hover;
4951: }
1.494 raeburn 4952:
1.777 tempelho 4953: table.LC_data_table tr > td.LC_browser_file,
4954: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4955: background: #CCFF88;
4956: }
1.777 tempelho 4957: table.LC_data_table tr > td.LC_browser_file_locked,
4958: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4959: background: #FFAA99;
1.387 albertel 4960: }
1.777 tempelho 4961: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779 bisitz 4962: background: #AAAAAA;
4963: }
1.777 tempelho 4964: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 4965: table.LC_data_table tr > td.LC_browser_file_metamodified {
4966: background: #FFFF77;
1.777 tempelho 4967: }
1.696 bisitz 4968: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4969: background: #CCCCFF;
1.387 albertel 4970: }
1.696 bisitz 4971:
1.707 bisitz 4972: table.LC_data_table tr > td.LC_roles_is {
4973: /* background: #77FF77; */
4974: }
4975: table.LC_data_table tr > td.LC_roles_future {
4976: background: #FFFF77;
4977: }
4978: table.LC_data_table tr > td.LC_roles_will {
4979: background: #FFAA77;
4980: }
4981: table.LC_data_table tr > td.LC_roles_expired {
4982: background: #FF7777;
4983: }
4984: table.LC_data_table tr > td.LC_roles_will_not {
4985: background: #AAFF77;
4986: }
4987: table.LC_data_table tr > td.LC_roles_selected {
4988: background: #11CC55;
4989: }
4990:
1.388 albertel 4991: span.LC_current_location {
1.701 harmsja 4992: font-size:larger;
1.388 albertel 4993: background: $pgbg;
4994: }
1.387 albertel 4995:
1.395 albertel 4996: span.LC_parm_menu_item {
4997: font-size: larger;
4998: font-family: $sans;
4999: }
5000: span.LC_parm_scope_all {
5001: color: red;
5002: }
5003: span.LC_parm_scope_folder {
5004: color: green;
5005: }
5006: span.LC_parm_scope_resource {
5007: color: orange;
5008: }
5009: span.LC_parm_part {
5010: color: blue;
5011: }
5012: span.LC_parm_folder, span.LC_parm_symb {
5013: font-size: x-small;
5014: font-family: $mono;
5015: color: #AAAAAA;
5016: }
5017:
1.396 albertel 5018: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
1.777 tempelho 5019: td.LC_parm_overview_parm_selectors,td.LC_parm_overview_restrictions {
1.396 albertel 5020: border: 1px solid black;
5021: border-collapse: collapse;
5022: }
5023: table.LC_parm_overview_restrictions td {
5024: border-width: 1px 4px 1px 4px;
5025: border-style: solid;
5026: border-color: $pgbg;
5027: text-align: center;
5028: }
5029: table.LC_parm_overview_restrictions th {
5030: background: $tabbg;
5031: border-width: 1px 4px 1px 4px;
5032: border-style: solid;
5033: border-color: $pgbg;
5034: }
1.398 albertel 5035: table#LC_helpmenu {
5036: border: 0px;
5037: height: 55px;
5038: border-spacing: 0px;
5039: }
5040:
5041: table#LC_helpmenu fieldset legend {
5042: font-size: larger;
5043: font-weight: bold;
5044: }
1.397 albertel 5045: table#LC_helpmenu_links {
5046: width: 100%;
5047: border: 1px solid black;
5048: background: $pgbg;
5049: padding: 0px;
5050: border-spacing: 1px;
5051: }
5052: table#LC_helpmenu_links tr td {
5053: padding: 1px;
5054: background: $tabbg;
1.399 albertel 5055: text-align: center;
5056: font-weight: bold;
1.397 albertel 5057: }
1.396 albertel 5058:
1.397 albertel 5059: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5060: table#LC_helpmenu_links a:active {
5061: text-decoration: none;
5062: color: $font;
5063: }
5064: table#LC_helpmenu_links a:hover {
5065: text-decoration: underline;
5066: color: $vlink;
5067: }
1.396 albertel 5068:
1.417 albertel 5069: .LC_chrt_popup_exists {
5070: border: 1px solid #339933;
5071: margin: -1px;
5072: }
5073: .LC_chrt_popup_up {
5074: border: 1px solid yellow;
5075: margin: -1px;
5076: }
5077: .LC_chrt_popup {
5078: border: 1px solid #8888FF;
5079: background: #CCCCFF;
5080: }
1.421 albertel 5081: table.LC_pick_box {
5082: border-collapse: separate;
5083: background: white;
5084: border: 1px solid black;
5085: border-spacing: 1px;
5086: }
5087: table.LC_pick_box td.LC_pick_box_title {
5088: background: $tabbg;
5089: font-weight: bold;
5090: text-align: right;
1.740 bisitz 5091: vertical-align: top;
1.421 albertel 5092: width: 184px;
5093: padding: 8px;
5094: }
1.645 raeburn 5095: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5096: background: $tabbg;
5097: font-weight: bold;
5098: text-align: right;
5099: width: 350px;
5100: padding: 8px;
5101: }
5102:
1.579 raeburn 5103: table.LC_pick_box td.LC_pick_box_value {
5104: text-align: left;
5105: padding: 8px;
5106: }
5107: table.LC_pick_box td.LC_pick_box_select {
5108: text-align: left;
5109: padding: 8px;
5110: }
1.424 albertel 5111: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5112: padding: 0px;
5113: height: 1px;
5114: background: black;
5115: }
5116: table.LC_pick_box td.LC_pick_box_submit {
5117: text-align: right;
5118: }
1.579 raeburn 5119: table.LC_pick_box td.LC_evenrow_value {
5120: text-align: left;
5121: padding: 8px;
5122: background-color: $data_table_light;
5123: }
5124: table.LC_pick_box td.LC_oddrow_value {
5125: text-align: left;
5126: padding: 8px;
5127: background-color: $data_table_light;
5128: }
5129: table.LC_helpform_receipt {
5130: width: 620px;
5131: border-collapse: separate;
5132: background: white;
5133: border: 1px solid black;
5134: border-spacing: 1px;
5135: }
5136: table.LC_helpform_receipt td.LC_pick_box_title {
5137: background: $tabbg;
5138: font-weight: bold;
5139: text-align: right;
5140: width: 184px;
5141: padding: 8px;
5142: }
5143: table.LC_helpform_receipt td.LC_evenrow_value {
5144: text-align: left;
5145: padding: 8px;
5146: background-color: $data_table_light;
5147: }
5148: table.LC_helpform_receipt td.LC_oddrow_value {
5149: text-align: left;
5150: padding: 8px;
5151: background-color: $data_table_light;
5152: }
5153: table.LC_helpform_receipt td.LC_pick_box_separator {
5154: padding: 0px;
5155: height: 1px;
5156: background: black;
5157: }
5158: span.LC_helpform_receipt_cat {
5159: font-weight: bold;
5160: }
1.424 albertel 5161: table.LC_group_priv_box {
5162: background: white;
5163: border: 1px solid black;
5164: border-spacing: 1px;
5165: }
5166: table.LC_group_priv_box td.LC_pick_box_title {
5167: background: $tabbg;
5168: font-weight: bold;
5169: text-align: right;
5170: width: 184px;
5171: }
5172: table.LC_group_priv_box td.LC_groups_fixed {
5173: background: $data_table_light;
5174: text-align: center;
5175: }
5176: table.LC_group_priv_box td.LC_groups_optional {
5177: background: $data_table_dark;
5178: text-align: center;
5179: }
5180: table.LC_group_priv_box td.LC_groups_functionality {
5181: background: $data_table_darker;
5182: text-align: center;
5183: font-weight: bold;
5184: }
5185: table.LC_group_priv td {
5186: text-align: left;
5187: padding: 0px;
5188: }
5189:
1.421 albertel 5190: table.LC_notify_front_page {
5191: background: white;
5192: border: 1px solid black;
5193: padding: 8px;
5194: }
5195: table.LC_notify_front_page td {
5196: padding: 8px;
5197: }
1.424 albertel 5198: .LC_navbuttons {
5199: margin: 2ex 0ex 2ex 0ex;
5200: }
1.423 albertel 5201: .LC_topic_bar {
5202: font-family: $sans;
5203: font-weight: bold;
5204: width: 100%;
5205: background: $tabbg;
5206: vertical-align: middle;
5207: margin: 2ex 0ex 2ex 0ex;
5208: }
5209: .LC_topic_bar span {
5210: vertical-align: middle;
5211: }
5212: .LC_topic_bar img {
5213: vertical-align: bottom;
5214: }
5215: table.LC_course_group_status {
5216: margin: 20px;
5217: }
5218: table.LC_status_selector td {
5219: vertical-align: top;
5220: text-align: center;
1.424 albertel 5221: padding: 4px;
5222: }
5223: table.LC_descriptive_input td.LC_description {
5224: vertical-align: top;
5225: text-align: right;
5226: font-weight: bold;
1.423 albertel 5227: }
1.599 albertel 5228: div.LC_feedback_link {
1.616 albertel 5229: clear: both;
1.599 albertel 5230: background: white;
1.779 bisitz 5231: width: 100%;
1.489 raeburn 5232: }
5233: span.LC_feedback_link {
1.599 albertel 5234: background: $feedback_link_bg;
5235: font-size: larger;
5236: }
5237: span.LC_message_link {
5238: background: $feedback_link_bg;
5239: font-size: larger;
5240: position: absolute;
5241: right: 1em;
1.489 raeburn 5242: }
1.421 albertel 5243:
1.515 albertel 5244: table.LC_prior_tries {
1.524 albertel 5245: border: 1px solid #000000;
5246: border-collapse: separate;
5247: border-spacing: 1px;
1.515 albertel 5248: }
1.523 albertel 5249:
1.515 albertel 5250: table.LC_prior_tries td {
1.524 albertel 5251: padding: 2px;
1.515 albertel 5252: }
1.523 albertel 5253:
5254: .LC_answer_correct {
5255: background: #AAFFAA;
5256: color: black;
5257: }
5258: .LC_answer_charged_try {
5259: background: #FFAAAA ! important;
5260: color: black;
5261: }
1.779 bisitz 5262: .LC_answer_not_charged_try,
1.523 albertel 5263: .LC_answer_no_grade,
5264: .LC_answer_late {
5265: background: #FFFFAA;
5266: color: black;
5267: }
5268: .LC_answer_previous {
5269: background: #AAAAFF;
5270: color: black;
5271: }
1.779 bisitz 5272: .LC_answer_no_message {
1.777 tempelho 5273: background: #FFFFFF;
5274: color: black;
1.779 bisitz 5275: }
5276: .LC_answer_unknown {
5277: background: orange;
5278: color: black;
1.777 tempelho 5279: }
1.529 albertel 5280: span.LC_prior_numerical,
5281: span.LC_prior_string,
5282: span.LC_prior_custom,
5283: span.LC_prior_reaction,
5284: span.LC_prior_math {
1.523 albertel 5285: font-family: monospace;
5286: white-space: pre;
5287: }
5288:
1.525 albertel 5289: span.LC_prior_string {
5290: font-family: monospace;
5291: white-space: pre;
5292: }
5293:
1.523 albertel 5294: table.LC_prior_option {
5295: width: 100%;
5296: border-collapse: collapse;
5297: }
1.528 albertel 5298: table.LC_prior_rank, table.LC_prior_match {
5299: border-collapse: collapse;
5300: }
5301: table.LC_prior_option tr td,
5302: table.LC_prior_rank tr td,
5303: table.LC_prior_match tr td {
1.524 albertel 5304: border: 1px solid #000000;
1.515 albertel 5305: }
5306:
1.770 droeschl 5307: td.LC_nobreak,
1.519 raeburn 5308: span.LC_nobreak {
1.544 albertel 5309: white-space: nowrap;
1.519 raeburn 5310: }
5311:
1.576 raeburn 5312: span.LC_cusr_emph {
5313: font-style: italic;
5314: }
5315:
1.633 raeburn 5316: span.LC_cusr_subheading {
5317: font-weight: normal;
5318: font-size: 85%;
5319: }
5320:
1.545 albertel 5321: table.LC_docs_documents {
5322: background: #BBBBBB;
1.547 albertel 5323: border-width: 0px;
1.545 albertel 5324: border-collapse: collapse;
5325: }
1.777 tempelho 5326: table.LC_docs_documents td.LC_docs_document {
1.779 bisitz 5327: border: 2px solid black;
5328: padding: 4px;
1.777 tempelho 5329: }
1.545 albertel 5330: .LC_docs_entry_move {
5331: border: 0px;
5332: border-collapse: collapse;
1.544 albertel 5333: }
5334:
1.545 albertel 5335: .LC_docs_entry_move td {
5336: border: 2px solid #BBBBBB;
5337: background: #DDDDDD;
5338: }
5339:
5340: .LC_docs_editor td.LC_docs_entry_commands {
5341: background: #DDDDDD;
5342: font-size: x-small;
5343: }
1.544 albertel 5344: .LC_docs_copy {
1.545 albertel 5345: color: #000099;
1.544 albertel 5346: }
5347: .LC_docs_cut {
1.545 albertel 5348: color: #550044;
1.544 albertel 5349: }
5350: .LC_docs_rename {
1.545 albertel 5351: color: #009900;
1.544 albertel 5352: }
5353: .LC_docs_remove {
1.545 albertel 5354: color: #990000;
5355: }
5356:
1.547 albertel 5357: .LC_docs_reinit_warn,
5358: .LC_docs_ext_edit {
5359: font-size: x-small;
5360: }
5361:
1.545 albertel 5362: .LC_docs_editor td.LC_docs_entry_title,
5363: .LC_docs_editor td.LC_docs_entry_icon {
5364: background: #FFFFBB;
5365: }
5366: .LC_docs_editor td.LC_docs_entry_parameter {
5367: background: #BBBBFF;
5368: font-size: x-small;
5369: white-space: nowrap;
5370: }
5371:
5372: table.LC_docs_adddocs td,
5373: table.LC_docs_adddocs th {
5374: border: 1px solid #BBBBBB;
5375: padding: 4px;
5376: background: #DDDDDD;
1.543 albertel 5377: }
5378:
1.584 albertel 5379: table.LC_sty_begin {
5380: background: #BBFFBB;
5381: }
5382: table.LC_sty_end {
5383: background: #FFBBBB;
5384: }
5385:
1.589 raeburn 5386: table.LC_double_column {
5387: border-width: 0px;
5388: border-collapse: collapse;
5389: width: 100%;
5390: padding: 2px;
5391: }
5392:
5393: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5394: top: 2px;
1.589 raeburn 5395: left: 2px;
5396: width: 47%;
5397: vertical-align: top;
5398: }
5399:
5400: table.LC_double_column tr td.LC_right_col {
5401: top: 2px;
1.779 bisitz 5402: right: 2px;
1.589 raeburn 5403: width: 47%;
5404: vertical-align: top;
5405: }
5406:
1.594 raeburn 5407: span.LC_role_level {
5408: font-weight: bold;
5409: }
5410:
1.591 raeburn 5411: div.LC_left_float {
5412: float: left;
5413: padding-right: 5%;
1.597 albertel 5414: padding-bottom: 4px;
1.591 raeburn 5415: }
5416:
5417: div.LC_clear_float_header {
1.597 albertel 5418: padding-bottom: 2px;
1.591 raeburn 5419: }
5420:
5421: div.LC_clear_float_footer {
1.597 albertel 5422: padding-top: 10px;
1.591 raeburn 5423: clear: both;
5424: }
5425:
1.597 albertel 5426:
5427: div.LC_grade_show_user {
5428: margin-top: 20px;
5429: border: 1px solid black;
5430: }
5431: div.LC_grade_user_name {
5432: background: #DDDDEE;
5433: border-bottom: 1px solid black;
1.705 tempelho 5434: font-weight: bold;
5435: font-size: large;
1.597 albertel 5436: }
5437: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5438: background: #DDEEDD;
5439: }
5440:
5441: div.LC_grade_show_problem,
5442: div.LC_grade_submissions,
5443: div.LC_grade_message_center,
5444: div.LC_grade_info_links,
5445: div.LC_grade_assign {
5446: margin: 5px;
5447: width: 99%;
5448: background: #FFFFFF;
5449: }
5450: div.LC_grade_show_problem_header,
5451: div.LC_grade_submissions_header,
5452: div.LC_grade_message_center_header,
5453: div.LC_grade_assign_header {
1.705 tempelho 5454: font-weight: bold;
5455: font-size: large;
1.597 albertel 5456: }
5457: div.LC_grade_show_problem_problem,
5458: div.LC_grade_submissions_body,
5459: div.LC_grade_message_center_body,
5460: div.LC_grade_assign_body {
5461: border: 1px solid black;
5462: width: 99%;
5463: background: #FFFFFF;
5464: }
1.598 albertel 5465: span.LC_grade_check_note {
1.705 tempelho 5466: font-weight: normal;
5467: font-size: medium;
1.598 albertel 5468: display: inline;
5469: position: absolute;
5470: right: 1em;
5471: }
1.597 albertel 5472:
1.613 albertel 5473: table.LC_scantron_action {
5474: width: 100%;
5475: }
5476: table.LC_scantron_action tr th {
1.698 harmsja 5477: font-weight:bold;
5478: font-style:normal;
1.613 albertel 5479: }
1.779 bisitz 5480: .LC_edit_problem_header,
1.614 albertel 5481: div.LC_edit_problem_footer {
1.705 tempelho 5482: font-weight: normal;
5483: font-size: medium;
1.602 albertel 5484: margin: 2px;
1.600 albertel 5485: }
5486: div.LC_edit_problem_header,
1.602 albertel 5487: div.LC_edit_problem_header div,
1.614 albertel 5488: div.LC_edit_problem_footer,
5489: div.LC_edit_problem_footer div,
1.602 albertel 5490: div.LC_edit_problem_editxml_header,
5491: div.LC_edit_problem_editxml_header div {
1.600 albertel 5492: margin-top: 5px;
5493: }
1.602 albertel 5494: div.LC_edit_problem_header_edit_row {
5495: background: $tabbg;
5496: padding: 3px;
5497: margin-bottom: 5px;
5498: }
1.600 albertel 5499: div.LC_edit_problem_header_title {
1.705 tempelho 5500: font-weight: bold;
5501: font-size: larger;
1.602 albertel 5502: background: $tabbg;
5503: padding: 3px;
5504: }
5505: table.LC_edit_problem_header_title {
1.705 tempelho 5506: font-size: larger;
5507: font-weight: bold;
1.602 albertel 5508: width: 100%;
5509: border-color: $pgbg;
5510: border-style: solid;
5511: border-width: $border;
5512:
1.600 albertel 5513: background: $tabbg;
1.602 albertel 5514: border-collapse: collapse;
5515: padding: 0px
5516: }
5517:
5518: div.LC_edit_problem_discards {
5519: float: left;
5520: padding-bottom: 5px;
5521: }
5522: div.LC_edit_problem_saves {
5523: float: right;
5524: padding-bottom: 5px;
1.600 albertel 5525: }
5526: hr.LC_edit_problem_divide {
1.602 albertel 5527: clear: both;
1.600 albertel 5528: color: $tabbg;
5529: background-color: $tabbg;
5530: height: 3px;
5531: border: 0px;
5532: }
1.679 riegler 5533: img.stift{
1.678 riegler 5534: border-width:0;
1.679 riegler 5535: vertical-align:middle;
1.677 riegler 5536: }
1.680 riegler 5537:
1.681 riegler 5538: table#LC_mainmenu{
5539: margin-top:10px;
5540: width:80%;
5541:
5542: }
5543:
1.680 riegler 5544: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5545: vertical-align: top;
5546: width: 45%;
5547: }
1.779 bisitz 5548: .LC_mainmenu_fieldset_category {
5549: color: $font;
5550: background: $pgbg;
5551: font-family: $sans;
5552: font-size: small;
5553: font-weight: bold;
1.777 tempelho 5554: }
1.716 raeburn 5555: div.LC_createcourse {
5556: margin: 10px 10px 10px 10px;
5557: }
5558:
1.693 droeschl 5559: /* ---- Remove when done ----
5560: # The following styles is part of the redesign of LON-CAPA and are
5561: # subject to change during this project.
5562: # Don't rely on their current functionality as they might be
5563: # changed or removed.
5564: # --------------------------*/
5565:
1.698 harmsja 5566: a:hover,
1.721 harmsja 5567: ol.LC_smallMenu a:hover,
5568: ol#LC_MenuBreadcrumbs a:hover,
5569: ol#LC_PathBreadcrumbs a:hover,
5570: ul#LC_TabMainMenuContent a:hover,
5571: .LC_FormSectionClearButton input:hover
5572: ul.LC_TabContent li:hover a{
1.698 harmsja 5573: color:#BF2317;
5574: text-decoration:none;
1.693 droeschl 5575: }
5576:
1.779 bisitz 5577: h1 {
1.721 harmsja 5578: padding:5px 10px 5px 20px;
1.693 droeschl 5579: line-height:130%;
5580: }
1.698 harmsja 5581:
1.693 droeschl 5582: h2,h3,h4,h5,h6
5583: {
1.721 harmsja 5584: margin:5px 0px 5px 0px;
5585: padding:0px;
5586: line-height:130%;
1.693 droeschl 5587: }
1.721 harmsja 5588: .LC_hcell{
1.698 harmsja 5589: padding:3px 15px 3px 15px;
5590: margin:0px;
1.703 harmsja 5591: background-color:$tabbg;
1.779 bisitz 5592: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5593: }
1.721 harmsja 5594: .LC_noBorder {
1.698 harmsja 5595: border:0px;
5596: }
1.693 droeschl 5597:
5598:
1.698 harmsja 5599: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5600:
1.761 tempelho 5601: .LC_Right {
5602: float: right;
5603: margin: 0px;
5604: padding: 0px;
5605: }
5606:
1.721 harmsja 5607: p, .LC_ContentBox {
1.698 harmsja 5608: padding: 10px;
5609:
5610: }
1.721 harmsja 5611: .LC_FormSectionClearButton input {
1.779 bisitz 5612: background-color:transparent;
1.698 harmsja 5613: border:0px;
5614: cursor:pointer;
5615: text-decoration:underline;
1.693 droeschl 5616: }
1.763 bisitz 5617:
5618: .LC_help_open_topic {
5619: color: #FFFFFF;
5620: background-color: #EEEEFF;
5621: margin: 1px;
5622: padding: 4px;
5623: border: 1px solid #000033;
5624: white-space: nowrap;
1.759 neumanie 5625: }
1.693 droeschl 5626:
1.698 harmsja 5627: dl,ul,div,fieldset {
5628: margin: 10px 10px 10px 0px;
1.693 droeschl 5629: overflow:hidden;
5630: }
1.721 harmsja 5631: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698 harmsja 5632: margin: 0px;
1.693 droeschl 5633: }
5634:
1.721 harmsja 5635: ol.LC_smallMenu li {
1.693 droeschl 5636: display: inline;
5637: padding: 5px 5px 0px 10px;
5638: vertical-align: top;
5639: }
5640:
1.721 harmsja 5641: ol.LC_smallMenu li img {
1.693 droeschl 5642: vertical-align: bottom;
5643: }
5644:
1.721 harmsja 5645: ol.LC_smallMenu a {
1.693 droeschl 5646: font-size: 90%;
5647: color: RGB(80, 80, 80);
5648: text-decoration: none;
5649: }
1.760 harmsja 5650: ol#LC_TabMainMenuContent, ul.LC_TabContent ,
1.741 harmsja 5651: ul.LC_TabContentBigger {
1.721 harmsja 5652: display:block;
5653: list-style:none;
1.741 harmsja 5654: margin: 0px;
1.693 droeschl 5655: padding: 0px;
5656: }
5657:
1.744 ehlerst 5658: ol#LC_TabMainMenuContent li, ul.LC_TabContent li,
1.741 harmsja 5659: ul.LC_TabContentBigger li{
1.693 droeschl 5660: display: inline;
1.741 harmsja 5661: border-right: solid 1px $lg_border_color;
5662: float:left;
5663: line-height:140%;
5664: white-space:nowrap;
5665: }
5666: ol#LC_TabMainMenuContent li{
1.693 droeschl 5667: vertical-align: bottom;
5668: border-bottom: solid 1px RGB(175, 175, 175);
1.721 harmsja 5669: padding: 5px 10px 5px 10px;
1.741 harmsja 5670: margin-right:5px;
5671: margin-bottom:3px;
1.693 droeschl 5672: font-weight: bold;
1.723 riegler 5673: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5674: }
5675:
1.721 harmsja 5676: ol#LC_TabMainMenuContent li a{
1.693 droeschl 5677: color: RGB(47, 47, 47);
5678: text-decoration: none;
5679: }
1.721 harmsja 5680: ul.LC_TabContent {
1.741 harmsja 5681: min-height:1.6em;
1.721 harmsja 5682: }
5683: ul.LC_TabContent li{
1.741 harmsja 5684: vertical-align:middle;
5685: padding:0px 10px 0px 10px;
1.745 ehlerst 5686: background-color:$tabbg;
5687: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5688: }
1.779 bisitz 5689: ul.LC_TabContent li a, ul.LC_TabContent li{
1.721 harmsja 5690: color:rgb(47,47,47);
5691: text-decoration:none;
5692: font-size:95%;
5693: font-weight:bold;
1.761 tempelho 5694: padding-right: 16px;
1.721 harmsja 5695: }
1.744 ehlerst 5696: ul.LC_TabContent li:hover, ul.LC_TabContent li.active{
1.761 tempelho 5697: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745 ehlerst 5698: border-bottom:solid 1px #FFFFFF;
1.761 tempelho 5699: padding-right: 16px;
1.744 ehlerst 5700: }
1.741 harmsja 5701: ul.LC_TabContentBigger li{
5702: vertical-align:bottom;
5703: border-top:solid 1px $lg_border_color;
5704: border-left:solid 1px $lg_border_color;
5705: padding:5px 10px 5px 10px;
5706: margin-left:2px;
5707: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5708: }
1.744 ehlerst 5709: ul.LC_TabContentBigger li:hover, ul.LC_TabContentBigger li.active{
5710: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5711: }
1.741 harmsja 5712: ul.LC_TabContentBigger li, ul.LC_TabContentBigger li a{
5713: font-size:110%;
5714: font-weight:bold;
5715: }
1.693 droeschl 5716:
1.721 harmsja 5717: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs {
1.693 droeschl 5718: border-top: solid 1px RGB(255, 255, 255);
5719: height: 20px;
5720: line-height: 20px;
5721: vertical-align: bottom;
5722: margin: 0px 0px 30px 0px;
5723: padding-left: 10px;
5724: list-style-position: inside;
1.723 riegler 5725: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5726: }
5727:
1.721 harmsja 5728: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li {
1.741 harmsja 5729: /*
1.723 riegler 5730: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.779 bisitz 5731: */
1.693 droeschl 5732: display: inline;
5733: padding: 0px 0px 0px 10px;
5734: vertical-align: bottom;
5735: overflow:hidden;
5736: }
5737:
1.721 harmsja 5738: ol#LC_MenuBreadcrumbs li a {
1.693 droeschl 5739: text-decoration: none;
5740: font-size:90%;
5741: }
1.721 harmsja 5742: ol#LC_PathBreadcrumbs li a{
1.698 harmsja 5743: text-decoration:none;
5744: font-size:100%;
5745: font-weight:bold;
1.693 droeschl 5746: }
1.721 harmsja 5747: .LC_ContentBoxSpecial
1.693 droeschl 5748: {
1.701 harmsja 5749: border: solid 1px $lg_border_color;
1.746 neumanie 5750: }
5751: .LC_ContentBoxSpecialContactInfo
5752: {
5753: border: solid 1px $lg_border_color;
5754: max-width:25%;
5755: min-width:25%;
1.698 harmsja 5756: }
1.747 neumanie 5757: .LC_AboutMe_Image
5758: {
5759: float:left;
5760: margin-right:10px;
5761: }
5762: .LC_Clear_AboutMe_Image
5763: {
5764: clear:left;
5765: }
1.721 harmsja 5766: dl.LC_ListStyleClean dt {
1.693 droeschl 5767: padding-right: 5px;
5768: display: table-header-group;
5769: }
5770:
1.721 harmsja 5771: dl.LC_ListStyleClean dd {
1.693 droeschl 5772: display: table-row;
5773: }
5774:
1.721 harmsja 5775: .LC_ListStyleClean,
5776: .LC_ListStyleSimple,
5777: .LC_ListStyleNormal,
1.777 tempelho 5778: .LC_ListStyle_Border,
1.721 harmsja 5779: .LC_ListStyleSpecial
1.693 droeschl 5780: {
5781: /*display:block; */
5782: list-style-position: inside;
5783: list-style-type: none;
5784: overflow: hidden;
5785: padding: 0px;
5786: }
5787:
1.721 harmsja 5788: .LC_ListStyleSimple li,
5789: .LC_ListStyleSimple dd,
5790: .LC_ListStyleNormal li,
5791: .LC_ListStyleNormal dd,
5792: .LC_ListStyleSpecial li,
5793: .LC_ListStyleSpecial dd
1.693 droeschl 5794: {
5795: margin: 0px;
5796: padding: 5px 5px 5px 10px;
5797: clear: both;
5798: }
5799:
1.721 harmsja 5800: .LC_ListStyleClean li,
5801: .LC_ListStyleClean dd {
1.693 droeschl 5802: padding-top: 0px;
5803: padding-bottom: 0px;
5804: }
5805:
1.721 harmsja 5806: .LC_ListStyleSimple dd,
5807: .LC_ListStyleSimple li{
1.698 harmsja 5808: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5809: }
5810:
1.721 harmsja 5811: .LC_ListStyleSpecial li,
5812: .LC_ListStyleSpecial dd {
1.693 droeschl 5813: list-style-type: none;
5814: background-color: RGB(220, 220, 220);
5815: margin-bottom: 4px;
5816: }
5817:
1.721 harmsja 5818: table.LC_SimpleTable {
1.698 harmsja 5819: margin:5px;
5820: border:solid 1px $lg_border_color;
1.693 droeschl 5821: }
5822:
1.721 harmsja 5823: table.LC_SimpleTable tr {
1.698 harmsja 5824: padding:0px;
5825: border:solid 1px $lg_border_color;
1.693 droeschl 5826: }
1.721 harmsja 5827: table.LC_SimpleTable thead{
1.698 harmsja 5828: background:rgb(220,220,220);
1.693 droeschl 5829: }
5830:
1.721 harmsja 5831: div.LC_columnSection {
1.693 droeschl 5832: display: block;
5833: clear: both;
5834: overflow: hidden;
5835: margin:0px;
5836: }
5837:
1.721 harmsja 5838: div.LC_columnSection>* {
1.693 droeschl 5839: float: left;
5840: margin: 10px 20px 10px 0px;
1.747 neumanie 5841: overflow:hidden;
1.693 droeschl 5842: }
1.721 harmsja 5843:
1.719 ehlerst 5844: .ContentBoxSpecialTemplate
5845: {
1.747 neumanie 5846: border: solid 1px $lg_border_color;
1.719 ehlerst 5847: }
5848: .ContentBoxTemplate {
5849: padding:10px;
5850: }
5851:
1.721 harmsja 5852: div.LC_columnSection > .ContentBoxTemplate,
5853: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719 ehlerst 5854: {
5855: width: 600px;
5856: }
1.753 droeschl 5857:
1.720 ehlerst 5858: .clear{
5859: clear: both;
5860: line-height: 0px;
5861: font-size: 0px;
5862: height: 0px;
5863: }
1.693 droeschl 5864:
1.694 tempelho 5865: .LC_loginpage_container {
5866: text-align:left;
5867: margin : 0 auto;
5868: width:65%;
5869: padding: 10px;
5870: height: auto;
1.712 muellerd 5871: background-color:#FFFFFF;
1.694 tempelho 5872: border:1px solid #CCCCCC;
5873: }
5874:
5875:
5876: .LC_loginpage_loginContainer {
5877: float:left;
1.712 muellerd 5878: width: 182px;
5879: border:1px solid #CCCCCC;
5880: background-color:$loginbg;
1.694 tempelho 5881: }
5882:
1.717 tempelho 5883: .LC_loginpage_loginContainer h2{
1.712 muellerd 5884: margin-top:0;
5885: display:block;
5886: background:$bgcol;
5887: color:$textcol;
5888: padding-left:5px;
5889: }
1.694 tempelho 5890: .LC_loginpage_loginInfo {
5891: margin-left:20px;
5892: float:left;
5893: width:30%;
5894: border:1px solid #CCCCCC;
5895: padding:10px;
5896: }
5897:
1.712 muellerd 5898: .LC_loginpage_loginDomain {
5899: margin-right:20px;
5900: width:20%;
5901: float:left;
5902: padding:10px;
5903: }
5904:
1.694 tempelho 5905: .LC_loginpage_space {
1.754 droeschl 5906: clear: both;
5907: margin-bottom: 20px;
1.694 tempelho 5908: border-bottom: 1px solid #CCCCCC;
5909: }
5910:
1.748 schulted 5911: table em{
1.754 droeschl 5912: font-weight: bold;
5913: font-style: normal;
1.748 schulted 5914: }
1.779 bisitz 5915: table.LC_tableBrowseRes,
1.768 schulted 5916: table.LC_tableOfContent{
1.769 schulted 5917: border:none;
5918: border-spacing: 1;
1.754 droeschl 5919: padding: 3px;
5920: background-color: #FFFFFF;
5921: font-size: 90%;
1.753 droeschl 5922: }
1.771 droeschl 5923: table.LC_tableBrowseRes a,
1.768 schulted 5924: table.LC_tableOfContent a {
1.771 droeschl 5925: background-color: transparent;
1.753 droeschl 5926: text-decoration: none;
5927: }
5928:
1.771 droeschl 5929: table.LC_tableBrowseRes tr.LC_trOdd,
1.768 schulted 5930: table.LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 5931: background-color: #EEEEEE;
1.753 droeschl 5932: }
5933:
1.768 schulted 5934: table.LC_tableOfContent img{
1.753 droeschl 5935: border: none;
5936: height: 1.3em;
5937: vertical-align: text-bottom;
5938: margin-right: 0.3em;
5939: }
1.757 schulted 5940:
1.774 ehlerst 5941: a#LC_content_toolbar_firsthomework{
5942: background-image:url(/res/adm/pages/open-first-problem.gif);
5943: }
5944:
5945: a#LC_content_toolbar_launchnav{
5946: background-image:url(/res/adm/pages/start-navigation.gif);
5947: }
5948:
5949: a#LC_content_toolbar_closenav{
5950: background-image:url(/res/adm/pages/close-navigation.gif);
5951: }
5952:
5953: a#LC_content_toolbar_everything{
5954: background-image:url(/res/adm/pages/show-all.gif);
5955: }
5956:
5957: a#LC_content_toolbar_uncompleted{
5958: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
5959: }
5960:
5961: #LC_content_toolbar_clearbubbles{
5962: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
5963: }
5964:
1.757 schulted 5965: a#LC_content_toolbar_changefolder{
5966: background : url(/res/adm/pages/close-all-folders.gif) top center ;
5967: }
5968:
5969: a#LC_content_toolbar_changefolder_toggled{
5970: background-image:url(/res/adm/pages/open-all-folders.gif);
5971: }
5972:
5973: ul#LC_toolbar li a:hover{
5974: background-position: bottom center;
5975: }
5976:
5977: ul#LC_toolbar{
1.779 bisitz 5978: padding:0;
1.757 schulted 5979: margin: 2px;
5980: list-style:none;
5981: position:relative;
5982: background-color:white;
5983: }
5984:
5985: ul#LC_toolbar li{
5986: border:1px solid white;
5987: padding:0;
5988: margin: 0;
1.767 droeschl 5989: float: left;
5990: display:inline;
1.757 schulted 5991: vertical-align:middle;
5992: }
5993:
5994: a.LC_toolbarItem{
1.767 droeschl 5995: display:block;
1.757 schulted 5996: padding:0;
5997: margin:0;
5998: height: 32px;
5999: width: 32px;
1.779 bisitz 6000: color:white;
6001: border:0 none;
1.757 schulted 6002: background-repeat:no-repeat;
6003: background-color:transparent;
6004: }
6005:
1.782 ! bisitz 6006: ul.LC_functionslist li {
! 6007: float: left;
! 6008: white-space: nowrap;
! 6009: height: 35px; /* at least as high as heighest list item */
! 6010: margin: 0px 15px 15px 10px;
! 6011: }
! 6012:
1.757 schulted 6013:
1.343 albertel 6014: END
6015: }
6016:
1.306 albertel 6017: =pod
6018:
6019: =item * &headtag()
6020:
6021: Returns a uniform footer for LON-CAPA web pages.
6022:
1.307 albertel 6023: Inputs: $title - optional title for the head
6024: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 6025: $args - optional arguments
1.319 albertel 6026: force_register - if is true call registerurl so the remote is
6027: informed
1.415 albertel 6028: redirect -> array ref of
6029: 1- seconds before redirect occurs
6030: 2- url to redirect to
6031: 3- whether the side effect should occur
1.315 albertel 6032: (side effect of setting
6033: $env{'internal.head.redirect'} to the url
6034: redirected too)
1.352 albertel 6035: domain -> force to color decorate a page for a specific
6036: domain
6037: function -> force usage of a specific rolish color scheme
6038: bgcolor -> override the default page bgcolor
1.460 albertel 6039: no_auto_mt_title
6040: -> prevent &mt()ing the title arg
1.464 albertel 6041:
1.306 albertel 6042: =cut
6043:
6044: sub headtag {
1.313 albertel 6045: my ($title,$head_extra,$args) = @_;
1.306 albertel 6046:
1.363 albertel 6047: my $function = $args->{'function'} || &get_users_function();
6048: my $domain = $args->{'domain'} || &determinedomain();
6049: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6050: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6051: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6052: #time(),
1.418 albertel 6053: $env{'environment.color.timestamp'},
1.363 albertel 6054: $function,$domain,$bgcolor);
6055:
1.369 www 6056: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6057:
1.308 albertel 6058: my $result =
6059: '<head>'.
1.461 albertel 6060: &font_settings();
1.319 albertel 6061:
1.461 albertel 6062: if (!$args->{'frameset'}) {
6063: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6064: }
1.319 albertel 6065: if ($args->{'force_register'}) {
6066: $result .= &Apache::lonmenu::registerurl(1);
6067: }
1.436 albertel 6068: if (!$args->{'no_nav_bar'}
6069: && !$args->{'only_body'}
6070: && !$args->{'frameset'}) {
6071: $result .= &help_menu_js();
6072: }
1.319 albertel 6073:
1.314 albertel 6074: if (ref($args->{'redirect'})) {
1.414 albertel 6075: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6076: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6077: if (!$inhibit_continue) {
6078: $env{'internal.head.redirect'} = $url;
6079: }
1.313 albertel 6080: $result.=<<ADDMETA
6081: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6082: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6083: ADDMETA
6084: }
1.306 albertel 6085: if (!defined($title)) {
6086: $title = 'The LearningOnline Network with CAPA';
6087: }
1.460 albertel 6088: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6089: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6090: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6091: .$head_extra;
1.306 albertel 6092: return $result;
6093: }
6094:
6095: =pod
6096:
1.340 albertel 6097: =item * &font_settings()
6098:
6099: Returns neccessary <meta> to set the proper encoding
6100:
6101: Inputs: none
6102:
6103: =cut
6104:
6105: sub font_settings {
6106: my $headerstring='';
1.647 www 6107: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6108: $headerstring.=
6109: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6110: }
6111: return $headerstring;
6112: }
6113:
1.341 albertel 6114: =pod
6115:
6116: =item * &xml_begin()
6117:
6118: Returns the needed doctype and <html>
6119:
6120: Inputs: none
6121:
6122: =cut
6123:
6124: sub xml_begin {
6125: my $output='';
6126:
1.592 albertel 6127: if ($env{'internal.start_page'}==1) {
6128: &Apache::lonhtmlcommon::init_htmlareafields();
6129: }
1.342 albertel 6130:
1.341 albertel 6131: if ($env{'browser.mathml'}) {
6132: $output='<?xml version="1.0"?>'
6133: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6134: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6135:
6136: # .'<!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">] >'
6137: .'<!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">'
6138: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6139: .'xmlns="http://www.w3.org/1999/xhtml">';
6140: } else {
6141: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6142: }
6143: return $output;
6144: }
1.340 albertel 6145:
6146: =pod
6147:
1.306 albertel 6148: =item * &endheadtag()
6149:
6150: Returns a uniform </head> for LON-CAPA web pages.
6151:
6152: Inputs: none
6153:
6154: =cut
6155:
6156: sub endheadtag {
6157: return '</head>';
6158: }
6159:
6160: =pod
6161:
6162: =item * &head()
6163:
6164: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6165:
1.648 raeburn 6166: Inputs:
6167:
6168: =over 4
6169:
6170: $title - optional title for the page
6171:
6172: $head_extra - optional extra HTML to put inside the <head>
6173:
6174: =back
1.405 albertel 6175:
1.306 albertel 6176: =cut
6177:
6178: sub head {
1.325 albertel 6179: my ($title,$head_extra,$args) = @_;
6180: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6181: }
6182:
6183: =pod
6184:
6185: =item * &start_page()
6186:
6187: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6188:
1.648 raeburn 6189: Inputs:
6190:
6191: =over 4
6192:
6193: $title - optional title for the page
6194:
6195: $head_extra - optional extra HTML to incude inside the <head>
6196:
6197: $args - additional optional args supported are:
6198:
6199: =over 8
6200:
6201: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6202: arg on
1.648 raeburn 6203: no_nav_bar -> is true will set &bodytag() notopbar arg on
6204: add_entries -> additional attributes to add to the <body>
6205: domain -> force to color decorate a page for a
1.317 albertel 6206: specific domain
1.648 raeburn 6207: function -> force usage of a specific rolish color
1.317 albertel 6208: scheme
1.648 raeburn 6209: redirect -> see &headtag()
6210: bgcolor -> override the default page bg color
6211: js_ready -> return a string ready for being used in
1.317 albertel 6212: a javascript writeln
1.648 raeburn 6213: html_encode -> return a string ready for being used in
1.320 albertel 6214: a html attribute
1.648 raeburn 6215: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6216: $forcereg arg
1.648 raeburn 6217: body_title -> alternate text to use instead of $title
1.326 albertel 6218: in the title box that appears, this text
6219: is not auto translated like the $title is
1.648 raeburn 6220: frameset -> if true will start with a <frameset>
1.330 albertel 6221: rather than <body>
1.648 raeburn 6222: no_title -> if true the title bar won't be shown
6223: skip_phases -> hash ref of
1.338 albertel 6224: head -> skip the <html><head> generation
6225: body -> skip all <body> generation
1.648 raeburn 6226: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6227: 'Switch To Inline Menu' link
1.648 raeburn 6228: no_auto_mt_title -> prevent &mt()ing the title arg
6229: inherit_jsmath -> when creating popup window in a page,
6230: should it have jsmath forced on by the
6231: current page
1.361 albertel 6232:
1.648 raeburn 6233: =back
1.460 albertel 6234:
1.648 raeburn 6235: =back
1.562 albertel 6236:
1.306 albertel 6237: =cut
6238:
6239: sub start_page {
1.309 albertel 6240: my ($title,$head_extra,$args) = @_;
1.318 albertel 6241: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6242: my %head_args;
1.352 albertel 6243: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6244: 'bgcolor','frameset','no_nav_bar','only_body',
6245: 'no_auto_mt_title') {
1.319 albertel 6246: if (defined($args->{$arg})) {
1.324 raeburn 6247: $head_args{$arg} = $args->{$arg};
1.319 albertel 6248: }
1.313 albertel 6249: }
1.319 albertel 6250:
1.315 albertel 6251: $env{'internal.start_page'}++;
1.338 albertel 6252: my $result;
6253: if (! exists($args->{'skip_phases'}{'head'}) ) {
6254: $result.=
1.341 albertel 6255: &xml_begin().
1.338 albertel 6256: &headtag($title,$head_extra,\%head_args).&endheadtag();
6257: }
6258:
6259: if (! exists($args->{'skip_phases'}{'body'}) ) {
6260: if ($args->{'frameset'}) {
6261: my $attr_string = &make_attr_string($args->{'force_register'},
6262: $args->{'add_entries'});
6263: $result .= "\n<frameset $attr_string>\n";
6264: } else {
6265: $result .=
6266: &bodytag($title,
6267: $args->{'function'}, $args->{'add_entries'},
6268: $args->{'only_body'}, $args->{'domain'},
6269: $args->{'force_register'}, $args->{'body_title'},
6270: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6271: $args->{'no_title'}, $args->{'no_inline_link'},
6272: $args);
1.338 albertel 6273: }
1.330 albertel 6274: }
1.338 albertel 6275:
1.315 albertel 6276: if ($args->{'js_ready'}) {
1.713 kaisler 6277: $result = &js_ready($result);
1.315 albertel 6278: }
1.320 albertel 6279: if ($args->{'html_encode'}) {
1.713 kaisler 6280: $result = &html_encode($result);
6281: }
6282:
1.758 kaisler 6283: #Breadcrumbs
6284: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6285: &Apache::lonhtmlcommon::clear_breadcrumbs();
6286: #if any br links exists, add them to the breadcrumbs
6287: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6288: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6289: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6290: }
6291: }
6292:
6293: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6294: if(exists($args->{'bread_crumbs_component'})){
6295: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6296: }else{
6297: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6298: }
1.320 albertel 6299: }
1.315 albertel 6300: return $result;
1.306 albertel 6301: }
6302:
1.330 albertel 6303:
1.306 albertel 6304: =pod
6305:
6306: =item * &head()
6307:
6308: Returns a complete </body></html> section for LON-CAPA web pages.
6309:
1.315 albertel 6310: Inputs: $args - additional optional args supported are:
6311: js_ready -> return a string ready for being used in
6312: a javascript writeln
1.320 albertel 6313: html_encode -> return a string ready for being used in
6314: a html attribute
1.330 albertel 6315: frameset -> if true will start with a <frameset>
6316: rather than <body>
1.493 albertel 6317: dicsussion -> if true will get discussion from
6318: lonxml::xmlend
6319: (you can pass the target and parser arguments
6320: through optional 'target' and 'parser' args
6321: to this routine)
1.306 albertel 6322:
6323: =cut
6324:
6325: sub end_page {
1.315 albertel 6326: my ($args) = @_;
6327: $env{'internal.end_page'}++;
1.330 albertel 6328: my $result;
1.335 albertel 6329: if ($args->{'discussion'}) {
6330: my ($target,$parser);
6331: if (ref($args->{'discussion'})) {
6332: ($target,$parser) =($args->{'discussion'}{'target'},
6333: $args->{'discussion'}{'parser'});
6334: }
6335: $result .= &Apache::lonxml::xmlend($target,$parser);
6336: }
6337:
1.330 albertel 6338: if ($args->{'frameset'}) {
6339: $result .= '</frameset>';
6340: } else {
1.635 raeburn 6341: $result .= &endbodytag($args);
1.330 albertel 6342: }
6343: $result .= "\n</html>";
6344:
1.315 albertel 6345: if ($args->{'js_ready'}) {
1.317 albertel 6346: $result = &js_ready($result);
1.315 albertel 6347: }
1.335 albertel 6348:
1.320 albertel 6349: if ($args->{'html_encode'}) {
6350: $result = &html_encode($result);
6351: }
1.335 albertel 6352:
1.315 albertel 6353: return $result;
6354: }
6355:
1.320 albertel 6356: sub html_encode {
6357: my ($result) = @_;
6358:
1.322 albertel 6359: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6360:
6361: return $result;
6362: }
1.317 albertel 6363: sub js_ready {
6364: my ($result) = @_;
6365:
1.323 albertel 6366: $result =~ s/[\n\r]/ /xmsg;
6367: $result =~ s/\\/\\\\/xmsg;
6368: $result =~ s/'/\\'/xmsg;
1.372 albertel 6369: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6370:
6371: return $result;
6372: }
6373:
1.315 albertel 6374: sub validate_page {
6375: if ( exists($env{'internal.start_page'})
1.316 albertel 6376: && $env{'internal.start_page'} > 1) {
6377: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6378: $env{'internal.start_page'}.' '.
1.316 albertel 6379: $ENV{'request.filename'});
1.315 albertel 6380: }
6381: if ( exists($env{'internal.end_page'})
1.316 albertel 6382: && $env{'internal.end_page'} > 1) {
6383: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6384: $env{'internal.end_page'}.' '.
1.316 albertel 6385: $env{'request.filename'});
1.315 albertel 6386: }
6387: if ( exists($env{'internal.start_page'})
6388: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6389: &Apache::lonnet::logthis('start_page called without end_page '.
6390: $env{'request.filename'});
1.315 albertel 6391: }
6392: if ( ! exists($env{'internal.start_page'})
6393: && exists($env{'internal.end_page'})) {
1.316 albertel 6394: &Apache::lonnet::logthis('end_page called without start_page'.
6395: $env{'request.filename'});
1.315 albertel 6396: }
1.306 albertel 6397: }
1.315 albertel 6398:
1.318 albertel 6399: sub simple_error_page {
6400: my ($r,$title,$msg) = @_;
6401: my $page =
6402: &Apache::loncommon::start_page($title).
6403: &mt($msg).
6404: &Apache::loncommon::end_page();
6405: if (ref($r)) {
6406: $r->print($page);
1.327 albertel 6407: return;
1.318 albertel 6408: }
6409: return $page;
6410: }
1.347 albertel 6411:
6412: {
1.610 albertel 6413: my @row_count;
1.347 albertel 6414: sub start_data_table {
1.422 albertel 6415: my ($add_class) = @_;
6416: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6417: unshift(@row_count,0);
1.422 albertel 6418: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6419: }
6420:
6421: sub end_data_table {
1.610 albertel 6422: shift(@row_count);
1.389 albertel 6423: return '</table>'."\n";;
1.347 albertel 6424: }
6425:
6426: sub start_data_table_row {
1.422 albertel 6427: my ($add_class) = @_;
1.610 albertel 6428: $row_count[0]++;
6429: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6430: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6431: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6432: }
1.471 banghart 6433:
6434: sub continue_data_table_row {
6435: my ($add_class) = @_;
1.610 albertel 6436: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6437: $css_class = (join(' ',$css_class,$add_class));
6438: return '<tr class="'.$css_class.'">'."\n";;
6439: }
1.347 albertel 6440:
6441: sub end_data_table_row {
1.389 albertel 6442: return '</tr>'."\n";;
1.347 albertel 6443: }
1.367 www 6444:
1.421 albertel 6445: sub start_data_table_empty_row {
1.707 bisitz 6446: # $row_count[0]++;
1.421 albertel 6447: return '<tr class="LC_empty_row" >'."\n";;
6448: }
6449:
6450: sub end_data_table_empty_row {
6451: return '</tr>'."\n";;
6452: }
6453:
1.367 www 6454: sub start_data_table_header_row {
1.389 albertel 6455: return '<tr class="LC_header_row">'."\n";;
1.367 www 6456: }
6457:
6458: sub end_data_table_header_row {
1.389 albertel 6459: return '</tr>'."\n";;
1.367 www 6460: }
1.347 albertel 6461: }
6462:
1.548 albertel 6463: =pod
6464:
6465: =item * &inhibit_menu_check($arg)
6466:
6467: Checks for a inhibitmenu state and generates output to preserve it
6468:
6469: Inputs: $arg - can be any of
6470: - undef - in which case the return value is a string
6471: to add into arguments list of a uri
6472: - 'input' - in which case the return value is a HTML
6473: <form> <input> field of type hidden to
6474: preserve the value
6475: - a url - in which case the return value is the url with
6476: the neccesary cgi args added to preserve the
6477: inhibitmenu state
6478: - a ref to a url - no return value, but the string is
6479: updated to include the neccessary cgi
6480: args to preserve the inhibitmenu state
6481:
6482: =cut
6483:
6484: sub inhibit_menu_check {
6485: my ($arg) = @_;
6486: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6487: if ($arg eq 'input') {
6488: if ($env{'form.inhibitmenu'}) {
6489: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6490: } else {
6491: return
6492: }
6493: }
6494: if ($env{'form.inhibitmenu'}) {
6495: if (ref($arg)) {
6496: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6497: } elsif ($arg eq '') {
6498: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6499: } else {
6500: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6501: }
6502: }
6503: if (!ref($arg)) {
6504: return $arg;
6505: }
6506: }
6507:
1.251 albertel 6508: ###############################################
1.182 matthew 6509:
6510: =pod
6511:
1.549 albertel 6512: =back
6513:
6514: =head1 User Information Routines
6515:
6516: =over 4
6517:
1.405 albertel 6518: =item * &get_users_function()
1.182 matthew 6519:
6520: Used by &bodytag to determine the current users primary role.
6521: Returns either 'student','coordinator','admin', or 'author'.
6522:
6523: =cut
6524:
6525: ###############################################
6526: sub get_users_function {
6527: my $function = 'student';
1.258 albertel 6528: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6529: $function='coordinator';
6530: }
1.258 albertel 6531: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6532: $function='admin';
6533: }
1.258 albertel 6534: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6535: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6536: $function='author';
6537: }
6538: return $function;
1.54 www 6539: }
1.99 www 6540:
6541: ###############################################
6542:
1.233 raeburn 6543: =pod
6544:
1.542 raeburn 6545: =item * &check_user_status()
1.274 raeburn 6546:
6547: Determines current status of supplied role for a
6548: specific user. Roles can be active, previous or future.
6549:
6550: Inputs:
6551: user's domain, user's username, course's domain,
1.375 raeburn 6552: course's number, optional section ID.
1.274 raeburn 6553:
6554: Outputs:
6555: role status: active, previous or future.
6556:
6557: =cut
6558:
6559: sub check_user_status {
1.412 raeburn 6560: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6561: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6562: my @uroles = keys %userinfo;
6563: my $srchstr;
6564: my $active_chk = 'none';
1.412 raeburn 6565: my $now = time;
1.274 raeburn 6566: if (@uroles > 0) {
1.412 raeburn 6567: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6568: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6569: } else {
1.412 raeburn 6570: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6571: }
6572: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6573: my $role_end = 0;
6574: my $role_start = 0;
6575: $active_chk = 'active';
1.412 raeburn 6576: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6577: $role_end = $1;
6578: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6579: $role_start = $1;
1.274 raeburn 6580: }
6581: }
6582: if ($role_start > 0) {
1.412 raeburn 6583: if ($now < $role_start) {
1.274 raeburn 6584: $active_chk = 'future';
6585: }
6586: }
6587: if ($role_end > 0) {
1.412 raeburn 6588: if ($now > $role_end) {
1.274 raeburn 6589: $active_chk = 'previous';
6590: }
6591: }
6592: }
6593: }
6594: return $active_chk;
6595: }
6596:
6597: ###############################################
6598:
6599: =pod
6600:
1.405 albertel 6601: =item * &get_sections()
1.233 raeburn 6602:
6603: Determines all the sections for a course including
6604: sections with students and sections containing other roles.
1.419 raeburn 6605: Incoming parameters:
6606:
6607: 1. domain
6608: 2. course number
6609: 3. reference to array containing roles for which sections should
6610: be gathered (optional).
6611: 4. reference to array containing status types for which sections
6612: should be gathered (optional).
6613:
6614: If the third argument is undefined, sections are gathered for any role.
6615: If the fourth argument is undefined, sections are gathered for any status.
6616: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6617:
1.374 raeburn 6618: Returns section hash (keys are section IDs, values are
6619: number of users in each section), subject to the
1.419 raeburn 6620: optional roles filter, optional status filter
1.233 raeburn 6621:
6622: =cut
6623:
6624: ###############################################
6625: sub get_sections {
1.419 raeburn 6626: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6627: if (!defined($cdom) || !defined($cnum)) {
6628: my $cid = $env{'request.course.id'};
6629:
6630: return if (!defined($cid));
6631:
6632: $cdom = $env{'course.'.$cid.'.domain'};
6633: $cnum = $env{'course.'.$cid.'.num'};
6634: }
6635:
6636: my %sectioncount;
1.419 raeburn 6637: my $now = time;
1.240 albertel 6638:
1.366 albertel 6639: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6640: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6641: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6642: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6643: my $start_index = &Apache::loncoursedata::CL_START();
6644: my $end_index = &Apache::loncoursedata::CL_END();
6645: my $status;
1.366 albertel 6646: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6647: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6648: $data->[$status_index],
6649: $data->[$start_index],
6650: $data->[$end_index]);
6651: if ($stu_status eq 'Active') {
6652: $status = 'active';
6653: } elsif ($end < $now) {
6654: $status = 'previous';
6655: } elsif ($start > $now) {
6656: $status = 'future';
6657: }
6658: if ($section ne '-1' && $section !~ /^\s*$/) {
6659: if ((!defined($possible_status)) || (($status ne '') &&
6660: (grep/^\Q$status\E$/,@{$possible_status}))) {
6661: $sectioncount{$section}++;
6662: }
1.240 albertel 6663: }
6664: }
6665: }
6666: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6667: foreach my $user (sort(keys(%courseroles))) {
6668: if ($user !~ /^(\w{2})/) { next; }
6669: my ($role) = ($user =~ /^(\w{2})/);
6670: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6671: my ($section,$status);
1.240 albertel 6672: if ($role eq 'cr' &&
6673: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6674: $section=$1;
6675: }
6676: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6677: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6678: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6679: if ($end == -1 && $start == -1) {
6680: next; #deleted role
6681: }
6682: if (!defined($possible_status)) {
6683: $sectioncount{$section}++;
6684: } else {
6685: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6686: $status = 'active';
6687: } elsif ($end < $now) {
6688: $status = 'future';
6689: } elsif ($start > $now) {
6690: $status = 'previous';
6691: }
6692: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6693: $sectioncount{$section}++;
6694: }
6695: }
1.233 raeburn 6696: }
1.366 albertel 6697: return %sectioncount;
1.233 raeburn 6698: }
6699:
1.274 raeburn 6700: ###############################################
1.294 raeburn 6701:
6702: =pod
1.405 albertel 6703:
6704: =item * &get_course_users()
6705:
1.275 raeburn 6706: Retrieves usernames:domains for users in the specified course
6707: with specific role(s), and access status.
6708:
6709: Incoming parameters:
1.277 albertel 6710: 1. course domain
6711: 2. course number
6712: 3. access status: users must have - either active,
1.275 raeburn 6713: previous, future, or all.
1.277 albertel 6714: 4. reference to array of permissible roles
1.288 raeburn 6715: 5. reference to array of section restrictions (optional)
6716: 6. reference to results object (hash of hashes).
6717: 7. reference to optional userdata hash
1.609 raeburn 6718: 8. reference to optional statushash
1.630 raeburn 6719: 9. flag if privileged users (except those set to unhide in
6720: course settings) should be excluded
1.609 raeburn 6721: Keys of top level results hash are roles.
1.275 raeburn 6722: Keys of inner hashes are username:domain, with
6723: values set to access type.
1.288 raeburn 6724: Optional userdata hash returns an array with arguments in the
6725: same order as loncoursedata::get_classlist() for student data.
6726:
1.609 raeburn 6727: Optional statushash returns
6728:
1.288 raeburn 6729: Entries for end, start, section and status are blank because
6730: of the possibility of multiple values for non-student roles.
6731:
1.275 raeburn 6732: =cut
1.405 albertel 6733:
1.275 raeburn 6734: ###############################################
1.405 albertel 6735:
1.275 raeburn 6736: sub get_course_users {
1.630 raeburn 6737: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6738: my %idx = ();
1.419 raeburn 6739: my %seclists;
1.288 raeburn 6740:
6741: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6742: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6743: $idx{end} = &Apache::loncoursedata::CL_END();
6744: $idx{start} = &Apache::loncoursedata::CL_START();
6745: $idx{id} = &Apache::loncoursedata::CL_ID();
6746: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6747: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6748: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6749:
1.290 albertel 6750: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6751: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6752: my $now = time;
1.277 albertel 6753: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6754: my $match = 0;
1.412 raeburn 6755: my $secmatch = 0;
1.419 raeburn 6756: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6757: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6758: if ($section eq '') {
6759: $section = 'none';
6760: }
1.291 albertel 6761: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6762: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6763: $secmatch = 1;
6764: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6765: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6766: $secmatch = 1;
6767: }
6768: } else {
1.419 raeburn 6769: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6770: $secmatch = 1;
6771: }
1.290 albertel 6772: }
1.412 raeburn 6773: if (!$secmatch) {
6774: next;
6775: }
1.419 raeburn 6776: }
1.275 raeburn 6777: if (defined($$types{'active'})) {
1.288 raeburn 6778: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6779: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6780: $match = 1;
1.275 raeburn 6781: }
6782: }
6783: if (defined($$types{'previous'})) {
1.609 raeburn 6784: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6785: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6786: $match = 1;
1.275 raeburn 6787: }
6788: }
6789: if (defined($$types{'future'})) {
1.609 raeburn 6790: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6791: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6792: $match = 1;
1.275 raeburn 6793: }
6794: }
1.609 raeburn 6795: if ($match) {
6796: push(@{$seclists{$student}},$section);
6797: if (ref($userdata) eq 'HASH') {
6798: $$userdata{$student} = $$classlist{$student};
6799: }
6800: if (ref($statushash) eq 'HASH') {
6801: $statushash->{$student}{'st'}{$section} = $status;
6802: }
1.288 raeburn 6803: }
1.275 raeburn 6804: }
6805: }
1.412 raeburn 6806: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6807: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6808: my $now = time;
1.609 raeburn 6809: my %displaystatus = ( previous => 'Expired',
6810: active => 'Active',
6811: future => 'Future',
6812: );
1.630 raeburn 6813: my %nothide;
6814: if ($hidepriv) {
6815: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6816: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6817: if ($user !~ /:/) {
6818: $nothide{join(':',split(/[\@]/,$user))}=1;
6819: } else {
6820: $nothide{$user} = 1;
6821: }
6822: }
6823: }
1.439 raeburn 6824: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6825: my $match = 0;
1.412 raeburn 6826: my $secmatch = 0;
1.439 raeburn 6827: my $status;
1.412 raeburn 6828: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6829: $user =~ s/:$//;
1.439 raeburn 6830: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6831: if ($end == -1 || $start == -1) {
6832: next;
6833: }
6834: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6835: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6836: my ($uname,$udom) = split(/:/,$user);
6837: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6838: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6839: $secmatch = 1;
6840: } elsif ($usec eq '') {
1.420 albertel 6841: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6842: $secmatch = 1;
6843: }
6844: } else {
6845: if (grep(/^\Q$usec\E$/,@{$sections})) {
6846: $secmatch = 1;
6847: }
6848: }
6849: if (!$secmatch) {
6850: next;
6851: }
1.288 raeburn 6852: }
1.419 raeburn 6853: if ($usec eq '') {
6854: $usec = 'none';
6855: }
1.275 raeburn 6856: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6857: if ($hidepriv) {
6858: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6859: (!$nothide{$uname.':'.$udom})) {
6860: next;
6861: }
6862: }
1.503 raeburn 6863: if ($end > 0 && $end < $now) {
1.439 raeburn 6864: $status = 'previous';
6865: } elsif ($start > $now) {
6866: $status = 'future';
6867: } else {
6868: $status = 'active';
6869: }
1.277 albertel 6870: foreach my $type (keys(%{$types})) {
1.275 raeburn 6871: if ($status eq $type) {
1.420 albertel 6872: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6873: push(@{$$users{$role}{$user}},$type);
6874: }
1.288 raeburn 6875: $match = 1;
6876: }
6877: }
1.419 raeburn 6878: if (($match) && (ref($userdata) eq 'HASH')) {
6879: if (!exists($$userdata{$uname.':'.$udom})) {
6880: &get_user_info($udom,$uname,\%idx,$userdata);
6881: }
1.420 albertel 6882: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6883: push(@{$seclists{$uname.':'.$udom}},$usec);
6884: }
1.609 raeburn 6885: if (ref($statushash) eq 'HASH') {
6886: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6887: }
1.275 raeburn 6888: }
6889: }
6890: }
6891: }
1.290 albertel 6892: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6893: if ((defined($cdom)) && (defined($cnum))) {
6894: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6895: if ( defined($csettings{'internal.courseowner'}) ) {
6896: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6897: next if ($owner eq '');
6898: my ($ownername,$ownerdom);
6899: if ($owner =~ /^([^:]+):([^:]+)$/) {
6900: $ownername = $1;
6901: $ownerdom = $2;
6902: } else {
6903: $ownername = $owner;
6904: $ownerdom = $cdom;
6905: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6906: }
6907: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6908: if (defined($userdata) &&
1.609 raeburn 6909: !exists($$userdata{$owner})) {
6910: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6911: if (!grep(/^none$/,@{$seclists{$owner}})) {
6912: push(@{$seclists{$owner}},'none');
6913: }
6914: if (ref($statushash) eq 'HASH') {
6915: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6916: }
1.290 albertel 6917: }
1.279 raeburn 6918: }
6919: }
6920: }
1.419 raeburn 6921: foreach my $user (keys(%seclists)) {
6922: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6923: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6924: }
1.275 raeburn 6925: }
6926: return;
6927: }
6928:
1.288 raeburn 6929: sub get_user_info {
6930: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6931: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6932: &plainname($uname,$udom,'lastname');
1.291 albertel 6933: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6934: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6935: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6936: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6937: return;
6938: }
1.275 raeburn 6939:
1.472 raeburn 6940: ###############################################
6941:
6942: =pod
6943:
6944: =item * &get_user_quota()
6945:
6946: Retrieves quota assigned for storage of portfolio files for a user
6947:
6948: Incoming parameters:
6949: 1. user's username
6950: 2. user's domain
6951:
6952: Returns:
1.536 raeburn 6953: 1. Disk quota (in Mb) assigned to student.
6954: 2. (Optional) Type of setting: custom or default
6955: (individually assigned or default for user's
6956: institutional status).
6957: 3. (Optional) - User's institutional status (e.g., faculty, staff
6958: or student - types as defined in localenroll::inst_usertypes
6959: for user's domain, which determines default quota for user.
6960: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6961:
6962: If a value has been stored in the user's environment,
1.536 raeburn 6963: it will return that, otherwise it returns the maximal default
6964: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6965:
6966: =cut
6967:
6968: ###############################################
6969:
6970:
6971: sub get_user_quota {
6972: my ($uname,$udom) = @_;
1.536 raeburn 6973: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6974: if (!defined($udom)) {
6975: $udom = $env{'user.domain'};
6976: }
6977: if (!defined($uname)) {
6978: $uname = $env{'user.name'};
6979: }
6980: if (($udom eq '' || $uname eq '') ||
6981: ($udom eq 'public') && ($uname eq 'public')) {
6982: $quota = 0;
1.536 raeburn 6983: $quotatype = 'default';
6984: $defquota = 0;
1.472 raeburn 6985: } else {
1.536 raeburn 6986: my $inststatus;
1.472 raeburn 6987: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6988: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6989: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6990: } else {
1.536 raeburn 6991: my %userenv =
6992: &Apache::lonnet::get('environment',['portfolioquota',
6993: 'inststatus'],$udom,$uname);
1.472 raeburn 6994: my ($tmp) = keys(%userenv);
6995: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6996: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6997: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6998: } else {
6999: undef(%userenv);
7000: }
7001: }
1.536 raeburn 7002: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 7003: if ($quota eq '') {
1.536 raeburn 7004: $quota = $defquota;
7005: $quotatype = 'default';
7006: } else {
7007: $quotatype = 'custom';
1.472 raeburn 7008: }
7009: }
1.536 raeburn 7010: if (wantarray) {
7011: return ($quota,$quotatype,$settingstatus,$defquota);
7012: } else {
7013: return $quota;
7014: }
1.472 raeburn 7015: }
7016:
7017: ###############################################
7018:
7019: =pod
7020:
7021: =item * &default_quota()
7022:
1.536 raeburn 7023: Retrieves default quota assigned for storage of user portfolio files,
7024: given an (optional) user's institutional status.
1.472 raeburn 7025:
7026: Incoming parameters:
7027: 1. domain
1.536 raeburn 7028: 2. (Optional) institutional status(es). This is a : separated list of
7029: status types (e.g., faculty, staff, student etc.)
7030: which apply to the user for whom the default is being retrieved.
7031: If the institutional status string in undefined, the domain
7032: default quota will be returned.
1.472 raeburn 7033:
7034: Returns:
7035: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7036: 2. (Optional) institutional type which determined the value of the
7037: default quota.
1.472 raeburn 7038:
7039: If a value has been stored in the domain's configuration db,
7040: it will return that, otherwise it returns 20 (for backwards
7041: compatibility with domains which have not set up a configuration
7042: db file; the original statically defined portfolio quota was 20 Mb).
7043:
1.536 raeburn 7044: If the user's status includes multiple types (e.g., staff and student),
7045: the largest default quota which applies to the user determines the
7046: default quota returned.
7047:
1.780 raeburn 7048: =back
7049:
1.472 raeburn 7050: =cut
7051:
7052: ###############################################
7053:
7054:
7055: sub default_quota {
1.536 raeburn 7056: my ($udom,$inststatus) = @_;
7057: my ($defquota,$settingstatus);
7058: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7059: ['quotas'],$udom);
7060: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7061: if ($inststatus ne '') {
1.765 raeburn 7062: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7063: foreach my $item (@statuses) {
1.711 raeburn 7064: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7065: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7066: if ($defquota eq '') {
7067: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7068: $settingstatus = $item;
7069: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7070: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7071: $settingstatus = $item;
7072: }
7073: }
7074: } else {
7075: if ($quotahash{'quotas'}{$item} ne '') {
7076: if ($defquota eq '') {
7077: $defquota = $quotahash{'quotas'}{$item};
7078: $settingstatus = $item;
7079: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7080: $defquota = $quotahash{'quotas'}{$item};
7081: $settingstatus = $item;
7082: }
1.536 raeburn 7083: }
7084: }
7085: }
7086: }
7087: if ($defquota eq '') {
1.711 raeburn 7088: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7089: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7090: } else {
7091: $defquota = $quotahash{'quotas'}{'default'};
7092: }
1.536 raeburn 7093: $settingstatus = 'default';
7094: }
7095: } else {
7096: $settingstatus = 'default';
7097: $defquota = 20;
7098: }
7099: if (wantarray) {
7100: return ($defquota,$settingstatus);
1.472 raeburn 7101: } else {
1.536 raeburn 7102: return $defquota;
1.472 raeburn 7103: }
7104: }
7105:
1.384 raeburn 7106: sub get_secgrprole_info {
7107: my ($cdom,$cnum,$needroles,$type) = @_;
7108: my %sections_count = &get_sections($cdom,$cnum);
7109: my @sections = (sort {$a <=> $b} keys(%sections_count));
7110: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7111: my @groups = sort(keys(%curr_groups));
7112: my $allroles = [];
7113: my $rolehash;
7114: my $accesshash = {
7115: active => 'Currently has access',
7116: future => 'Will have future access',
7117: previous => 'Previously had access',
7118: };
7119: if ($needroles) {
7120: $rolehash = {'all' => 'all'};
1.385 albertel 7121: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7122: if (&Apache::lonnet::error(%user_roles)) {
7123: undef(%user_roles);
7124: }
7125: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7126: my ($role)=split(/\:/,$item,2);
7127: if ($role eq 'cr') { next; }
7128: if ($role =~ /^cr/) {
7129: $$rolehash{$role} = (split('/',$role))[3];
7130: } else {
7131: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7132: }
7133: }
7134: foreach my $key (sort(keys(%{$rolehash}))) {
7135: push(@{$allroles},$key);
7136: }
7137: push (@{$allroles},'st');
7138: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7139: }
7140: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7141: }
7142:
1.555 raeburn 7143: sub user_picker {
1.627 raeburn 7144: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7145: my $currdom = $dom;
7146: my %curr_selected = (
7147: srchin => 'dom',
1.580 raeburn 7148: srchby => 'lastname',
1.555 raeburn 7149: );
7150: my $srchterm;
1.625 raeburn 7151: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7152: if ($srch->{'srchby'} ne '') {
7153: $curr_selected{'srchby'} = $srch->{'srchby'};
7154: }
7155: if ($srch->{'srchin'} ne '') {
7156: $curr_selected{'srchin'} = $srch->{'srchin'};
7157: }
7158: if ($srch->{'srchtype'} ne '') {
7159: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7160: }
7161: if ($srch->{'srchdomain'} ne '') {
7162: $currdom = $srch->{'srchdomain'};
7163: }
7164: $srchterm = $srch->{'srchterm'};
7165: }
7166: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7167: 'usr' => 'Search criteria',
1.563 raeburn 7168: 'doma' => 'Domain/institution to search',
1.558 albertel 7169: 'uname' => 'username',
7170: 'lastname' => 'last name',
1.555 raeburn 7171: 'lastfirst' => 'last name, first name',
1.558 albertel 7172: 'crs' => 'in this course',
1.576 raeburn 7173: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7174: 'alc' => 'all LON-CAPA',
1.573 raeburn 7175: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7176: 'exact' => 'is',
7177: 'contains' => 'contains',
1.569 raeburn 7178: 'begins' => 'begins with',
1.571 raeburn 7179: 'youm' => "You must include some text to search for.",
7180: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7181: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7182: 'yomc' => "You must choose a domain when using an institutional directory search.",
7183: 'ymcd' => "You must choose a domain when using a domain search.",
7184: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7185: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7186: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7187: );
1.563 raeburn 7188: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7189: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7190:
7191: my @srchins = ('crs','dom','alc','instd');
7192:
7193: foreach my $option (@srchins) {
7194: # FIXME 'alc' option unavailable until
7195: # loncreateuser::print_user_query_page()
7196: # has been completed.
7197: next if ($option eq 'alc');
7198: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7199: if ($curr_selected{'srchin'} eq $option) {
7200: $srchinsel .= '
7201: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7202: } else {
7203: $srchinsel .= '
7204: <option value="'.$option.'">'.$lt{$option}.'</option>';
7205: }
1.555 raeburn 7206: }
1.563 raeburn 7207: $srchinsel .= "\n </select>\n";
1.555 raeburn 7208:
7209: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7210: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7211: if ($curr_selected{'srchby'} eq $option) {
7212: $srchbysel .= '
7213: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7214: } else {
7215: $srchbysel .= '
7216: <option value="'.$option.'">'.$lt{$option}.'</option>';
7217: }
7218: }
7219: $srchbysel .= "\n </select>\n";
7220:
7221: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7222: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7223: if ($curr_selected{'srchtype'} eq $option) {
7224: $srchtypesel .= '
7225: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7226: } else {
7227: $srchtypesel .= '
7228: <option value="'.$option.'">'.$lt{$option}.'</option>';
7229: }
7230: }
7231: $srchtypesel .= "\n </select>\n";
7232:
1.558 albertel 7233: my ($newuserscript,$new_user_create);
1.556 raeburn 7234:
7235: if ($forcenewuser) {
1.576 raeburn 7236: if (ref($srch) eq 'HASH') {
7237: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7238: if ($cancreate) {
7239: $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>';
7240: } else {
7241: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
7242: my %usertypetext = (
7243: official => 'institutional',
7244: unofficial => 'non-institutional',
7245: );
7246: $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 />';
7247: }
1.576 raeburn 7248: }
7249: }
7250:
1.556 raeburn 7251: $newuserscript = <<"ENDSCRIPT";
7252:
1.570 raeburn 7253: function setSearch(createnew,callingForm) {
1.556 raeburn 7254: if (createnew == 1) {
1.570 raeburn 7255: for (var i=0; i<callingForm.srchby.length; i++) {
7256: if (callingForm.srchby.options[i].value == 'uname') {
7257: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7258: }
7259: }
1.570 raeburn 7260: for (var i=0; i<callingForm.srchin.length; i++) {
7261: if ( callingForm.srchin.options[i].value == 'dom') {
7262: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7263: }
7264: }
1.570 raeburn 7265: for (var i=0; i<callingForm.srchtype.length; i++) {
7266: if (callingForm.srchtype.options[i].value == 'exact') {
7267: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7268: }
7269: }
1.570 raeburn 7270: for (var i=0; i<callingForm.srchdomain.length; i++) {
7271: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7272: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7273: }
7274: }
7275: }
7276: }
7277: ENDSCRIPT
1.558 albertel 7278:
1.556 raeburn 7279: }
7280:
1.555 raeburn 7281: my $output = <<"END_BLOCK";
1.556 raeburn 7282: <script type="text/javascript">
1.570 raeburn 7283: function validateEntry(callingForm) {
1.558 albertel 7284:
1.556 raeburn 7285: var checkok = 1;
1.558 albertel 7286: var srchin;
1.570 raeburn 7287: for (var i=0; i<callingForm.srchin.length; i++) {
7288: if ( callingForm.srchin[i].checked ) {
7289: srchin = callingForm.srchin[i].value;
1.558 albertel 7290: }
7291: }
7292:
1.570 raeburn 7293: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7294: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7295: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7296: var srchterm = callingForm.srchterm.value;
7297: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7298: var msg = "";
7299:
7300: if (srchterm == "") {
7301: checkok = 0;
1.571 raeburn 7302: msg += "$lt{'youm'}\\n";
1.556 raeburn 7303: }
7304:
1.569 raeburn 7305: if (srchtype== 'begins') {
7306: if (srchterm.length < 2) {
7307: checkok = 0;
1.571 raeburn 7308: msg += "$lt{'thte'}\\n";
1.569 raeburn 7309: }
7310: }
7311:
1.556 raeburn 7312: if (srchtype== 'contains') {
7313: if (srchterm.length < 3) {
7314: checkok = 0;
1.571 raeburn 7315: msg += "$lt{'thet'}\\n";
1.556 raeburn 7316: }
7317: }
7318: if (srchin == 'instd') {
7319: if (srchdomain == '') {
7320: checkok = 0;
1.571 raeburn 7321: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7322: }
7323: }
7324: if (srchin == 'dom') {
7325: if (srchdomain == '') {
7326: checkok = 0;
1.571 raeburn 7327: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7328: }
7329: }
7330: if (srchby == 'lastfirst') {
7331: if (srchterm.indexOf(",") == -1) {
7332: checkok = 0;
1.571 raeburn 7333: msg += "$lt{'whus'}\\n";
1.556 raeburn 7334: }
7335: if (srchterm.indexOf(",") == srchterm.length -1) {
7336: checkok = 0;
1.571 raeburn 7337: msg += "$lt{'whse'}\\n";
1.556 raeburn 7338: }
7339: }
7340: if (checkok == 0) {
1.571 raeburn 7341: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7342: return;
7343: }
7344: if (checkok == 1) {
1.570 raeburn 7345: callingForm.submit();
1.556 raeburn 7346: }
7347: }
7348:
7349: $newuserscript
7350:
7351: </script>
1.558 albertel 7352:
7353: $new_user_create
7354:
1.555 raeburn 7355: <table>
1.558 albertel 7356: <tr>
1.573 raeburn 7357: <td>$lt{'doma'}:</td>
7358: <td>$domform</td>
7359: </td>
7360: </tr>
7361: <tr>
7362: <td>$lt{'usr'}:</td>
1.563 raeburn 7363: <td>$srchbysel
7364: $srchtypesel
7365: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7366: $srchinsel
1.563 raeburn 7367: </td>
7368: </tr>
1.555 raeburn 7369: </table>
7370: <br />
7371: END_BLOCK
1.558 albertel 7372:
1.555 raeburn 7373: return $output;
7374: }
7375:
1.612 raeburn 7376: sub user_rule_check {
1.615 raeburn 7377: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7378: my $response;
7379: if (ref($usershash) eq 'HASH') {
7380: foreach my $user (keys(%{$usershash})) {
7381: my ($uname,$udom) = split(/:/,$user);
7382: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7383: my ($id,$newuser);
1.612 raeburn 7384: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7385: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7386: $id = $usershash->{$user}->{'id'};
7387: }
7388: my $inst_response;
7389: if (ref($checks) eq 'HASH') {
7390: if (defined($checks->{'username'})) {
1.615 raeburn 7391: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7392: &Apache::lonnet::get_instuser($udom,$uname);
7393: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7394: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7395: &Apache::lonnet::get_instuser($udom,undef,$id);
7396: }
1.615 raeburn 7397: } else {
7398: ($inst_response,%{$inst_results->{$user}}) =
7399: &Apache::lonnet::get_instuser($udom,$uname);
7400: return;
1.612 raeburn 7401: }
1.615 raeburn 7402: if (!$got_rules->{$udom}) {
1.612 raeburn 7403: my %domconfig = &Apache::lonnet::get_dom('configuration',
7404: ['usercreation'],$udom);
7405: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7406: foreach my $item ('username','id') {
1.612 raeburn 7407: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7408: $$curr_rules{$udom}{$item} =
7409: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7410: }
7411: }
7412: }
1.615 raeburn 7413: $got_rules->{$udom} = 1;
1.585 raeburn 7414: }
1.612 raeburn 7415: foreach my $item (keys(%{$checks})) {
7416: if (ref($$curr_rules{$udom}) eq 'HASH') {
7417: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7418: if (@{$$curr_rules{$udom}{$item}} > 0) {
7419: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7420: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7421: if ($rule_check{$rule}) {
7422: $$rulematch{$user}{$item} = $rule;
7423: if ($inst_response eq 'ok') {
1.615 raeburn 7424: if (ref($inst_results) eq 'HASH') {
7425: if (ref($inst_results->{$user}) eq 'HASH') {
7426: if (keys(%{$inst_results->{$user}}) == 0) {
7427: $$alerts{$item}{$udom}{$uname} = 1;
7428: }
1.612 raeburn 7429: }
7430: }
1.615 raeburn 7431: }
7432: last;
1.585 raeburn 7433: }
7434: }
7435: }
7436: }
7437: }
7438: }
7439: }
7440: }
1.612 raeburn 7441: return;
7442: }
7443:
7444: sub user_rule_formats {
7445: my ($domain,$domdesc,$curr_rules,$check) = @_;
7446: my %text = (
7447: 'username' => 'Usernames',
7448: 'id' => 'IDs',
7449: );
7450: my $output;
7451: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7452: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7453: if (@{$ruleorder} > 0) {
7454: $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>';
7455: foreach my $rule (@{$ruleorder}) {
7456: if (ref($curr_rules) eq 'ARRAY') {
7457: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7458: if (ref($rules->{$rule}) eq 'HASH') {
7459: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7460: $rules->{$rule}{'desc'}.'</li>';
7461: }
7462: }
7463: }
7464: }
7465: $output .= '</ul>';
7466: }
7467: }
7468: return $output;
7469: }
7470:
7471: sub instrule_disallow_msg {
1.615 raeburn 7472: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7473: my $response;
7474: my %text = (
7475: item => 'username',
7476: items => 'usernames',
7477: match => 'matches',
7478: do => 'does',
7479: action => 'a username',
7480: one => 'one',
7481: );
7482: if ($count > 1) {
7483: $text{'item'} = 'usernames';
7484: $text{'match'} ='match';
7485: $text{'do'} = 'do';
7486: $text{'action'} = 'usernames',
7487: $text{'one'} = 'ones';
7488: }
7489: if ($checkitem eq 'id') {
7490: $text{'items'} = 'IDs';
7491: $text{'item'} = 'ID';
7492: $text{'action'} = 'an ID';
1.615 raeburn 7493: if ($count > 1) {
7494: $text{'item'} = 'IDs';
7495: $text{'action'} = 'IDs';
7496: }
1.612 raeburn 7497: }
1.674 bisitz 7498: $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 7499: if ($mode eq 'upload') {
7500: if ($checkitem eq 'username') {
7501: $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'}.");
7502: } elsif ($checkitem eq 'id') {
1.674 bisitz 7503: $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 7504: }
1.669 raeburn 7505: } elsif ($mode eq 'selfcreate') {
7506: if ($checkitem eq 'id') {
7507: $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.");
7508: }
1.615 raeburn 7509: } else {
7510: if ($checkitem eq 'username') {
7511: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7512: } elsif ($checkitem eq 'id') {
7513: $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.");
7514: }
1.612 raeburn 7515: }
7516: return $response;
1.585 raeburn 7517: }
7518:
1.624 raeburn 7519: sub personal_data_fieldtitles {
7520: my %fieldtitles = &Apache::lonlocal::texthash (
7521: id => 'Student/Employee ID',
7522: permanentemail => 'E-mail address',
7523: lastname => 'Last Name',
7524: firstname => 'First Name',
7525: middlename => 'Middle Name',
7526: generation => 'Generation',
7527: gen => 'Generation',
1.765 raeburn 7528: inststatus => 'Affiliation',
1.624 raeburn 7529: );
7530: return %fieldtitles;
7531: }
7532:
1.642 raeburn 7533: sub sorted_inst_types {
7534: my ($dom) = @_;
7535: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7536: my $othertitle = &mt('All users');
7537: if ($env{'request.course.id'}) {
1.668 raeburn 7538: $othertitle = &mt('Any users');
1.642 raeburn 7539: }
7540: my @types;
7541: if (ref($order) eq 'ARRAY') {
7542: @types = @{$order};
7543: }
7544: if (@types == 0) {
7545: if (ref($usertypes) eq 'HASH') {
7546: @types = sort(keys(%{$usertypes}));
7547: }
7548: }
7549: if (keys(%{$usertypes}) > 0) {
7550: $othertitle = &mt('Other users');
7551: }
7552: return ($othertitle,$usertypes,\@types);
7553: }
7554:
1.645 raeburn 7555: sub get_institutional_codes {
7556: my ($settings,$allcourses,$LC_code) = @_;
7557: # Get complete list of course sections to update
7558: my @currsections = ();
7559: my @currxlists = ();
7560: my $coursecode = $$settings{'internal.coursecode'};
7561:
7562: if ($$settings{'internal.sectionnums'} ne '') {
7563: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7564: }
7565:
7566: if ($$settings{'internal.crosslistings'} ne '') {
7567: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7568: }
7569:
7570: if (@currxlists > 0) {
7571: foreach (@currxlists) {
7572: if (m/^([^:]+):(\w*)$/) {
7573: unless (grep/^$1$/,@{$allcourses}) {
7574: push @{$allcourses},$1;
7575: $$LC_code{$1} = $2;
7576: }
7577: }
7578: }
7579: }
7580:
7581: if (@currsections > 0) {
7582: foreach (@currsections) {
7583: if (m/^(\w+):(\w*)$/) {
7584: my $sec = $coursecode.$1;
7585: my $lc_sec = $2;
7586: unless (grep/^$sec$/,@{$allcourses}) {
7587: push @{$allcourses},$sec;
7588: $$LC_code{$sec} = $lc_sec;
7589: }
7590: }
7591: }
7592: }
7593: return;
7594: }
7595:
1.112 bowersj2 7596: =pod
7597:
1.780 raeburn 7598: =head1 Slot Helpers
7599:
7600: =over 4
7601:
7602: =item * sorted_slots()
7603:
7604: Sorts an array of slot names in order of slot start time (earliest first).
7605:
7606: Inputs:
7607:
7608: =over 4
7609:
7610: slotsarr - Reference to array of unsorted slot names.
7611:
7612: slots - Reference to hash of hash, where outer hash keys are slot names.
7613:
1.549 albertel 7614: =back
7615:
1.780 raeburn 7616: Returns:
7617:
7618: =over 4
7619:
7620: sorted - An array of slot names sorted by the start time of the slot.
7621:
7622: =back
7623:
7624: =back
7625:
7626: =cut
7627:
7628:
7629: sub sorted_slots {
7630: my ($slotsarr,$slots) = @_;
7631: my @sorted;
7632: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
7633: @sorted =
7634: sort {
7635: if (ref($slots->{$a}) && ref($slots->{$b})) {
7636: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
7637: }
7638: if (ref($slots->{$a})) { return -1;}
7639: if (ref($slots->{$b})) { return 1;}
7640: return 0;
7641: } @{$slotsarr};
7642: }
7643: return @sorted;
7644: }
7645:
7646:
7647: =pod
7648:
1.549 albertel 7649: =head1 HTTP Helpers
7650:
7651: =over 4
7652:
1.648 raeburn 7653: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7654:
1.258 albertel 7655: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7656: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7657: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7658:
7659: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7660: $possible_names is an ref to an array of form element names. As an example:
7661: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7662: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7663:
7664: =cut
1.1 albertel 7665:
1.6 albertel 7666: sub get_unprocessed_cgi {
1.25 albertel 7667: my ($query,$possible_names)= @_;
1.26 matthew 7668: # $Apache::lonxml::debug=1;
1.356 albertel 7669: foreach my $pair (split(/&/,$query)) {
7670: my ($name, $value) = split(/=/,$pair);
1.369 www 7671: $name = &unescape($name);
1.25 albertel 7672: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7673: $value =~ tr/+/ /;
7674: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7675: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7676: }
1.16 harris41 7677: }
1.6 albertel 7678: }
7679:
1.112 bowersj2 7680: =pod
7681:
1.648 raeburn 7682: =item * &cacheheader()
1.112 bowersj2 7683:
7684: returns cache-controlling header code
7685:
7686: =cut
7687:
1.7 albertel 7688: sub cacheheader {
1.258 albertel 7689: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7690: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7691: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7692: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7693: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7694: return $output;
1.7 albertel 7695: }
7696:
1.112 bowersj2 7697: =pod
7698:
1.648 raeburn 7699: =item * &no_cache($r)
1.112 bowersj2 7700:
7701: specifies header code to not have cache
7702:
7703: =cut
7704:
1.9 albertel 7705: sub no_cache {
1.216 albertel 7706: my ($r) = @_;
7707: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7708: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7709: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7710: $r->no_cache(1);
7711: $r->header_out("Expires" => $date);
7712: $r->header_out("Pragma" => "no-cache");
1.123 www 7713: }
7714:
7715: sub content_type {
1.181 albertel 7716: my ($r,$type,$charset) = @_;
1.299 foxr 7717: if ($r) {
7718: # Note that printout.pl calls this with undef for $r.
7719: &no_cache($r);
7720: }
1.258 albertel 7721: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7722: unless ($charset) {
7723: $charset=&Apache::lonlocal::current_encoding;
7724: }
7725: if ($charset) { $type.='; charset='.$charset; }
7726: if ($r) {
7727: $r->content_type($type);
7728: } else {
7729: print("Content-type: $type\n\n");
7730: }
1.9 albertel 7731: }
1.25 albertel 7732:
1.112 bowersj2 7733: =pod
7734:
1.648 raeburn 7735: =item * &add_to_env($name,$value)
1.112 bowersj2 7736:
1.258 albertel 7737: adds $name to the %env hash with value
1.112 bowersj2 7738: $value, if $name already exists, the entry is converted to an array
7739: reference and $value is added to the array.
7740:
7741: =cut
7742:
1.25 albertel 7743: sub add_to_env {
7744: my ($name,$value)=@_;
1.258 albertel 7745: if (defined($env{$name})) {
7746: if (ref($env{$name})) {
1.25 albertel 7747: #already have multiple values
1.258 albertel 7748: push(@{ $env{$name} },$value);
1.25 albertel 7749: } else {
7750: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7751: my $first=$env{$name};
7752: undef($env{$name});
7753: push(@{ $env{$name} },$first,$value);
1.25 albertel 7754: }
7755: } else {
1.258 albertel 7756: $env{$name}=$value;
1.25 albertel 7757: }
1.31 albertel 7758: }
1.149 albertel 7759:
7760: =pod
7761:
1.648 raeburn 7762: =item * &get_env_multiple($name)
1.149 albertel 7763:
1.258 albertel 7764: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7765: values may be defined and end up as an array ref.
7766:
7767: returns an array of values
7768:
7769: =cut
7770:
7771: sub get_env_multiple {
7772: my ($name) = @_;
7773: my @values;
1.258 albertel 7774: if (defined($env{$name})) {
1.149 albertel 7775: # exists is it an array
1.258 albertel 7776: if (ref($env{$name})) {
7777: @values=@{ $env{$name} };
1.149 albertel 7778: } else {
1.258 albertel 7779: $values[0]=$env{$name};
1.149 albertel 7780: }
7781: }
7782: return(@values);
7783: }
7784:
1.660 raeburn 7785: sub ask_for_embedded_content {
7786: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7787: my $upload_output = '
7788: <form name="upload_embedded" action="'.$actionurl.'"
7789: method="post" enctype="multipart/form-data">';
7790: $upload_output .= $state;
1.661 raeburn 7791: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7792:
7793: my $num = 0;
7794: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7795: $upload_output .= &start_data_table_row().
7796: '<td>'.$embed_file.'</td><td>';
7797: if ($args->{'ignore_remote_references'}
7798: && $embed_file =~ m{^\w+://}) {
7799: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7800: } elsif ($args->{'error_on_invalid_names'}
7801: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7802:
7803: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7804:
7805: } else {
7806: $upload_output .='
1.661 raeburn 7807: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7808: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7809: my $attrib = join(':',@{$$allfiles{$embed_file}});
7810: $upload_output .=
7811: "\n\t\t".
7812: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7813: $attrib.'" />';
7814: if (exists($$codebase{$embed_file})) {
7815: $upload_output .=
7816: "\n\t\t".
7817: '<input name="codebase_'.$num.'" type="hidden" value="'.
7818: &escape($$codebase{$embed_file}).'" />';
7819: }
7820: }
7821: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7822: $num++;
7823: }
7824: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7825: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7826: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7827: '.&mt('(only files for which a location has been provided will be uploaded)').'
7828: </form>';
7829: return $upload_output;
7830: }
7831:
1.661 raeburn 7832: sub upload_embedded {
7833: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7834: $current_disk_usage) = @_;
7835: my $output;
7836: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7837: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7838: my $orig_uploaded_filename =
7839: $env{'form.embedded_item_'.$i.'.filename'};
7840:
7841: $env{'form.embedded_orig_'.$i} =
7842: &unescape($env{'form.embedded_orig_'.$i});
7843: my ($path,$fname) =
7844: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7845: # no path, whole string is fname
7846: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7847:
7848: $path = $env{'form.currentpath'}.$path;
7849: $fname = &Apache::lonnet::clean_filename($fname);
7850: # See if there is anything left
7851: next if ($fname eq '');
7852:
7853: # Check if file already exists as a file or directory.
7854: my ($state,$msg);
7855: if ($context eq 'portfolio') {
7856: my $port_path = $dirpath;
7857: if ($group ne '') {
7858: $port_path = "groups/$group/$port_path";
7859: }
7860: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7861: $dir_root,$port_path,$disk_quota,
7862: $current_disk_usage,$uname,$udom);
7863: if ($state eq 'will_exceed_quota'
7864: || $state eq 'file_locked'
7865: || $state eq 'file_exists' ) {
7866: $output .= $msg;
7867: next;
7868: }
7869: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7870: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7871: if ($state eq 'exists') {
7872: $output .= $msg;
7873: next;
7874: }
7875: }
7876: # Check if extension is valid
7877: if (($fname =~ /\.(\w+)$/) &&
7878: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7879: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7880: next;
7881: } elsif (($fname =~ /\.(\w+)$/) &&
7882: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7883: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7884: next;
7885: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7886: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7887: next;
7888: }
7889:
7890: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7891: if ($context eq 'portfolio') {
7892: my $result=
7893: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7894: $dirpath.$path);
7895: if ($result !~ m|^/uploaded/|) {
7896: $output .= '<span class="LC_error">'
7897: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7898: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7899: .'</span><br />';
7900: next;
7901: } else {
7902: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7903: $path.$fname.'</span>').'</p>';
7904: }
7905: } else {
7906: # Save the file
7907: my $target = $env{'form.embedded_item_'.$i};
7908: my $fullpath = $dir_root.$dirpath.'/'.$path;
7909: my $dest = $fullpath.$fname;
7910: my $url = $url_root.$dirpath.'/'.$path.$fname;
7911: my @parts=split(/\//,$fullpath);
7912: my $count;
7913: my $filepath = $dir_root;
7914: for ($count=4;$count<=$#parts;$count++) {
7915: $filepath .= "/$parts[$count]";
7916: if ((-e $filepath)!=1) {
7917: mkdir($filepath,0770);
7918: }
7919: }
7920: my $fh;
7921: if (!open($fh,'>'.$dest)) {
7922: &Apache::lonnet::logthis('Failed to create '.$dest);
7923: $output .= '<span class="LC_error">'.
7924: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7925: '</span><br />';
7926: } else {
7927: if (!print $fh $env{'form.embedded_item_'.$i}) {
7928: &Apache::lonnet::logthis('Failed to write to '.$dest);
7929: $output .= '<span class="LC_error">'.
7930: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7931: '</span><br />';
7932: } else {
7933: if ($context eq 'testbank') {
7934: $output .= &mt('Embedded file uploaded successfully:').
7935: ' <a href="'.$url.'">'.
7936: $orig_uploaded_filename.'</a><br />';
7937: } else {
1.705 tempelho 7938: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7939: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7940: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7941: }
7942: }
7943: close($fh);
7944: }
7945: }
7946: }
7947: return $output;
7948: }
7949:
7950: sub check_for_existing {
7951: my ($path,$fname,$element) = @_;
7952: my ($state,$msg);
7953: if (-d $path.'/'.$fname) {
7954: $state = 'exists';
7955: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7956: } elsif (-e $path.'/'.$fname) {
7957: $state = 'exists';
7958: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7959: }
7960: if ($state eq 'exists') {
7961: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7962: }
7963: return ($state,$msg);
7964: }
7965:
7966: sub check_for_upload {
7967: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7968: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7969: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7970: my $getpropath = 1;
7971: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7972: $getpropath);
7973: my $found_file = 0;
7974: my $locked_file = 0;
7975: foreach my $line (@dir_list) {
7976: my ($file_name)=split(/\&/,$line,2);
7977: if ($file_name eq $fname){
7978: $file_name = $path.$file_name;
7979: if ($group ne '') {
7980: $file_name = $group.$file_name;
7981: }
7982: $found_file = 1;
7983: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7984: $locked_file = 1;
7985: }
7986: }
7987: }
7988: if (($current_disk_usage + $filesize) > $disk_quota){
7989: my $msg = '<span class="LC_error">'.
7990: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7991: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7992: return ('will_exceed_quota',$msg);
7993: } elsif ($found_file) {
7994: if ($locked_file) {
7995: my $msg = '<span class="LC_error">';
7996: $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>');
7997: $msg .= '</span><br />';
7998: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7999: return ('file_locked',$msg);
8000: } else {
8001: my $msg = '<span class="LC_error">';
8002: $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'});
8003: $msg .= '</span>';
8004: $msg .= '<br />';
8005: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
8006: return ('file_exists',$msg);
8007: }
8008: }
8009: }
8010:
1.31 albertel 8011:
1.41 ng 8012: =pod
1.45 matthew 8013:
1.464 albertel 8014: =back
1.41 ng 8015:
1.112 bowersj2 8016: =head1 CSV Upload/Handling functions
1.38 albertel 8017:
1.41 ng 8018: =over 4
8019:
1.648 raeburn 8020: =item * &upfile_store($r)
1.41 ng 8021:
8022: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 8023: needs $env{'form.upfile'}
1.41 ng 8024: returns $datatoken to be put into hidden field
8025:
8026: =cut
1.31 albertel 8027:
8028: sub upfile_store {
8029: my $r=shift;
1.258 albertel 8030: $env{'form.upfile'}=~s/\r/\n/gs;
8031: $env{'form.upfile'}=~s/\f/\n/gs;
8032: $env{'form.upfile'}=~s/\n+/\n/gs;
8033: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 8034:
1.258 albertel 8035: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
8036: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 8037: {
1.158 raeburn 8038: my $datafile = $r->dir_config('lonDaemons').
8039: '/tmp/'.$datatoken.'.tmp';
8040: if ( open(my $fh,">$datafile") ) {
1.258 albertel 8041: print $fh $env{'form.upfile'};
1.158 raeburn 8042: close($fh);
8043: }
1.31 albertel 8044: }
8045: return $datatoken;
8046: }
8047:
1.56 matthew 8048: =pod
8049:
1.648 raeburn 8050: =item * &load_tmp_file($r)
1.41 ng 8051:
8052: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 8053: needs $env{'form.datatoken'},
8054: sets $env{'form.upfile'} to the contents of the file
1.41 ng 8055:
8056: =cut
1.31 albertel 8057:
8058: sub load_tmp_file {
8059: my $r=shift;
8060: my @studentdata=();
8061: {
1.158 raeburn 8062: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 8063: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 8064: if ( open(my $fh,"<$studentfile") ) {
8065: @studentdata=<$fh>;
8066: close($fh);
8067: }
1.31 albertel 8068: }
1.258 albertel 8069: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 8070: }
8071:
1.56 matthew 8072: =pod
8073:
1.648 raeburn 8074: =item * &upfile_record_sep()
1.41 ng 8075:
8076: Separate uploaded file into records
8077: returns array of records,
1.258 albertel 8078: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8079:
8080: =cut
1.31 albertel 8081:
8082: sub upfile_record_sep {
1.258 albertel 8083: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8084: } else {
1.248 albertel 8085: my @records;
1.258 albertel 8086: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8087: if ($line=~/^\s*$/) { next; }
8088: push(@records,$line);
8089: }
8090: return @records;
1.31 albertel 8091: }
8092: }
8093:
1.56 matthew 8094: =pod
8095:
1.648 raeburn 8096: =item * &record_sep($record)
1.41 ng 8097:
1.258 albertel 8098: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8099:
8100: =cut
8101:
1.263 www 8102: sub takeleft {
8103: my $index=shift;
8104: return substr('0000'.$index,-4,4);
8105: }
8106:
1.31 albertel 8107: sub record_sep {
8108: my $record=shift;
8109: my %components=();
1.258 albertel 8110: if ($env{'form.upfiletype'} eq 'xml') {
8111: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8112: my $i=0;
1.356 albertel 8113: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8114: $field=~s/^(\"|\')//;
8115: $field=~s/(\"|\')$//;
1.263 www 8116: $components{&takeleft($i)}=$field;
1.31 albertel 8117: $i++;
8118: }
1.258 albertel 8119: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8120: my $i=0;
1.356 albertel 8121: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8122: $field=~s/^(\"|\')//;
8123: $field=~s/(\"|\')$//;
1.263 www 8124: $components{&takeleft($i)}=$field;
1.31 albertel 8125: $i++;
8126: }
8127: } else {
1.561 www 8128: my $separator=',';
1.480 banghart 8129: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8130: $separator=';';
1.480 banghart 8131: }
1.31 albertel 8132: my $i=0;
1.561 www 8133: # the character we are looking for to indicate the end of a quote or a record
8134: my $looking_for=$separator;
8135: # do not add the characters to the fields
8136: my $ignore=0;
8137: # we just encountered a separator (or the beginning of the record)
8138: my $just_found_separator=1;
8139: # store the field we are working on here
8140: my $field='';
8141: # work our way through all characters in record
8142: foreach my $character ($record=~/(.)/g) {
8143: if ($character eq $looking_for) {
8144: if ($character ne $separator) {
8145: # Found the end of a quote, again looking for separator
8146: $looking_for=$separator;
8147: $ignore=1;
8148: } else {
8149: # Found a separator, store away what we got
8150: $components{&takeleft($i)}=$field;
8151: $i++;
8152: $just_found_separator=1;
8153: $ignore=0;
8154: $field='';
8155: }
8156: next;
8157: }
8158: # single or double quotation marks after a separator indicate beginning of a quote
8159: # we are now looking for the end of the quote and need to ignore separators
8160: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8161: $looking_for=$character;
8162: next;
8163: }
8164: # ignore would be true after we reached the end of a quote
8165: if ($ignore) { next; }
8166: if (($just_found_separator) && ($character=~/\s/)) { next; }
8167: $field.=$character;
8168: $just_found_separator=0;
1.31 albertel 8169: }
1.561 www 8170: # catch the very last entry, since we never encountered the separator
8171: $components{&takeleft($i)}=$field;
1.31 albertel 8172: }
8173: return %components;
8174: }
8175:
1.144 matthew 8176: ######################################################
8177: ######################################################
8178:
1.56 matthew 8179: =pod
8180:
1.648 raeburn 8181: =item * &upfile_select_html()
1.41 ng 8182:
1.144 matthew 8183: Return HTML code to select a file from the users machine and specify
8184: the file type.
1.41 ng 8185:
8186: =cut
8187:
1.144 matthew 8188: ######################################################
8189: ######################################################
1.31 albertel 8190: sub upfile_select_html {
1.144 matthew 8191: my %Types = (
8192: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8193: semisv => &mt('Semicolon separated values'),
1.144 matthew 8194: space => &mt('Space separated'),
8195: tab => &mt('Tabulator separated'),
8196: # xml => &mt('HTML/XML'),
8197: );
8198: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8199: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8200: foreach my $type (sort(keys(%Types))) {
8201: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8202: }
8203: $Str .= "</select>\n";
8204: return $Str;
1.31 albertel 8205: }
8206:
1.301 albertel 8207: sub get_samples {
8208: my ($records,$toget) = @_;
8209: my @samples=({});
8210: my $got=0;
8211: foreach my $rec (@$records) {
8212: my %temp = &record_sep($rec);
8213: if (! grep(/\S/, values(%temp))) { next; }
8214: if (%temp) {
8215: $samples[$got]=\%temp;
8216: $got++;
8217: if ($got == $toget) { last; }
8218: }
8219: }
8220: return \@samples;
8221: }
8222:
1.144 matthew 8223: ######################################################
8224: ######################################################
8225:
1.56 matthew 8226: =pod
8227:
1.648 raeburn 8228: =item * &csv_print_samples($r,$records)
1.41 ng 8229:
8230: Prints a table of sample values from each column uploaded $r is an
8231: Apache Request ref, $records is an arrayref from
8232: &Apache::loncommon::upfile_record_sep
8233:
8234: =cut
8235:
1.144 matthew 8236: ######################################################
8237: ######################################################
1.31 albertel 8238: sub csv_print_samples {
8239: my ($r,$records) = @_;
1.662 bisitz 8240: my $samples = &get_samples($records,5);
1.301 albertel 8241:
1.594 raeburn 8242: $r->print(&mt('Samples').'<br />'.&start_data_table().
8243: &start_data_table_header_row());
1.356 albertel 8244: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8245: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8246: $r->print(&end_data_table_header_row());
1.301 albertel 8247: foreach my $hash (@$samples) {
1.594 raeburn 8248: $r->print(&start_data_table_row());
1.356 albertel 8249: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8250: $r->print('<td>');
1.356 albertel 8251: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8252: $r->print('</td>');
8253: }
1.594 raeburn 8254: $r->print(&end_data_table_row());
1.31 albertel 8255: }
1.594 raeburn 8256: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8257: }
8258:
1.144 matthew 8259: ######################################################
8260: ######################################################
8261:
1.56 matthew 8262: =pod
8263:
1.648 raeburn 8264: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8265:
8266: Prints a table to create associations between values and table columns.
1.144 matthew 8267:
1.41 ng 8268: $r is an Apache Request ref,
8269: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8270: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8271:
8272: =cut
8273:
1.144 matthew 8274: ######################################################
8275: ######################################################
1.31 albertel 8276: sub csv_print_select_table {
8277: my ($r,$records,$d) = @_;
1.301 albertel 8278: my $i=0;
8279: my $samples = &get_samples($records,1);
1.144 matthew 8280: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8281: &start_data_table().&start_data_table_header_row().
1.144 matthew 8282: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8283: '<th>'.&mt('Column').'</th>'.
8284: &end_data_table_header_row()."\n");
1.356 albertel 8285: foreach my $array_ref (@$d) {
8286: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8287: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8288:
8289: $r->print('<td><select name=f'.$i.
1.32 matthew 8290: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8291: $r->print('<option value="none"></option>');
1.356 albertel 8292: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8293: $r->print('<option value="'.$sample.'"'.
8294: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8295: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8296: }
1.594 raeburn 8297: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8298: $i++;
8299: }
1.594 raeburn 8300: $r->print(&end_data_table());
1.31 albertel 8301: $i--;
8302: return $i;
8303: }
1.56 matthew 8304:
1.144 matthew 8305: ######################################################
8306: ######################################################
8307:
1.56 matthew 8308: =pod
1.31 albertel 8309:
1.648 raeburn 8310: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8311:
8312: Prints a table of sample values from the upload and can make associate samples to internal names.
8313:
8314: $r is an Apache Request ref,
8315: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8316: $d is an array of 2 element arrays (internal name, displayed name)
8317:
8318: =cut
8319:
1.144 matthew 8320: ######################################################
8321: ######################################################
1.31 albertel 8322: sub csv_samples_select_table {
8323: my ($r,$records,$d) = @_;
8324: my $i=0;
1.144 matthew 8325: #
1.662 bisitz 8326: my $max_samples = 5;
8327: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8328: $r->print(&start_data_table().
8329: &start_data_table_header_row().'<th>'.
8330: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8331: &end_data_table_header_row());
1.301 albertel 8332:
8333: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8334: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8335: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8336: foreach my $option (@$d) {
8337: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8338: $r->print('<option value="'.$value.'"'.
1.253 albertel 8339: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8340: $display.'</option>');
1.31 albertel 8341: }
8342: $r->print('</select></td><td>');
1.662 bisitz 8343: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8344: if (defined($samples->[$line]{$key})) {
8345: $r->print($samples->[$line]{$key}."<br />\n");
8346: }
8347: }
1.594 raeburn 8348: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8349: $i++;
8350: }
1.594 raeburn 8351: $r->print(&end_data_table());
1.31 albertel 8352: $i--;
8353: return($i);
1.115 matthew 8354: }
8355:
1.144 matthew 8356: ######################################################
8357: ######################################################
8358:
1.115 matthew 8359: =pod
8360:
1.648 raeburn 8361: =item * &clean_excel_name($name)
1.115 matthew 8362:
8363: Returns a replacement for $name which does not contain any illegal characters.
8364:
8365: =cut
8366:
1.144 matthew 8367: ######################################################
8368: ######################################################
1.115 matthew 8369: sub clean_excel_name {
8370: my ($name) = @_;
8371: $name =~ s/[:\*\?\/\\]//g;
8372: if (length($name) > 31) {
8373: $name = substr($name,0,31);
8374: }
8375: return $name;
1.25 albertel 8376: }
1.84 albertel 8377:
1.85 albertel 8378: =pod
8379:
1.648 raeburn 8380: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8381:
8382: Returns either 1 or undef
8383:
8384: 1 if the part is to be hidden, undef if it is to be shown
8385:
8386: Arguments are:
8387:
8388: $id the id of the part to be checked
8389: $symb, optional the symb of the resource to check
8390: $udom, optional the domain of the user to check for
8391: $uname, optional the username of the user to check for
8392:
8393: =cut
1.84 albertel 8394:
8395: sub check_if_partid_hidden {
8396: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8397: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8398: $symb,$udom,$uname);
1.141 albertel 8399: my $truth=1;
8400: #if the string starts with !, then the list is the list to show not hide
8401: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8402: my @hiddenlist=split(/,/,$hiddenparts);
8403: foreach my $checkid (@hiddenlist) {
1.141 albertel 8404: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8405: }
1.141 albertel 8406: return !$truth;
1.84 albertel 8407: }
1.127 matthew 8408:
1.138 matthew 8409:
8410: ############################################################
8411: ############################################################
8412:
8413: =pod
8414:
1.157 matthew 8415: =back
8416:
1.138 matthew 8417: =head1 cgi-bin script and graphing routines
8418:
1.157 matthew 8419: =over 4
8420:
1.648 raeburn 8421: =item * &get_cgi_id()
1.138 matthew 8422:
8423: Inputs: none
8424:
8425: Returns an id which can be used to pass environment variables
8426: to various cgi-bin scripts. These environment variables will
8427: be removed from the users environment after a given time by
8428: the routine &Apache::lonnet::transfer_profile_to_env.
8429:
8430: =cut
8431:
8432: ############################################################
8433: ############################################################
1.152 albertel 8434: my $uniq=0;
1.136 matthew 8435: sub get_cgi_id {
1.154 albertel 8436: $uniq=($uniq+1)%100000;
1.280 albertel 8437: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8438: }
8439:
1.127 matthew 8440: ############################################################
8441: ############################################################
8442:
8443: =pod
8444:
1.648 raeburn 8445: =item * &DrawBarGraph()
1.127 matthew 8446:
1.138 matthew 8447: Facilitates the plotting of data in a (stacked) bar graph.
8448: Puts plot definition data into the users environment in order for
8449: graph.png to plot it. Returns an <img> tag for the plot.
8450: The bars on the plot are labeled '1','2',...,'n'.
8451:
8452: Inputs:
8453:
8454: =over 4
8455:
8456: =item $Title: string, the title of the plot
8457:
8458: =item $xlabel: string, text describing the X-axis of the plot
8459:
8460: =item $ylabel: string, text describing the Y-axis of the plot
8461:
8462: =item $Max: scalar, the maximum Y value to use in the plot
8463: If $Max is < any data point, the graph will not be rendered.
8464:
1.140 matthew 8465: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8466: they are plotted. If undefined, default values will be used.
8467:
1.178 matthew 8468: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8469:
1.138 matthew 8470: =item @Values: An array of array references. Each array reference holds data
8471: to be plotted in a stacked bar chart.
8472:
1.239 matthew 8473: =item If the final element of @Values is a hash reference the key/value
8474: pairs will be added to the graph definition.
8475:
1.138 matthew 8476: =back
8477:
8478: Returns:
8479:
8480: An <img> tag which references graph.png and the appropriate identifying
8481: information for the plot.
8482:
1.127 matthew 8483: =cut
8484:
8485: ############################################################
8486: ############################################################
1.134 matthew 8487: sub DrawBarGraph {
1.178 matthew 8488: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8489: #
8490: if (! defined($colors)) {
8491: $colors = ['#33ff00',
8492: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8493: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8494: ];
8495: }
1.228 matthew 8496: my $extra_settings = {};
8497: if (ref($Values[-1]) eq 'HASH') {
8498: $extra_settings = pop(@Values);
8499: }
1.127 matthew 8500: #
1.136 matthew 8501: my $identifier = &get_cgi_id();
8502: my $id = 'cgi.'.$identifier;
1.129 matthew 8503: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8504: return '';
8505: }
1.225 matthew 8506: #
8507: my @Labels;
8508: if (defined($labels)) {
8509: @Labels = @$labels;
8510: } else {
8511: for (my $i=0;$i<@{$Values[0]};$i++) {
8512: push (@Labels,$i+1);
8513: }
8514: }
8515: #
1.129 matthew 8516: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8517: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8518: my %ValuesHash;
8519: my $NumSets=1;
8520: foreach my $array (@Values) {
8521: next if (! ref($array));
1.136 matthew 8522: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8523: join(',',@$array);
1.129 matthew 8524: }
1.127 matthew 8525: #
1.136 matthew 8526: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8527: if ($NumBars < 3) {
8528: $width = 120+$NumBars*32;
1.220 matthew 8529: $xskip = 1;
1.225 matthew 8530: $bar_width = 30;
8531: } elsif ($NumBars < 5) {
8532: $width = 120+$NumBars*20;
8533: $xskip = 1;
8534: $bar_width = 20;
1.220 matthew 8535: } elsif ($NumBars < 10) {
1.136 matthew 8536: $width = 120+$NumBars*15;
8537: $xskip = 1;
8538: $bar_width = 15;
8539: } elsif ($NumBars <= 25) {
8540: $width = 120+$NumBars*11;
8541: $xskip = 5;
8542: $bar_width = 8;
8543: } elsif ($NumBars <= 50) {
8544: $width = 120+$NumBars*8;
8545: $xskip = 5;
8546: $bar_width = 4;
8547: } else {
8548: $width = 120+$NumBars*8;
8549: $xskip = 5;
8550: $bar_width = 4;
8551: }
8552: #
1.137 matthew 8553: $Max = 1 if ($Max < 1);
8554: if ( int($Max) < $Max ) {
8555: $Max++;
8556: $Max = int($Max);
8557: }
1.127 matthew 8558: $Title = '' if (! defined($Title));
8559: $xlabel = '' if (! defined($xlabel));
8560: $ylabel = '' if (! defined($ylabel));
1.369 www 8561: $ValuesHash{$id.'.title'} = &escape($Title);
8562: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8563: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8564: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8565: $ValuesHash{$id.'.NumBars'} = $NumBars;
8566: $ValuesHash{$id.'.NumSets'} = $NumSets;
8567: $ValuesHash{$id.'.PlotType'} = 'bar';
8568: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8569: $ValuesHash{$id.'.height'} = $height;
8570: $ValuesHash{$id.'.width'} = $width;
8571: $ValuesHash{$id.'.xskip'} = $xskip;
8572: $ValuesHash{$id.'.bar_width'} = $bar_width;
8573: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8574: #
1.228 matthew 8575: # Deal with other parameters
8576: while (my ($key,$value) = each(%$extra_settings)) {
8577: $ValuesHash{$id.'.'.$key} = $value;
8578: }
8579: #
1.646 raeburn 8580: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8581: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8582: }
8583:
8584: ############################################################
8585: ############################################################
8586:
8587: =pod
8588:
1.648 raeburn 8589: =item * &DrawXYGraph()
1.137 matthew 8590:
1.138 matthew 8591: Facilitates the plotting of data in an XY graph.
8592: Puts plot definition data into the users environment in order for
8593: graph.png to plot it. Returns an <img> tag for the plot.
8594:
8595: Inputs:
8596:
8597: =over 4
8598:
8599: =item $Title: string, the title of the plot
8600:
8601: =item $xlabel: string, text describing the X-axis of the plot
8602:
8603: =item $ylabel: string, text describing the Y-axis of the plot
8604:
8605: =item $Max: scalar, the maximum Y value to use in the plot
8606: If $Max is < any data point, the graph will not be rendered.
8607:
8608: =item $colors: Array ref containing the hex color codes for the data to be
8609: plotted in. If undefined, default values will be used.
8610:
8611: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8612:
8613: =item $Ydata: Array ref containing Array refs.
1.185 www 8614: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8615:
8616: =item %Values: hash indicating or overriding any default values which are
8617: passed to graph.png.
8618: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8619:
8620: =back
8621:
8622: Returns:
8623:
8624: An <img> tag which references graph.png and the appropriate identifying
8625: information for the plot.
8626:
1.137 matthew 8627: =cut
8628:
8629: ############################################################
8630: ############################################################
8631: sub DrawXYGraph {
8632: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8633: #
8634: # Create the identifier for the graph
8635: my $identifier = &get_cgi_id();
8636: my $id = 'cgi.'.$identifier;
8637: #
8638: $Title = '' if (! defined($Title));
8639: $xlabel = '' if (! defined($xlabel));
8640: $ylabel = '' if (! defined($ylabel));
8641: my %ValuesHash =
8642: (
1.369 www 8643: $id.'.title' => &escape($Title),
8644: $id.'.xlabel' => &escape($xlabel),
8645: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8646: $id.'.y_max_value'=> $Max,
8647: $id.'.labels' => join(',',@$Xlabels),
8648: $id.'.PlotType' => 'XY',
8649: );
8650: #
8651: if (defined($colors) && ref($colors) eq 'ARRAY') {
8652: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8653: }
8654: #
8655: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8656: return '';
8657: }
8658: my $NumSets=1;
1.138 matthew 8659: foreach my $array (@{$Ydata}){
1.137 matthew 8660: next if (! ref($array));
8661: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8662: }
1.138 matthew 8663: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8664: #
8665: # Deal with other parameters
8666: while (my ($key,$value) = each(%Values)) {
8667: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8668: }
8669: #
1.646 raeburn 8670: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8671: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8672: }
8673:
8674: ############################################################
8675: ############################################################
8676:
8677: =pod
8678:
1.648 raeburn 8679: =item * &DrawXYYGraph()
1.138 matthew 8680:
8681: Facilitates the plotting of data in an XY graph with two Y axes.
8682: Puts plot definition data into the users environment in order for
8683: graph.png to plot it. Returns an <img> tag for the plot.
8684:
8685: Inputs:
8686:
8687: =over 4
8688:
8689: =item $Title: string, the title of the plot
8690:
8691: =item $xlabel: string, text describing the X-axis of the plot
8692:
8693: =item $ylabel: string, text describing the Y-axis of the plot
8694:
8695: =item $colors: Array ref containing the hex color codes for the data to be
8696: plotted in. If undefined, default values will be used.
8697:
8698: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8699:
8700: =item $Ydata1: The first data set
8701:
8702: =item $Min1: The minimum value of the left Y-axis
8703:
8704: =item $Max1: The maximum value of the left Y-axis
8705:
8706: =item $Ydata2: The second data set
8707:
8708: =item $Min2: The minimum value of the right Y-axis
8709:
8710: =item $Max2: The maximum value of the left Y-axis
8711:
8712: =item %Values: hash indicating or overriding any default values which are
8713: passed to graph.png.
8714: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8715:
8716: =back
8717:
8718: Returns:
8719:
8720: An <img> tag which references graph.png and the appropriate identifying
8721: information for the plot.
1.136 matthew 8722:
8723: =cut
8724:
8725: ############################################################
8726: ############################################################
1.137 matthew 8727: sub DrawXYYGraph {
8728: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8729: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8730: #
8731: # Create the identifier for the graph
8732: my $identifier = &get_cgi_id();
8733: my $id = 'cgi.'.$identifier;
8734: #
8735: $Title = '' if (! defined($Title));
8736: $xlabel = '' if (! defined($xlabel));
8737: $ylabel = '' if (! defined($ylabel));
8738: my %ValuesHash =
8739: (
1.369 www 8740: $id.'.title' => &escape($Title),
8741: $id.'.xlabel' => &escape($xlabel),
8742: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8743: $id.'.labels' => join(',',@$Xlabels),
8744: $id.'.PlotType' => 'XY',
8745: $id.'.NumSets' => 2,
1.137 matthew 8746: $id.'.two_axes' => 1,
8747: $id.'.y1_max_value' => $Max1,
8748: $id.'.y1_min_value' => $Min1,
8749: $id.'.y2_max_value' => $Max2,
8750: $id.'.y2_min_value' => $Min2,
1.136 matthew 8751: );
8752: #
1.137 matthew 8753: if (defined($colors) && ref($colors) eq 'ARRAY') {
8754: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8755: }
8756: #
8757: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8758: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8759: return '';
8760: }
8761: my $NumSets=1;
1.137 matthew 8762: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8763: next if (! ref($array));
8764: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8765: }
8766: #
8767: # Deal with other parameters
8768: while (my ($key,$value) = each(%Values)) {
8769: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8770: }
8771: #
1.646 raeburn 8772: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8773: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8774: }
8775:
8776: ############################################################
8777: ############################################################
8778:
8779: =pod
8780:
1.157 matthew 8781: =back
8782:
1.139 matthew 8783: =head1 Statistics helper routines?
8784:
8785: Bad place for them but what the hell.
8786:
1.157 matthew 8787: =over 4
8788:
1.648 raeburn 8789: =item * &chartlink()
1.139 matthew 8790:
8791: Returns a link to the chart for a specific student.
8792:
8793: Inputs:
8794:
8795: =over 4
8796:
8797: =item $linktext: The text of the link
8798:
8799: =item $sname: The students username
8800:
8801: =item $sdomain: The students domain
8802:
8803: =back
8804:
1.157 matthew 8805: =back
8806:
1.139 matthew 8807: =cut
8808:
8809: ############################################################
8810: ############################################################
8811: sub chartlink {
8812: my ($linktext, $sname, $sdomain) = @_;
8813: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8814: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8815: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8816: '">'.$linktext.'</a>';
1.153 matthew 8817: }
8818:
8819: #######################################################
8820: #######################################################
8821:
8822: =pod
8823:
8824: =head1 Course Environment Routines
1.157 matthew 8825:
8826: =over 4
1.153 matthew 8827:
1.648 raeburn 8828: =item * &restore_course_settings()
1.153 matthew 8829:
1.648 raeburn 8830: =item * &store_course_settings()
1.153 matthew 8831:
8832: Restores/Store indicated form parameters from the course environment.
8833: Will not overwrite existing values of the form parameters.
8834:
8835: Inputs:
8836: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8837:
8838: a hash ref describing the data to be stored. For example:
8839:
8840: %Save_Parameters = ('Status' => 'scalar',
8841: 'chartoutputmode' => 'scalar',
8842: 'chartoutputdata' => 'scalar',
8843: 'Section' => 'array',
1.373 raeburn 8844: 'Group' => 'array',
1.153 matthew 8845: 'StudentData' => 'array',
8846: 'Maps' => 'array');
8847:
8848: Returns: both routines return nothing
8849:
1.631 raeburn 8850: =back
8851:
1.153 matthew 8852: =cut
8853:
8854: #######################################################
8855: #######################################################
8856: sub store_course_settings {
1.496 albertel 8857: return &store_settings($env{'request.course.id'},@_);
8858: }
8859:
8860: sub store_settings {
1.153 matthew 8861: # save to the environment
8862: # appenv the same items, just to be safe
1.300 albertel 8863: my $udom = $env{'user.domain'};
8864: my $uname = $env{'user.name'};
1.496 albertel 8865: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8866: my %SaveHash;
8867: my %AppHash;
8868: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8869: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8870: my $envname = 'environment.'.$basename;
1.258 albertel 8871: if (exists($env{'form.'.$setting})) {
1.153 matthew 8872: # Save this value away
8873: if ($type eq 'scalar' &&
1.258 albertel 8874: (! exists($env{$envname}) ||
8875: $env{$envname} ne $env{'form.'.$setting})) {
8876: $SaveHash{$basename} = $env{'form.'.$setting};
8877: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8878: } elsif ($type eq 'array') {
8879: my $stored_form;
1.258 albertel 8880: if (ref($env{'form.'.$setting})) {
1.153 matthew 8881: $stored_form = join(',',
8882: map {
1.369 www 8883: &escape($_);
1.258 albertel 8884: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8885: } else {
8886: $stored_form =
1.369 www 8887: &escape($env{'form.'.$setting});
1.153 matthew 8888: }
8889: # Determine if the array contents are the same.
1.258 albertel 8890: if ($stored_form ne $env{$envname}) {
1.153 matthew 8891: $SaveHash{$basename} = $stored_form;
8892: $AppHash{$envname} = $stored_form;
8893: }
8894: }
8895: }
8896: }
8897: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8898: $udom,$uname);
1.153 matthew 8899: if ($put_result !~ /^(ok|delayed)/) {
8900: &Apache::lonnet::logthis('unable to save form parameters, '.
8901: 'got error:'.$put_result);
8902: }
8903: # Make sure these settings stick around in this session, too
1.646 raeburn 8904: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8905: return;
8906: }
8907:
8908: sub restore_course_settings {
1.499 albertel 8909: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8910: }
8911:
8912: sub restore_settings {
8913: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8914: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8915: next if (exists($env{'form.'.$setting}));
1.496 albertel 8916: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8917: '.'.$setting;
1.258 albertel 8918: if (exists($env{$envname})) {
1.153 matthew 8919: if ($type eq 'scalar') {
1.258 albertel 8920: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8921: } elsif ($type eq 'array') {
1.258 albertel 8922: $env{'form.'.$setting} = [
1.153 matthew 8923: map {
1.369 www 8924: &unescape($_);
1.258 albertel 8925: } split(',',$env{$envname})
1.153 matthew 8926: ];
8927: }
8928: }
8929: }
1.127 matthew 8930: }
8931:
1.618 raeburn 8932: #######################################################
8933: #######################################################
8934:
8935: =pod
8936:
8937: =head1 Domain E-mail Routines
8938:
8939: =over 4
8940:
1.648 raeburn 8941: =item * &build_recipient_list()
1.618 raeburn 8942:
1.766 raeburn 8943: Build recipient lists for four types of e-mail:
8944: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
8945: (d) Help requests, generated by
8946: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618 raeburn 8947:
8948: Inputs:
1.619 raeburn 8949: defmail (scalar - email address of default recipient),
1.618 raeburn 8950: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8951: defdom (domain for which to retrieve configuration settings),
8952: origmail (scalar - email address of recipient from loncapa.conf,
8953: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8954:
1.655 raeburn 8955: Returns: comma separated list of addresses to which to send e-mail.
8956:
8957: =back
1.618 raeburn 8958:
8959: =cut
8960:
8961: ############################################################
8962: ############################################################
8963: sub build_recipient_list {
1.619 raeburn 8964: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8965: my @recipients;
8966: my $otheremails;
8967: my %domconfig =
8968: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8969: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 8970: if (exists($domconfig{'contacts'}{$mailing})) {
8971: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8972: my @contacts = ('adminemail','supportemail');
8973: foreach my $item (@contacts) {
8974: if ($domconfig{'contacts'}{$mailing}{$item}) {
8975: my $addr = $domconfig{'contacts'}{$item};
8976: if (!grep(/^\Q$addr\E$/,@recipients)) {
8977: push(@recipients,$addr);
8978: }
1.619 raeburn 8979: }
1.766 raeburn 8980: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 8981: }
8982: }
1.766 raeburn 8983: } elsif ($origmail ne '') {
8984: push(@recipients,$origmail);
1.618 raeburn 8985: }
1.619 raeburn 8986: } elsif ($origmail ne '') {
8987: push(@recipients,$origmail);
1.618 raeburn 8988: }
1.688 raeburn 8989: if (defined($defmail)) {
8990: if ($defmail ne '') {
8991: push(@recipients,$defmail);
8992: }
1.618 raeburn 8993: }
8994: if ($otheremails) {
1.619 raeburn 8995: my @others;
8996: if ($otheremails =~ /,/) {
8997: @others = split(/,/,$otheremails);
1.618 raeburn 8998: } else {
1.619 raeburn 8999: push(@others,$otheremails);
9000: }
9001: foreach my $addr (@others) {
9002: if (!grep(/^\Q$addr\E$/,@recipients)) {
9003: push(@recipients,$addr);
9004: }
1.618 raeburn 9005: }
9006: }
1.619 raeburn 9007: my $recipientlist = join(',',@recipients);
1.618 raeburn 9008: return $recipientlist;
9009: }
9010:
1.127 matthew 9011: ############################################################
9012: ############################################################
1.154 albertel 9013:
1.655 raeburn 9014: =pod
9015:
9016: =head1 Course Catalog Routines
9017:
9018: =over 4
9019:
9020: =item * &gather_categories()
9021:
9022: Converts category definitions - keys of categories hash stored in
9023: coursecategories in configuration.db on the primary library server in a
9024: domain - to an array. Also generates javascript and idx hash used to
9025: generate Domain Coordinator interface for editing Course Categories.
9026:
9027: Inputs:
1.663 raeburn 9028:
1.655 raeburn 9029: categories (reference to hash of category definitions).
1.663 raeburn 9030:
1.655 raeburn 9031: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9032: categories and subcategories).
1.663 raeburn 9033:
1.655 raeburn 9034: idx (reference to hash of counters used in Domain Coordinator interface for
9035: editing Course Categories).
1.663 raeburn 9036:
1.655 raeburn 9037: jsarray (reference to array of categories used to create Javascript arrays for
9038: Domain Coordinator interface for editing Course Categories).
9039:
9040: Returns: nothing
9041:
9042: Side effects: populates cats, idx and jsarray.
9043:
9044: =cut
9045:
9046: sub gather_categories {
9047: my ($categories,$cats,$idx,$jsarray) = @_;
9048: my %counters;
9049: my $num = 0;
9050: foreach my $item (keys(%{$categories})) {
9051: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
9052: if ($container eq '' && $depth == 0) {
9053: $cats->[$depth][$categories->{$item}] = $cat;
9054: } else {
9055: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
9056: }
9057: my ($escitem,$tail) = split(/:/,$item,2);
9058: if ($counters{$tail} eq '') {
9059: $counters{$tail} = $num;
9060: $num ++;
9061: }
9062: if (ref($idx) eq 'HASH') {
9063: $idx->{$item} = $counters{$tail};
9064: }
9065: if (ref($jsarray) eq 'ARRAY') {
9066: push(@{$jsarray->[$counters{$tail}]},$item);
9067: }
9068: }
9069: return;
9070: }
9071:
9072: =pod
9073:
9074: =item * &extract_categories()
9075:
9076: Used to generate breadcrumb trails for course categories.
9077:
9078: Inputs:
1.663 raeburn 9079:
1.655 raeburn 9080: categories (reference to hash of category definitions).
1.663 raeburn 9081:
1.655 raeburn 9082: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9083: categories and subcategories).
1.663 raeburn 9084:
1.655 raeburn 9085: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9086:
1.655 raeburn 9087: allitems (reference to hash - key is category key
9088: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9089:
1.655 raeburn 9090: idx (reference to hash of counters used in Domain Coordinator interface for
9091: editing Course Categories).
1.663 raeburn 9092:
1.655 raeburn 9093: jsarray (reference to array of categories used to create Javascript arrays for
9094: Domain Coordinator interface for editing Course Categories).
9095:
1.665 raeburn 9096: subcats (reference to hash of arrays containing all subcategories within each
9097: category, -recursive)
9098:
1.655 raeburn 9099: Returns: nothing
9100:
9101: Side effects: populates trails and allitems hash references.
9102:
9103: =cut
9104:
9105: sub extract_categories {
1.665 raeburn 9106: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9107: if (ref($categories) eq 'HASH') {
9108: &gather_categories($categories,$cats,$idx,$jsarray);
9109: if (ref($cats->[0]) eq 'ARRAY') {
9110: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9111: my $name = $cats->[0][$i];
9112: my $item = &escape($name).'::0';
9113: my $trailstr;
9114: if ($name eq 'instcode') {
9115: $trailstr = &mt('Official courses (with institutional codes)');
9116: } else {
9117: $trailstr = $name;
9118: }
9119: if ($allitems->{$item} eq '') {
9120: push(@{$trails},$trailstr);
9121: $allitems->{$item} = scalar(@{$trails})-1;
9122: }
9123: my @parents = ($name);
9124: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9125: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9126: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9127: if (ref($subcats) eq 'HASH') {
9128: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9129: }
9130: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9131: }
9132: } else {
9133: if (ref($subcats) eq 'HASH') {
9134: $subcats->{$item} = [];
1.655 raeburn 9135: }
9136: }
9137: }
9138: }
9139: }
9140: return;
9141: }
9142:
9143: =pod
9144:
9145: =item *&recurse_categories()
9146:
9147: Recursively used to generate breadcrumb trails for course categories.
9148:
9149: Inputs:
1.663 raeburn 9150:
1.655 raeburn 9151: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9152: categories and subcategories).
1.663 raeburn 9153:
1.655 raeburn 9154: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9155:
9156: category (current course category, for which breadcrumb trail is being generated).
9157:
9158: trails (reference to array of breadcrumb trails for each category).
9159:
1.655 raeburn 9160: allitems (reference to hash - key is category key
9161: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9162:
1.655 raeburn 9163: parents (array containing containers directories for current category,
9164: back to top level).
9165:
9166: Returns: nothing
9167:
9168: Side effects: populates trails and allitems hash references
9169:
9170: =cut
9171:
9172: sub recurse_categories {
1.665 raeburn 9173: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9174: my $shallower = $depth - 1;
9175: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9176: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9177: my $name = $cats->[$depth]{$category}[$k];
9178: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9179: my $trailstr = join(' -> ',(@{$parents},$category));
9180: if ($allitems->{$item} eq '') {
9181: push(@{$trails},$trailstr);
9182: $allitems->{$item} = scalar(@{$trails})-1;
9183: }
9184: my $deeper = $depth+1;
9185: push(@{$parents},$category);
1.665 raeburn 9186: if (ref($subcats) eq 'HASH') {
9187: my $subcat = &escape($name).':'.$category.':'.$depth;
9188: for (my $j=@{$parents}; $j>=0; $j--) {
9189: my $higher;
9190: if ($j > 0) {
9191: $higher = &escape($parents->[$j]).':'.
9192: &escape($parents->[$j-1]).':'.$j;
9193: } else {
9194: $higher = &escape($parents->[$j]).'::'.$j;
9195: }
9196: push(@{$subcats->{$higher}},$subcat);
9197: }
9198: }
9199: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9200: $subcats);
1.655 raeburn 9201: pop(@{$parents});
9202: }
9203: } else {
9204: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9205: my $trailstr = join(' -> ',(@{$parents},$category));
9206: if ($allitems->{$item} eq '') {
9207: push(@{$trails},$trailstr);
9208: $allitems->{$item} = scalar(@{$trails})-1;
9209: }
9210: }
9211: return;
9212: }
9213:
1.663 raeburn 9214: =pod
9215:
9216: =item *&assign_categories_table()
9217:
9218: Create a datatable for display of hierarchical categories in a domain,
9219: with checkboxes to allow a course to be categorized.
9220:
9221: Inputs:
9222:
9223: cathash - reference to hash of categories defined for the domain (from
9224: configuration.db)
9225:
9226: currcat - scalar with an & separated list of categories assigned to a course.
9227:
9228: Returns: $output (markup to be displayed)
9229:
9230: =cut
9231:
9232: sub assign_categories_table {
9233: my ($cathash,$currcat) = @_;
9234: my $output;
9235: if (ref($cathash) eq 'HASH') {
9236: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9237: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9238: $maxdepth = scalar(@cats);
9239: if (@cats > 0) {
9240: my $itemcount = 0;
9241: if (ref($cats[0]) eq 'ARRAY') {
9242: $output = &Apache::loncommon::start_data_table();
9243: my @currcategories;
9244: if ($currcat ne '') {
9245: @currcategories = split('&',$currcat);
9246: }
9247: for (my $i=0; $i<@{$cats[0]}; $i++) {
9248: my $parent = $cats[0][$i];
9249: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9250: next if ($parent eq 'instcode');
9251: my $item = &escape($parent).'::0';
9252: my $checked = '';
9253: if (@currcategories > 0) {
9254: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9255: $checked = ' checked="checked"';
1.663 raeburn 9256: }
9257: }
1.675 raeburn 9258: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9259: '<input type="checkbox" name="usecategory" value="'.
9260: $item.'"'.$checked.' />'.$parent.'</span>'.
9261: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9262: my $depth = 1;
9263: push(@path,$parent);
9264: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9265: pop(@path);
9266: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9267: $itemcount ++;
9268: }
9269: $output .= &Apache::loncommon::end_data_table();
9270: }
9271: }
9272: }
9273: return $output;
9274: }
9275:
9276: =pod
9277:
9278: =item *&assign_category_rows()
9279:
9280: Create a datatable row for display of nested categories in a domain,
9281: with checkboxes to allow a course to be categorized,called recursively.
9282:
9283: Inputs:
9284:
9285: itemcount - track row number for alternating colors
9286:
9287: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9288: categories and subcategories.
9289:
9290: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9291:
9292: parent - parent of current category item
9293:
9294: path - Array containing all categories back up through the hierarchy from the
9295: current category to the top level.
9296:
9297: currcategories - reference to array of current categories assigned to the course
9298:
9299: Returns: $output (markup to be displayed).
9300:
9301: =cut
9302:
9303: sub assign_category_rows {
9304: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9305: my ($text,$name,$item,$chgstr);
9306: if (ref($cats) eq 'ARRAY') {
9307: my $maxdepth = scalar(@{$cats});
9308: if (ref($cats->[$depth]) eq 'HASH') {
9309: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9310: my $numchildren = @{$cats->[$depth]{$parent}};
9311: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9312: $text .= '<td><table class="LC_datatable">';
9313: for (my $j=0; $j<$numchildren; $j++) {
9314: $name = $cats->[$depth]{$parent}[$j];
9315: $item = &escape($name).':'.&escape($parent).':'.$depth;
9316: my $deeper = $depth+1;
9317: my $checked = '';
9318: if (ref($currcategories) eq 'ARRAY') {
9319: if (@{$currcategories} > 0) {
9320: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9321: $checked = ' checked="checked"';
1.663 raeburn 9322: }
9323: }
9324: }
1.664 raeburn 9325: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9326: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9327: $item.'"'.$checked.' />'.$name.'</label></span>'.
9328: '<input type="hidden" name="catname" value="'.$name.'" />'.
9329: '</td><td>';
1.663 raeburn 9330: if (ref($path) eq 'ARRAY') {
9331: push(@{$path},$name);
9332: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9333: pop(@{$path});
9334: }
9335: $text .= '</td></tr>';
9336: }
9337: $text .= '</table></td>';
9338: }
9339: }
9340: }
9341: return $text;
9342: }
9343:
1.655 raeburn 9344: ############################################################
9345: ############################################################
9346:
9347:
1.443 albertel 9348: sub commit_customrole {
1.664 raeburn 9349: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9350: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9351: ($start?', '.&mt('starting').' '.localtime($start):'').
9352: ($end?', ending '.localtime($end):'').': <b>'.
9353: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9354: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9355: '</b><br />';
9356: return $output;
9357: }
9358:
9359: sub commit_standardrole {
1.541 raeburn 9360: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9361: my ($output,$logmsg,$linefeed);
9362: if ($context eq 'auto') {
9363: $linefeed = "\n";
9364: } else {
9365: $linefeed = "<br />\n";
9366: }
1.443 albertel 9367: if ($three eq 'st') {
1.541 raeburn 9368: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9369: $one,$two,$sec,$context);
9370: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9371: ($result eq 'unknown_course') || ($result eq 'refused')) {
9372: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9373: } else {
1.541 raeburn 9374: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9375: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9376: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9377: if ($context eq 'auto') {
9378: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9379: } else {
9380: $output .= '<b>'.$result.'</b>'.$linefeed.
9381: &mt('Add to classlist').': <b>ok</b>';
9382: }
9383: $output .= $linefeed;
1.443 albertel 9384: }
9385: } else {
9386: $output = &mt('Assigning').' '.$three.' in '.$url.
9387: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9388: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9389: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9390: if ($context eq 'auto') {
9391: $output .= $result.$linefeed;
9392: } else {
9393: $output .= '<b>'.$result.'</b>'.$linefeed;
9394: }
1.443 albertel 9395: }
9396: return $output;
9397: }
9398:
9399: sub commit_studentrole {
1.541 raeburn 9400: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9401: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9402: if ($context eq 'auto') {
9403: $linefeed = "\n";
9404: } else {
9405: $linefeed = '<br />'."\n";
9406: }
1.443 albertel 9407: if (defined($one) && defined($two)) {
9408: my $cid=$one.'_'.$two;
9409: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9410: my $secchange = 0;
9411: my $expire_role_result;
9412: my $modify_section_result;
1.628 raeburn 9413: if ($oldsec ne '-1') {
9414: if ($oldsec ne $sec) {
1.443 albertel 9415: $secchange = 1;
1.628 raeburn 9416: my $now = time;
1.443 albertel 9417: my $uurl='/'.$cid;
9418: $uurl=~s/\_/\//g;
9419: if ($oldsec) {
9420: $uurl.='/'.$oldsec;
9421: }
1.626 raeburn 9422: $oldsecurl = $uurl;
1.628 raeburn 9423: $expire_role_result =
1.652 raeburn 9424: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9425: if ($env{'request.course.sec'} ne '') {
9426: if ($expire_role_result eq 'refused') {
9427: my @roles = ('st');
9428: my @statuses = ('previous');
9429: my @roledoms = ($one);
9430: my $withsec = 1;
9431: my %roleshash =
9432: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9433: \@statuses,\@roles,\@roledoms,$withsec);
9434: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9435: my ($oldstart,$oldend) =
9436: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9437: if ($oldend > 0 && $oldend <= $now) {
9438: $expire_role_result = 'ok';
9439: }
9440: }
9441: }
9442: }
1.443 albertel 9443: $result = $expire_role_result;
9444: }
9445: }
9446: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9447: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9448: if ($modify_section_result =~ /^ok/) {
9449: if ($secchange == 1) {
1.628 raeburn 9450: if ($sec eq '') {
9451: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9452: } else {
9453: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9454: }
1.443 albertel 9455: } elsif ($oldsec eq '-1') {
1.628 raeburn 9456: if ($sec eq '') {
9457: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9458: } else {
9459: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9460: }
1.443 albertel 9461: } else {
1.628 raeburn 9462: if ($sec eq '') {
9463: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9464: } else {
9465: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9466: }
1.443 albertel 9467: }
9468: } else {
1.628 raeburn 9469: if ($secchange) {
9470: $$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;
9471: } else {
9472: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9473: }
1.443 albertel 9474: }
9475: $result = $modify_section_result;
9476: } elsif ($secchange == 1) {
1.628 raeburn 9477: if ($oldsec eq '') {
9478: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9479: } else {
9480: $$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;
9481: }
1.626 raeburn 9482: if ($expire_role_result eq 'refused') {
9483: my $newsecurl = '/'.$cid;
9484: $newsecurl =~ s/\_/\//g;
9485: if ($sec ne '') {
9486: $newsecurl.='/'.$sec;
9487: }
9488: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9489: if ($sec eq '') {
9490: $$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;
9491: } else {
9492: $$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;
9493: }
9494: }
9495: }
1.443 albertel 9496: }
9497: } else {
1.626 raeburn 9498: $$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 9499: $result = "error: incomplete course id\n";
9500: }
9501: return $result;
9502: }
9503:
9504: ############################################################
9505: ############################################################
9506:
1.566 albertel 9507: sub check_clone {
1.578 raeburn 9508: my ($args,$linefeed) = @_;
1.566 albertel 9509: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9510: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9511: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9512: my $clonemsg;
9513: my $can_clone = 0;
9514:
9515: if ($clonehome eq 'no_host') {
1.578 raeburn 9516: $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 9517: } else {
9518: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9519: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9520: $can_clone = 1;
9521: } else {
9522: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9523: $args->{'clonedomain'},$args->{'clonecourse'});
9524: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9525: if (grep(/^\*$/,@cloners)) {
9526: $can_clone = 1;
9527: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9528: $can_clone = 1;
9529: } else {
9530: my %roleshash =
9531: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9532: $args->{'ccdomain'},
9533: 'userroles',['active'],['cc'],
9534: [$args->{'clonedomain'}]);
9535: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9536: $can_clone = 1;
9537: } else {
9538: $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'});
9539: }
1.566 albertel 9540: }
1.578 raeburn 9541: }
1.566 albertel 9542: }
9543: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9544: }
9545:
1.444 albertel 9546: sub construct_course {
1.541 raeburn 9547: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9548: my $outcome;
1.541 raeburn 9549: my $linefeed = '<br />'."\n";
9550: if ($context eq 'auto') {
9551: $linefeed = "\n";
9552: }
1.566 albertel 9553:
9554: #
9555: # Are we cloning?
9556: #
9557: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9558: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9559: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9560: if ($context ne 'auto') {
1.578 raeburn 9561: if ($clonemsg ne '') {
9562: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9563: }
1.566 albertel 9564: }
9565: $outcome .= $clonemsg.$linefeed;
9566:
9567: if (!$can_clone) {
9568: return (0,$outcome);
9569: }
9570: }
9571:
1.444 albertel 9572: #
9573: # Open course
9574: #
9575: my $crstype = lc($args->{'crstype'});
9576: my %cenv=();
9577: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9578: $args->{'cdescr'},
9579: $args->{'curl'},
9580: $args->{'course_home'},
9581: $args->{'nonstandard'},
9582: $args->{'crscode'},
9583: $args->{'ccuname'}.':'.
9584: $args->{'ccdomain'},
9585: $args->{'crstype'});
9586:
9587: # Note: The testing routines depend on this being output; see
9588: # Utils::Course. This needs to at least be output as a comment
9589: # if anyone ever decides to not show this, and Utils::Course::new
9590: # will need to be suitably modified.
1.541 raeburn 9591: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9592: #
9593: # Check if created correctly
9594: #
1.479 albertel 9595: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9596: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9597: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9598:
1.444 albertel 9599: #
1.566 albertel 9600: # Do the cloning
9601: #
9602: if ($can_clone && $cloneid) {
9603: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9604: if ($context ne 'auto') {
9605: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9606: }
9607: $outcome .= $clonemsg.$linefeed;
9608: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9609: # Copy all files
1.637 www 9610: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9611: # Restore URL
1.566 albertel 9612: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9613: # Restore title
1.566 albertel 9614: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9615: # Mark as cloned
1.566 albertel 9616: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9617: # Need to clone grading mode
9618: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9619: $cenv{'grading'}=$newenv{'grading'};
9620: # Do not clone these environment entries
9621: &Apache::lonnet::del('environment',
9622: ['default_enrollment_start_date',
9623: 'default_enrollment_end_date',
9624: 'question.email',
9625: 'policy.email',
9626: 'comment.email',
9627: 'pch.users.denied',
1.725 raeburn 9628: 'plc.users.denied',
9629: 'hidefromcat',
9630: 'categories'],
1.638 www 9631: $$crsudom,$$crsunum);
1.444 albertel 9632: }
1.566 albertel 9633:
1.444 albertel 9634: #
9635: # Set environment (will override cloned, if existing)
9636: #
9637: my @sections = ();
9638: my @xlists = ();
9639: if ($args->{'crstype'}) {
9640: $cenv{'type'}=$args->{'crstype'};
9641: }
9642: if ($args->{'crsid'}) {
9643: $cenv{'courseid'}=$args->{'crsid'};
9644: }
9645: if ($args->{'crscode'}) {
9646: $cenv{'internal.coursecode'}=$args->{'crscode'};
9647: }
9648: if ($args->{'crsquota'} ne '') {
9649: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9650: } else {
9651: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9652: }
9653: if ($args->{'ccuname'}) {
9654: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9655: ':'.$args->{'ccdomain'};
9656: } else {
9657: $cenv{'internal.courseowner'} = $args->{'curruser'};
9658: }
9659: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9660: if ($args->{'crssections'}) {
9661: $cenv{'internal.sectionnums'} = '';
9662: if ($args->{'crssections'} =~ m/,/) {
9663: @sections = split/,/,$args->{'crssections'};
9664: } else {
9665: $sections[0] = $args->{'crssections'};
9666: }
9667: if (@sections > 0) {
9668: foreach my $item (@sections) {
9669: my ($sec,$gp) = split/:/,$item;
9670: my $class = $args->{'crscode'}.$sec;
9671: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9672: $cenv{'internal.sectionnums'} .= $item.',';
9673: unless ($addcheck eq 'ok') {
9674: push @badclasses, $class;
9675: }
9676: }
9677: $cenv{'internal.sectionnums'} =~ s/,$//;
9678: }
9679: }
9680: # do not hide course coordinator from staff listing,
9681: # even if privileged
9682: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9683: # add crosslistings
9684: if ($args->{'crsxlist'}) {
9685: $cenv{'internal.crosslistings'}='';
9686: if ($args->{'crsxlist'} =~ m/,/) {
9687: @xlists = split/,/,$args->{'crsxlist'};
9688: } else {
9689: $xlists[0] = $args->{'crsxlist'};
9690: }
9691: if (@xlists > 0) {
9692: foreach my $item (@xlists) {
9693: my ($xl,$gp) = split/:/,$item;
9694: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9695: $cenv{'internal.crosslistings'} .= $item.',';
9696: unless ($addcheck eq 'ok') {
9697: push @badclasses, $xl;
9698: }
9699: }
9700: $cenv{'internal.crosslistings'} =~ s/,$//;
9701: }
9702: }
9703: if ($args->{'autoadds'}) {
9704: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9705: }
9706: if ($args->{'autodrops'}) {
9707: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9708: }
9709: # check for notification of enrollment changes
9710: my @notified = ();
9711: if ($args->{'notify_owner'}) {
9712: if ($args->{'ccuname'} ne '') {
9713: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9714: }
9715: }
9716: if ($args->{'notify_dc'}) {
9717: if ($uname ne '') {
1.630 raeburn 9718: push(@notified,$uname.':'.$udom);
1.444 albertel 9719: }
9720: }
9721: if (@notified > 0) {
9722: my $notifylist;
9723: if (@notified > 1) {
9724: $notifylist = join(',',@notified);
9725: } else {
9726: $notifylist = $notified[0];
9727: }
9728: $cenv{'internal.notifylist'} = $notifylist;
9729: }
9730: if (@badclasses > 0) {
9731: my %lt=&Apache::lonlocal::texthash(
9732: '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',
9733: 'dnhr' => 'does not have rights to access enrollment in these classes',
9734: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9735: );
1.541 raeburn 9736: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9737: ' ('.$lt{'adby'}.')';
9738: if ($context eq 'auto') {
9739: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9740: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9741: foreach my $item (@badclasses) {
9742: if ($context eq 'auto') {
9743: $outcome .= " - $item\n";
9744: } else {
9745: $outcome .= "<li>$item</li>\n";
9746: }
9747: }
9748: if ($context eq 'auto') {
9749: $outcome .= $linefeed;
9750: } else {
1.566 albertel 9751: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9752: }
9753: }
1.444 albertel 9754: }
9755: if ($args->{'no_end_date'}) {
9756: $args->{'endaccess'} = 0;
9757: }
9758: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9759: $cenv{'internal.autoend'}=$args->{'enrollend'};
9760: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9761: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9762: if ($args->{'showphotos'}) {
9763: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9764: }
9765: $cenv{'internal.authtype'} = $args->{'authtype'};
9766: $cenv{'internal.autharg'} = $args->{'autharg'};
9767: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9768: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9769: 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');
9770: if ($context eq 'auto') {
9771: $outcome .= $krb_msg;
9772: } else {
1.566 albertel 9773: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9774: }
9775: $outcome .= $linefeed;
1.444 albertel 9776: }
9777: }
9778: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9779: if ($args->{'setpolicy'}) {
9780: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9781: }
9782: if ($args->{'setcontent'}) {
9783: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9784: }
9785: }
9786: if ($args->{'reshome'}) {
9787: $cenv{'reshome'}=$args->{'reshome'}.'/';
9788: $cenv{'reshome'}=~s/\/+$/\//;
9789: }
9790: #
9791: # course has keyed access
9792: #
9793: if ($args->{'setkeys'}) {
9794: $cenv{'keyaccess'}='yes';
9795: }
9796: # if specified, key authority is not course, but user
9797: # only active if keyaccess is yes
9798: if ($args->{'keyauth'}) {
1.487 albertel 9799: my ($user,$domain) = split(':',$args->{'keyauth'});
9800: $user = &LONCAPA::clean_username($user);
9801: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9802: if ($user ne '' && $domain ne '') {
1.487 albertel 9803: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9804: }
9805: }
9806:
9807: if ($args->{'disresdis'}) {
9808: $cenv{'pch.roles.denied'}='st';
9809: }
9810: if ($args->{'disablechat'}) {
9811: $cenv{'plc.roles.denied'}='st';
9812: }
9813:
9814: # Record we've not yet viewed the Course Initialization Helper for this
9815: # course
9816: $cenv{'course.helper.not.run'} = 1;
9817: #
9818: # Use new Randomseed
9819: #
9820: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9821: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9822: #
9823: # The encryption code and receipt prefix for this course
9824: #
9825: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9826: $cenv{'internal.encpref'}=100+int(9*rand(99));
9827: #
9828: # By default, use standard grading
9829: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9830:
1.541 raeburn 9831: $outcome .= $linefeed.&mt('Setting environment').': '.
9832: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9833: #
9834: # Open all assignments
9835: #
9836: if ($args->{'openall'}) {
9837: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9838: my %storecontent = ($storeunder => time,
9839: $storeunder.'.type' => 'date_start');
9840:
9841: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9842: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9843: }
9844: #
9845: # Set first page
9846: #
9847: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9848: || ($cloneid)) {
1.445 albertel 9849: use LONCAPA::map;
1.444 albertel 9850: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9851:
9852: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9853: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9854:
1.444 albertel 9855: $outcome .= ($fatal?$errtext:'read ok').' - ';
9856: my $title; my $url;
9857: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9858: $title=&mt('Syllabus');
1.444 albertel 9859: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9860: } else {
1.690 bisitz 9861: $title=&mt('Navigate Contents');
1.444 albertel 9862: $url='/adm/navmaps';
9863: }
1.445 albertel 9864:
9865: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9866: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9867:
9868: if ($errtext) { $fatal=2; }
1.541 raeburn 9869: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9870: }
1.566 albertel 9871:
9872: return (1,$outcome);
1.444 albertel 9873: }
9874:
9875: ############################################################
9876: ############################################################
9877:
1.378 raeburn 9878: sub course_type {
9879: my ($cid) = @_;
9880: if (!defined($cid)) {
9881: $cid = $env{'request.course.id'};
9882: }
1.404 albertel 9883: if (defined($env{'course.'.$cid.'.type'})) {
9884: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9885: } else {
9886: return 'Course';
1.377 raeburn 9887: }
9888: }
1.156 albertel 9889:
1.406 raeburn 9890: sub group_term {
9891: my $crstype = &course_type();
9892: my %names = (
9893: 'Course' => 'group',
9894: 'Group' => 'team',
9895: );
9896: return $names{$crstype};
9897: }
9898:
1.156 albertel 9899: sub icon {
9900: my ($file)=@_;
1.505 albertel 9901: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9902: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9903: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9904: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9905: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9906: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9907: $curfext.".gif") {
9908: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9909: $curfext.".gif";
9910: }
9911: }
1.249 albertel 9912: return &lonhttpdurl($iconname);
1.154 albertel 9913: }
1.84 albertel 9914:
1.575 albertel 9915: sub lonhttpdurl {
1.692 www 9916: #
9917: # Had been used for "small fry" static images on separate port 8080.
9918: # Modify here if lightweight http functionality desired again.
9919: # Currently eliminated due to increasing firewall issues.
9920: #
1.575 albertel 9921: my ($url)=@_;
1.692 www 9922: return $url;
1.215 albertel 9923: }
9924:
1.213 albertel 9925: sub connection_aborted {
9926: my ($r)=@_;
9927: $r->print(" ");$r->rflush();
9928: my $c = $r->connection;
9929: return $c->aborted();
9930: }
9931:
1.221 foxr 9932: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9933: # strings as 'strings'.
9934: sub escape_single {
1.221 foxr 9935: my ($input) = @_;
1.223 albertel 9936: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9937: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9938: return $input;
9939: }
1.223 albertel 9940:
1.222 foxr 9941: # Same as escape_single, but escape's "'s This
9942: # can be used for "strings"
9943: sub escape_double {
9944: my ($input) = @_;
9945: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9946: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9947: return $input;
9948: }
1.223 albertel 9949:
1.222 foxr 9950: # Escapes the last element of a full URL.
9951: sub escape_url {
9952: my ($url) = @_;
1.238 raeburn 9953: my @urlslices = split(/\//, $url,-1);
1.369 www 9954: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9955: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9956: }
1.462 albertel 9957:
9958: # -------------------------------------------------------- Initliaze user login
9959: sub init_user_environment {
1.463 albertel 9960: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9961: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9962:
9963: my $public=($username eq 'public' && $domain eq 'public');
9964:
9965: # See if old ID present, if so, remove
9966:
9967: my ($filename,$cookie,$userroles);
9968: my $now=time;
9969:
9970: if ($public) {
9971: my $max_public=100;
9972: my $oldest;
9973: my $oldest_time=0;
9974: for(my $next=1;$next<=$max_public;$next++) {
9975: if (-e $lonids."/publicuser_$next.id") {
9976: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9977: if ($mtime<$oldest_time || !$oldest_time) {
9978: $oldest_time=$mtime;
9979: $oldest=$next;
9980: }
9981: } else {
9982: $cookie="publicuser_$next";
9983: last;
9984: }
9985: }
9986: if (!$cookie) { $cookie="publicuser_$oldest"; }
9987: } else {
1.463 albertel 9988: # if this isn't a robot, kill any existing non-robot sessions
9989: if (!$args->{'robot'}) {
9990: opendir(DIR,$lonids);
9991: while ($filename=readdir(DIR)) {
9992: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9993: unlink($lonids.'/'.$filename);
9994: }
1.462 albertel 9995: }
1.463 albertel 9996: closedir(DIR);
1.462 albertel 9997: }
9998: # Give them a new cookie
1.463 albertel 9999: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 10000: : $now.$$.int(rand(10000)));
1.463 albertel 10001: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 10002:
10003: # Initialize roles
10004:
10005: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10006: }
10007: # ------------------------------------ Check browser type and MathML capability
10008:
10009: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10010: $clientunicode,$clientos) = &decode_user_agent($r);
10011:
10012: # -------------------------------------- Any accessibility options to remember?
10013: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
10014: foreach my $option ('imagesuppress','appletsuppress',
10015: 'embedsuppress','fontenhance','blackwhite') {
10016: if ($form->{$option} eq 'true') {
10017: &Apache::lonnet::put('environment',{$option => 'on'},
10018: $domain,$username);
10019: } else {
10020: &Apache::lonnet::del('environment',[$option],
10021: $domain,$username);
10022: }
10023: }
10024: }
10025: # ------------------------------------------------------------- Get environment
10026:
10027: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10028: my ($tmp) = keys(%userenv);
10029: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10030: # default remote control to off
10031: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10032: } else {
10033: undef(%userenv);
10034: }
10035: if (($userenv{'interface'}) && (!$form->{'interface'})) {
10036: $form->{'interface'}=$userenv{'interface'};
10037: }
10038: $env{'environment.remote'}=$userenv{'remote'};
10039: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10040:
10041: # --------------- Do not trust query string to be put directly into environment
10042: foreach my $option ('imagesuppress','appletsuppress',
10043: 'embedsuppress','fontenhance','blackwhite',
10044: 'interface','localpath','localres') {
10045: $form->{$option}=~s/[\n\r\=]//gs;
10046: }
10047: # --------------------------------------------------------- Write first profile
10048:
10049: {
10050: my %initial_env =
10051: ("user.name" => $username,
10052: "user.domain" => $domain,
10053: "user.home" => $authhost,
10054: "browser.type" => $clientbrowser,
10055: "browser.version" => $clientversion,
10056: "browser.mathml" => $clientmathml,
10057: "browser.unicode" => $clientunicode,
10058: "browser.os" => $clientos,
10059: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
10060: "request.course.fn" => '',
10061: "request.course.uri" => '',
10062: "request.course.sec" => '',
10063: "request.role" => 'cm',
10064: "request.role.adv" => $env{'user.adv'},
10065: "request.host" => $ENV{'REMOTE_ADDR'},);
10066:
10067: if ($form->{'localpath'}) {
10068: $initial_env{"browser.localpath"} = $form->{'localpath'};
10069: $initial_env{"browser.localres"} = $form->{'localres'};
10070: }
10071:
10072: if ($public) {
10073: $initial_env{"environment.remote"} = "off";
10074: }
10075: if ($form->{'interface'}) {
10076: $form->{'interface'}=~s/\W//gs;
10077: $initial_env{"browser.interface"} = $form->{'interface'};
10078: $env{'browser.interface'}=$form->{'interface'};
10079: foreach my $option ('imagesuppress','appletsuppress',
10080: 'embedsuppress','fontenhance','blackwhite') {
10081: if (($form->{$option} eq 'true') ||
10082: ($userenv{$option} eq 'on')) {
10083: $initial_env{"browser.$option"} = "on";
10084: }
10085: }
10086: }
10087:
1.724 raeburn 10088: foreach my $tool ('aboutme','blog','portfolio') {
10089: $userenv{'availabletools.'.$tool} =
10090: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10091: }
10092:
1.765 raeburn 10093: foreach my $crstype ('official','unofficial') {
10094: $userenv{'canrequest.'.$crstype} =
10095: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10096: 'reload','requestcourses');
10097: }
10098:
1.462 albertel 10099: $env{'user.environment'} = "$lonids/$cookie.id";
10100:
10101: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10102: &GDBM_WRCREAT(),0640)) {
10103: &_add_to_env(\%disk_env,\%initial_env);
10104: &_add_to_env(\%disk_env,\%userenv,'environment.');
10105: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10106: if (ref($args->{'extra_env'})) {
10107: &_add_to_env(\%disk_env,$args->{'extra_env'});
10108: }
1.462 albertel 10109: untie(%disk_env);
10110: } else {
1.705 tempelho 10111: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10112: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10113: return 'error: '.$!;
10114: }
10115: }
10116: $env{'request.role'}='cm';
10117: $env{'request.role.adv'}=$env{'user.adv'};
10118: $env{'browser.type'}=$clientbrowser;
10119:
10120: return $cookie;
10121:
10122: }
10123:
10124: sub _add_to_env {
10125: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10126: if (ref($env_data) eq 'HASH') {
10127: while (my ($key,$value) = each(%$env_data)) {
10128: $idf->{$prefix.$key} = $value;
10129: $env{$prefix.$key} = $value;
10130: }
1.462 albertel 10131: }
10132: }
10133:
1.685 tempelho 10134: # --- Get the symbolic name of a problem and the url
10135: sub get_symb {
10136: my ($request,$silent) = @_;
1.726 raeburn 10137: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10138: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10139: if ($symb eq '') {
10140: if (!$silent) {
10141: $request->print("Unable to handle ambiguous references:$url:.");
10142: return ();
10143: }
10144: }
10145: &Apache::lonenc::check_decrypt(\$symb);
10146: return ($symb);
10147: }
10148:
10149: # --------------------------------------------------------------Get annotation
10150:
10151: sub get_annotation {
10152: my ($symb,$enc) = @_;
10153:
10154: my $key = $symb;
10155: if (!$enc) {
10156: $key =
10157: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10158: }
10159: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10160: return $annotation{$key};
10161: }
10162:
10163: sub clean_symb {
1.731 raeburn 10164: my ($symb,$delete_enc) = @_;
1.685 tempelho 10165:
10166: &Apache::lonenc::check_decrypt(\$symb);
10167: my $enc = $env{'request.enc'};
1.731 raeburn 10168: if ($delete_enc) {
1.730 raeburn 10169: delete($env{'request.enc'});
10170: }
1.685 tempelho 10171:
10172: return ($symb,$enc);
10173: }
1.462 albertel 10174:
1.41 ng 10175: =pod
10176:
10177: =back
10178:
1.112 bowersj2 10179: =cut
1.41 ng 10180:
1.112 bowersj2 10181: 1;
10182: __END__;
1.41 ng 10183:
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